Struct webrtc::track::track_local::track_local_static_rtp::TrackLocalStaticRTP

pub struct TrackLocalStaticRTP { /* private fields */ }

TrackLocalStaticRTP is a TrackLocal that has a pre-set codec and accepts RTP Packets. If you wish to send a media.Sample use TrackLocalStaticSample

Implementations

impl TrackLocalStaticRTP

pub fn new(codec: RTCRtpCodecCapability, id: String, stream_id: String) -> Self

returns a TrackLocalStaticRTP.

pub fn codec(&self) -> RTCRtpCodecCapability

codec gets the Codec of the track

pub async fn any_binding_paused(&self) -> bool

pub async fn all_binding_paused(&self) -> bool

pub async fn write_rtp_with_extensions(
    &self,
    p: &Packet,
    extensions: &[HeaderExtension]
) -> Result<usize>

write_rtp_with_extensions writes a RTP Packet to the TrackLocalStaticRTP If one PeerConnection fails the packets will still be sent to all PeerConnections. The error message will contain the ID of the failed PeerConnections so you can remove them

If the RTCRtpSender direction is such that no packets should be sent, any call to this function are blocked internally. Care must be taken to not increase the sequence number while the sender is paused. While the actual sending is blocked, the receiver will miss out when the sequence number “rolls over”, which in turn will break SRTP.

Extensions that are already configured on the packet are overwritten by extensions in extensions.

Trait Implementations

impl Debug for TrackLocalStaticRTP

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl TrackLocal for TrackLocalStaticRTP

fn bind<'life0, 'life1, 'async_trait>(
    &'life0 self,
    t: &'life1 TrackLocalContext
) -> Pin<Box<dyn Future<Output = Result<RTCRtpCodecParameters>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

bind is called by the PeerConnection after negotiation is complete This asserts that the code requested is supported by the remote peer. If so it setups all the state (SSRC and PayloadType) to have a call

fn unbind<'life0, 'life1, 'async_trait>(
    &'life0 self,
    t: &'life1 TrackLocalContext
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

unbind implements the teardown logic when the track is no longer needed. This happens because a track has been stopped.

fn id(&self) -> &str

id is the unique identifier for this Track. This should be unique for the stream, but doesn’t have to globally unique. A common example would be ‘audio’ or ‘video’ and StreamID would be ‘desktop’ or ‘webcam’

fn stream_id(&self) -> &str

stream_id is the group this track belongs too. This must be unique

fn kind(&self) -> RTPCodecType

kind controls if this TrackLocal is audio or video

fn as_any(&self) -> &dyn Any

impl TrackLocalWriter for TrackLocalStaticRTP

fn write_rtp<'life0, 'life1, 'async_trait>(
    &'life0 self,
    p: &'life1 Packet
) -> Pin<Box<dyn Future<Output = Result<usize>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

write_rtp writes a RTP Packet to the TrackLocalStaticRTP If one PeerConnection fails the packets will still be sent to all PeerConnections. The error message will contain the ID of the failed PeerConnections so you can remove them

If the RTCRtpSender direction is such that no packets should be sent, any call to this function are blocked internally. Care must be taken to not increase the sequence number while the sender is paused. While the actual sending is blocked, the receiver will miss out when the sequence number “rolls over”, which in turn will break SRTP.

fn write<'life0, 'life1, 'async_trait>(
    &'life0 self,
    b: &'life1 [u8]
) -> Pin<Box<dyn Future<Output = Result<usize>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

write writes a RTP Packet as a buffer to the TrackLocalStaticRTP If one PeerConnection fails the packets will still be sent to all PeerConnections. The error message will contain the ID of the failed PeerConnections so you can remove them