From 5f49cc702e23e5f9b63b84056beb3eed19719b9d Mon Sep 17 00:00:00 2001 From: Jeongyoon Nam Date: Thu, 8 Dec 2022 10:15:30 +0900 Subject: [PATCH] Fix typo Change-Id: I887131128d3ea4c22e4f8b685bc1b3ed38c7c93f --- include/trackrenderer_capi/trackrenderer_capi.h | 70 +++++++++++----------- .../trackrenderer_capi/trackrenderer_internal.h | 2 +- 2 files changed, 36 insertions(+), 36 deletions(-) diff --git a/include/trackrenderer_capi/trackrenderer_capi.h b/include/trackrenderer_capi/trackrenderer_capi.h index 9ee3156..a775c85 100644 --- a/include/trackrenderer_capi/trackrenderer_capi.h +++ b/include/trackrenderer_capi/trackrenderer_capi.h @@ -85,7 +85,7 @@ typedef void (*trackrenderer_error_cb)(const TrackRendererErrorType error_code, * @description If there is a resource conflict, this function will notice * that there is resource conflict. Then trackrenderer can * release the current TV decoder and display resources. Data - * feeding also need to be stoped as well. + * feeding also need to be stopped as well. * @param [in] userdata : userdata of * trackrenderer_resource_conflicted_cb callback function. * @pre The callback function should be set by @@ -138,7 +138,7 @@ typedef void (*trackrenderer_eos_cb)(void* userdata); * function. * @pre The callback function should be set by * trackrenderer_set_event_cb, in advance. - * @post User can handle fuctionality referencing resolution info. + * @post User can handle functionality referencing resolution info. * @see trackrenderer_set_event_cb() */ typedef void (*trackrenderer_event_cb)(const TrackRendererEventType event_type, @@ -172,7 +172,7 @@ typedef void (*trackrenderer_subtitle_rawdata_cb)( * @param [in] type : subtitle type (text or picture) \n * @param [in] duration : subtitle duration (ms) \n * @param [in] attr_list : list of subtitle attribute \n - * @param [in] attr_list_size : length of subtite attribute \n + * @param [in] attr_list_size : length of subtitle attribute \n * @param [in] userdata : userdata of * trackrenderer_subtitledata_cb callback function. * @pre The callback function should be set by @@ -378,8 +378,8 @@ int trackrenderer_prepare(TrackRendererHandle handle); /** * @brief Trackrenderer pause displaying media contents * @param [in] handle : trackrenderer handle ptr. - * @return Return 0 if trakrenderer is successfully paused. - * Oterwise return -1 if trackrenderer already release the + * @return Return 0 if trackrenderer is successfully paused. + * Otherwise return -1 if trackrenderer already release the * resource. * @pre The trackrenderer must be at least created and set up. * trackrenderer_create() @@ -396,7 +396,7 @@ int trackrenderer_pause(TrackRendererHandle handle); * @description In this function trackrenderer resume media contents from * paused position. * @param [in] handle : trackrenderer handle ptr. - * @return Returen 0 if trackrenderer is successfully resume media + * @return Return 0 if trackrenderer is successfully resume media * contents. * Otherwise -1. * @pre The trackrenderer must be at least created and set up. @@ -410,14 +410,14 @@ int trackrenderer_resume(TrackRendererHandle handle); /** * @brief Set active track info to set up trackrenderer properties. - * @description In this fuction, trackrenderer set track info which is + * @description In this function, trackrenderer set track info which is * necessary for media contents playback. * @param [in] handle : trackrenderer handle ptr. * @param [in] track : Active tracks for playing media contents. * @param [in] size : Number of tracks. The maximum number of tracks * is 3.(audio, video, subtitle) * @return Return 0 if there are any active tracks among audio, video, - * subtitle and successcully set the track info to trackrenderer. + * subtitle and successfully set the track info to trackrenderer. * Otherwise -1 if there is not any active tracks or already set * tracks info. * @pre Get active tracks list for playing. @@ -470,8 +470,8 @@ void trackrenderer_set_ini_element(TrackRendererHandle handle, * the stream in milliseconds * @param [in] playback_rate : For trick play playback rate. * @return Return 0 if he trackrenderer can seek the position or set - * playback rate successfully. Playback rate 0 is not accecptable - * eventhough return value is 0. + * playback rate successfully. Playback rate 0 is not acceptable + * even though return value is 0. * Otherwise -1 if the trackrenderer is not even setup, * trackrenderer fail to seek playback position or fail to set * playback rate. @@ -483,7 +483,7 @@ void trackrenderer_set_ini_element(TrackRendererHandle handle, * @exception None * @remark Seek is asynchronous operation. trackrenderer_seekdone_cb() is * called when seek operation is finished. - * The accecptable playback rate is different for each streaming + * The acceptable playback rate is different for each streaming * source type. */ int trackrenderer_seek(TrackRendererHandle handle, @@ -501,8 +501,8 @@ int trackrenderer_seek(TrackRendererHandle handle, * @param [in] audio_mute : audio is mute on/off when seek to target * position. * @return Return 0 if he trackrenderer can seek the position or set - * playback rate successfully. Playback rate 0 is not accecptable - * eventhough return value is 0. + * playback rate successfully. Playback rate 0 is not acceptable + * even though return value is 0. * Otherwise -1 if the trackrenderer is not even setup, * trackrenderer fail to seek playback position or fail to set * playback rate. @@ -515,7 +515,7 @@ int trackrenderer_seek(TrackRendererHandle handle, * @version 2.0 * @remark Seek is asynchronous operation. trackrenderer_seekdone_cb() is * called when seek operation is finished. - * The accecptable playback rate is different for each streaming + * The acceptable playback rate is different for each streaming * source type. */ int trackrenderer_seek2(TrackRendererHandle handle, @@ -532,7 +532,7 @@ int trackrenderer_seek2(TrackRendererHandle handle, * on, false: mute off. * @return Return 0 if he trackrenderer can set playback rate * successfully. Playback rate 0 is not accecptable - * eventhough return value is 0. + * even though return value is 0. * Otherwise -1 if the trackrenderer is not even setup, * trackrenderer fail to set playback rate. * @pre The trackrenderer must be at least created and set up. @@ -543,7 +543,7 @@ int trackrenderer_seek2(TrackRendererHandle handle, * @exception None * @version 2.0 * @remark Setting playback rate is asynchronous operation. - * The accecptable playback rate is different for each streaming + * The acceptable playback rate is different for each streaming * source type. */ int trackrenderer_set_playback_rate(TrackRendererHandle handle, @@ -642,12 +642,12 @@ int trackrenderer_activate(TrackRendererHandle handle, * @description In this function push the buffer to trackrenderer queue of * buffer. When the buffer is full, the queue is blocked until * free space becomes available in queue. With parameter, user can - * know the submition result and can handle for it. This should be + * know the submission result and can handle for it. This should be * called repeatedly during playback. * @param [in] handle : trackrenderer handle ptr. * @param [in] data : the data user want to add to the trackrenderer buffer - * @param [out] retval : the result of submition. + * @param [out] retval : the result of submission. * @return Return 0 if trackrenderer successfully add the buffer to queue * or the EOS data. * Otherwise -1 if the trackrenderer is not even set up, queue is @@ -673,12 +673,12 @@ int trackrenderer_submit_packet(TrackRendererHandle handle, * @description In this function push the buffer to trackrenderer queue of * buffer. When the buffer is full, the queue is blocked until * free space becomes available in queue. With parameter, user can - * know the submition result and can handle for it. This should be + * know the submission result and can handle for it. This should be * called repeatedly during playback. * @param [in] handle : trackrenderer handle ptr. * @param [in] data : the data user want to add to the trackrenderer * buffer - * @param [out] retval : the result of submition. + * @param [out] retval : the result of submission. * @return Return 0 if trackrenderer successfully add the buffer to queue * or the EOS data. * Otherwise -1 if the trackrenderer is not even set up, queue is @@ -700,7 +700,7 @@ int trackrenderer_submit_packet2(TrackRendererHandle handle, /** * @brief Set drm property. - * @description Set drm property for decription. The properties will be used + * @description Set drm property for decryption. The properties will be used * for drm licensing just in case trackrender does security * process itself. * @param [in] handle : trackrenderer handle ptr. @@ -715,7 +715,7 @@ void trackrenderer_set_drm(TrackRendererHandle handle, /** * @brief Notify drm licensing is done. - * @description In this function let user know that trackrenderer getright is + * @description In this function let user know that trackrenderer gets right is * finished successfully. This is used when trackrenderer does drm * process itself. * @param [in] handle : trackrenderer handle ptr. @@ -863,7 +863,7 @@ int trackrenderer_set_display(TrackRendererHandle handle, * @param [in] y : y param of display window * @param [in] w : width of display window * @param [in] h : height of display window - * @return Return 0 if rendering oejct and properties are successfully + * @return Return 0 if rendering object and properties are successfully * applied for displaying contents or stored for future * displaying. * Otherwise -1 if the trackrenderer is not even setup. @@ -908,7 +908,7 @@ int trackrenderer_set_display_roi(TrackRendererHandle handle, * @post None * @exception None * @version 2.0 - * @remark The minimum value of input are 0,maximun value is 1. + * @remark The minimum value of input are 0,maximum value is 1. * @see esplusplayer_set_display() \n * esplusplayer_set_display_visible() */ @@ -986,7 +986,7 @@ void trackrenderer_get_display_mode(TrackRendererHandle handle, int trackrenderer_set_audio_mute(TrackRendererHandle handle, bool is_mute); /** - * (This is need to be checked wether it is using or not) + * (This is need to be checked whether it is using or not) * @brief Set trackrenderer video still mode * @param [in] handle : trackrenderer handle ptr. * @param [in] type : trackrenderer still mode on, off or non @@ -1025,8 +1025,8 @@ TrackRendererState trackrenderer_get_state(TrackRendererHandle handle); * NULL); * @endcode * @remark a name of attribute and a type of value must be paired. \n - * if you set wrong type of attribute, unknown error can be - * occured.\n if trackrenderer can't parse attr_name, assertion + * if you set wrong type of attribute, unknown error can occur. + * \n if trackrenderer can't parse attr_name, assertion * will be failed. * @see If you want to know what kinds of attribute are there, please * refer this link: \n @@ -1054,8 +1054,8 @@ void trackrenderer_set_attribute(TrackRendererHandle handle, * NULL); * @endcode * @remark a name of attribute and a type of value must be paired. \n - * if you set wrong type of attribute, unknown error can be - * occured.\n if trackrenderer can't parse attr_name, assertion + * if you set wrong type of attribute, unknown error can occur. + * \n if trackrenderer can't parse attr_name, assertion * will be failed. * @see If you want to know what kinds of attribute are there, please * refer this link: \n @@ -1158,7 +1158,7 @@ void trackrenderer_set_error_cb(TrackRendererHandle handle, void* userdata); /** - * @brief Set resource conflict callback funciton + * @brief Set resource conflict callback function * @description If there is resource conflict error, trackrender must release * the current TV decoder and display resource and data feeding * need to be stop as well. @@ -1180,7 +1180,7 @@ void trackrenderer_set_resourceconflict_cb( void* userdata); /** - * @brief Set seek done callback funciton. + * @brief Set seek done callback function. * @description If seek operation is finished, the trackrenderer_seekdone_cb * will be called to notify seek status to help to decide next * operation during or after seek. @@ -1201,7 +1201,7 @@ void trackrenderer_set_seekdone_cb(TrackRendererHandle handle, void* userdata); /** - * @brief Set flush done callback funciton. + * @brief Set flush done callback function. * @description If flush operation is finished, the trackrenderer_flushdone_cb * will be called to notify flush status to help to decide next * operation after flush. @@ -1298,7 +1298,7 @@ void trackrenderer_set_subtitle_rawdata_cb( * [in] type : subtitle type (text or picture) \n * [in] duration : subtitle duration (ms) \n * [in] attr_list : list of subtitle attribute \n - * [in] attr_list_size : length of subtite attribute \n + * [in] attr_list_size : length of subtitle attribute \n * [in] userdata : userdata of trackrenderer_subtitledata_cb * callback function. */ @@ -1339,7 +1339,7 @@ void trackrenderer_set_eos_cb(TrackRendererHandle handle, * callback function. * @pre None * @post When there is closed caption data, call - * trackrenderer_closedcaption_cb to nofity that there is closed + * trackrenderer_closedcaption_cb to notify that there is closed * caption needed to be displayed. * @exception None * @remark trackrenderer_closedcaption_cb \n @@ -1357,7 +1357,7 @@ void trackrenderer_set_closedcaption_cb(TrackRendererHandle handle, * @description In this function set drm initialize data callback. If * trackrenderer detected any informations which need to * initiate drm, the trackrenderer_drminitdata_cb is called to share the drm - * informations for dectyption. + * informations for decryption. * @param [in] handle : trackrenderer handle ptr. * @param [in] callback : trackrenderer_drminitdata_cb ptr. * @param [in] userdata : userdata of trackrenderer_drminitdata_cb diff --git a/include/trackrenderer_capi/trackrenderer_internal.h b/include/trackrenderer_capi/trackrenderer_internal.h index 32c5795..54d70ce 100644 --- a/include/trackrenderer_capi/trackrenderer_internal.h +++ b/include/trackrenderer_capi/trackrenderer_internal.h @@ -51,7 +51,7 @@ typedef void* TrackRendererHandle; * @param [in] y : y param of display window * @param [in] w : width of display window * @param [in] h : height of display window - * @return Return 0 if rendering oejct and properties are successfully + * @return Return 0 if rendering object and properties are successfully * applied for displaying contents or stored for future * displaying. * Otherwise -1 if the trackrenderer is not even setup. -- 2.7.4