package twcc

Import Path
	github.com/pion/interceptor/pkg/twcc (on go.dev)

Dependency Relation
	imports 11 packages, and imported by one package

Involved Source Files

	    arrival_time_map.go
	    header_extension_interceptor.go
	    sender_interceptor.go
	  d twcc.go
		Package twcc provides interceptors to implement transport wide congestion control.
Package-Level Type Names (total 6)

	/* sort by: alphabet | popularity */
	 type HeaderExtensionInterceptor (struct)
		HeaderExtensionInterceptor adds transport wide sequence numbers as header extension to each RTP packet.

		Fields (only one)
			NoOp interceptor.NoOp
		Methods (total 7)
			(*HeaderExtensionInterceptor) BindLocalStream(info *interceptor.StreamInfo, writer interceptor.RTPWriter) interceptor.RTPWriter
				BindLocalStream returns a writer that adds a rtp.TransportCCExtension
				header with increasing sequence numbers to each outgoing packet.

			(*HeaderExtensionInterceptor) BindRTCPReader(reader interceptor.RTCPReader) interceptor.RTCPReader
				BindRTCPReader lets you modify any incoming RTCP packets. It is called once per sender/receiver, however this might
				change in the future. The returned method will be called once per packet batch.

			(*HeaderExtensionInterceptor) BindRTCPWriter(writer interceptor.RTCPWriter) interceptor.RTCPWriter
				BindRTCPWriter lets you modify any outgoing RTCP packets. It is called once per PeerConnection. The returned method
				will be called once per packet batch.

			(*HeaderExtensionInterceptor) BindRemoteStream(_ *interceptor.StreamInfo, reader interceptor.RTPReader) interceptor.RTPReader
				BindRemoteStream lets you modify any incoming RTP packets.
				It is called once for per RemoteStream. The returned method
				will be called once per rtp packet.

			(*HeaderExtensionInterceptor) Close() error
				Close closes the Interceptor, cleaning up any data if necessary.

			(*HeaderExtensionInterceptor) UnbindLocalStream(_ *interceptor.StreamInfo)
				UnbindLocalStream is called when the Stream is removed. It can be used to clean up any data related to that track.

			(*HeaderExtensionInterceptor) UnbindRemoteStream(_ *interceptor.StreamInfo)
				UnbindRemoteStream is called when the Stream is removed. It can be used to clean up any data related to that track.

		Implements (at least 3)
			*HeaderExtensionInterceptor : github.com/pion/interceptor.Interceptor
			*HeaderExtensionInterceptor : github.com/prometheus/common/expfmt.Closer
			*HeaderExtensionInterceptor : io.Closer

	 type HeaderExtensionInterceptorFactory (struct)
		HeaderExtensionInterceptorFactory is a interceptor.Factory for a HeaderExtensionInterceptor.

		Methods (only one)
			(*HeaderExtensionInterceptorFactory) NewInterceptor(_ string) (interceptor.Interceptor, error)
				NewInterceptor constructs a new HeaderExtensionInterceptor.

		Implements (at least one exported)
			*HeaderExtensionInterceptorFactory : github.com/pion/interceptor.Factory
		As Outputs Of (at least one exported)
			func NewHeaderExtensionInterceptor() (*HeaderExtensionInterceptorFactory, error)

	 type Option (func)
		An Option is a function that can be used to configure a SenderInterceptor.

		As Outputs Of (at least one exported)
			func SendInterval(interval time.Duration) Option
		As Inputs Of (at least one exported)
			func NewSenderInterceptor(opts ...Option) (*SenderInterceptorFactory, error)

	 type Recorder (struct)
		Recorder records incoming RTP packets and their delays and creates
		transport wide congestion control feedback reports as specified in
		https://datatracker.ietf.org/doc/html/draft-holmer-rmcat-transport-wide-cc-extensions-01

		Methods (total 3)
			(*Recorder) BuildFeedbackPacket() []rtcp.Packet
				BuildFeedbackPacket creates a new RTCP packet containing a TWCC feedback report.

			(*Recorder) PacketsHeld() int
				PacketsHeld returns the number of received packets currently held by the recorder.

			(*Recorder) Record(mediaSSRC uint32, sequenceNumber uint16, arrivalTime int64)
				Record marks a packet with mediaSSRC and a transport wide sequence number sequenceNumber as received at arrivalTime.

		As Outputs Of (at least one exported)
			func NewRecorder(senderSSRC uint32) *Recorder

	 type SenderInterceptor (struct)
		SenderInterceptor sends transport wide congestion control reports as specified in:
		https://datatracker.ietf.org/doc/html/draft-holmer-rmcat-transport-wide-cc-extensions-01

		Fields (only one)
			NoOp interceptor.NoOp
		Methods (total 7)
			(*SenderInterceptor) BindLocalStream(_ *interceptor.StreamInfo, writer interceptor.RTPWriter) interceptor.RTPWriter
				BindLocalStream lets you modify any outgoing RTP packets. It is called once for per LocalStream. The returned method
				will be called once per rtp packet.

			(*SenderInterceptor) BindRTCPReader(reader interceptor.RTCPReader) interceptor.RTCPReader
				BindRTCPReader lets you modify any incoming RTCP packets. It is called once per sender/receiver, however this might
				change in the future. The returned method will be called once per packet batch.

			(*SenderInterceptor) BindRTCPWriter(writer interceptor.RTCPWriter) interceptor.RTCPWriter
				BindRTCPWriter lets you modify any outgoing RTCP packets. It is called once per PeerConnection. The returned method
				will be called once per packet batch.

			(*SenderInterceptor) BindRemoteStream(info *interceptor.StreamInfo, reader interceptor.RTPReader) interceptor.RTPReader
				BindRemoteStream lets you modify any incoming RTP packets.
				It is called once for per RemoteStream. The returned method
				will be called once per rtp packet.

			(*SenderInterceptor) Close() error
				Close closes the interceptor.

			(*SenderInterceptor) UnbindLocalStream(_ *interceptor.StreamInfo)
				UnbindLocalStream is called when the Stream is removed. It can be used to clean up any data related to that track.

			(*SenderInterceptor) UnbindRemoteStream(_ *interceptor.StreamInfo)
				UnbindRemoteStream is called when the Stream is removed. It can be used to clean up any data related to that track.

		Implements (at least 3)
			*SenderInterceptor : github.com/pion/interceptor.Interceptor
			*SenderInterceptor : github.com/prometheus/common/expfmt.Closer
			*SenderInterceptor : io.Closer

	 type SenderInterceptorFactory (struct)
		SenderInterceptorFactory is a interceptor.Factory for a SenderInterceptor.

		Methods (only one)
			(*SenderInterceptorFactory) NewInterceptor(_ string) (interceptor.Interceptor, error)
				NewInterceptor constructs a new SenderInterceptor.

		Implements (at least one exported)
			*SenderInterceptorFactory : github.com/pion/interceptor.Factory
		As Outputs Of (at least one exported)
			func NewSenderInterceptor(opts ...Option) (*SenderInterceptorFactory, error)


Package-Level Functions (total 4)

	 func NewHeaderExtensionInterceptor() (*HeaderExtensionInterceptorFactory, error)
		NewHeaderExtensionInterceptor returns a HeaderExtensionInterceptorFactory.

	 func NewRecorder(senderSSRC uint32) *Recorder
		NewRecorder creates a new Recorder which uses the given senderSSRC in the created
		feedback packets.

	 func NewSenderInterceptor(opts ...Option) (*SenderInterceptorFactory, error)
		NewSenderInterceptor returns a new SenderInterceptorFactory configured with the given options.

	 func SendInterval(interval time.Duration) Option
		SendInterval sets the interval at which the interceptor
		will send new feedback reports.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.