Struct rtp_types::RtpPacketBuilder

pub struct RtpPacketBuilder<P: PayloadLength, E: PayloadLength> { /* private fields */ }

Struct for building a new RTP packet

Implementations

impl<P: PayloadLength, E: PayloadLength> RtpPacketBuilder<P, E>

pub fn new() -> RtpPacketBuilder<P, E>

Construct a new packet builder

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

Set the number of padding bytes to use for this packet

pub fn maybe_padding(self, padding: Option<u8>) -> Self

Set 1. whether padding is used and 2. the number of padding bytes to use for this packet

pub fn add_csrc(self, csrc: u32) -> Self

Add a Contribution Source for this packet

pub fn clear_csrcs(self) -> Self

Clear any CSRCs configured for this packet

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

Set the marker bit for this packet

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

Set the payload type for this packet

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

Set the sequence number for this packet

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

Set the RTP timestamp for this packet

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

Set the Sequence source for this packet

pub fn extension(self, extension_id: u16, extension_data: E) -> Self

Set the extension header for this packet

pub fn clear_extension(self) -> Self

Clear any extension data configured for this packet

pub fn payload(self, payload: P) -> Self

Add a chunk of payload data for this packet.

Can be called multiple times, in which case the payload data chunks will be concatenated when the final packet is created.

pub fn clear_payloads(self) -> Self

Clear any payloads currently configured

pub fn calculate_size(&self) -> Result<usize, RtpWriteError>

Calculate the size required for writing the packet.

pub fn write_unchecked<O>( &self, writer: &mut impl RtpPacketWriter<Payload = P, Extension = E, Output = O> ) -> O

Write this packet using writer without any validity checks

pub fn write<O>( &self, writer: &mut impl RtpPacketWriter<Payload = P, Extension = E, Output = O> ) -> Result<O, RtpWriteError>

Write the packet using writer.

impl<'a> RtpPacketBuilder<&'a [u8], &'a [u8]>

pub fn write_into_unchecked<'b: 'a>(&self, buf: &'b mut [u8]) -> usize

Write this packet into buf without any validity checks. Returns the number of bytes written.

pub fn write_into<'b: 'a>( &self, buf: &'b mut [u8] ) -> Result<usize, RtpWriteError>

Write this packet into buf. On success returns the number of bytes written or an RtpWriteError on failure.

pub fn write_into_vec_unchecked(&self, buf: &'a mut Vec<u8>)

Write this packet into buf without any validity checks. The data will be appended to the end of the provide Vec.

pub fn write_into_vec(&self, buf: &'a mut Vec<u8>) -> Result<(), RtpWriteError>

Write this packet into buf. The data will be appended to the end of the provide Vec.

pub fn write_vec_unchecked(&self) -> Vec<u8>

Write this packet into a newly generated Vec<u8> without any validity checks.

pub fn write_vec(&self) -> Result<Vec<u8>, RtpWriteError>

Write this packet into a newly generated Vec<u8>.

Trait Implementations

impl<P: Debug + PayloadLength, E: Debug + PayloadLength> Debug for RtpPacketBuilder<P, E>

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

Formats the value using the given formatter.

impl<P: PayloadLength, E: PayloadLength> Default for RtpPacketBuilder<P, E>

fn default() -> Self

Returns the “default value” for a type.