forked from mdn/content
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: Add missing documentation for RTCSessionDescriptionInit, RTCLoca…
…lSessionDescriptionInit Add missing documentation for RTCSessionDescriptionInit, RTCLocalSessionDescriptionInit interfaces. Also correct several links referencing those interfaces. Also add a clear explanation of the relationship between RTCSessionDescription, RTCSessionDescriptionInit, and RTCLocalSessionDescriptionInit interfaces. Fixes mdn#33962
- Loading branch information
Showing
7 changed files
with
83 additions
and
10 deletions.
There are no files selected for viewing
29 changes: 29 additions & 0 deletions
29
files/en-us/web/api/rtclocalsessiondescriptioninit/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
title: RTCLocalSessionDescriptionInit | ||
slug: Web/API/RTCLocalSessionDescriptionInit | ||
page-type: web-api-interface | ||
browser-compat: api.RTCSessionDescription | ||
--- | ||
|
||
{{APIRef("WebRTC")}} | ||
|
||
The **`RTCLocalSessionDescriptionInit`** dictionary is used to provide {{Glossary("SDP")}} values in {{domxref("RTCPeerConnection.setLocalDescription")}}. Especially, empty object(`{}`) conforms the `RTCLocalSessionDescriptionInit` dictionary. | ||
|
||
### Properties | ||
|
||
- `type` | ||
- : A string which is used to set the `type` property of the new `RTCSessionDescription` object. For more information, see documentation for the {{domxref("RTCSessionDescription.type")}} property. | ||
- `sdp` | ||
- : A string containing the {{Glossary("SDP")}} describing the session. If `type` is `"rollback"`, this member is unused. | ||
|
||
|
||
## Specifications | ||
|
||
https://w3c.github.io/webrtc-pc/#dom-rtclocalsessiondescriptioninit | ||
|
||
## See also | ||
|
||
- [WebRTC](/en-US/docs/Web/API/WebRTC_API) | ||
- {{domxref("RTCSessionDescription")}} | ||
- {{domxref("RTCSessionDescriptionInit")}} | ||
- {{domxref("RTCPeerConnection.setLocalDescription")}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
title: RTCSessionDescriptionInit | ||
slug: Web/API/RTCSessionDescriptionInit | ||
page-type: web-api-interface | ||
browser-compat: api.RTCSessionDescription | ||
--- | ||
|
||
{{APIRef("WebRTC")}} | ||
|
||
The **`RTCSessionDescriptionInit`** dictionary is used to provide {{Glossary("SDP")}} values in several methods of the {{domxref("RTCPeerConnection")}} interface, such as {{domxref("RTCPeerConnection.createOffer")}}, {{domxref("RTCPeerConnection.createAnswer")}}, and {{domxref("RTCPeerConnection.setRemoteDescription")}}. Also it can be used to create new `RTCSessionDescription` objects, though this is less common. | ||
|
||
### Properties | ||
|
||
- `type` | ||
- : A string which is used to set the `type` property of the new `RTCSessionDescription` object. This is a required property. For more information, see documentation for the {{domxref("RTCSessionDescription.type")}} property. | ||
- `sdp` | ||
- : A string containing the {{Glossary("SDP")}} describing the session. If `type` is `"rollback"`, this member is unused. | ||
|
||
## Specifications | ||
|
||
https://w3c.github.io/webrtc-pc/#dom-rtcsessiondescriptioninit | ||
|
||
## See also | ||
|
||
- [WebRTC](/en-US/docs/Web/API/WebRTC_API) | ||
- {{domxref("RTCSessionDescription")}} | ||
- {{domxref("RTCLocalSessionDescriptionInit")}} | ||
- {{domxref("RTCPeerConnection.createOffer")}} | ||
- {{domxref("RTCPeerConnection.createAnswer")}} | ||
- {{domxref("RTCPeerConnection.setRemoteDescription")}} |