Struct RTCRtpReceiver

Source

pub struct RTCRtpReceiver<'a, I = NoopInterceptor>where
    I: Interceptor,
{ /* private fields */ }

Expand description

Represents an RTP receiver for a media stream track.

The RTCRtpReceiver interface allows an application to inspect the receipt of a MediaStreamTrack as defined in the W3C WebRTC specification.

§Lifetime

This struct borrows the RTCPeerConnection mutably, ensuring exclusive access during RTP receiver operations.

Implementations§

Source §

impl RTCRtpReceiver<'_, I>
where I: Interceptor,

Source

pub fn track(&self) -> &MediaStreamTrack

Returns the track associated with this receiver.

The track method returns the MediaStreamTrack that is associated with this receiver as specified in the W3C WebRTC specification.

§Returns

Returns a reference to the MediaStreamTrack associated with this receiver.

Source

pub fn get_capabilities(&self, kind: RtpCodecKind) -> Option<RTCRtpCapabilities>

Returns the RTP capabilities for the specified codec kind.

The static get_capabilities method returns the most optimistic view of the capabilities of the system for receiving media of the given kind as defined in the W3C WebRTC specification.

§Parameters

kind - The codec kind (audio or video)

§Returns

Returns the RTP capabilities supported by this receiver for the specified codec kind.

Source

pub fn get_parameters(&mut self) -> &RTCRtpReceiveParameters

Returns the RTP receive parameters for this receiver.

The get_parameters method returns the current parameters for how the receiver’s track is decoded as defined in the W3C WebRTC specification.

§Returns

Returns a reference to the RTP receive parameters.

Source

pub fn get_contributing_sources( &self, ) -> impl Iterator<Item = &RTCRtpContributingSource>

Returns an iterator over the contributing sources for this receiver.

The get_contributing_sources method returns information about the contributing sources (CSRCs) for the most recent RTP packets received by this receiver as defined in the W3C WebRTC specification.

Contributing sources represent mixers or other entities that have contributed to the RTP stream.

§Returns

Returns an iterator over RTCRtpContributingSource objects.

Source

pub fn get_synchronization_sources( &self, ) -> impl Iterator<Item = &RTCRtpSynchronizationSource>

Returns an iterator over the synchronization sources for this receiver.

The get_synchronization_sources method returns information about the synchronization sources (SSRCs) for the most recent RTP packets received by this receiver as defined in the W3C WebRTC specification.

Synchronization sources represent the original sources of the RTP packets.

§Returns

Returns an iterator over RTCRtpSynchronizationSource objects.

Source

pub fn write_rtcp(&mut self, packets: Vec<Box<dyn Packet>>) -> Result<()>

Writes RTCP feedback packets for this receiver.

This method allows sending receiver-side RTCP feedback such as:

Receiver Reports (RR)
Picture Loss Indication (PLI)
Full Intra Request (FIR)
Negative Acknowledgements (NACK)

§Parameters

packets - A vector of RTCP packets to send

§Returns

Returns Ok(()) if the packets were queued successfully.

§Errors

Returns an error if internal handle_write returns error

§Example

// Send a Picture Loss Indication to request a keyframe
use rtcp::picture_loss_indication::PictureLossIndication;

let pli = PictureLossIndication {
    sender_ssrc: 0,
    media_ssrc: remote_ssrc,
};
receiver.write_rtcp(vec![Box::new(pli)])?;