[v0.3.22] remove api reference warning 35/89535/5
authorEunhae Choi <eunhae1.choi@samsung.com>
Mon, 26 Sep 2016 03:28:17 +0000 (12:28 +0900)
committerEunhae Choi <eunhae1.choi@samsung.com>
Mon, 26 Sep 2016 04:11:09 +0000 (13:11 +0900)
Change-Id: I9ef59aad28762488323fff073df275144d82792b

include/common/player.h
include/common/player_internal.h
include/wearable/player.h
include/wearable/player_internal.h
packaging/capi-media-player.spec

index ea10af7..545b2f6 100644 (file)
@@ -680,7 +680,7 @@ int player_get_audio_latency_mode(player_h player, audio_latency_mode_e *latency
  * @brief Starts or resumes playback.
  * @since_tizen 2.3
  * @remarks Sound can be mixed with other sounds if you don't control the stream focus in sound-manager module since 3.0.\n
- * You can refer to @ref CAPI_MEDIA_SUOND_MANAGER_MODULE.
+ * You can refer to @ref CAPI_MEDIA_SOUND_MANAGER_MODULE.
  * @details Plays current media content, or resumes play if paused.
  *
  * @param[in]   player The handle to the media player
index 95560f0..91675d5 100644 (file)
@@ -136,9 +136,8 @@ typedef void (*player_media_stream_buffer_status_cb_ex) (player_media_stream_buf
  * @brief Registers a callback function to be invoked when audio frame is decoded. Audio only contents is possible. If included video, error happens.
  * @since_tizen 2.4
  * @param[in] player    The handle to the media player
- * @param[in] sync Sync on the clock
- * @param[in] format Audio format of output pcm
- * @param[in] callback The callback function to register
+ * @param[in] sync      Sync on the clock
+ * @param[in] callback  The callback function to register
  * @param[in] user_data The user data to be passed to the callback function
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -146,7 +145,6 @@ typedef void (*player_media_stream_buffer_status_cb_ex) (player_media_stream_buf
  * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation
  * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state
- * @retval #PLAYER_ERROR_NOT_SUPPORTD Not supported
  * @pre The player state must be #PLAYER_STATE_IDLE by player_create() or player_unprepare().
  * @post player_audio_pcm_extraction_cb() will be invoked.
  */
@@ -155,16 +153,16 @@ int player_set_pcm_extraction_mode(player_h player, bool sync, player_audio_pcm_
 /**
  * @brief Set pcm mode spec. Samplerate, channel is needed.
  * @since_tizen 2.4
- * @param[in] player    The handle to the media player
+ * @param[in] player     The handle to the media player
+ * @param[in] format     Audio format
  * @param[in] samplerate Samplerate
- * @param[in] channel Channel
+ * @param[in] channel    Channel
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #PLAYER_ERROR_NONE Successful
  * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation
  * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state
- * @retval #PLAYER_ERROR_NOT_SUPPORTD Not supported
  * @pre The player state must be #PLAYER_STATE_IDLE by player_create() or player_unprepare().
  * @see player_set_pcm_extraction_mode()
  */
@@ -438,7 +436,6 @@ int player_set_display_parent_win_id(player_h player, int win_id);
  * @retval #PLAYER_ERROR_NONE Successful
  * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation
  * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state
- * @retval #PLAYER_ERROR_NOT_SUPPORTD Not supported
  * @pre The original uri must be set first by player_set_uri().
  * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED.
  * @see player_set_uri(), player_set_looping()
@@ -457,7 +454,6 @@ int player_set_next_uri(player_h player, const char *uri);
  * @retval #PLAYER_ERROR_NONE Successful
  * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation
  * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state
- * @retval #PLAYER_ERROR_NOT_SUPPORTD Not supported
  * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED.
  * @see player_set_uri()
  */
index bf7951e..efff259 100755 (executable)
@@ -678,7 +678,7 @@ int player_get_audio_latency_mode(player_h player, audio_latency_mode_e *latency
  * @brief Starts or resumes playback.
  * @since_tizen 2.3.1
  * @remarks Sound can be mixed with other sounds if you don't control the stream focus in sound-manager module since 3.0.\n
- * You can refer to @ref CAPI_MEDIA_SUOND_MANAGER_MODULE.
+ * You can refer to @ref CAPI_MEDIA_SOUND_MANAGER_MODULE.
  * @details Plays current media content, or resumes play if paused.
  *
  * @param[in]   player The handle to the media player
index 45722f9..33d9961 100644 (file)
@@ -72,9 +72,8 @@ typedef void (*player_media_stream_buffer_status_cb_ex) (player_media_stream_buf
  * @brief Registers a callback function to be invoked when audio frame is decoded. Audio only contents is possible. If included video, error happens.
  * @since_tizen 2.4
  * @param[in] player    The handle to the media player
- * @param[in] sync Sync on the clock
- * @param[in] format Audio format of output pcm
- * @param[in] callback The callback function to register
+ * @param[in] sync      Sync on the clock
+ * @param[in] callback  The callback function to register
  * @param[in] user_data The user data to be passed to the callback function
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -82,7 +81,6 @@ typedef void (*player_media_stream_buffer_status_cb_ex) (player_media_stream_buf
  * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation
  * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state
- * @retval #PLAYER_ERROR_NOT_SUPPORTD Not supported
  * @pre The player state must be #PLAYER_STATE_IDLE by player_create() or player_unprepare().
  * @post player_audio_pcm_extraction_cb() will be invoked.
  */
@@ -91,16 +89,16 @@ int player_set_pcm_extraction_mode(player_h player, bool sync, player_audio_pcm_
 /**
  * @brief Set pcm mode spec. Samplerate, channel is needed.
  * @since_tizen 2.4
- * @param[in] player    The handle to the media player
+ * @param[in] player     The handle to the media player
+ * @param[in] format     Audio format
  * @param[in] samplerate Samplerate
- * @param[in] channel Channel
+ * @param[in] channel    Channel
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #PLAYER_ERROR_NONE Successful
  * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation
  * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state
- * @retval #PLAYER_ERROR_NOT_SUPPORTD Not supported
  * @pre The player state must be #PLAYER_STATE_IDLE by player_create() or player_unprepare().
  * @see player_set_pcm_extraction_mode()
  */
@@ -192,7 +190,6 @@ int player_set_media_stream_dynamic_resolution(player_h player, bool drc);
  * @retval #PLAYER_ERROR_NONE Successful
  * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation
  * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state
- * @retval #PLAYER_ERROR_NOT_SUPPORTD Not supported
  * @pre The original uri must be set first by player_set_uri().
  * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED.
  * @see player_set_uri(), player_set_looping()
@@ -211,7 +208,6 @@ int player_set_next_uri(player_h player, const char *uri);
  * @retval #PLAYER_ERROR_NONE Successful
  * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation
  * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state
- * @retval #PLAYER_ERROR_NOT_SUPPORTD Not supported
  * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED.
  * @see player_set_uri()
  */
index c131210..782770c 100644 (file)
@@ -1,6 +1,6 @@
 Name:       capi-media-player
 Summary:    A Media Player API
-Version:    0.3.21
+Version:    0.3.22
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0