The Interceptor interface is the foundation of the Pion Interceptor library. It allows you to add functionality to PeerConnections by modifying incoming/outgoing RTP/RTCP packets or sending your own packets as needed.
Interface Definition
type Interceptor interface {
BindRTCPReader(reader RTCPReader) RTCPReader
BindRTCPWriter(writer RTCPWriter) RTCPWriter
BindLocalStream(info *StreamInfo, writer RTPWriter) RTPWriter
UnbindLocalStream(info *StreamInfo)
BindRemoteStream(info *StreamInfo, reader RTPReader) RTPReader
UnbindRemoteStream(info *StreamInfo)
io.Closer
}
Methods
BindRTCPReader
BindRTCPReader(reader RTCPReader) RTCPReader
RTCPReader - A wrapped reader that can modify packets
BindRTCPWriter
BindRTCPWriter(writer RTCPWriter) RTCPWriter
RTCPWriter - A wrapped writer that can modify packets
BindLocalStream
BindLocalStream(info *StreamInfo, writer RTPWriter) RTPWriter
Information about the stream being bound
RTPWriter - A wrapped writer that can modify packets
UnbindLocalStream
UnbindLocalStream(info *StreamInfo)
Information about the stream being unbound
BindRemoteStream
BindRemoteStream(info *StreamInfo, reader RTPReader) RTPReader
Information about the stream being bound
RTPReader - A wrapped reader that can modify packets
UnbindRemoteStream
UnbindRemoteStream(info *StreamInfo)
Information about the stream being unbound
Close
Closes the interceptor, cleaning up any data if necessary.
Returns: error - Any error that occurred during cleanup
RTPWriter
type RTPWriter interface {
Write(header *rtp.Header, payload []byte, attributes Attributes) (int, error)
}
RTPReader
type RTPReader interface {
Read([]byte, Attributes) (int, Attributes, error)
}
RTCPWriter
type RTCPWriter interface {
Write(pkts []rtcp.Packet, attributes Attributes) (int, error)
}
RTCPReader
type RTCPReader interface {
Read([]byte, Attributes) (int, Attributes, error)
}
Usage Example
import (
"github.com/pion/interceptor"
"github.com/pion/rtp"
)
// Custom interceptor that logs RTP packets
type LoggingInterceptor struct {
interceptor.NoOp
}
func (i *LoggingInterceptor) BindRemoteStream(
info *interceptor.StreamInfo,
reader interceptor.RTPReader,
) interceptor.RTPReader {
return interceptor.RTPReaderFunc(func(b []byte, a interceptor.Attributes) (int, interceptor.Attributes, error) {
n, attr, err := reader.Read(b, a)
if err != nil {
return 0, nil, err
}
// Log packet info
fmt.Printf("Received RTP packet of %d bytes\n", n)
return n, attr, nil
})
}
See Also
- Factory - Interface for constructing interceptors
- Chain - Run multiple interceptors in sequence
- NoOp - Base implementation for easy interceptor creation
- StreamInfo - Stream metadata
Reference
For more details, see the pkg.go.dev documentation.