package rfc8888

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

Dependency Relation
	imports 7 packages, and imported by one package

Involved Source Files

	  d interceptor.go
		Package rfc8888 provides an interceptor that generates congestion control
		feedback reports as defined by RFC 8888.

	    option.go
	    recorder.go
	    stream_log.go
	    ticker.go
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type Option (func)
		An Option is a function that can be used to configure a SenderInterceptor.

		As Outputs Of (at least 3)
			func SenderNow(f func() time.Time) Option
			func SenderTicker(f TickerFactory) Option
			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 arrival times. Recorder can
		be used to create feedback reports as defined by RFC 8888.

		Methods (total 2)
			(*Recorder) AddPacket(ts time.Time, ssrc uint32, seq uint16, ecn uint8)
				AddPacket writes a packet to the underlying stream.

			(*Recorder) BuildReport(now time.Time, maxSize int) *rtcp.CCFeedbackReport
				BuildReport creates a new rtcp.CCFeedbackReport containing all packets that
				were added by AddPacket and missing packets.

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

	 type SenderInterceptor (struct)
		SenderInterceptor sends congestion control feedback as specified in RFC 8888.

		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(_ *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)

	 type TickerFactory (func)
		TickerFactory is a factory to create new tickers.

		As Inputs Of (at least one exported)
			func SenderTicker(f TickerFactory) Option


Package-Level Functions (total 5)

	 func NewRecorder() *Recorder
		NewRecorder creates a new Recorder.

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

	 func SenderNow(f func() time.Time) Option
		SenderNow sets an alternative for the time.Now function.

	 func SenderTicker(f TickerFactory) Option
		SenderTicker sets an alternative for time.Ticker.

	 func SendInterval(interval time.Duration) Option
		SendInterval sets the feedback send interval for the interceptor.

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.