Skip to main content

IntervalPliInterceptor

Struct IntervalPliInterceptor 

Source
pub struct IntervalPliInterceptor<P> { /* private fields */ }
Expand description

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

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

Implementations§

Source§

impl<P> IntervalPliInterceptor<P>

Source

pub fn force_pli(&mut self, now: Instant)

Request a keyframe from every bound stream, now.

§Why this takes an instant, and why it is not on the trait

Ein is () for every interceptor, so there is no typed event to carry an out-of-band request through a chain — and widening the trait for one interceptor would break every other. So this is an inherent method, reachable while the concrete type is still in hand (before Registry::boxed erases it). The instant is a parameter because a sans-I/O interceptor has no clock to ask.

Source

pub fn force_pli_for(&mut self, now: Instant, ssrcs: &[u32])

Request a keyframe from specific streams, now.

SSRCs that are not bound are ignored: a PLI for a stream nobody is receiving has no destination.

Source

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

The streams currently being asked for keyframes.

Trait Implementations§

Source§

impl<P: Interceptor> Interceptor for IntervalPliInterceptor<P>

Source§

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.
Source§

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.
Source§

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.
Source§

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.
Source§

fn with<O, F>(self, f: F) -> O
where Self: Sized, F: FnOnce(Self) -> O, O: Interceptor,

Wrap this interceptor with another layer. Read more
Source§

impl<P: Interceptor> Protocol<TransportMessage<Packet>, TransportMessage<Packet>, ()> for IntervalPliInterceptor<P>

Source§

type Rout = TransportMessage<Packet>

Output read message type Read more
Source§

type Wout = TransportMessage<Packet>

Output write message type Read more
Source§

type Eout = ()

Output event type Read more
Source§

type Error = Error

Error type for protocol operations
Source§

type Time = Instant

Time/Instant type for timeout handling Read more
Source§

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

Poll for a processed read message. Read more
Source§

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

Handle an outgoing write message. Read more
Source§

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

Handle a custom event. Read more
Source§

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

Poll for a generated event. Read more
Source§

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

Close the protocol. Read more
Source§

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

Handle an incoming read message. Read more
Source§

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

Handle a timeout event. Read more
Source§

fn poll_timeout(&mut self) -> Option<Self::Time>

Poll for the next timeout deadline. Read more
Source§

fn poll_write(&mut self) -> Option<Self::Wout>

Poll for a processed write message. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.