Struct RtpPacket 

pub struct RtpPacket { /* private fields */ }

RTP packet.

Implementations

impl RtpPacket

pub const fn new() -> Self

Create a new RTP packet.

pub fn from_parts( header: RtpHeader, payload: Bytes, ) -> Result<Self, InvalidInput>

Create a new RTP packets from given parts.

pub fn deconstruct(self) -> (RtpHeader, Bytes)

Deconstruct the packet into its parts.

pub fn decode(frame: Bytes) -> Result<Self, InvalidInput>

Decode RTP packet from given data frame.

pub fn encode(&self, buf: &mut BytesMut)

Encode the packet.

pub fn header(&self) -> &RtpHeader

Get the RTP header.

pub fn marker(&self) -> bool

Get the marker bit value.

pub fn with_marker(self, marker: bool) -> Self

Set the marker bit.

pub fn payload_type(&self) -> u8

Get the payload type.

Note: Only the lower 7 bits are used.

pub fn with_payload_type(self, payload_type: u8) -> Self

Set the payload type.

Panics

The method panics if the payload type is greater than 127.

pub fn sequence_number(&self) -> u16

Get the RTP sequence number.

pub fn with_sequence_number(self, sequence_number: u16) -> Self

Set the RTP sequence number.

pub fn timestamp(&self) -> u32

Get the RTP timestamp.

pub fn with_timestamp(self, timestamp: u32) -> Self

Set the RTP timestamp.

pub fn ssrc(&self) -> u32

Get the SSRC identifier.

pub fn with_ssrc(self, ssrc: u32) -> Self

Set the SSRC identifier.

pub fn csrcs(&self) -> &[u32]

Get the CSRC identifiers.

pub fn with_csrcs<T>(self, csrcs: T) -> Self

where T: Into<Vec<u32>>,

Set the CSRC identifiers.

Panics

The method panics if the number of identifiers is greater than 255.

pub fn padding(&self) -> u8

Get length of the optional padding.

Zero means that the padding is not used at all.

pub fn payload(&self) -> &Bytes

Get the packet payload including the optional padding.

pub fn stripped_payload(&self) -> Bytes

Get the packet payload without any padding.

pub fn with_payload(self, payload: Bytes, padding: u8) -> Self

Set the payload and add padding of a given length.

If the padding is zero, no padding will be added and the padding bit in the RTP header will be set to zero.

pub fn with_padded_payload(self, payload: Bytes) -> Self

Set the payload that already includes padding.

Panics

The method panics if the given payload is empty, if the last byte is zero or if the length of the padding is greater than the length of the payload.

pub fn raw_size(&self) -> usize

Get raw size of the packet (i.e. byte length of the encoded packet).

Trait Implementations

impl AsRef<RtpPacket> for IncomingRtpPacket

fn as_ref(&self) -> &RtpPacket

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<RtpPacket> for OrderedRtpPacket

fn as_ref(&self) -> &RtpPacket

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<RtpPacket> for IncomingRtpPacket

fn borrow(&self) -> &RtpPacket

Immutably borrows from an owned value.

impl Borrow<RtpPacket> for OrderedRtpPacket

fn borrow(&self) -> &RtpPacket

Immutably borrows from an owned value.

impl Clone for RtpPacket

fn clone(&self) -> RtpPacket

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for RtpPacket

fn default() -> Self

Returns the “default value” for a type.

impl From<IncomingRtpPacket> for RtpPacket

fn from(packet: IncomingRtpPacket) -> Self

Converts to this type from the input type.

impl From<OrderedRtpPacket> for RtpPacket

fn from(packet: OrderedRtpPacket) -> Self

Converts to this type from the input type.

impl From<RtpPacket> for PacketMux

fn from(packet: RtpPacket) -> Self

Converts to this type from the input type.

impl<T, E> Sink<RtpPacket> for DefaultRtpTransceiver<T, E>

where T: Sink<RtpPacket>,

type Error = <T as Sink<RtpPacket>>::Error

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut Self>, packet: RtpPacket, ) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<P, E> Sink<RtpPacket> for MuxedRtcpHandler<P, E>

type Error = E

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: RtpPacket) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<T> Sink<RtpPacket> for RtpChannel<T>

where T: Sink<Bytes>,

type Error = <T as Sink<Bytes>>::Error

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: RtpPacket) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.