From 0b187d92457a23f83fde4852ac207619df7af3eb Mon Sep 17 00:00:00 2001 From: Eunhye Choi Date: Mon, 9 Sep 2019 17:12:10 +0900 Subject: [PATCH] [ACR-1410/2] update API reference - apply feedback during "DOC PREPARE" step. Change-Id: I88138bc08c3af1c0c9640c67363aad67f18aaa8e --- include/player.h | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/include/player.h b/include/player.h index f0bd5ed..c7e82e9 100644 --- a/include/player.h +++ b/include/player.h @@ -154,10 +154,10 @@ typedef enum { * @see player_set_media_packet_audio_frame_decoded_cb() */ typedef enum { - PLAYER_AUDIO_EXTRACT_DEFAULT = 0x00, /**< Sync with the playback clock and multichannel audio stream */ - PLAYER_AUDIO_EXTRACT_NO_SYNC_WITH_CLOCK = 0x01, /**< No sync with the playback clock */ - PLAYER_AUDIO_EXTRACT_DEINTERLEAVE = 0x02, /**< Splits one interleaved multichannel audio stream into many mono audio streams */ - PLAYER_AUDIO_EXTRACT_NO_SYNC_AND_DEINTERLEAVE = 0x03, /**< No sync with clock and splits into mono streams */ + PLAYER_AUDIO_EXTRACT_DEFAULT = 0x00, /**< Synchronized multichannel audio stream with the playback clock */ + PLAYER_AUDIO_EXTRACT_NO_SYNC_WITH_CLOCK = 0x01, /**< No synchronized multichannel audio stream with the playback clock */ + PLAYER_AUDIO_EXTRACT_DEINTERLEAVE = 0x02, /**< Synchronized mono audio stream with the playback clock */ + PLAYER_AUDIO_EXTRACT_NO_SYNC_AND_DEINTERLEAVE = 0x03, /**< No synchronized mono audio stream with playback clock */ } player_audio_extract_option_e; /** @@ -358,7 +358,7 @@ typedef void (*player_video_captured_cb)(unsigned char *captured_data, int width typedef void (*player_media_packet_video_decoded_cb)(media_packet_h packet, void *user_data); /** - * @brief Called to register for notifications about delivering media packet when audio frame is decoded. + * @brief Called to register for notifications about delivering media packet when audio data is decoded. * @since_tizen 5.5 * @remarks The @a packet should be released by calling media_packet_destroy(). \n * It is recommended to release it as soon as it is rendered, to avoid memory exhaustion. @@ -1044,7 +1044,7 @@ int player_is_looping(player_h player, bool *looping); int player_set_display(player_h player, player_display_type_e type, player_display_h display); /** - * @brief Sets a media packet video callback function to be called once per frame. + * @brief Sets a callback function for getting the decoded video frame. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @remarks This function must be called before calling player_prepare() or player_prepare_async().\n * A registered callback is called in a separate thread (not in the main loop).\n @@ -1070,7 +1070,7 @@ int player_set_display(player_h player, player_display_type_e type, player_displ int player_set_media_packet_video_frame_decoded_cb(player_h player, player_media_packet_video_decoded_cb callback, void *user_data); /** - * @brief Unsets the media packet video frame callback function. + * @brief Unsets the callback notifying the decoded video frame. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @param[in] player The handle to the media player * @return @c 0 on success, @@ -1083,9 +1083,9 @@ int player_set_media_packet_video_frame_decoded_cb(player_h player, player_media int player_unset_media_packet_video_frame_decoded_cb(player_h player); /** - * @brief Sets a media packet audio decoded callback function. + * @brief Sets a callback function for getting the decoded audio data. * @details This function is used to get audio PCM data of input media content via registered callback.\n - * This function allows to specify the output PCM format by @ref CAPI_MEDIA_TOOL_MEDIA_FORMAT_MODULE API. + * An application can specify the output PCM format by @ref CAPI_MEDIA_TOOL_MEDIA_FORMAT_MODULE API. * @since_tizen 5.5 * @remarks This function must be called before calling player_prepare() or player_prepare_async().\n * A registered callback is called in a separate thread (not in the main loop).\n @@ -1137,7 +1137,7 @@ int player_set_media_packet_audio_frame_decoded_cb(player_h player, media_format player_audio_extract_option_e opt, player_media_packet_audio_decoded_cb callback, void *user_data); /** - * @brief Unsets the media packet audio frame decoded callback function. + * @brief Unsets the callback notifying the decoded audio data. * @since_tizen 5.5 * @param[in] player The handle to the media player * @return @c 0 on success, -- 2.7.4