Improve documentation of ConfigureTWCCSender

jech · web-flow · commit c50ca41e56d3 · 2025-01-08T10:00:37.000-05:00
Mention that it must be called after registering codecs.
diff --git a/interceptor.go b/interceptor.go
@@ -94,6 +94,7 @@ func ConfigureTWCCHeaderExtensionSender(mediaEngine *MediaEngine, interceptorReg
 }
 
 // ConfigureTWCCSender will setup everything necessary for generating TWCC reports.
+// This must be called after registering codecs with the MediaEngine.
 func ConfigureTWCCSender(mediaEngine *MediaEngine, interceptorRegistry *interceptor.Registry) error {
 	mediaEngine.RegisterFeedback(RTCPFeedback{Type: TypeRTCPFBTransportCC}, RTPCodecTypeVideo)
 	if err := mediaEngine.RegisterHeaderExtension(RTPHeaderExtensionCapability{URI: sdp.TransportCCURI}, RTPCodecTypeVideo); err != nil {

Original file line number	Diff line number	Diff line change
`@@ -94,6 +94,7 @@ func ConfigureTWCCHeaderExtensionSender(mediaEngine *MediaEngine, interceptorReg`
`94`	`94`	`}`
`95`	`95`
`96`	`96`	`// ConfigureTWCCSender will setup everything necessary for generating TWCC reports.`
	`97`	`+// This must be called after registering codecs with the MediaEngine.`
`97`	`98`	`func ConfigureTWCCSender(mediaEngine MediaEngine, interceptorRegistry interceptor.Registry) error {`
`98`	`99`	`mediaEngine.RegisterFeedback(RTCPFeedback{Type: TypeRTCPFBTransportCC}, RTPCodecTypeVideo)`
`99`	`100`	`if err := mediaEngine.RegisterHeaderExtension(RTPHeaderExtensionCapability{URI: sdp.TransportCCURI}, RTPCodecTypeVideo); err != nil {`