From: Sangchul Lee Date: Tue, 20 Aug 2024 01:56:04 +0000 (+0900) Subject: Improve documentation X-Git-Tag: accepted/tizen/unified/20240821.081515^0 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=4f1619919c5e5dfc1b35f4769aa2e5e84cb315f7;p=platform%2Fcore%2Fapi%2Fwebrtc.git Improve documentation Missing privilege information has been added to webrtc_screen_source_set[unset]_crop(). Missing # character for enum value has been added. [Version] 1.1.28 [Issue Type] Doxygen Change-Id: I2c01e891fdb245ba9706d6e36a032cadd03e70ca Signed-off-by: Sangchul Lee --- diff --git a/include/webrtc.h b/include/webrtc.h index b5cc03af..ee05d38a 100644 --- a/include/webrtc.h +++ b/include/webrtc.h @@ -1669,6 +1669,8 @@ int webrtc_file_source_get_looping(webrtc_h webrtc, unsigned int source_id, bool * @platform * @brief Sets the crop coordinates of a screen source. * @since_tizen 7.0 + * @privlevel platform + * @privilege %http://tizen.org/privilege/internal/default/platform * @remarks The coordinates are in UI (screen) units, and the start coordinate refers to the upper left corner of the video display area on the screen.\n * If we give a rectangle within that area (described by x, y, width, height) then this sub-area will be sent to peer and * it changes the video resolution. @@ -1700,6 +1702,8 @@ int webrtc_screen_source_set_crop(webrtc_h webrtc, unsigned int source_id, int x * @platform * @brief Unsets the crop coordinates of a screen source. * @since_tizen 7.0 + * @privlevel platform + * @privilege %http://tizen.org/privilege/internal/default/platform * @param[in] webrtc WebRTC handle * @param[in] source_id The screen source id * @return @c 0 on success, @@ -2467,7 +2471,7 @@ int webrtc_unset_ice_candidate_cb(webrtc_h webrtc); * @retval #WEBRTC_ERROR_INVALID_PARAMETER Invalid parameter * @retval #WEBRTC_ERROR_INVALID_OPERATION Invalid operation * @retval #WEBRTC_ERROR_INVALID_STATE Invalid state - * @pre @a webrtc state must be set to #WEBRTC_STATE_NEGOTIATING or WEBRTC_STATE_PLAYING. + * @pre @a webrtc state must be set to #WEBRTC_STATE_NEGOTIATING or #WEBRTC_STATE_PLAYING. * @post @a offer must be set as a local description by calling webrtc_set_local_description() * @post @a offer must be sent to the remote peer via the signaling channel. * @see webrtc_state_changed_cb() @@ -2491,7 +2495,7 @@ int webrtc_create_offer(webrtc_h webrtc, bundle *options, char **offer); * @retval #WEBRTC_ERROR_INVALID_PARAMETER Invalid parameter * @retval #WEBRTC_ERROR_INVALID_OPERATION Invalid operation * @retval #WEBRTC_ERROR_INVALID_STATE Invalid state - * @pre @a webrtc state must be set to #WEBRTC_STATE_NEGOTIATING or WEBRTC_STATE_PLAYING. + * @pre @a webrtc state must be set to #WEBRTC_STATE_NEGOTIATING or #WEBRTC_STATE_PLAYING. * @pre The remote SDP offer must be set by calling webrtc_set_remote_description(). * @pre The signaling state must be set to #WEBRTC_SIGNALING_STATE_HAVE_REMOTE_OFFER. * @post @a answer must be set as a local description by calling webrtc_set_local_description() @@ -2519,7 +2523,7 @@ int webrtc_create_answer(webrtc_h webrtc, bundle *options, char **answer); * @retval #WEBRTC_ERROR_INVALID_PARAMETER Invalid parameter * @retval #WEBRTC_ERROR_INVALID_OPERATION Invalid operation * @retval #WEBRTC_ERROR_INVALID_STATE Invalid state - * @pre @a webrtc state must be set to #WEBRTC_STATE_NEGOTIATING or WEBRTC_STATE_PLAYING. + * @pre @a webrtc state must be set to #WEBRTC_STATE_NEGOTIATING or #WEBRTC_STATE_PLAYING. * @post webrtc_session_description_created_cb() will be invoked. * @see webrtc_state_changed_cb() * @see webrtc_negotiation_needed_cb() @@ -2544,7 +2548,7 @@ int webrtc_create_offer_async(webrtc_h webrtc, bundle *options, webrtc_session_d * @retval #WEBRTC_ERROR_INVALID_PARAMETER Invalid parameter * @retval #WEBRTC_ERROR_INVALID_OPERATION Invalid operation * @retval #WEBRTC_ERROR_INVALID_STATE Invalid state - * @pre @a webrtc state must be set to #WEBRTC_STATE_NEGOTIATING or WEBRTC_STATE_PLAYING. + * @pre @a webrtc state must be set to #WEBRTC_STATE_NEGOTIATING or #WEBRTC_STATE_PLAYING. * @pre The remote SDP offer must be set by calling webrtc_set_remote_description(). * @pre The signaling state must be set to #WEBRTC_SIGNALING_STATE_HAVE_REMOTE_OFFER. * @post webrtc_session_description_created_cb() will be invoked. @@ -2570,7 +2574,7 @@ int webrtc_create_answer_async(webrtc_h webrtc, bundle *options, webrtc_session_ * @retval #WEBRTC_ERROR_INVALID_PARAMETER Invalid parameter * @retval #WEBRTC_ERROR_INVALID_OPERATION Invalid operation * @retval #WEBRTC_ERROR_INVALID_STATE Invalid state - * @pre @a webrtc state must be set to #WEBRTC_STATE_NEGOTIATING or WEBRTC_STATE_PLAYING. + * @pre @a webrtc state must be set to #WEBRTC_STATE_NEGOTIATING or #WEBRTC_STATE_PLAYING. * @see webrtc_create_offer() * @see webrtc_create_offer_async() * @see webrtc_create_answer() @@ -2635,7 +2639,7 @@ int webrtc_get_local_description(webrtc_h webrtc, char **description); * @retval #WEBRTC_ERROR_INVALID_PARAMETER Invalid parameter * @retval #WEBRTC_ERROR_INVALID_OPERATION Invalid operation * @retval #WEBRTC_ERROR_INVALID_STATE Invalid state - * @pre @a webrtc state must be set to #WEBRTC_STATE_NEGOTIATING or WEBRTC_STATE_PLAYING. + * @pre @a webrtc state must be set to #WEBRTC_STATE_NEGOTIATING or #WEBRTC_STATE_PLAYING. * @see webrtc_state_changed_cb() * @see webrtc_set_signaling_state_change_cb() * @see webrtc_get_signaling_state() diff --git a/packaging/capi-media-webrtc.spec b/packaging/capi-media-webrtc.spec index 082d17de..03dba2e4 100644 --- a/packaging/capi-media-webrtc.spec +++ b/packaging/capi-media-webrtc.spec @@ -1,6 +1,6 @@ Name: capi-media-webrtc Summary: A WebRTC library in Tizen Native API -Version: 1.1.27 +Version: 1.1.28 Release: 0 Group: Multimedia/API License: Apache-2.0