include/wav_player_internal.h

   1 /*
   2 * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3 *
   4 * Licensed under the Apache License, Version 2.0 (the "License");
   5 * you may not use this file except in compliance with the License.
   6 * You may obtain a copy of the License at
   7 *
   8 * http://www.apache.org/licenses/LICENSE-2.0
   9 *
  10 * Unless required by applicable law or agreed to in writing, software
  11 * distributed under the License is distributed on an "AS IS" BASIS,
  12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 * See the License for the specific language governing permissions and
  14 * limitations under the License.
  15 */
  16
  17
  18
  19
  20 #ifndef __TIZEN_MEDIA_WAV_PLAYER_INTERNAL_H__
  21 #define __TIZEN_MEDIA_WAV_PLAYER_INTERNAL_H__
  22
  23 #include <tizen.h>
  24 #include <sound_manager.h>
  25 #include <wav_player.h>
  26
  27 #ifdef __cplusplus
  28 extern "C"
  29 {
  30 #endif
  31
  32 /**
  33  * @file wav_player_internal.h
  34  * @brief This file contains the Wav Player Internal API
  35  */
  36
  37 /**
  38  * @addtogroup CAPI_MEDIA_WAV_PLAYER_MODULE
  39  * @{
  40  */
  41
  42 /**
  43  * @internal
  44  * @brief Plays a WAV file with loop.
  45  * @since_tizen 3.0
  46  *
  47  * @param[in] path      The file path to play
  48  * @param[in] stream_info       The sound stream information handle
  49  * @param[in] loop_count        The number of loop (@c 0 = infinite)
  50  * @param[in] callback  The callback function to be invoked when a WAV file is no longer being played
  51  * @param[in] user_data The user data to be passed to the callback function
  52  * @param[out] id       The WAV player ID (can be set to @c NULL)
  53  *
  54  * @return @c 0 on success,
  55  *         otherwise a negative error value
  56  * @retval #WAV_PLAYER_ERROR_NONE Successful
  57  * @retval #WAV_PLAYER_ERROR_INVALID_PARAMETER Invalid parameter
  58  * @retval #WAV_PLAYER_ERROR_INVALID_OPERATION Invalid operation
  59  * @retval #WAV_PLAYER_ERROR_FORMAT_NOT_SUPPORTED Not supported format
  60  * @retval #WAV_PLAYER_ERROR_NOT_SUPPORTED_TYPE Not supported stream type
  61  *
  62  * @post        It invokes wav_player_playback_completed_cb() when a WAV file is no longer being played.
  63  * @see wav_player_stop()
  64  * @see wav_player_playback_completed_cb()
  65  * @see sound_manager_create_stream_information()
  66  * @see sound_manager_destroy_stream_information()
  67  */
  68 int wav_player_start_loop(const char *path, sound_stream_info_h stream_info, unsigned int loop_count, wav_player_playback_completed_cb callback, void *user_data, int *id);
  69
  70 /**
  71  * @}
  72  */
  73
  74 #ifdef __cplusplus
  75 }
  76 #endif
  77
  78 #endif /* __TIZEN_MEDIA_WAV_PLAYER_INTERNAL_H__ */