package report

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

Dependency Relation
	imports 8 packages, and imported by one package

Involved Source Files

	    receiver_interceptor.go
	    receiver_option.go
	    receiver_stream.go
	  d report.go
		Package report provides interceptors to implement sending sender and receiver reports.

	    sender_interceptor.go
	    sender_option.go
	    sender_stream.go
	    ticker.go
Package-Level Type Names (total 8)

	/* sort by: alphabet | popularity */
	 type ReceiverInterceptor (struct)
		ReceiverInterceptor interceptor generates receiver reports.

		Fields (only one)
			NoOp interceptor.NoOp
		Methods (total 7)
			(*ReceiverInterceptor) 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.

			(*ReceiverInterceptor) 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.

			(*ReceiverInterceptor) 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.

			(*ReceiverInterceptor) 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.

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

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

			(*ReceiverInterceptor) UnbindRemoteStream(info *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)
			*ReceiverInterceptor : github.com/pion/interceptor.Interceptor
			*ReceiverInterceptor : github.com/prometheus/common/expfmt.Closer
			*ReceiverInterceptor : io.Closer

	 type ReceiverInterceptorFactory (struct)
		ReceiverInterceptorFactory is a interceptor.Factory for a ReceiverInterceptor.

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

		Implements (at least one exported)
			*ReceiverInterceptorFactory : github.com/pion/interceptor.Factory
		As Outputs Of (at least one exported)
			func NewReceiverInterceptor(opts ...ReceiverOption) (*ReceiverInterceptorFactory, error)

	 type ReceiverOption (func)
		ReceiverOption can be used to configure ReceiverInterceptor.

		As Outputs Of (at least 3)
			func ReceiverInterval(interval time.Duration) ReceiverOption
			func ReceiverLog(log logging.LeveledLogger) ReceiverOption
			func ReceiverNow(f func() time.Time) ReceiverOption
		As Inputs Of (at least one exported)
			func NewReceiverInterceptor(opts ...ReceiverOption) (*ReceiverInterceptorFactory, error)

	 type SenderInterceptor (struct)
		SenderInterceptor interceptor generates sender reports.

		Fields (only one)
			NoOp interceptor.NoOp
		Methods (total 7)
			(*SenderInterceptor) BindLocalStream(info *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(info *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 ...SenderOption) (*SenderInterceptorFactory, error)

	 type SenderOption (func)
		SenderOption can be used to configure SenderInterceptor.

		As Outputs Of (at least 5)
			func SenderInterval(interval time.Duration) SenderOption
			func SenderLog(log logging.LeveledLogger) SenderOption
			func SenderNow(f func() time.Time) SenderOption
			func SenderTicker(f TickerFactory) SenderOption
			func SenderUseLatestPacket() SenderOption
		As Inputs Of (at least one exported)
			func NewSenderInterceptor(opts ...SenderOption) (*SenderInterceptorFactory, error)

	 type Ticker (interface)
		Ticker is an interface for *time.Ticker for use with the SenderTicker option.

		Methods (total 2)
			( Ticker) Ch() <-chan time.Time
			( Ticker) Stop()

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

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


Package-Level Functions (total 10)

	 func NewReceiverInterceptor(opts ...ReceiverOption) (*ReceiverInterceptorFactory, error)
		NewReceiverInterceptor returns a new ReceiverInterceptorFactory.

	 func NewSenderInterceptor(opts ...SenderOption) (*SenderInterceptorFactory, error)
		NewSenderInterceptor returns a new SenderInterceptorFactory.

	 func ReceiverInterval(interval time.Duration) ReceiverOption
		ReceiverInterval sets send interval for the interceptor.

	 func ReceiverLog(log logging.LeveledLogger) ReceiverOption
		ReceiverLog sets a logger for the interceptor.

	 func ReceiverNow(f func() time.Time) ReceiverOption
		ReceiverNow sets an alternative for the time.Now function.

	 func SenderInterval(interval time.Duration) SenderOption
		SenderInterval sets send interval for the interceptor.

	 func SenderLog(log logging.LeveledLogger) SenderOption
		SenderLog sets a logger for the interceptor.

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

	 func SenderTicker(f TickerFactory) SenderOption
		SenderTicker sets an alternative for the time.NewTicker function.

	 func SenderUseLatestPacket() SenderOption
		SenderUseLatestPacket sets the interceptor to always use the latest packet, even
		if it appears to be out-of-order.

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.