tizen 2.3.1 release

[framework/api/wav-player.git] / include / wav_player.h

diff --git a/include/wav_player.h b/include/wav_player.h
old mode 100644 (file)
new mode 100755 (executable)
index 39aa74e..db65bf5
--- a/include/wav_player.h
+++ b/include/wav_player.h
@@ -14,9 +14,6 @@
 * limitations under the License. 
 */
 
-
-
-
 #ifndef __TIZEN_MEDIA_WAV_PLAYER_H__
 #define __TIZEN_MEDIA_WAV_PLAYER_H__
 
@@ -28,11 +25,9 @@ extern "C"
 {
 #endif
 
-#define WAV_PLAYER_ERROR_CLASS          TIZEN_ERROR_MULTIMEDIA_CLASS | 0x50
-
 /**
  * @file wav_player.h
- * @brief This file contains the WAV player API
+ * @brief This file contains the WAV player API.
  */
 
 /**
@@ -41,51 +36,43 @@ extern "C"
  */
 
 /**
- * @brief Enumerations of error code for WAV player.
+ * @brief Enumeration of error codes for WAV player.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  */
 typedef enum
 {
     WAV_PLAYER_ERROR_NONE        = TIZEN_ERROR_NONE,                      /**< Successful */
     WAV_PLAYER_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER,       /**< Invalid parameter */
     WAV_PLAYER_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION,       /**< Invalid operation */
-    WAV_PLAYER_ERROR_FORMAT_NOT_SUPPORTED = WAV_PLAYER_ERROR_CLASS | 0x01                        /**< Not supported format */
+    WAV_PLAYER_ERROR_FORMAT_NOT_SUPPORTED = TIZEN_ERROR_WAV_PLAYER | 0x01                        /**< Format not supported */
 } wav_player_error_e;
 
 /**
- * @}
- */
-
-
-/**
- * @addtogroup CAPI_MEDIA_WAV_PLAYER_MODULE
- * @{
- */
-
-/**
- * @brief Called when a WAV file has finished playing.
+ * @brief Called when a WAV file is no longer being played.
  * @details This callback is not invoked by calling wav_player_stop().
- *
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @param[in] id       The completed wav player ID
  * @param[in] user_data        The user data passed from the callback registration function
  * @see wav_player_start()
  */
 typedef void (*wav_player_playback_completed_cb)(int id, void *user_data);
 
-
 /**
  * @brief Plays a WAV file.
- * @param[in] path     The WAV file path to play
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @param[in] path     The WAV file path to the file to be played
  * @param[in] type     The sound type
- * @param[in] callback The callback function to invoke when a WAV file is finished playing
+ * @param[in] callback The callback function to be invoked when a WAV file is no longer being played
  * @param[in] user_data        The user data to be passed to the callback function
- * @param[out] id      The WAV player ID ( can be set to NULL )
+ * @param[out] id      The WAV player ID (can be set to @c NULL)
  *
- * @return 0 on success, otherwise a negative error value.
+ * @return @c 0 on success, 
+ *         otherwise a negative error value
  * @retval #WAV_PLAYER_ERROR_NONE Successful
- * @retval #WAV_PLAYER_ERROR_INVALID_PARAMETER Invalid parameter 
+ * @retval #WAV_PLAYER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #WAV_PLAYER_ERROR_INVALID_OPERATION Invalid operation
  *
- * @post       It invokes wav_player_playback_completed_cb() when a WAV file has finished playing.
+ * @post       It invokes wav_player_playback_completed_cb() when a WAV file is no longer being played.
  * @see wav_player_stop()
  * @see wav_player_playback_completed_cb()
  */
@@ -93,10 +80,11 @@ int wav_player_start(const char *path, sound_type_e type, wav_player_playback_co
 
 /**
  * @brief Stops playing the WAV file.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @param[in] id  The WAV player ID to stop
  *
- * @param[in] id       The WAV player ID to stop
- *
- * @return 0 on success, otherwise a negative error value.
+ * @return @c 0 on success, 
+ *         otherwise a negative error value
  * @retval #WAV_PLAYER_ERROR_NONE Successful
  * @retval #WAV_PLAYER_ERROR_INVALID_PARAMETER Invalid parameter 
  * @retval #WAV_PLAYER_ERROR_INVALID_OPERATION Invalid operation