From: Jeongmo Yang Date: Thu, 20 Aug 2020 22:56:31 +0000 (+0900) Subject: Update header file for documentation (#2) X-Git-Tag: submit/tizen/20200821.022954^0 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F02%2F241902%2F2;p=platform%2Fcore%2Fapi%2Fmediatool.git Update header file for documentation (#2) [Version] 0.1.19 [Issue Type] Documentation Change-Id: I0edec48e62181080a36d3f94524942ce43a82443 Signed-off-by: Jeongmo Yang --- diff --git a/include/media_format.h b/include/media_format.h index c6fe93b..51b9d63 100644 --- a/include/media_format.h +++ b/include/media_format.h @@ -358,7 +358,7 @@ int media_format_get_text_info(media_format_h fmt, media_format_mimetype_e * mim * @see media_format_set_video_avg_bps() * @see media_format_set_video_max_bps() */ -int media_format_get_video_info(media_format_h fmt, media_format_mimetype_e * mimetype, int *width, int *height, int *avg_bps, int *max_bps); +int media_format_get_video_info(media_format_h fmt, media_format_mimetype_e *mimetype, int *width, int *height, int *avg_bps, int *max_bps); /** * @brief Gets audio information of media format. @@ -382,7 +382,7 @@ int media_format_get_video_info(media_format_h fmt, media_format_mimetype_e * mi * @see media_format_set_audio_bit() * @see media_format_set_audio_avg_bps() */ -int media_format_get_audio_info(media_format_h fmt, media_format_mimetype_e * mimetype, int *channel, int *samplerate, int *bit, int *avg_bps); +int media_format_get_audio_info(media_format_h fmt, media_format_mimetype_e *mimetype, int *channel, int *samplerate, int *bit, int *avg_bps); /** * @brief Gets audio aac type of media format. @@ -482,7 +482,7 @@ int media_format_set_text_type(media_format_h fmt, media_format_text_type_e type * @retval #MEDIA_FORMAT_ERROR_NONE Successful * @retval #MEDIA_FORMAT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MEDIA_FORMAT_ERROR_INVALID_OPERATION Invalid operation - * @see media_format_get_video() + * @see media_format_get_video_info() */ int media_format_set_video_mime(media_format_h fmt, media_format_mimetype_e mimetype); @@ -498,7 +498,7 @@ int media_format_set_video_mime(media_format_h fmt, media_format_mimetype_e mime * @retval #MEDIA_FORMAT_ERROR_NONE Successful * @retval #MEDIA_FORMAT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MEDIA_FORMAT_ERROR_INVALID_OPERATION Invalid operation - * @see media_format_get_video() + * @see media_format_get_video_info() */ int media_format_set_video_width(media_format_h fmt, int width); @@ -514,7 +514,7 @@ int media_format_set_video_width(media_format_h fmt, int width); * @retval #MEDIA_FORMAT_ERROR_NONE Successful * @retval #MEDIA_FORMAT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MEDIA_FORMAT_ERROR_INVALID_OPERATION Invalid operation - * @see media_format_get_video() + * @see media_format_get_video_info() */ int media_format_set_video_height(media_format_h fmt, int height); @@ -530,7 +530,7 @@ int media_format_set_video_height(media_format_h fmt, int height); * @retval #MEDIA_FORMAT_ERROR_NONE Successful * @retval #MEDIA_FORMAT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MEDIA_FORMAT_ERROR_INVALID_OPERATION Invalid operation - * @see media_format_get_video() + * @see media_format_get_video_info() */ int media_format_set_video_avg_bps(media_format_h fmt, int avg_bps); @@ -546,7 +546,7 @@ int media_format_set_video_avg_bps(media_format_h fmt, int avg_bps); * @retval #MEDIA_FORMAT_ERROR_NONE Successful * @retval #MEDIA_FORMAT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MEDIA_FORMAT_ERROR_INVALID_OPERATION Invalid operation - * @see media_format_get_video() + * @see media_format_get_video_info() */ int media_format_set_video_max_bps(media_format_h fmt, int max_bps); @@ -576,7 +576,7 @@ int media_format_set_video_frame_rate(media_format_h fmt, int frame_rate); * @retval #MEDIA_FORMAT_ERROR_NONE Successful * @retval #MEDIA_FORMAT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MEDIA_FORMAT_ERROR_INVALID_OPERATION Invalid operation - * @see media_format_get_audio() + * @see media_format_get_audio_info() */ int media_format_set_audio_mime(media_format_h fmt, media_format_mimetype_e mimetype); @@ -592,7 +592,7 @@ int media_format_set_audio_mime(media_format_h fmt, media_format_mimetype_e mime * @retval #MEDIA_FORMAT_ERROR_NONE Successful * @retval #MEDIA_FORMAT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MEDIA_FORMAT_ERROR_INVALID_OPERATION Invalid operation - * @see media_format_get_audio() + * @see media_format_get_audio_info() */ int media_format_set_audio_channel(media_format_h fmt, int channel); @@ -608,7 +608,7 @@ int media_format_set_audio_channel(media_format_h fmt, int channel); * @retval #MEDIA_FORMAT_ERROR_NONE Successful * @retval #MEDIA_FORMAT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MEDIA_FORMAT_ERROR_INVALID_OPERATION Invalid operation - * @see media_format_get_audio() + * @see media_format_get_audio_info() */ int media_format_set_audio_samplerate(media_format_h fmt, int samplerate); @@ -625,7 +625,7 @@ int media_format_set_audio_samplerate(media_format_h fmt, int samplerate); * @retval #MEDIA_FORMAT_ERROR_NONE Successful * @retval #MEDIA_FORMAT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MEDIA_FORMAT_ERROR_INVALID_OPERATION Invalid operation - * @see media_format_get_audio() + * @see media_format_get_audio_info() */ int media_format_set_audio_bit(media_format_h fmt, int bit); @@ -641,7 +641,7 @@ int media_format_set_audio_bit(media_format_h fmt, int bit); * @retval #MEDIA_FORMAT_ERROR_NONE Successful * @retval #MEDIA_FORMAT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MEDIA_FORMAT_ERROR_INVALID_OPERATION Invalid operation - * @see media_format_get_audio() + * @see media_format_get_audio_info() */ int media_format_set_audio_avg_bps(media_format_h fmt, int avg_bps); @@ -721,6 +721,7 @@ int media_format_unref(media_format_h fmt); * @retval #MEDIA_FORMAT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MEDIA_FORMAT_ERROR_OUT_OF_MEMORY Out of memory * @retval #MEDIA_FORMAT_ERROR_INVALID_OPERATION Invalid operation + * @see media_format_make_writable() */ int media_format_is_writable(media_format_h fmt, bool * is_writable); @@ -744,6 +745,7 @@ int media_format_is_writable(media_format_h fmt, bool * is_writable); * @retval #MEDIA_FORMAT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MEDIA_FORMAT_ERROR_OUT_OF_MEMORY Out of memory * @retval #MEDIA_FORMAT_ERROR_INVALID_OPERATION Invalid operation + * @see media_format_is_writable() */ int media_format_make_writable(media_format_h fmt, media_format_h * out_fmt); diff --git a/include/media_packet_pool.h b/include/media_packet_pool.h index 6531885..ab8aba0 100644 --- a/include/media_packet_pool.h +++ b/include/media_packet_pool.h @@ -159,7 +159,6 @@ int media_packet_pool_allocate(media_packet_pool_h pool); * @retval #MEDIA_PACKET_ERROR_INVALID_OPERATION The user does not allocate the pool.\n * The pool should be allocated with media_packet_pool_allocate() before acquiring media packet from the pool. * @retval #MEDIA_PACKET_ERROR_NO_AVAILABLE_PACKET No available packet - * @see media_pakcet_pool_set_size() * @see media_packet_pool_release_packet() * */ diff --git a/packaging/capi-media-tool.spec b/packaging/capi-media-tool.spec index 0f0febb..a8bda28 100755 --- a/packaging/capi-media-tool.spec +++ b/packaging/capi-media-tool.spec @@ -1,6 +1,6 @@ Name: capi-media-tool Summary: A Core API media tool library in Tizen Native API -Version: 0.1.18 +Version: 0.1.19 Release: 0 Group: Multimedia/API License: Apache-2.0