Struct rtp_rs::RtpPacketBuilder

pub struct RtpPacketBuilder<'a> { /* fields omitted */ }

A new packet build which collects the data which should be written as RTP packet

Implementations

impl<'a> RtpPacketBuilder<'a>

pub fn new() -> Self

Create a new RTP packet builder

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

Set the payload type. The type must be in range of [0; 127], else RtpPacketBuilder::build_info will fail.

pub fn padded(self, pad: Pad) -> Self

Control if and how bytes are appended to the packet if the headers and payload together do not have an appropriate length (for instance if the length of the resulting RTP data must be a multiple of 4 bytes).

The default is Pad::none() - no padding bytes will be added and the padding flag will not be set in the RTP header.

pub fn marked(self, flag: bool) -> Self

Set the marker bit in the RTP header

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

Add a contributing source (csrc). If added more than 15 contributing sources the rest will be discarded.

pub fn set_csrc(self, csrcs: &[u32]) -> Self

Set the contributing sources (csrc). If added more than 15 contributing sources the rest will be discarded.

pub fn sequence(self, seq: Seq) -> Self

Set the sequence number

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

Set the source for this packet

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

Set the timestamp

pub fn extension(self, id: u16, payload: &'a [u8]) -> Self

Add a custom extension payload. The bytes should be aligned to a a four byte boundary, else RtpPacketBuilder::build_info will fail.

pub fn payload(self, payload: &'a [u8]) -> Self

Set the payload of the packet

pub fn target_length(&self) -> usize

Calculate the target length of the packet. This can be used to allocate a buffer for the build_into method.

pub fn build_into_unchecked(&self, target: &mut [u8]) -> usize

Build the packet into the target buffer but ignore all validity checks.

pub fn build_into(
    &self,
    target: &mut [u8]
) -> Result<usize, RtpPacketBuildError>

Build the RTP packet on the target buffer. The length of the final packet will be returned on success.

pub fn build(&self) -> Result<Vec<u8>, RtpPacketBuildError>

Build the RTP packet. On success it returns a buffer containing the target packet.

Trait Implementations

impl<'a> Clone for RtpPacketBuilder<'a>

fn clone(&self) -> RtpPacketBuilder<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.