Revise @since_tizen 60/244160/7
authorSangchul Lee <sc11.lee@samsung.com>
Tue, 15 Sep 2020 09:30:56 +0000 (18:30 +0900)
committerSangchul Lee <sc11.lee@samsung.com>
Thu, 24 Sep 2020 07:11:38 +0000 (07:11 +0000)
Fix it from 6.0 to 6.5.

[Version] 0.1.25
[Issue Type] Doxygen

Change-Id: Iaa9c834604c2da4a5a61b8dacb49ea090a9e63ad
Signed-off-by: Sangchul Lee <sc11.lee@samsung.com>
include/webrtc.h
packaging/capi-media-webrtc.spec

index 1c2450b1fc92ff410946474beabcdfada91988c4..000e4e31631d652b82a532094926eeda1b91b9d5 100644 (file)
@@ -39,13 +39,13 @@ extern "C" {
 
 /**
  * @brief WebRTC handle type.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  */
 typedef void *webrtc_h;
 
 /**
  * @brief Enumeration for WebRTC error.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  */
 typedef enum
 {
@@ -63,7 +63,7 @@ typedef enum
 
 /**
  * @brief Enumeration for WebRTC state.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  */
 typedef enum
 {
@@ -74,7 +74,7 @@ typedef enum
 
 /**
  * @brief Enumeration for WebRTC media source type.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  */
 typedef enum {
        WEBRTC_MEDIA_SOURCE_TYPE_CAMERA,
@@ -85,7 +85,7 @@ typedef enum {
 
 /**
  * @brief Called when an error occurs.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @remarks The @a webrtc is the same object for which the callback was set.\nThe @a webrtc should not be released.
  * @param [in] webrtc     WebRTC handle
  * @param [in] error      The error code
@@ -98,7 +98,7 @@ typedef void (*webrtc_error_cb)(webrtc_h webrtc, webrtc_error_e error, webrtc_st
 
 /**
  * @brief Called when the WebRTC state is changed.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @remarks The @a webrtc is the same object for which the callback was set.\nThe @a webrtc should not be released.
  * @param [in] webrtc     WebRTC handle
  * @param [in] previous   The previous state of the WebRTC handle
@@ -111,7 +111,7 @@ typedef void (*webrtc_state_changed_cb)(webrtc_h webrtc, webrtc_state_e previous
 
 /**
  * @brief Called when the WebRTC needs session negotiation.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @remarks The @a webrtc is the same object for which the callback was set.\nThe @a webrtc should not be released.
  * @param [in] webrtc     WebRTC handle
  * @param [in] user_data  The user data passed from the callback registration function
@@ -122,7 +122,7 @@ typedef void (*webrtc_negotiation_needed_cb)(webrtc_h webrtc, void *user_data);
 
 /**
  * @brief Called when the WebRTC needs to send the ICE candidate message to the remote peer through the signaling channel.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @remarks The @a webrtc is the same object for which the callback was set.\nThe @a webrtc should not be released.
  * @param [in] webrtc     WebRTC handle
  * @param [in] candidate  The ICE candidate message
@@ -134,7 +134,7 @@ typedef void (*webrtc_ice_candidate_cb)(webrtc_h webrtc, const char *candidate,
 
 /**
  * @brief Sets a callback function to be invoked when an asynchronous operation error occurs.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @param [in] webrtc      WebRTC handle
  * @param [in] callback    Callback function pointer
  * @param [in] user_data   The user data to be passed to the callback function
@@ -150,7 +150,7 @@ int webrtc_set_error_cb(webrtc_h webrtc, webrtc_error_cb callback, void *user_da
 
 /**
  * @brief Unsets the error callback function.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @param [in] webrtc      WebRTC handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -163,7 +163,7 @@ int webrtc_unset_error_cb(webrtc_h webrtc);
 
 /**
  * @brief Sets a callback function to be invoked when the WebRTC state is changed.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @param [in] webrtc      WebRTC handle
  * @param [in] callback    Callback function pointer
  * @param [in] user_data   The user data to be passed to the callback function
@@ -179,7 +179,7 @@ int webrtc_set_state_changed_cb(webrtc_h webrtc, webrtc_state_changed_cb callbac
 
 /**
  * @brief Unsets the state changed callback function.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @param [in] webrtc      WebRTC handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -192,7 +192,7 @@ int webrtc_unset_state_changed_cb(webrtc_h webrtc);
 
 /**
  * @brief Creates an instance of WebRTC.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @remarks You must release @a webrtc using webrtc_destroy().
  * @param [out] webrtc    WebRTC handle
  * @return @c 0 on success,
@@ -207,7 +207,7 @@ int webrtc_create(webrtc_h *webrtc);
 
 /**
  * @brief Starts the WebRTC.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @param [in] webrtc    WebRTC handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -224,7 +224,7 @@ int webrtc_start(webrtc_h webrtc);
 
 /**
  * @brief Stops the WebRTC.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @param [in] webrtc    WebRTC handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -241,7 +241,7 @@ int webrtc_stop(webrtc_h webrtc);
 
 /**
  * @brief Destroys the WebRTC.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @param [in] webrtc    WebRTC handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -255,7 +255,7 @@ int webrtc_destroy(webrtc_h webrtc);
 
 /**
  * @brief Gets the WebRTC state.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @param [in] webrtc    WebRTC handle
  * @param [out] state    WebRTC state
  * @return @c 0 on success,
@@ -269,7 +269,7 @@ int webrtc_get_state(webrtc_h webrtc, webrtc_state_e *state);
 
 /**
  * @brief Adds a media source.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @param [in] webrtc      WebRTC handle
  * @param [in] type        The media source type to be added
  * @param [out] source_id  The media source id
@@ -286,7 +286,7 @@ int webrtc_add_media_source(webrtc_h webrtc, webrtc_media_source_type_e type, un
 
 /**
  * @brief Removes the media source.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @param [in] webrtc      WebRTC handle
  * @param [in] source_id   The media source id to be removed
  * @return @c 0 on success,
@@ -303,7 +303,7 @@ int webrtc_remove_media_source(webrtc_h webrtc, unsigned int source_id);
 
 /**
  * @brief Sets a STUN server URL.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @param [in] webrtc       WebRTC handle
  * @param [in] stun_server  The STUN server URL
  * @return @c 0 on success,
@@ -317,7 +317,7 @@ int webrtc_set_stun_server(webrtc_h webrtc, const char *stun_server);
 
 /**
  * @brief Sets a negotiation needed callback function to be invoked when a change has occurred which requires session negotiation.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @param [in] webrtc      WebRTC handle
  * @param [in] callback    Callback function pointer
  * @param [in] user_data   The user data to be passed to the callback function
@@ -336,7 +336,7 @@ int webrtc_set_negotiation_needed_cb(webrtc_h webrtc, webrtc_negotiation_needed_
 
 /**
  * @brief Unsets the negotiation needed callback function.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @param [in] webrtc      WebRTC handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -349,7 +349,7 @@ int webrtc_unset_negotiation_needed_cb(webrtc_h webrtc);
 
 /**
  * @brief Sets an ICE candidate callback function to be invoked when the WebRTC needs to send the ICE candidate message to the remote peer.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @param [in] webrtc      WebRTC handle
  * @param [in] callback    Callback function pointer
  * @param [in] user_data   The user data to be passed to the callback function
@@ -368,7 +368,7 @@ int webrtc_set_ice_candidate_cb(webrtc_h webrtc, webrtc_ice_candidate_cb callbac
 
 /**
  * @brief Unsets the ice candidate callback function.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @param [in] webrtc      WebRTC handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -381,7 +381,7 @@ int webrtc_unset_ice_candidate_cb(webrtc_h webrtc);
 
 /**
  * @brief Creates SDP offer to start a new WebRTC connection to a remote peer.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @remarks The @a offer should be released using free().
  * @param [in] webrtc      WebRTC handle
  * @param [out] offer      SDP offer
@@ -399,7 +399,7 @@ int webrtc_create_offer(webrtc_h webrtc, char **offer);
 
 /**
  * @brief Creates SDP answer to an offer received from a remote peer during the negotiation of a WebRTC connection.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @remarks The @a answer should be released using free().
  * @param [in] webrtc      WebRTC handle
  * @param [out] answer     SDP answer
@@ -416,7 +416,7 @@ int webrtc_create_answer(webrtc_h webrtc, char **answer);
 
 /**
  * @brief Sets the session description for a local peer associated with a WebRTC connection.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @remarks @a description is a JSON string.\n
  *          It will be {"sdp":{"type":"offer or answer","sdp":"..."}}.
  * @param [in] webrtc      WebRTC handle
@@ -435,7 +435,7 @@ int webrtc_set_local_description(webrtc_h webrtc, const char *description);
 
 /**
  * @brief Sets the session description of the remote peer's current offer or answer.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @remarks @a description is a JSON string.\n
  *          It will be {"sdp":{"type":"offer or answer","sdp":"..."}}.
  * @param [in] webrtc      WebRTC handle
@@ -452,7 +452,7 @@ int webrtc_set_remote_description(webrtc_h webrtc, const char *description);
 
 /**
  * @brief Adds a new ICE candidate from the remote peer over its signaling channel.
- * @since_tizen 6.0
+ * @since_tizen 6.5
  * @remarks @a candidate is a JSON string.\n
  *          It will be {"ice":{"candidate":"..."}}.
  * @param [in] webrtc      WebRTC handle
index 018c71ab32170f9511ff56edfde4aadbcea13c62..901854e8fe8835f24e5a309e4524a9542cc71225 100644 (file)
@@ -1,6 +1,6 @@
 Name:       capi-media-webrtc
 Summary:    A WebRTC library in Tizen Native API
-Version:    0.1.24
+Version:    0.1.25
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0