diff options
author | Youngwoo <young222.cho@samsung.com> | 2022-12-23 11:00:15 +0900 |
---|---|---|
committer | Youngwoo <young222.cho@samsung.com> | 2022-12-23 14:33:09 +0900 |
commit | d04c8d886a41ad4ea16f4870a0c1e4bbd25bec30 (patch) | |
tree | 07b4fda343f605c0e4089894c06bb70cb8070ee1 | |
parent | b9b9ba54c86a4500d941616587306290a9dcfed4 (diff) | |
download | player-d04c8d886a41ad4ea16f4870a0c1e4bbd25bec30.tar.gz player-d04c8d886a41ad4ea16f4870a0c1e4bbd25bec30.tar.bz2 player-d04c8d886a41ad4ea16f4870a0c1e4bbd25bec30.zip |
[0.3.153] Update doxygen indent
Change-Id: Id51867d8760ddad5e024ac7d3b4d1a5099ed4722
Signed-off-by: Youngwoo <young222.cho@samsung.com>
-rw-r--r-- | include/player.h | 136 |
1 files changed, 68 insertions, 68 deletions
diff --git a/include/player.h b/include/player.h index 815bf36..13096a0 100644 --- a/include/player.h +++ b/include/player.h @@ -393,7 +393,7 @@ typedef void (*player_media_packet_audio_decoded_cb)(media_packet_h packet, void * @brief Called when the buffer level drops below the threshold of max size or no free space in buffer. * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif * @remarks This function is used for media stream playback only. - * @param[in] status The buffer status + * @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() @@ -406,7 +406,7 @@ typedef void (*player_media_stream_buffer_status_cb)(player_media_stream_buffer_ * @details The next push-buffer should produce buffers from the new offset. * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif * @remarks This function is used for media stream playback only. - * @param[in] offset The new byte position to seek + * @param[in] offset The new byte position to seek * @param[in] user_data The user data passed from the callback registration function */ typedef void (*player_media_stream_seek_cb)(unsigned long long offset, void *user_data); @@ -716,7 +716,7 @@ int player_get_volume(player_h player, float *left, float *right); * @remarks This function is related to the following feature:\n * %http://tizen.org/feature/multimedia.player.stream_info\n * If this feature is not supported, the stream_type of the player is fixed to the #SOUND_STREAM_TYPE_MEDIA. - * @param[in] player The handle to the media player + * @param[in] player The handle to the media player * @param[in] stream_info The sound manager info type * @return @c 0 on success, * otherwise a negative error value @@ -758,7 +758,7 @@ int player_set_sound_stream_info(player_h player, sound_stream_info_h stream_inf * @remarks If audio offload is enabled by calling player_audio_offload_set_enabled(), * this function will return #PLAYER_ERROR_NOT_AVAILABLE and * this will not work at all even if it was called before enabling offload. (Since 5.5) - * @param[in] player The handle to the media player + * @param[in] player The handle to the media player * @param[in] latency_mode The latency mode to be applied to the audio * @return @c 0 on success, * otherwise a negative error value @@ -778,7 +778,7 @@ int player_set_audio_latency_mode(player_h player, audio_latency_mode_e latency_ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @remarks If audio offload is enabled by calling player_audio_offload_set_enabled(), * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) - * @param[in] player The handle to the media player + * @param[in] player The handle to the media player * @param[out] latency_mode The latency mode to get from the audio * @return @c 0 on success, * otherwise a negative error value @@ -978,7 +978,7 @@ int player_get_play_position_nsec(player_h player, int64_t *nanoseconds); * Until this function is called, by default the player is not muted. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @param[in] player The handle to the media player - * @param[in] muted The new mute status: (@c true = mute, @c false = not muted) + * @param[in] muted The new mute status: (@c true = mute, @c false = not muted) * @return @c 0 on success, * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful @@ -1009,7 +1009,7 @@ int player_is_muted(player_h player, bool *muted); * @details If the looping status is @c true, playback automatically restarts upon finishing. * If it is @c false, it won't. The default value is @c false. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif - * @param[in] player The handle to the media player + * @param[in] player The handle to the media player * @param[in] looping The new looping status: (@c true = looping, @c false = non-looping ) * @return @c 0 on success, * otherwise a negative error value @@ -1025,7 +1025,7 @@ int player_set_looping(player_h player, bool looping); * @details If the looping status is @c true, playback automatically restarts upon finishing. * If it is @c false, it won't. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif - * @param[in] player The handle to the media player + * @param[in] player The handle to the media player * @param[out] looping The looping status: (@c true = looping, @c false = non-looping ) * @return @c 0 on success, * otherwise a negative error value @@ -1048,8 +1048,8 @@ int player_is_looping(player_h player, bool *looping); * To avoid #PLAYER_ERROR_INVALID_OPERATION in sub thread, ecore_thread_main_loop_begin() and * ecore_thread_main_loop_end() can be used, but deadlock can be also occurred if main thread is busy. * So, it's not recommended to use them. (since 5.0) - * @param[in] player The handle to the media player - * @param[in] type The display type + * @param[in] player The handle to the media player + * @param[in] type The display type * @param[in] display The handle to display * @return @c 0 on success, * otherwise a negative error value @@ -1081,8 +1081,8 @@ int player_set_display(player_h player, player_display_type_e type, player_displ * and all the packets have to be destroyed before player_unprepare() is called.\n * @remarks If the content is encrypted or there are copyright issues with it, * this function could be unsupported depending on the DRM policy. - * @param[in] player The handle to the media player - * @param[in] callback The callback function to be registered + * @param[in] player The handle to the media player + * @param[in] callback The callback function to be registered * @param[in] user_data The user data to be passed to the callback function * @return @c 0 on success, * otherwise a negative error value @@ -1257,9 +1257,9 @@ int player_set_media_stream_info(player_h player, player_stream_type_e type, med * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif * @remarks This function is used for media stream playback only. * @remarks The callback is called in a separate 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 + * @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 * @param[in] user_data The user data to be passed to the callback function * @return @c 0 on success, * otherwise a negative error value @@ -1326,8 +1326,8 @@ int player_unset_media_stream_seek_cb(player_h player, player_stream_type_e type * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif * @remarks This function is used for media stream playback only. * @remarks If the buffer level over the max size, player_media_stream_buffer_status_cb() will be invoked with overflow status. - * @param[in] player The handle to the media player - * @param[in] type The type of target stream + * @param[in] player The handle to the media player + * @param[in] type The type of target stream * @param[in] max_size The max bytes of buffer, it has to be bigger than zero. (default: 200000) * @return @c 0 on success, * otherwise a negative error value @@ -1343,8 +1343,8 @@ int player_set_media_stream_buffer_max_size(player_h player, player_stream_type_ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif * @remarks This function is used for media stream playback only. * @remarks If the buffer level over the max size, player_media_stream_buffer_status_cb() will be invoked with overflow status. - * @param[in] player The handle to the media player - * @param[in] type The type of target stream + * @param[in] player The handle to the media player + * @param[in] type The type of target stream * @param[out] max_size The max bytes of buffer * @return @c 0 on success, * otherwise a negative error value @@ -1360,8 +1360,8 @@ int player_get_media_stream_buffer_max_size(player_h player, player_stream_type_ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif * @remarks This function is used for media stream playback only. * @remarks If the buffer level drops below the percent value, player_media_stream_buffer_status_cb() will be invoked with underrun status. - * @param[in] player The handle to the media player - * @param[in] type The type of target stream + * @param[in] player The handle to the media player + * @param[in] type The type of target stream * @param[in] percent The minimum threshold(0~100) of buffer (default: 0) * @return @c 0 on success, * otherwise a negative error value @@ -1377,8 +1377,8 @@ int player_set_media_stream_buffer_min_threshold(player_h player, player_stream_ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif * @remarks This function is used for media stream playback only. * @remarks If the buffer level drops below the percent value, player_media_stream_buffer_status_cb() will be invoked with underrun status. - * @param[in] player The handle to the media player - * @param[in] type The type of target stream + * @param[in] player The handle to the media player + * @param[in] type The type of target stream * @param[out] percent The minimum threshold(0~100) of buffer * @return @c 0 on success, * otherwise a negative error value @@ -1421,7 +1421,7 @@ int player_set_display_mode(player_h player, player_display_mode_e mode); * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @remarks If no display is set, no operation is performed. * @param[in] player The handle to the media player - * @param[out] mode The current display mode + * @param[out] mode The current display mode * @return @c 0 on success, * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful @@ -1441,9 +1441,9 @@ int player_get_display_mode(player_h player, player_display_mode_e *mode); * @remarks The minimum value of width and height are 1. * @remarks ROI area can be set before setting ROI display mode. (since 4.0) * @param[in] player The handle to the media player - * @param[in] x X coordinate of area - * @param[in] y Y coordinate of area - * @param[in] width Width of area + * @param[in] x X coordinate of area + * @param[in] y Y coordinate of area + * @param[in] width Width of area * @param[in] height Height of area * @return @c 0 on success, * otherwise a negative error value @@ -1462,7 +1462,7 @@ int player_set_display_roi_area(player_h player, int x, int y, int width, int he * @remarks If no display is set, no operation is performed. * @remarks If you set visible before calling player_set_display(), it will be applied on #PLAYER_STATE_READY state. * @param[in] player The handle to the media player - * @param[in] visible The visibility of the display (@c true = visible, @c false = non-visible ) + * @param[in] visible The visibility of the display (@c true = visible, @c false = non-visible ) * @return @c 0 on success, * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful @@ -1476,7 +1476,7 @@ int player_set_display_visible(player_h player, bool visible); /** * @brief Gets the visibility of the video display. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif - * @param[in] player The handle to the media player + * @param[in] player The handle to the media player * @param[out] visible The current visibility of the display (@c true = visible, @c false = non-visible ) * @return @c 0 on success, * otherwise a negative error value @@ -1510,7 +1510,7 @@ int player_set_display_rotation(player_h player, player_display_rotation_e rotat /** * @brief Gets the rotation of the video surface display. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif - * @param[in] player The handle to the media player + * @param[in] player The handle to the media player * @param[out] rotation The current rotation of the display * @return @c 0 on success, * otherwise a negative error value @@ -1538,9 +1538,9 @@ int player_get_display_rotation(player_h player, player_display_rotation_e *rota * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @remarks You must release @a value using @c free(). * @remarks The playback type should be local playback or HTTP streaming playback. - * @param[in] player The handle to the media player - * @param[in] key The key attribute name to get - * @param[out] value The value of the key attribute \n + * @param[in] player The handle to the media player + * @param[in] key The key attribute name to get + * @param[out] value The value of the key attribute \n * It can be an empty string if there is no content information. * @return @c 0 on success, * otherwise a negative error value @@ -1558,7 +1558,7 @@ int player_get_content_info(player_h player, player_content_info_e key, char **v * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @remarks You must release @a audio_codec and @a video_codec using free(). * @remarks The playback type should be local playback or HTTP streaming playback. - * @param[in] player The handle to the media player + * @param[in] player The handle to the media player * @param[out] audio_codec The name of the audio codec \n * It can be @c NULL if there is no audio codec. * @param[out] video_codec The name of the video codec \n @@ -1577,13 +1577,13 @@ int player_get_codec_info(player_h player, char **audio_codec, char **video_code * @brief Gets the audio stream information. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @remarks The playback type should be local playback or HTTP streaming playback. - * @param[in] player The handle to the media player - * @param[out] sample_rate The audio sample rate [Hz] \n - * Value can be invalid if there is no audio stream information. - * @param[out] channel The audio channel (1: mono, 2: stereo) \n - * Value can be invalid if there is no audio stream information. - * @param[out] bit_rate The audio bit rate [Hz] \n - * Value can be invalid if there is no audio stream information. + * @param[in] player The handle to the media player + * @param[out] sample_rate The audio sample rate [Hz] \n + * Value can be invalid if there is no audio stream information. + * @param[out] channel The audio channel (1: mono, 2: stereo) \n + * Value can be invalid if there is no audio stream information. + * @param[out] bit_rate The audio bit rate [Hz] \n + * Value can be invalid if there is no audio stream information. * @return @c 0 on success, * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful @@ -1598,9 +1598,9 @@ int player_get_audio_stream_info(player_h player, int *sample_rate, int *channel * @brief Gets the video stream information. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @remarks The playback type should be local playback or HTTP streaming playback. - * @param[in] player The handle to the media player - * @param[out] fps The frame per second of the video \n - * It can be @c 0 if there is no video stream information. + * @param[in] player The handle to the media player + * @param[out] fps The frame per second of the video \n + * It can be @c 0 if there is no video stream information. * @param[out] bit_rate The video bit rate [Hz] \n * It can be an invalid value if there is no video stream information. * @return @c 0 on success, @@ -1617,9 +1617,9 @@ int player_get_video_stream_info(player_h player, int *fps, int *bit_rate); * @brief Gets the video display's height and width. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @remarks The playback type should be local playback or HTTP streaming playback. - * @param[in] player The handle to the media player - * @param[out] width The width of the video \n - * Value can be invalid if there is no video or no display is set. + * @param[in] player The handle to the media player + * @param[out] width The width of the video \n + * Value can be invalid if there is no video or no display is set. * @param[out] height The height of the video \n * Value can be invalid value if there is no video or no display is set. * @return @c 0 on success, @@ -1638,9 +1638,9 @@ int player_get_video_size(player_h player, int *width, int *height); * @remarks You must not release @a album_art. * The @a album_art is managed by the platform and will be released * when the player is unprepared or destroyed by calling player_unprepare() or player_destroy(). - * @param[in] player The handle to the media player + * @param[in] player The handle to the media player * @param[out] album_art The encoded artwork image - * @param[out] size The encoded artwork size + * @param[out] size The encoded artwork size * @return @c 0 on success, * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful @@ -1725,8 +1725,8 @@ int player_audio_effect_get_equalizer_bands_count(player_h player, int *count); * this will not work at all even if it was called before enabling audio offload * which makes audio effect function group unavailable. (Since 5.5) * @param[in] player The handle to the media player - * @param[in] index The index of the equalizer band to be set - * @param[in] level The new gain in decibel that is set to the given band [dB] + * @param[in] index The index of the equalizer band to be set + * @param[in] level The new gain in decibel that is set to the given band [dB] * @return @c 0 on success, * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful @@ -1747,9 +1747,9 @@ int player_audio_effect_set_equalizer_band_level(player_h player, int index, int * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @remarks If player_audio_effect_equalizer_is_available() returns @a available parameter as @c false, * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) - * @param[in] player The handle to the media player - * @param[in] index The index of the requested equalizer band - * @param[out] level The gain in decibel of the given band [dB] + * @param[in] player The handle to the media player + * @param[in] index The index of the requested equalizer band + * @param[out] level The gain in decibel of the given band [dB] * @return @c 0 on success, * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful @@ -1767,9 +1767,9 @@ int player_audio_effect_get_equalizer_band_level(player_h player, int index, int * this function will return #PLAYER_ERROR_NOT_AVAILABLE and * this will not work at all even if it was called before enabling audio offload * which makes audio effect function group unavailable. (Since 5.5) - * @param[in] player The handle to the media player + * @param[in] player The handle to the media player * @param[in] band_levels The list of band levels to be set - * @param[in] length The length of the band level + * @param[in] length The length of the band level * @return @c 0 on success, * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful @@ -1790,8 +1790,8 @@ int player_audio_effect_set_equalizer_all_bands(player_h player, int *band_level * @remarks If player_audio_effect_equalizer_is_available() returns @a available parameter as @c false, * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) * @param[in] player The handle to the media player - * @param[out] min The minimum value to be set [dB] - * @param[out] max The maximum value to be set [dB] + * @param[out] min The minimum value to be set [dB] + * @param[out] max The maximum value to be set [dB] * @return @c 0 on success, * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful @@ -1809,8 +1809,8 @@ int player_audio_effect_get_equalizer_level_range(player_h player, int *min, int * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @remarks If player_audio_effect_equalizer_is_available() returns @a available parameter as @c false, * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) - * @param[in] player The handle to the media player - * @param[in] index The index of the requested equalizer band + * @param[in] player The handle to the media player + * @param[in] index The index of the requested equalizer band * @param[out] frequency The frequency of the given band [dB] * @return @c 0 on success, * otherwise a negative error value @@ -1927,7 +1927,7 @@ int player_capture_video(player_h player, player_video_captured_cb callback, voi * to reflect the cookie information when the streaming connection is set up. * @param[in] player The handle to the media player * @param[in] cookie The cookie to set - * @param[in] size The size of the cookie + * @param[in] size The size of the cookie * @return @c 0 on success, * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful @@ -1945,9 +1945,9 @@ int player_set_streaming_cookie(player_h player, const char *cookie, int size); * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @remarks This function must be called before calling the player_prepare() or player_prepare_async() * to reflect the user agent information when the streaming connection is set up. - * @param[in] player The handle to the media player + * @param[in] player The handle to the media player * @param[in] user_agent The user agent to set - * @param[in] size The size of the user agent + * @param[in] size The size of the user agent * @return @c 0 on success, * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful @@ -1965,7 +1965,7 @@ int player_set_streaming_user_agent(player_h player, const char *user_agent, int * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @param[in] player The handle to the media player * @param[out] start The starting position of received data in percentage [0, 100] - * @param[out] end The end position of received data in percentage [0, 100] + * @param[out] end The end position of received data in percentage [0, 100] * @return @c 0 on success, * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful @@ -2334,7 +2334,7 @@ int player_get_track_language_code(player_h player, player_stream_type_e type, i * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) * @param[in] player The handle to the media player * @param[in] type The type of target stream which is #PLAYER_STREAM_TYPE_AUDIO or #PLAYER_STREAM_TYPE_TEXT - * @param[out] count The number of track + * @param[out] count The number of track * @return @c 0 on success, * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful @@ -2484,7 +2484,7 @@ int player_is_audio_only(player_h player, bool *audio_only); * this will not work at all even if this was called before enabling offload. (Since 5.5) * @remarks This function could be unavailable depending on the audio codec type and * this will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) - * @param[in] player The handle to the media player + * @param[in] player The handle to the media player * @param[in] enabled The new replaygain status: (@c true = enable, @c false = disable) * @return @c 0 on success, * otherwise a negative error value @@ -2771,8 +2771,8 @@ int player_audio_offload_set_enabled(player_h player, bool enabled); * @since_tizen 5.5 * @remarks This function is related to the following feature:\n * %http://tizen.org/feature/multimedia.player.audio_offload\n - * @param[in] player The handle to the media player - * @param[out] enabled The enabling status (default: false) + * @param[in] player The handle to the media player + * @param[out] enabled The enabling status (default: false) * @return @c 0 on success, * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful |