Package: github.com/pion/interceptor/pkg/nack

package nack Import Path github.com/pion/interceptor/pkg/nack (on go.dev) Dependency Relation imports 9 packages, and imported by one package Involved Source Files errors.go generator_interceptor.go generator_option.go d nack.go Package nack provides interceptors to implement sending and receiving negative acknowledgements receive_log.go responder_interceptor.go responder_option.go Package-Level Type Names (total 6) /* sort by: alphabet | popularity */ type GeneratorInterceptor (struct) GeneratorInterceptor interceptor generates nack feedback messages. Fields (only one) NoOp interceptor.NoOp Methods (total 7) (*GeneratorInterceptor) 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. (*GeneratorInterceptor) 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. (*GeneratorInterceptor) 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. (*GeneratorInterceptor) 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. (*GeneratorInterceptor) Close() error Close closes the interceptor. (*GeneratorInterceptor) UnbindLocalStream(_ *interceptor.StreamInfo) UnbindLocalStream is called when the Stream is removed. It can be used to clean up any data related to that track. (*GeneratorInterceptor) 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) *GeneratorInterceptor : github.com/pion/interceptor.Interceptor *GeneratorInterceptor : github.com/prometheus/common/expfmt.Closer *GeneratorInterceptor : io.Closer type GeneratorInterceptorFactory (struct) GeneratorInterceptorFactory is a interceptor.Factory for a GeneratorInterceptor. Methods (only one) (*GeneratorInterceptorFactory) NewInterceptor(_ string) (interceptor.Interceptor, error) NewInterceptor constructs a new ReceiverInterceptor. Implements (at least one exported) *GeneratorInterceptorFactory : github.com/pion/interceptor.Factory As Outputs Of (at least one exported) func NewGeneratorInterceptor(opts ...GeneratorOption) (*GeneratorInterceptorFactory, error) type GeneratorOption (func) GeneratorOption can be used to configure GeneratorInterceptor. As Outputs Of (at least 6) func GeneratorInterval(interval time.Duration) GeneratorOption func GeneratorLog(log logging.LeveledLogger) GeneratorOption func GeneratorMaxNacksPerPacket(maxNacks uint16) GeneratorOption func GeneratorSize(size uint16) GeneratorOption func GeneratorSkipLastN(skipLastN uint16) GeneratorOption func GeneratorStreamsFilter(filter func(info *interceptor.StreamInfo) bool) GeneratorOption As Inputs Of (at least one exported) func NewGeneratorInterceptor(opts ...GeneratorOption) (*GeneratorInterceptorFactory, error) type ResponderInterceptor (struct) ResponderInterceptor responds to nack feedback messages. Fields (only one) NoOp interceptor.NoOp Methods (total 7) (*ResponderInterceptor) 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. (*ResponderInterceptor) 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. (*ResponderInterceptor) 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. (*ResponderInterceptor) 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. (*ResponderInterceptor) Close() error Close closes the Interceptor, cleaning up any data if necessary. (*ResponderInterceptor) 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. (*ResponderInterceptor) 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) *ResponderInterceptor : github.com/pion/interceptor.Interceptor *ResponderInterceptor : github.com/prometheus/common/expfmt.Closer *ResponderInterceptor : io.Closer type ResponderInterceptorFactory (struct) ResponderInterceptorFactory is a interceptor.Factory for a ResponderInterceptor. Methods (only one) (*ResponderInterceptorFactory) NewInterceptor(_ string) (interceptor.Interceptor, error) NewInterceptor constructs a new ResponderInterceptor. Implements (at least one exported) *ResponderInterceptorFactory : github.com/pion/interceptor.Factory As Outputs Of (at least one exported) func NewResponderInterceptor(opts ...ResponderOption) (*ResponderInterceptorFactory, error) type ResponderOption (func) ResponderOption can be used to configure ResponderInterceptor. As Outputs Of (at least 4) func DisableCopy() ResponderOption func ResponderLog(log logging.LeveledLogger) ResponderOption func ResponderSize(size uint16) ResponderOption func ResponderStreamsFilter(filter func(info *interceptor.StreamInfo) bool) ResponderOption As Inputs Of (at least one exported) func NewResponderInterceptor(opts ...ResponderOption) (*ResponderInterceptorFactory, error) Package-Level Functions (total 12) func DisableCopy() ResponderOption DisableCopy bypasses copy of underlying packets. It should be used when you are not re-using underlying buffers of packets that have been written. func GeneratorInterval(interval time.Duration) GeneratorOption GeneratorInterval sets the nack send interval for the interceptor. func GeneratorLog(log logging.LeveledLogger) GeneratorOption GeneratorLog sets a logger for the interceptor. func GeneratorMaxNacksPerPacket(maxNacks uint16) GeneratorOption GeneratorMaxNacksPerPacket sets the maximum number of NACKs sent per missing packet, e.g. if set to 2, a missing packet will only be NACKed at most twice. If set to 0 (default), max number of NACKs is unlimited. func GeneratorSize(size uint16) GeneratorOption GeneratorSize sets the size of the interceptor. Size must be one of: 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768. func GeneratorSkipLastN(skipLastN uint16) GeneratorOption GeneratorSkipLastN sets the number of packets (n-1 packets before the last received packets) to ignore when generating nack requests. func GeneratorStreamsFilter(filter func(info *interceptor.StreamInfo) bool) GeneratorOption GeneratorStreamsFilter sets filter for generator streams. func NewGeneratorInterceptor(opts ...GeneratorOption) (*GeneratorInterceptorFactory, error) NewGeneratorInterceptor returns a new GeneratorInterceptorFactory. func NewResponderInterceptor(opts ...ResponderOption) (*ResponderInterceptorFactory, error) NewResponderInterceptor returns a new ResponderInterceptorFactor. func ResponderLog(log logging.LeveledLogger) ResponderOption ResponderLog sets a logger for the interceptor. func ResponderSize(size uint16) ResponderOption ResponderSize sets the size of the interceptor. Size must be one of: 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768. func ResponderStreamsFilter(filter func(info *interceptor.StreamInfo) bool) ResponderOption ResponderStreamsFilter sets filter for local streams. Package-Level Variables (only one) var ErrInvalidSize error ErrInvalidSize is returned by newReceiveLog/newRTPBuffer, when an incorrect buffer size is supplied.

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.