From f7609aaa289d3e640dba895e0162e26647baf5bb Mon Sep 17 00:00:00 2001 From: Eunhae Choi Date: Tue, 27 Sep 2016 19:29:45 +0900 Subject: [PATCH] [ACR-793] modify doxygen of callback function and wrong return value Change-Id: I6d2f309314440864a9c3876911aa1f5c8eed1642 --- include/common/player.h | 115 ++++++++++++++++++------------------ include/common/player_internal.h | 16 ++--- include/wearable/player.h | 116 +++++++++++++++++++------------------ include/wearable/player_internal.h | 14 ++--- 4 files changed, 132 insertions(+), 129 deletions(-) mode change 100755 => 100644 include/wearable/player.h diff --git a/include/common/player.h b/include/common/player.h index e4d009e..0ab366f 100644 --- a/include/common/player.h +++ b/include/common/player.h @@ -348,9 +348,9 @@ typedef void (*player_video_captured_cb)(unsigned char *data, int width, int hei * @brief Called to register for notifications about delivering media packet when every video frame is decoded. * @since_tizen 2.3 * - * @remarks This function is issued in the context of gstreamer so the UI update code should not be directly invoked.\n - * the packet should be released by media_packet_destroy() after use. \n - * Otherwise, decoder can't work more because it can't have enough buffer to fill decoded frame. + * @remarks This function is called in the context of gstreamer so the UI update code should not be directly invoked.\n + * The packet should be released after use by calling media_packet_destroy(). \n + * If not, the decoder will fail due to having insufficient buffer space for the decoded frame. * * @param[in] pkt Reference pointer to the media packet * @param[in] user_data The user data passed from the callback registration function @@ -423,7 +423,7 @@ int player_create(player_h *player); * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @post The player state will be #PLAYER_STATE_NONE. * @see player_create() */ @@ -432,9 +432,9 @@ int player_destroy(player_h player); /** * @brief Prepares the media player for playback. * @since_tizen 2.3 - * @remarks The mediastorage privilege(http://tizen.org/privilege/mediastorage) should be added if any video/audio files are used to play located in the internal storage. - * @remarks The externalstorage privilege(http://tizen.org/privilege/externalstorage) should be added if any video/audio files are used to play located in the external storage. - * @remarks The internet privilege(http://tizen.org/privilege/internet) should be added if any URLs are used to play from network. + * @remarks The mediastorage privilege(http://tizen.org/privilege/mediastorage) must be added if any video/audio files are used to play located in the internal storage. + * @remarks The externalstorage privilege(http://tizen.org/privilege/externalstorage) must be added if any video/audio files are used to play located in the external storage. + * @remarks The internet privilege(http://tizen.org/privilege/internet) must be added if any URLs are used to play from network. * @param[in] player The handle to the media player * @return @c 0 on success, * otherwise a negative error value @@ -457,9 +457,9 @@ int player_prepare(player_h player); /** * @brief Prepares the media player for playback, asynchronously. * @since_tizen 2.3 - * @remarks The mediastorage privilege(http://tizen.org/privilege/mediastorage) should be added if any video/audio files are used to play located in the internal storage. - * @remarks The externalstorage privilege(http://tizen.org/privilege/externalstorage) should be added if any video/audio files are used to play located in the external storage. - * @remarks The internet privilege(http://tizen.org/privilege/internet) should be added if any URLs are used to play from network. + * @remarks The mediastorage privilege(http://tizen.org/privilege/mediastorage) must be added if any video/audio files are used to play located in the internal storage. + * @remarks The externalstorage privilege(http://tizen.org/privilege/externalstorage) must be added if any video/audio files are used to play located in the external storage. + * @remarks The internet privilege(http://tizen.org/privilege/internet) must be added if any URLs are used to play from network. * @param[in] player The handle to the media player * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -759,7 +759,7 @@ int player_pause(player_h player); * @param[in] player The handle to the media player * @param[in] millisecond The position in milliseconds from the start to the seek point * @param[in] accurate If @c true the selected position is returned, but this might be considerably slow, - * otherwise @c false + * if @c false the nearest keyframe position is returned, but this might be faster but less accurate. * @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, @@ -768,7 +768,7 @@ int player_pause(player_h player); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_SEEK_FAILED Seek operation failure - * @pre The player state must be one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @post It invokes player_seek_completed_cb() when seek operation completes, if you set a callback. * @see player_get_play_position() */ @@ -785,7 +785,7 @@ int player_set_play_position(player_h player, int millisecond, bool accurate, pl * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_SEEK_FAILED Seek operation failure - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_play_position() */ int player_get_play_position(player_h player, int *millisecond); @@ -804,7 +804,7 @@ int player_get_play_position(player_h player, int *millisecond); * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_is_muted() */ int player_set_mute(player_h player, bool muted); @@ -822,7 +822,7 @@ int player_set_mute(player_h player, bool muted); * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_mute() */ int player_is_muted(player_h player, bool *muted); @@ -841,7 +841,7 @@ int player_is_muted(player_h player, bool *muted); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_is_looping() */ int player_set_looping(player_h player, bool looping); @@ -860,7 +860,7 @@ int player_set_looping(player_h player, bool looping); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_looping() */ int player_is_looping(player_h player, bool *looping); @@ -891,8 +891,8 @@ int player_set_display(player_h player, player_display_type_e type, player_displ /** * @brief Registers a media packet video callback function to be called once per frame. * @since_tizen 2.3 - * @remarks This function should be called before preparing. \n - * A registered callback is called on the internal thread of the player. \n + * @remarks This function should be called before calling player_prepare() or player_prepare_async().\n + * A registered callback is called in a seperate thread (not in the main loop).\n * A video frame can be retrieved using a registered callback as a media packet.\n * The callback function holds the same buffer that will be drawn on the display device.\n * So if you change the media packet in a registered callback, it will be displayed on the device\n @@ -907,7 +907,7 @@ int player_set_display(player_h player, player_display_type_e type, player_displ * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid state - * @pre The player's state should be #PLAYER_STATE_IDLE. And, #PLAYER_DISPLAY_TYPE_NONE should be set by calling player_set_display. + * @pre The player's state should be #PLAYER_STATE_IDLE. And, #PLAYER_DISPLAY_TYPE_NONE should be set by calling player_set_display(). * @see player_unset_media_packet_video_frame_decoded_cb */ int player_set_media_packet_video_frame_decoded_cb(player_h player, player_media_packet_video_decoded_cb callback, void *user_data); @@ -971,6 +971,7 @@ int player_set_media_stream_info(player_h player, player_stream_type_e type, med * @brief Registers a callback function to be invoked when buffer underrun or overflow is occurred. * @since_tizen 2.4 * @remarks This API is used for media stream playback only. + * @remarks The callback is called in a seperate thread (not in the main loop). * @param[in] player The handle to the media player * @param[in] type The type of target stream * @param[in] callback The buffer status callback function to register @@ -1006,6 +1007,7 @@ int player_unset_media_stream_buffer_status_cb(player_h player, player_stream_ty * @brief Registers a callback function to be invoked when seeking is occurred. * @since_tizen 2.4 * @remarks This API is used for media stream playback only. + * @remarks The callback is called in a seperate thread (not in the main loop). * @param[in] player The handle to the media player * @param[in] type The type of target stream * @param[in] callback The callback function to register @@ -1049,7 +1051,7 @@ int player_unset_media_stream_seek_cb(player_h player, player_stream_type_e type * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. (since 3.0) + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. (since 3.0) * @see player_get_media_stream_buffer_max_size() * @see player_media_stream_buffer_status_cb() */ @@ -1068,7 +1070,7 @@ int player_set_media_stream_buffer_max_size(player_h player, player_stream_type_ * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_media_stream_buffer_max_size() * @see player_media_stream_buffer_status_cb() */ @@ -1087,7 +1089,7 @@ int player_get_media_stream_buffer_max_size(player_h player, player_stream_type_ * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. (since 3.0) + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. (since 3.0) * @see player_get_media_stream_buffer_min_threshold() * @see player_media_stream_buffer_status_cb() */ @@ -1106,7 +1108,7 @@ int player_set_media_stream_buffer_min_threshold(player_h player, player_stream_ * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_media_stream_buffer_min_threshold() * @see player_media_stream_buffer_status_cb() */ @@ -1134,7 +1136,7 @@ int player_get_media_stream_buffer_min_threshold(player_h player, player_stream_ * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid state * @pre The player should support display mode changes. - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see #player_display_mode_e * @see player_set_display() * @see player_get_display_mode() @@ -1152,7 +1154,7 @@ int player_set_display_mode(player_h player, player_display_mode_e mode); * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see #player_display_mode_e * @see player_set_display_mode() */ @@ -1175,7 +1177,7 @@ int player_get_display_mode(player_h player, player_display_mode_e *mode); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @pre display_mode should be set to #PLAYER_DISPLAY_MODE_DST_ROI. - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_display() * @see player_set_display_mode() */ @@ -1193,7 +1195,7 @@ int player_set_display_roi_area(player_h player, int x, int y, int width, int he * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_display() * @see player_is_display_visible() */ @@ -1209,7 +1211,7 @@ int player_set_display_visible(player_h player, bool visible); * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_display_visible() */ int player_is_display_visible(player_h player, bool* visible); @@ -1228,7 +1230,7 @@ int player_is_display_visible(player_h player, bool* visible); * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid state * @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see #player_display_rotation_e * @see player_set_display * @see player_get_display_rotation() @@ -1245,7 +1247,7 @@ int player_set_display_rotation(player_h player, player_display_rotation_e rotat * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see #player_display_rotation_e * @see player_set_display_rotation() */ @@ -1277,7 +1279,7 @@ int player_get_display_rotation(player_h player, player_display_rotation_e *rota * @retval #PLAYER_ERROR_OUT_OF_MEMORY Not enough memory is available * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. */ int player_get_content_info(player_h player, player_content_info_e key, char ** value); @@ -1297,7 +1299,7 @@ int player_get_content_info(player_h player, player_content_info_e key, char ** * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. */ int player_get_codec_info(player_h player, char **audio_codec, char **video_codec); @@ -1318,7 +1320,7 @@ int player_get_codec_info(player_h player, char **audio_codec, char **video_code * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. */ int player_get_audio_stream_info(player_h player, int *sample_rate, int *channel, int *bit_rate); @@ -1337,7 +1339,7 @@ int player_get_audio_stream_info(player_h player, int *sample_rate, int *channel * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. */ int player_get_video_stream_info(player_h player, int *fps, int *bit_rate); @@ -1356,7 +1358,7 @@ int player_get_video_stream_info(player_h player, int *fps, int *bit_rate); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. */ int player_get_video_size(player_h player, int *width, int *height); @@ -1373,7 +1375,7 @@ int player_get_video_size(player_h player, int *width, int *height); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. */ int player_get_album_art(player_h player, void **album_art, int *size); @@ -1390,7 +1392,7 @@ int player_get_album_art(player_h player, void **album_art, int *size); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. * @see player_set_uri() * @see player_set_memory_buffer() */ @@ -1416,7 +1418,7 @@ int player_get_duration(player_h player, int *duration); * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_audio_effect_set_equalizer_band_level() * @see player_audio_effect_set_equalizer_all_bands() */ @@ -1434,7 +1436,7 @@ int player_audio_effect_get_equalizer_bands_count(player_h player, int *count); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_audio_effect_get_equalizer_bands_count() * @see player_audio_effect_get_equalizer_level_range() * @see player_audio_effect_get_equalizer_band_level() @@ -1453,7 +1455,7 @@ int player_audio_effect_set_equalizer_band_level(player_h player, int index, int * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_audio_effect_set_equalizer_band_level() */ int player_audio_effect_get_equalizer_band_level(player_h player, int index, int *level); @@ -1470,7 +1472,7 @@ int player_audio_effect_get_equalizer_band_level(player_h player, int index, int * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_audio_effect_get_equalizer_bands_count() * @see player_audio_effect_get_equalizer_level_range() * @see player_audio_effect_set_equalizer_band_level() @@ -1488,7 +1490,7 @@ int player_audio_effect_set_equalizer_all_bands(player_h player, int *band_level * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_audio_effect_set_equalizer_band_level() * @see player_audio_effect_set_equalizer_all_bands() */ @@ -1505,7 +1507,7 @@ int player_audio_effect_get_equalizer_level_range(player_h player, int* min, int * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. */ int player_audio_effect_get_equalizer_band_frequency(player_h player, int index, int *frequency); @@ -1520,7 +1522,7 @@ int player_audio_effect_get_equalizer_band_frequency(player_h player, int index, * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. */ int player_audio_effect_get_equalizer_band_frequency_range(player_h player, int index, int *range); @@ -1532,7 +1534,7 @@ int player_audio_effect_get_equalizer_band_frequency_range(player_h player, int * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_audio_effect_set_equalizer_band_level() * @see player_audio_effect_set_equalizer_all_bands() */ @@ -1547,7 +1549,7 @@ int player_audio_effect_equalizer_clear(player_h player); * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_audio_effect_set_equalizer_band_level() * @see player_audio_effect_set_equalizer_all_bands() */ @@ -1697,6 +1699,7 @@ int player_unset_interrupted_cb(player_h player); /** * @brief Registers a callback function to be invoked when an error occurs. * @since_tizen 2.3 + * @remarks The callback is called in a seperate thread (not in the main loop). * @param[in] player The handle to the media player * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -1862,7 +1865,7 @@ int player_set_playback_rate(player_h player, float rate); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @pre The path value can be @c NULL for reset when the player state is set to #PLAYER_STATE_IDLE by calling player_create() or player_unprepare(). */ int player_set_subtitle_path(player_h player, const char *path); @@ -1870,6 +1873,7 @@ int player_set_subtitle_path(player_h player, const char *path); /** * @brief Registers a callback function to be invoked when a subtitle updates. * @since_tizen 2.3 + * @remarks The callback is called in a seperate thread (not in the main loop). * @param[in] player The handle to the media player * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -1912,7 +1916,7 @@ int player_unset_subtitle_updated_cb(player_h player); * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state * @pre The subtitle must be set by calling player_set_subtitle_path(). - * @pre The player state must be one of these: #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. */ int player_set_subtitle_position_offset(player_h player, int millisecond); @@ -1920,6 +1924,7 @@ int player_set_subtitle_position_offset(player_h player, int millisecond); * @brief Registers a callback function to be invoked when video stream is changed. * @since_tizen 2.4 * @remarks The stream changing is detected just before rendering operation. + * @remarks The callback is called in a seperate thread (not in the main loop). * @param[in] player The handle to the media player * @param[in] callback The stream changed callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -1962,8 +1967,7 @@ int player_unset_video_stream_changed_cb(player_h player); * @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 one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED */ int player_get_current_track(player_h player, player_stream_type_e type, int *index); @@ -1982,8 +1986,7 @@ int player_get_current_track(player_h player, player_stream_type_e type, int *in * @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 one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED */ int player_get_track_language_code(player_h player, player_stream_type_e type, int index, char **code); @@ -2000,8 +2003,7 @@ int player_get_track_language_code(player_h player, player_stream_type_e type, i * @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 one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED */ int player_get_track_count(player_h player, player_stream_type_e type, int *count); @@ -2018,8 +2020,7 @@ int player_get_track_count(player_h player, player_stream_type_e type, int *coun * @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 one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED * @see player_get_current_track() */ int player_select_track(player_h player, player_stream_type_e type, int index); diff --git a/include/common/player_internal.h b/include/common/player_internal.h index 5f267c2..3c4ffdf 100644 --- a/include/common/player_internal.h +++ b/include/common/player_internal.h @@ -252,7 +252,7 @@ int player_set_media_stream_dynamic_resolution(player_h player, bool drc); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_display_rotation */ int player_set_ecore_wl_display(player_h player, player_display_type_e type, Ecore_Wl_Window *ecore_wl_window, int x, int y, int width, int height); @@ -407,7 +407,7 @@ int player_set_display_parent_win_id(player_h player, int win_id); * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state * @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. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_uri(), player_set_looping() */ int player_set_next_uri(player_h player, const char *uri); @@ -424,7 +424,7 @@ 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 - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_uri() */ int player_get_next_uri(player_h player, char **uri); @@ -441,7 +441,7 @@ int player_get_next_uri(player_h player, char **uri); * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_is_gapless() */ int player_set_gapless(player_h player, bool gapless); @@ -459,7 +459,7 @@ int player_set_gapless(player_h player, bool gapless); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_gapless() */ int player_is_gapless(player_h player, bool *gapless); @@ -494,7 +494,7 @@ int player_enable_tsurf_pool(player_h player, bool enable); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_enable_tsurf_pool() */ int player_is_enabled_tsurf_pool(player_h player, bool *enabled); @@ -511,7 +511,7 @@ int player_is_enabled_tsurf_pool(player_h player, bool *enabled); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED * @see player_set_media_packet_video_frame_decoded_cb() */ int player_get_media_packet_video_frame_pool_size(player_h player, int *size); @@ -527,7 +527,7 @@ int player_get_media_packet_video_frame_pool_size(player_h player, int *size); * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @pre display_type must be set to PLAYER_DISPLAY_TYPE_OVERLAY by player_set_display. * @pre player_media_packet_video_decoded_cb must be set. * @see player_set_display() diff --git a/include/wearable/player.h b/include/wearable/player.h old mode 100755 new mode 100644 index 72e1a1e..360e75f --- a/include/wearable/player.h +++ b/include/wearable/player.h @@ -347,9 +347,9 @@ typedef void (*player_video_captured_cb)(unsigned char *data, int width, int hei * @brief Called to register for notifications about delivering media packet when every video frame is decoded. * @since_tizen 2.3.1 * - * @remarks This function is issued in the context of gstreamer so the UI update code should not be directly invoked.\n - * the packet should be released by media_packet_destroy() after use. \n - * Otherwise, decoder can't work more because it can't have enough buffer to fill decoded frame. + * @remarks This function is called in the context of gstreamer so the UI update code should not be directly invoked.\n + * The packet should be released after use by calling media_packet_destroy(). \n + * If not, the decoder will fail due to having insufficient buffer space for the decoded frame. * * @param[in] pkt Reference pointer to the media packet * @param[in] user_data The user data passed from the callback registration function @@ -360,6 +360,7 @@ typedef void (*player_media_packet_video_decoded_cb)(media_packet_h pkt, void *u * @brief Called when the buffer level drops below the threshold of max size or no free space in buffer. * @since_tizen 3.0 * @remarks This API is used for media stream playback only. + * @param[in] status The buffer status * @param[in] user_data The user data passed from the callback registration function * @see player_set_media_stream_buffer_status_cb() * @see player_set_media_stream_buffer_max_size() @@ -421,7 +422,7 @@ int player_create(player_h *player); * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @post The player state will be #PLAYER_STATE_NONE. * @see player_create() */ @@ -430,9 +431,9 @@ int player_destroy(player_h player); /** * @brief Prepares the media player for playback. * @since_tizen 2.3.1 - * @remarks The mediastorage privilege(http://tizen.org/privilege/mediastorage) should be added if any video/audio files are used to play located in the internal storage. - * @remarks The externalstorage privilege(http://tizen.org/privilege/externalstorage) should be added if any video/audio files are used to play located in the external storage. - * @remarks The internet privilege(http://tizen.org/privilege/internet) should be added if any URLs are used to play from network. + * @remarks The mediastorage privilege(http://tizen.org/privilege/mediastorage) must be added if any video/audio files are used to play located in the internal storage. + * @remarks The externalstorage privilege(http://tizen.org/privilege/externalstorage) must be added if any video/audio files are used to play located in the external storage. + * @remarks The internet privilege(http://tizen.org/privilege/internet) must be added if any URLs are used to play from network. * @param[in] player The handle to the media player * @return @c 0 on success, * otherwise a negative error value @@ -455,9 +456,9 @@ int player_prepare(player_h player); /** * @brief Prepares the media player for playback, asynchronously. * @since_tizen 2.3.1 - * @remarks The mediastorage privilege(http://tizen.org/privilege/mediastorage) should be added if any video/audio files are used to play located in the internal storage. - * @remarks The externalstorage privilege(http://tizen.org/privilege/externalstorage) should be added if any video/audio files are used to play located in the external storage. - * @remarks The internet privilege(http://tizen.org/privilege/internet) should be added if any URLs are used to play from network. + * @remarks The mediastorage privilege(http://tizen.org/privilege/mediastorage) must be added if any video/audio files are used to play located in the internal storage. + * @remarks The externalstorage privilege(http://tizen.org/privilege/externalstorage) must be added if any video/audio files are used to play located in the external storage. + * @remarks The internet privilege(http://tizen.org/privilege/internet) must be added if any URLs are used to play from network. * @param[in] player The handle to the media player * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -757,7 +758,7 @@ int player_pause(player_h player); * @param[in] player The handle to the media player * @param[in] millisecond The position in milliseconds from the start to the seek point * @param[in] accurate If @c true the selected position is returned, but this might be considerably slow, - * otherwise @c false + * if @c false the nearest keyframe position is returned, but this might be faster but less accurate. * @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, @@ -766,7 +767,7 @@ int player_pause(player_h player); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_SEEK_FAILED Seek operation failure - * @pre The player state must be one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @post It invokes player_seek_completed_cb() when seek operation completes, if you set a callback. * @see player_get_play_position() */ @@ -783,7 +784,7 @@ int player_set_play_position(player_h player, int millisecond, bool accurate, pl * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_SEEK_FAILED Seek operation failure - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_play_position() */ int player_get_play_position(player_h player, int *millisecond); @@ -802,7 +803,7 @@ int player_get_play_position(player_h player, int *millisecond); * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_is_muted() */ int player_set_mute(player_h player, bool muted); @@ -820,7 +821,7 @@ int player_set_mute(player_h player, bool muted); * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_mute() */ int player_is_muted(player_h player, bool *muted); @@ -839,7 +840,7 @@ int player_is_muted(player_h player, bool *muted); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_is_looping() */ int player_set_looping(player_h player, bool looping); @@ -858,7 +859,7 @@ int player_set_looping(player_h player, bool looping); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_looping() */ int player_is_looping(player_h player, bool *looping); @@ -889,8 +890,8 @@ int player_set_display(player_h player, player_display_type_e type, player_displ /** * @brief Registers a media packet video callback function to be called once per frame. * @since_tizen 2.3.1 - * @remarks This function should be called before preparing. \n - * A registered callback is called on the internal thread of the player. \n + * @remarks This function should be called before calling player_prepare() or player_prepare_async().\n + * A registered callback is called in a seperate thread (not in the main loop).\n * A video frame can be retrieved using a registered callback as a media packet.\n * The callback function holds the same buffer that will be drawn on the display device.\n * So if you change the media packet in a registered callback, it will be displayed on the device\n @@ -905,7 +906,7 @@ int player_set_display(player_h player, player_display_type_e type, player_displ * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid state - * @pre The player's state should be #PLAYER_STATE_IDLE. And, #PLAYER_DISPLAY_TYPE_NONE should be set by calling player_set_display. + * @pre The player's state should be #PLAYER_STATE_IDLE. And, #PLAYER_DISPLAY_TYPE_NONE should be set by calling player_set_display(). * @see player_unset_media_packet_video_frame_decoded_cb */ int player_set_media_packet_video_frame_decoded_cb(player_h player, player_media_packet_video_decoded_cb callback, void *user_data); @@ -969,6 +970,7 @@ int player_set_media_stream_info(player_h player, player_stream_type_e type, med * @brief Registers a callback function to be invoked when buffer underrun or overflow is occurred. * @since_tizen 3.0 * @remarks This API is used for media stream playback only. + * @remarks The callback is called in a seperate thread (not in the main loop). * @param[in] player The handle to the media player * @param[in] type The type of target stream * @param[in] callback The buffer status callback function to register @@ -1004,6 +1006,7 @@ int player_unset_media_stream_buffer_status_cb(player_h player, player_stream_ty * @brief Registers a callback function to be invoked when seeking is occurred. * @since_tizen 3.0 * @remarks This API is used for media stream playback only. + * @remarks The callback is called in a seperate thread (not in the main loop). * @param[in] player The handle to the media player * @param[in] type The type of target stream * @param[in] callback The callback function to register @@ -1047,7 +1050,7 @@ int player_unset_media_stream_seek_cb(player_h player, player_stream_type_e type * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be set to #PLAYER_STATE_IDLE by calling player_create() or player_unprepare(). + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. (since 3.0) * @see player_get_media_stream_buffer_max_size() * @see player_media_stream_buffer_status_cb() */ @@ -1066,7 +1069,7 @@ int player_set_media_stream_buffer_max_size(player_h player, player_stream_type_ * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be set to #PLAYER_STATE_IDLE by calling player_create() or player_unprepare(). + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_media_stream_buffer_max_size() * @see player_media_stream_buffer_status_cb() */ @@ -1085,7 +1088,7 @@ int player_get_media_stream_buffer_max_size(player_h player, player_stream_type_ * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be set to #PLAYER_STATE_IDLE by calling player_create() or player_unprepare(). + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. (since 3.0) * @see player_get_media_stream_buffer_min_threshold() * @see player_media_stream_buffer_status_cb() */ @@ -1104,7 +1107,7 @@ int player_set_media_stream_buffer_min_threshold(player_h player, player_stream_ * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be set to #PLAYER_STATE_IDLE by calling player_create() or player_unprepare(). + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_media_stream_buffer_min_threshold() * @see player_media_stream_buffer_status_cb() */ @@ -1132,7 +1135,7 @@ int player_get_media_stream_buffer_min_threshold(player_h player, player_stream_ * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid state * @pre The player should support display mode changes. - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see #player_display_mode_e * @see player_set_display() * @see player_get_display_mode() @@ -1150,7 +1153,7 @@ int player_set_display_mode(player_h player, player_display_mode_e mode); * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see #player_display_mode_e * @see player_set_display_mode() */ @@ -1173,7 +1176,7 @@ int player_get_display_mode(player_h player, player_display_mode_e *mode); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @pre display_mode should be set to #PLAYER_DISPLAY_MODE_DST_ROI. - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_display() * @see player_set_display_mode() */ @@ -1191,7 +1194,7 @@ int player_set_display_roi_area(player_h player, int x, int y, int width, int he * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_display() * @see player_is_display_visible() */ @@ -1207,7 +1210,7 @@ int player_set_display_visible(player_h player, bool visible); * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_display_visible() */ int player_is_display_visible(player_h player, bool* visible); @@ -1226,7 +1229,7 @@ int player_is_display_visible(player_h player, bool* visible); * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid state * @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see #player_display_rotation_e * @see player_set_display * @see player_get_display_rotation() @@ -1243,7 +1246,7 @@ int player_set_display_rotation(player_h player, player_display_rotation_e rotat * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see #player_display_rotation_e * @see player_set_display_rotation() */ @@ -1275,7 +1278,7 @@ int player_get_display_rotation(player_h player, player_display_rotation_e *rota * @retval #PLAYER_ERROR_OUT_OF_MEMORY Not enough memory is available * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. */ int player_get_content_info(player_h player, player_content_info_e key, char ** value); @@ -1295,7 +1298,7 @@ int player_get_content_info(player_h player, player_content_info_e key, char ** * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. */ int player_get_codec_info(player_h player, char **audio_codec, char **video_codec); @@ -1316,7 +1319,7 @@ int player_get_codec_info(player_h player, char **audio_codec, char **video_code * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. */ int player_get_audio_stream_info(player_h player, int *sample_rate, int *channel, int *bit_rate); @@ -1335,7 +1338,7 @@ int player_get_audio_stream_info(player_h player, int *sample_rate, int *channel * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. */ int player_get_video_stream_info(player_h player, int *fps, int *bit_rate); @@ -1354,7 +1357,7 @@ int player_get_video_stream_info(player_h player, int *fps, int *bit_rate); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. */ int player_get_video_size(player_h player, int *width, int *height); @@ -1371,7 +1374,7 @@ int player_get_video_size(player_h player, int *width, int *height); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. */ int player_get_album_art(player_h player, void **album_art, int *size); @@ -1388,7 +1391,7 @@ int player_get_album_art(player_h player, void **album_art, int *size); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. * @see player_set_uri() * @see player_set_memory_buffer() */ @@ -1414,7 +1417,7 @@ int player_get_duration(player_h player, int *duration); * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_audio_effect_set_equalizer_band_level() * @see player_audio_effect_set_equalizer_all_bands() */ @@ -1432,7 +1435,7 @@ int player_audio_effect_get_equalizer_bands_count(player_h player, int *count); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_audio_effect_get_equalizer_bands_count() * @see player_audio_effect_get_equalizer_level_range() * @see player_audio_effect_get_equalizer_band_level() @@ -1451,7 +1454,7 @@ int player_audio_effect_set_equalizer_band_level(player_h player, int index, int * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_audio_effect_set_equalizer_band_level() */ int player_audio_effect_get_equalizer_band_level(player_h player, int index, int *level); @@ -1468,7 +1471,7 @@ int player_audio_effect_get_equalizer_band_level(player_h player, int index, int * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_audio_effect_get_equalizer_bands_count() * @see player_audio_effect_get_equalizer_level_range() * @see player_audio_effect_set_equalizer_band_level() @@ -1486,7 +1489,7 @@ int player_audio_effect_set_equalizer_all_bands(player_h player, int *band_level * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_audio_effect_set_equalizer_band_level() * @see player_audio_effect_set_equalizer_all_bands() */ @@ -1503,7 +1506,7 @@ int player_audio_effect_get_equalizer_level_range(player_h player, int* min, int * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. */ int player_audio_effect_get_equalizer_band_frequency(player_h player, int index, int *frequency); @@ -1518,7 +1521,7 @@ int player_audio_effect_get_equalizer_band_frequency(player_h player, int index, * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. */ int player_audio_effect_get_equalizer_band_frequency_range(player_h player, int index, int *range); @@ -1530,7 +1533,7 @@ int player_audio_effect_get_equalizer_band_frequency_range(player_h player, int * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_audio_effect_set_equalizer_band_level() * @see player_audio_effect_set_equalizer_all_bands() */ @@ -1545,7 +1548,7 @@ int player_audio_effect_equalizer_clear(player_h player); * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_audio_effect_set_equalizer_band_level() * @see player_audio_effect_set_equalizer_all_bands() */ @@ -1695,6 +1698,7 @@ int player_unset_interrupted_cb(player_h player); /** * @brief Registers a callback function to be invoked when an error occurs. * @since_tizen 2.3.1 + * @remarks The callback is called in a seperate thread (not in the main loop). * @param[in] player The handle to the media player * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -1860,7 +1864,7 @@ int player_set_playback_rate(player_h player, float rate); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @pre The path value can be @c NULL for reset when the player state is set to #PLAYER_STATE_IDLE by calling player_create() or player_unprepare(). */ int player_set_subtitle_path(player_h player, const char *path); @@ -1868,6 +1872,7 @@ int player_set_subtitle_path(player_h player, const char *path); /** * @brief Registers a callback function to be invoked when a subtitle updates. * @since_tizen 2.3.1 + * @remarks The callback is called in a seperate thread (not in the main loop). * @param[in] player The handle to the media player * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -1910,7 +1915,7 @@ int player_unset_subtitle_updated_cb(player_h player); * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state * @pre The subtitle must be set by calling player_set_subtitle_path(). - * @pre The player state must be one of these: #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. */ int player_set_subtitle_position_offset(player_h player, int millisecond); @@ -1918,6 +1923,7 @@ int player_set_subtitle_position_offset(player_h player, int millisecond); * @brief Registers a callback function to be invoked when video stream is changed. * @since_tizen 3.0 * @remarks The stream changing is detected just before rendering operation. + * @remarks The callback is called in a seperate thread (not in the main loop). * @param[in] player The handle to the media player * @param[in] callback The stream changed callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -1960,8 +1966,7 @@ int player_unset_video_stream_changed_cb(player_h player); * @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 one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED */ int player_get_current_track(player_h player, player_stream_type_e type, int *index); @@ -1980,8 +1985,7 @@ int player_get_current_track(player_h player, player_stream_type_e type, int *in * @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 one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED */ int player_get_track_language_code(player_h player, player_stream_type_e type, int index, char **code); @@ -1998,8 +2002,7 @@ int player_get_track_language_code(player_h player, player_stream_type_e type, i * @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 one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED */ int player_get_track_count(player_h player, player_stream_type_e type, int *count); @@ -2016,8 +2019,7 @@ int player_get_track_count(player_h player, player_stream_type_e type, int *coun * @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 one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED * @see player_get_current_track() */ int player_select_track(player_h player, player_stream_type_e type, int index); diff --git a/include/wearable/player_internal.h b/include/wearable/player_internal.h index a1b01dd..b71b7fe 100644 --- a/include/wearable/player_internal.h +++ b/include/wearable/player_internal.h @@ -192,7 +192,7 @@ int player_set_media_stream_dynamic_resolution(player_h player, bool drc); * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state * @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. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_uri(), player_set_looping() */ int player_set_next_uri(player_h player, const char *uri); @@ -209,7 +209,7 @@ 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 - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_uri() */ int player_get_next_uri(player_h player, char **uri); @@ -226,7 +226,7 @@ int player_get_next_uri(player_h player, char **uri); * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_is_gapless() */ int player_set_gapless(player_h player, bool gapless); @@ -244,7 +244,7 @@ int player_set_gapless(player_h player, bool gapless); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_gapless() */ int player_is_gapless(player_h player, bool *gapless); @@ -266,7 +266,7 @@ int player_is_gapless(player_h player, bool *gapless); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_display_rotation */ int player_set_ecore_wl_display(player_h player, player_display_type_e type, Ecore_Wl_Window *ecore_wl_window, int x, int y, int width, int height); @@ -301,7 +301,7 @@ int player_enable_tsurf_pool(player_h player, bool enable); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_enable_tsurf_pool() */ int player_is_enabled_tsurf_pool(player_h player, bool *enabled); @@ -318,7 +318,7 @@ int player_is_enabled_tsurf_pool(player_h player, bool *enabled); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be one of these: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED * @see player_set_media_packet_video_frame_decoded_cb() */ int player_get_media_packet_video_frame_pool_size(player_h player, int *size); -- 2.7.4