From 0eff049e7ea57defc00044253f0945d956be14c8 Mon Sep 17 00:00:00 2001 From: Philipp Hancke Date: Sun, 2 Oct 2022 10:25:15 +0200 Subject: [PATCH] describe some more... --- index.bs | 160 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 156 insertions(+), 4 deletions(-) diff --git a/index.bs b/index.bs index 997db93..f4f1b93 100644 --- a/index.bs +++ b/index.bs @@ -264,6 +264,7 @@ The setEncryptionKey(|key|, |keyID|) met # RTCRtpScriptTransform # {#scriptTransform} +## RTCEncodedVideoFrameType dictionary ## {#RTCEncodedVideoFrameType} 
 // New enum for video frame types. Will eventually re-use the equivalent defined
 // by WebCodecs.
@@ -272,7 +273,51 @@ enum RTCEncodedVideoFrameType {
     "key",
     "delta",
 };
-
+
+ + + + + + + + + + + + + + + + + + + + + +
{{RTCEncodedVideoFrameType}} Enumeration description
Enum valueDescription
+ empty + +

+ This frame contains no data. +

+
+ key + +

+ This frame can be decoded without reference to any other frames. +

+
+ delta + +

+ This frame references another frame and can not be decoded without that frame. +

+
+ +## RTCEncodedVideoFrameMetadata dictionary ## {#RTCEncodedVideoFrameMetadata} +
 dictionary RTCEncodedVideoFrameMetadata {
     long long frameId;
     sequence<long long> dependencies;
@@ -284,18 +329,88 @@ dictionary RTCEncodedVideoFrameMetadata {
     octet payloadType;
     sequence<unsigned long> contributingSources;
 };
+
+### Members ### {#RTCEncodedVideoFrameMetadata-members} +
+
+ synchronizationSource of type unsigned long +
+
+

+ The synchronization source (ssrc) identifier is an unsigned integer value per [[RFC3550]] + used to identify the stream of RTP packets that the encoded frame object is describing. +

+
+
+ payloadType of type octet +
+
+

+ The payload type is an unsigned integer value in the range from 0 to 127 per [[RFC3550]] + that is used to describe the format of the RTP payload. +

+
+
+ contributingSources of type sequence<unsigned long> +
+
+

+ The list of contribution sources (csrc list) as defined in [[RFC3550]]. +

+
+
+ + +## RTCEncodedVideoFrame interface ## {#RTCEncodedVideoFrame-interface} +
 // New interfaces to define encoded video and audio frames. Will eventually
 // re-use or extend the equivalent defined in WebCodecs.
 [Exposed=(Window,DedicatedWorker)]
 interface RTCEncodedVideoFrame {
     readonly attribute RTCEncodedVideoFrameType type;
-    readonly attribute unsigned long timestamp; // RTP timestamp.
+    readonly attribute unsigned long timestamp;
     attribute ArrayBuffer data;
     RTCEncodedVideoFrameMetadata getMetadata();
 };
+### Members ### {#RTCEncodedVideoFrame-members} +
+
+ timestamp of type unsigned long +
+
+

+ The RTP timestamp identifier is an unsigned integer value per [[RFC3550]] + that reflects the sampling instant of the first octet in the RTP data packet. +

+
+
+ data of type ArrayBuffer +
+
+

+ The encoded frame data. +

+
+
+ +### Methods ### {#RTCEncodedVideoFrame-methods} +
+
+ getMetadata() + returns the {{RTCEncodedVideoFrameMetadata}} associated with the frame. +
+
+ ## RTCEncodedAudioFrameMetadata dictionary ## {#RTCEncodedAudioFrameMetadata} 
 dictionary RTCEncodedAudioFrameMetadata {
@@ -304,7 +419,7 @@ dictionary RTCEncodedAudioFrameMetadata {
     sequence<unsigned long> contributingSources;
 };
-### Dictionary {{RTCEncodedAudioFrameMetadata}} Members ### {#RTCEncodedAudioFrameMetadata-members} +### Members ### {#RTCEncodedAudioFrameMetadata-members}
@@ -336,16 +451,53 @@ dictionary RTCEncodedAudioFrameMetadata {

+ +## RTCEncodedAudioFrame interface ## {#RTCEncodedAudioFrame-interface} 
 [Exposed=(Window,DedicatedWorker)]
 interface RTCEncodedAudioFrame {
-    readonly attribute unsigned long timestamp; // RTP timestamp.
+    readonly attribute unsigned long timestamp;
     attribute ArrayBuffer data;
     RTCEncodedAudioFrameMetadata getMetadata();
 };
+
+ +### Members ### {#RTCEncodedAudioFrame-members} +
+
+ timestamp of type unsigned long +
+
+

+ The RTP timestamp identifier is an unsigned integer value per [[RFC3550]] + that reflects the sampling instant of the first octet in the RTP data packet. +

+
+
+ data of type ArrayBuffer +
+
+

+ The encoded frame data. +

+
+
+ +### Methods ### {#RTCEncodedAudioFrame-methods} +
+
+ getMetadata() + returns the {{RTCEncodedAudioFrameMetadata}} associated with the frame. +
+
// New interfaces to expose JavaScript-based transforms. +#Interfaces [Exposed=DedicatedWorker] interface RTCTransformEvent : Event {