Document direction behavior

algesten · algesten · commit 1fa5f2319cac · 2022-10-12T19:27:31.000+02:00
diff --git a/webrtc/src/api/media_engine/mod.rs b/webrtc/src/api/media_engine/mod.rs
@@ -334,8 +334,12 @@ impl MediaEngine {
         }
     }
 
-    /// register_header_extension adds a header extension to the MediaEngine
-    /// To determine the negotiated value use [`get_header_extension_id`] after signaling is complete
+    /// Adds a header extension to the MediaEngine
+    /// To determine the negotiated value use [`get_header_extension_id`] after signaling is complete.
+    ///
+    /// The `allowed_direction` controls for which transceiver directions the extension matches. If
+    /// set to `None` it matches all directions. The `SendRecv` direction would match all transceiver
+    /// directions apart from `Inactive`. Inactive ony matches inactive.
     pub fn register_header_extension(
         &mut self,
         extension: RTCRtpHeaderExtensionCapability,

Original file line number	Diff line number	Diff line change
`@@ -334,8 +334,12 @@ impl MediaEngine {`
`334`	`334`	`}`
`335`	`335`	`}`
`336`	`336`
`337`		`- /// register_header_extension adds a header extension to the MediaEngine`
`338`		- /// To determine the negotiated value use [`get_header_extension_id`] after signaling is complete
	`337`	`+ /// Adds a header extension to the MediaEngine`
	`338`	+ /// To determine the negotiated value use [`get_header_extension_id`] after signaling is complete.
	`339`	`+ ///`
	`340`	+ /// The `allowed_direction` controls for which transceiver directions the extension matches. If
	`341`	+ /// set to `None` it matches all directions. The `SendRecv` direction would match all transceiver
	`342`	+ /// directions apart from `Inactive`. Inactive ony matches inactive.
`339`	`343`	`pub fn register_header_extension(`
`340`	`344`	`&mut self,`
`341`	`345`	`extension: RTCRtpHeaderExtensionCapability,`