From 58ffe3cd0bd73f505a9330e08997f926089906a6 Mon Sep 17 00:00:00 2001 From: PatrickCoop12 <123266129+PatrickCoop12@users.noreply.github.com> Date: Sat, 14 Dec 2024 03:47:56 -0800 Subject: [PATCH] Update StartWebRTCSession.mdx Suggestions to improve usability of documentation --- api-reference/endpoint/StartWebRTCSession.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/api-reference/endpoint/StartWebRTCSession.mdx b/api-reference/endpoint/StartWebRTCSession.mdx index fa28328..c24780a 100644 --- a/api-reference/endpoint/StartWebRTCSession.mdx +++ b/api-reference/endpoint/StartWebRTCSession.mdx @@ -2,4 +2,6 @@ title: '/StartWebRTCSession' description: 'Start a WebRTC session' openapi: 'POST /StartWebRTCSession' ---- \ No newline at end of file + +Not sure if this has been brought up before, but it is unclear where the SDP and type are obtained from for reference in the StartWebRTCSession API payload. I've read through the documentation, and noted the CreateOffer and CreateAnswer methods for the RTCPeerConnection instance, but when attempting to set local description using the CreateOffer method, nothing gets set. Adding an example of how to properly use your APIs including where to obtain required parameters would be immensely helpful. I alone have spent 3 hours on this so I can only imagine the collective time spent by devs navigating your documentation. +---