From cce7760d690414c9fd29a028203896ceb8e75fa7 Mon Sep 17 00:00:00 2001 From: Gilbok Lee Date: Tue, 30 Jan 2018 10:56:54 +0900 Subject: [PATCH] Fix mistakes in header description [Version] 0.1.26 [Profile] Mobile, Wearable, TV [Issue Type] Fix description bugs Change-Id: Iee9d5d42d4a6059785a3606b9c4b51e7c32313bb --- include/mediademuxer.h | 103 ++++++++++++++++++++------------------- packaging/capi-mediademuxer.spec | 2 +- 2 files changed, 53 insertions(+), 52 deletions(-) diff --git a/include/mediademuxer.h b/include/mediademuxer.h index be38977..2cbe965 100755 --- a/include/mediademuxer.h +++ b/include/mediademuxer.h @@ -14,8 +14,8 @@ * limitations under the License. */ -#ifndef __TIZEN_MEDIADEMUXER_H__ -#define __TIZEN_MEDIADEMUXER_H__ +#ifndef __TIZEN_MULTIMEDIA_MEDIADEMUXER_H__ +#define __TIZEN_MULTIMEDIA_MEDIADEMUXER_H__ #include #include @@ -43,7 +43,7 @@ extern "C" { typedef struct mediademuxer_s *mediademuxer_h; /** - * @brief Enumeration for media demuxer state + * @brief Enumeration for media demuxer state. * @since_tizen 3.0 */ typedef enum { @@ -81,10 +81,10 @@ typedef enum { * #MEDIADEMUXER_ERROR_SEEK_FAILED, * #MEDIADEMUXER_ERROR_DRM_NOT_PERMITTED * @since_tizen 3.0 - * @param[in] error The error that occurred in media demuxer - * @param[in] user_data The user data passed from the code where - * mediademuxer_set_error_cb() was invoked - * This data will be accessible from mediademuxer_error_cb() + * @param[in] error The error that occurred in media demuxer + * @param[in] user_data The user data passed from the code where + * mediademuxer_set_error_cb() was invoked + * This data will be accessible from mediademuxer_error_cb() * @pre Create media demuxer handle by calling mediademuxer_create() function. * @see mediademuxer_set_error_cb() * @see mediademuxer_unset_error_cb() @@ -94,10 +94,10 @@ typedef void (*mediademuxer_error_cb) (mediademuxer_error_e error, void *user_da /** * @brief Called when end of stream occurs in media demuxer. * @since_tizen 3.0 - * @param[in] track_num The track_num which indicate eos for which track number occured - * @param[in] user_data The user data passed from the code where - * mediademuxer_set_eos_cb() was invoked - * This data will be accessible from mediademuxer_eos_cb() + * @param[in] track_num The track_num which indicate eos for which track number occured + * @param[in] user_data The user data passed from the code where + * mediademuxer_set_eos_cb() was invoked + * This data will be accessible from mediademuxer_eos_cb() * @pre Create media demuxer handle by calling mediademuxer_create() function. * @see mediademuxer_set_eos_cb() * @see mediademuxer_unset_eos_cb() @@ -108,7 +108,7 @@ typedef void (*mediademuxer_eos_cb) (int track_num, void *user_data); * @brief Creates a media demuxer handle for demuxing. * @since_tizen 3.0 * @remarks You must release @a demuxer using mediademuxer_destroy() function. - * @param[out] demuxer A new handle to media demuxer + * @param[out] demuxer A new handle to media demuxer * @return @c 0 on success, otherwise a negative error value * @retval #MEDIADEMUXER_ERROR_NONE Successful * @retval #MEDIADEMUXER_ERROR_INVALID_OPERATION Invalid Operation @@ -125,7 +125,7 @@ int mediademuxer_create(mediademuxer_h *demuxer); * @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 You must release @a demuxer using mediademuxer_destroy() function. - * @param[in] demuxer The media demuxer handle + * @param[in] demuxer The media demuxer handle * @param[in] path The content location, such as the file path * @return @c 0 on success, otherwise a negative error value * @retval #MEDIADEMUXER_ERROR_NONE Successful @@ -140,8 +140,8 @@ int mediademuxer_set_data_source(mediademuxer_h demuxer, const char *path); /** * @brief Prepares the media demuxer for demuxing. * @since_tizen 3.0 - * @remark User should call this before mediademuxer_start() function. - * @param[in] demuxer The media demuxer handle + * @remarks User should call this before mediademuxer_start() function. + * @param[in] demuxer The media demuxer handle * @return @c 0 on success, otherwise a negative error value * @retval #MEDIADEMUXER_ERROR_NONE Successful * @retval #MEDIADEMUXER_ERROR_INVALID_PARAMETER Invalid parameter @@ -158,8 +158,9 @@ int mediademuxer_prepare(mediademuxer_h demuxer); /** * @brief Gets the total track count present in the container stream. * @since_tizen 3.0 - * @param[in] demuxer The media demuxer handle - * @param[out] count The number of tracks present + * @param[in] demuxer The media demuxer handle + * @param[out] count The number of tracks present + * @return @c 0 on success, otherwise a negative error value * @retval #MEDIADEMUXER_ERROR_NONE Successful * @retval #MEDIADEMUXER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MEDIADEMUXER_ERROR_INVALID_STATE Invalid state @@ -173,8 +174,8 @@ int mediademuxer_get_track_count(mediademuxer_h demuxer, int *count); /** * @brief Selects the track to be performed. * @since_tizen 3.0 - * @param[in] demuxer The media demuxer handle - * @param[in] track_index The track index on which is selected for read + * @param[in] demuxer The media demuxer handle + * @param[in] track_index The track index on which is selected for read * @return @c 0 on success, otherwise a negative error value * @retval #MEDIADEMUXER_ERROR_NONE Successful * @retval #MEDIADEMUXER_ERROR_INVALID_PARAMETER Invalid parameter @@ -189,8 +190,8 @@ int mediademuxer_select_track(mediademuxer_h demuxer, int track_index); /** * @brief Starts the media demuxer. * @since_tizen 3.0 - * @remark User should call this before mediademuxer_read_sample() function. - * @param[in] demuxer The media demuxer handle + * @remarks User should call this before mediademuxer_read_sample() function. + * @param[in] demuxer The media demuxer handle * @return @c 0 on success, otherwise a negative error value * @retval #MEDIADEMUXER_ERROR_NONE Successful * @retval #MEDIADEMUXER_ERROR_INVALID_PARAMETER Invalid parameter @@ -209,9 +210,9 @@ int mediademuxer_start(mediademuxer_h demuxer); * @brief Retrieves the track format of the read sample. * @since_tizen 3.0 * @remarks The @a format should be released using media_format_unref() function. - * @param[in] demuxer The media demuxer handle - * @param[in] track_index The index of the track - * @param[out] format The media format handle + * @param[in] demuxer The media demuxer handle + * @param[in] track_index The index of the track + * @param[out] format The media format handle * @return @c 0 on success, otherwise a negative error value * @retval #MEDIADEMUXER_ERROR_NONE Successful * @retval #MEDIADEMUXER_ERROR_INVALID_PARAMETER Invalid parameter @@ -229,11 +230,11 @@ int mediademuxer_get_track_info(mediademuxer_h demuxer, int track_index, media_f /** * @brief Reads a frame(sample) of one single track. * @since_tizen 3.0 - * @remark The @a outbuf should be released using media_packet_destroy() function. - * @remark Once this API is called, user app can call the mediatool APIs to extract + * @remarks The @a outbuf should be released using media_packet_destroy() function. + * @remarks Once this function is called, user app can call the mediatool APIs to extract * side information such as pts, size, duration, flags etc. - * @param[in] demuxer The media demuxer handle - * @param[in] track_index The index of track of which data is needed + * @param[in] demuxer The media demuxer handle + * @param[in] track_index The index of track of which data is needed * @param[out] outbuf The media packet handle * @return @c 0 on success, otherwise a negative error value * @retval #MEDIADEMUXER_ERROR_NONE Successful @@ -254,9 +255,9 @@ int mediademuxer_read_sample(mediademuxer_h demuxer, int track_index, media_pack /** * @brief Seeks to a particular instance of time (in milli seconds). * @since_tizen 3.0 - * @remark If mediademuxer_seek() is followed by mediademuxer_read_sample(), outbuf will be the key frame right before the seek position. - * @param[in] demuxer The media demuxer handle - * @param[in] pos The value of the new start position + * @remarks If mediademuxer_seek() is followed by mediademuxer_read_sample(), outbuf will be the key frame right before the seek position. + * @param[in] demuxer The media demuxer handle + * @param[in] pos The value of the new start position * @return @c 0 on success, otherwise a negative error value * @retval #MEDIADEMUXER_ERROR_NONE Successful * @retval #MEDIADEMUXER_ERROR_INVALID_PARAMETER Invalid parameter @@ -271,8 +272,8 @@ int mediademuxer_seek(mediademuxer_h demuxer, int64_t pos); /** * @brief Unselects the selected track. * @since_tizen 3.0 - * @param[in] demuxer The media demuxer handle - * @param[in] track_index The track index to be unselected + * @param[in] demuxer The media demuxer handle + * @param[in] track_index The track index to be unselected * @return @c 0 on success, otherwise a negative error value * @retval #MEDIADEMUXER_ERROR_NONE Successful * @retval #MEDIADEMUXER_ERROR_INVALID_PARAMETER Invalid parameter @@ -288,8 +289,8 @@ int mediademuxer_unselect_track(mediademuxer_h demuxer, int track_index); /** * @brief Stops the media demuxer. * @since_tizen 3.0 - * @remark User can call this if need to stop demuxing if needed. - * @param[in] demuxer The media demuxer handle + * @remarks User can call this if need to stop demuxing if needed. + * @param[in] demuxer The media demuxer handle * @return @c 0 on success, otherwise a negative error value * @retval #MEDIADEMUXER_ERROR_NONE Successful * @retval #MEDIADEMUXER_ERROR_INVALID_PARAMETER Invalid parameter @@ -306,7 +307,7 @@ int mediademuxer_stop(mediademuxer_h demuxer); * @brief Resets the media demuxer. * @since_tizen 3.0 * @remarks User should call this before mediademuxer_destroy() function. - * @param[in] demuxer The media demuxer handle + * @param[in] demuxer The media demuxer handle * @return @c 0 on success, otherwise a negative error value * @retval #MEDIADEMUXER_ERROR_NONE Successful * @retval #MEDIADEMUXER_ERROR_INVALID_PARAMETER Invalid parameter @@ -321,7 +322,7 @@ int mediademuxer_unprepare(mediademuxer_h demuxer); /** * @brief Removes the instance of media demuxer and clear all its context memory. * @since_tizen 3.0 - * @param[in] demuxer The media demuxer handle + * @param[in] demuxer The media demuxer handle * @return @c 0 on success, otherwise a negative error value * @retval #MEDIADEMUXER_ERROR_NONE Successful * @retval #MEDIADEMUXER_ERROR_INVALID_PARAMETER Invalid parameter @@ -336,7 +337,7 @@ int mediademuxer_destroy(mediademuxer_h demuxer); /** * @brief Gets media demuxer state. * @since_tizen 3.0 - * @param[in] demuxer The media demuxer handle + * @param[in] demuxer The media demuxer handle * @param[out] state The media demuxer sate * @return @c 0 on success, otherwise a negative error value * @retval #MEDIADEMUXER_ERROR_NONE Successful @@ -348,13 +349,13 @@ int mediademuxer_destroy(mediademuxer_h demuxer); int mediademuxer_get_state(mediademuxer_h demuxer, mediademuxer_state *state); /** - * @brief Registers an error callback function to be invoked when an error occurs. + * @brief Sets an error callback function to be invoked when an error occurs. * @since_tizen 3.0 * @param[in] demuxer The media demuxer handle * @param[in] callback Callback function pointer - * @param[in] user_data The user data passed from the code where - * mediademuxer_set_error_cb() was invoked - * This data will be accessible from mediademuxer_error_cb() + * @param[in] user_data The user data passed from the code where + * mediademuxer_set_error_cb() was invoked + * This data will be accessible from mediademuxer_error_cb() * @return @c 0 on success, otherwise a negative error value * @retval #MEDIADEMUXER_ERROR_NONE Successful * @retval #MEDIADEMUXER_ERROR_INVALID_PARAMETER Invalid parameter @@ -367,9 +368,9 @@ int mediademuxer_get_state(mediademuxer_h demuxer, mediademuxer_state *state); int mediademuxer_set_error_cb(mediademuxer_h demuxer, mediademuxer_error_cb callback, void *user_data); /** - * @brief Unregisters the error callback function. + * @brief Unsets the error callback function. * @since_tizen 3.0 - * @param[in] demuxer The media demuxer handle + * @param[in] demuxer The media demuxer handle * @return @c 0 on success, otherwise a negative error value * @retval #MEDIADEMUXER_ERROR_NONE Successful * @retval #MEDIADEMUXER_ERROR_INVALID_PARAMETER Invalid parameter @@ -379,13 +380,13 @@ int mediademuxer_set_error_cb(mediademuxer_h demuxer, mediademuxer_error_cb call int mediademuxer_unset_error_cb(mediademuxer_h demuxer); /** - * @brief Registers an eos callback function to be invoked when an eos occurs. + * @brief Sets an eos callback function to be invoked when an eos occurs. * @since_tizen 3.0 * @param[in] demuxer The media demuxer handle * @param[in] callback Callback function pointer - * @param[in] user_data The user data passed from the code where - * mediademuxer_set_eos_cb() was invoked - * This data will be accessible from mediademuxer_eos_cb() + * @param[in] user_data The user data passed from the code where + * mediademuxer_set_eos_cb() was invoked + * This data will be accessible from mediademuxer_eos_cb() * @return @c 0 on success, otherwise a negative error value * @retval #MEDIADEMUXER_ERROR_NONE Successful * @retval #MEDIADEMUXER_ERROR_INVALID_PARAMETER Invalid parameter @@ -398,9 +399,9 @@ int mediademuxer_unset_error_cb(mediademuxer_h demuxer); int mediademuxer_set_eos_cb(mediademuxer_h demuxer, mediademuxer_eos_cb callback, void *user_data); /** - * @brief Unregisters the eos callback function. + * @brief Unsets the eos callback function. * @since_tizen 3.0 - * @param[in] demuxer The media demuxer handle + * @param[in] demuxer The media demuxer handle * @return @c 0 on success, otherwise a negative error value * @retval #MEDIADEMUXER_ERROR_NONE Successful * @retval #MEDIADEMUXER_ERROR_INVALID_PARAMETER Invalid parameter @@ -416,4 +417,4 @@ int mediademuxer_unset_eos_cb(mediademuxer_h demuxer); #ifdef __cplusplus } #endif -#endif /* __TIZEN_MEDIADEMUXER_H__ */ +#endif /* __TIZEN_MULTIMEDIA_MEDIADEMUXER_H__ */ diff --git a/packaging/capi-mediademuxer.spec b/packaging/capi-mediademuxer.spec index d9fbcf1..f15f084 100755 --- a/packaging/capi-mediademuxer.spec +++ b/packaging/capi-mediademuxer.spec @@ -1,6 +1,6 @@ Name: capi-mediademuxer Summary: A Media Demuxer library in Tizen Native API -Version: 0.1.25 +Version: 0.1.26 Release: 1 Group: Multimedia/API License: Apache-2.0 -- 2.7.4