From: Sangchul Lee <sc11.lee@samsung.com>
Date: Tue, 20 Aug 2024 01:43:37 +0000 (+0900)
Subject: Add examples for webrtc_get_local[remote]_description()
X-Git-Tag: accepted/tizen/unified/20240821.081515~1
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F43%2F316343%2F1;p=platform%2Fcore%2Fapi%2Fwebrtc.git

Add examples for webrtc_get_local[remote]_description()

[Version] 1.1.27
[Issue Type] Doxygen

Change-Id: Ib7e84f979fe847333a349a48ce307088f299fb97
Signed-off-by: Sangchul Lee <sc11.lee@samsung.com>
---

diff --git a/include/webrtc.h b/include/webrtc.h
index 357e1c89..b5cc03af 100644
--- a/include/webrtc.h
+++ b/include/webrtc.h
@@ -2595,6 +2595,29 @@ int webrtc_set_local_description(webrtc_h webrtc, const char *description);
  * @retval #WEBRTC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #WEBRTC_ERROR_INVALID_OPERATION Invalid operation
  * @see webrtc_set_local_description()
+ * @par Example
+ * @code
+   #include <webrtc.h>
+   ...
+   webrtc_h webrtc;
+   char *offer_desc = NULL;
+   char *local_desc = NULL;
+   ...
+   webrtc_create(&webrtc);
+   // after setting media and starting handle
+   ...
+   webrtc_create_offer(webrtc, NULL, &offer_desc);
+   webrtc_set_local_description(webrtc, offer_desc);
+   // process negotiation via signaling server
+   ...
+   // get local description for some reason
+   webrtc_get_local_description(webrtc, &local_desc);
+   ...
+   // after use, free it
+   if (local_desc)
+       free(local_desc);
+   ...
+ * @endcode
  */
 int webrtc_get_local_description(webrtc_h webrtc, char **description);
 
@@ -2634,6 +2657,29 @@ int webrtc_set_remote_description(webrtc_h webrtc, const char *description);
  * @retval #WEBRTC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #WEBRTC_ERROR_INVALID_OPERATION Invalid operation
  * @see webrtc_set_remote_description()
+ * @par Example
+ * @code
+   #include <webrtc.h>
+   ...
+   webrtc_h webrtc;
+   char *remote_desc = NULL;
+   ...
+   webrtc_create(&webrtc);
+   // after setting media and starting handle
+   ...
+   // process negotiation via signaling server
+   // get remote (offer or answer) description from signaling server
+   remote_desc = __get_remote_desc();
+   webrtc_set_remote_description(webrtc, remote_desc);
+   ...
+   // get remote description for some reason
+   webrtc_get_remote_description(webrtc, &remote_desc);
+   ...
+   // after use, free it
+   if (remote_desc)
+       free(remote_desc);
+   ...
+ * @endcode
  */
 int webrtc_get_remote_description(webrtc_h webrtc, char **description);
 
diff --git a/packaging/capi-media-webrtc.spec b/packaging/capi-media-webrtc.spec
index 6d034e7e..082d17de 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.26
+Version:    1.1.27
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0