Struct IntervalPliInterceptor 

pub struct IntervalPliInterceptor { /* private fields */ }

Requests a keyframe from every bound remote stream on a fixed interval.

Where this belongs in the chain

It only generates, and what it generates is RTCP, so its position is fixed by nothing except being on the application side of the pacer — as everything that generates is, so that what it produces is still metered on its way out.

Forcing a keyframe

Attach Attribute::ForcePli to a packet handed to handle_read. Under the nested design this was an inherent method, force_pli, which became unreachable the moment anything wrapped this interceptor — it was dead code in practice. An attribute rides on a packet through the walk and reaches this interceptor wherever it sits, and is not consumed, so anything further on sees both the request and the PLI it produced.

Sans-I/O has no clock of its own, so the interval is measured from the first Instant the interceptor is handed, whether that arrives via handle_read or handle_timeout.

Implementations

impl IntervalPliInterceptor

pub fn new(interval: Duration) -> Self

A generator asking every bound stream for a keyframe every interval.

A zero interval disables periodic requests, leaving only Attribute::ForcePli — matching upstream, which creates no ticker when its interval is not positive.

pub fn bound_streams(&self) -> impl Iterator<Item = u32> + '_

The streams currently being asked for keyframes.

Trait Implementations

impl Default for IntervalPliInterceptor

fn default() -> Self

Returns the “default value” for a type.

impl Interceptor for IntervalPliInterceptor

fn bind_remote_stream(&mut self, info: &StreamInfo)

bind_remote_stream lets you modify any incoming RTP packets. It is called once for per RemoteStream. The returned method will be called once per rtp packet.

fn unbind_remote_stream(&mut self, info: &StreamInfo)

unbind_remote_stream is called when the Stream is removed. It can be used to clean up any data related to that track.

fn bind_local_stream(&mut self, _info: &StreamInfo)

bind_local_stream lets you modify any outgoing RTP packets. It is called once for per LocalStream. The returned method will be called once per rtp packet.

fn unbind_local_stream(&mut self, _info: &StreamInfo)

unbind_local_stream is called when the Stream is removed. It can be used to clean up any data related to that track.

impl Protocol<TransportMessage<AttributedPacket>, TransportMessage<AttributedPacket>, ()> for IntervalPliInterceptor

type Rout = TransportMessage<AttributedPacket>

Output read message type

type Wout = TransportMessage<AttributedPacket>

Output write message type

type Eout = ()

Output event type

type Error = Error

Error type for protocol operations

type Time = Instant

Time/Instant type for timeout handling

fn handle_read(&mut self, msg: TaggedPacket) -> Result<(), Self::Error>

Handle an incoming read message.

fn poll_read(&mut self) -> Option<Self::Rout>

Poll for a processed read message.

fn handle_write(&mut self, msg: TaggedPacket) -> Result<(), Self::Error>

Handle an outgoing write message.

fn poll_write(&mut self) -> Option<TaggedPacket>

Poll for a processed write message.

fn handle_timeout(&mut self, now: Instant) -> Result<(), Error>

Handle a timeout event.

fn poll_timeout(&mut self) -> Option<Instant>

Poll for the next timeout deadline.

fn handle_event(&mut self, _evt: Ein) -> Result<(), Self::Error>

Handle a custom event.

fn poll_event(&mut self) -> Option<Self::Eout>

Poll for a generated event.

fn close(&mut self) -> Result<(), Self::Error>

Close the protocol.