Struct RtcpPacket 

pub struct RtcpPacket { /* private fields */ }

RTCP packet.

Implementations

impl RtcpPacket

pub const fn new(packet_type: RtcpPacketType) -> Self

Create a new packet.

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

Create a new RTCP packet from given parts.

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

Deconstruct the packet into its header and payload.

pub fn decode(data: &mut Bytes) -> Result<Self, InvalidInput>

Decode an RTCP packet.

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

Encode the packet.

pub fn header(&self) -> &RtcpHeader

Get the packet header.

pub fn packet_type(&self) -> RtcpPacketType

Get the packet type.

pub fn with_packet_type(self, packet_type: RtcpPacketType) -> Self

Set the packet type.

pub fn item_count(&self) -> u8

Get number of items in the packet body.

Note: Only the lower 5 bits are actually used.

pub fn with_item_count(self, count: u8) -> Self

Set the number of items in the packet body.

Panics

The method panics if the number of items is greater than 31.

pub fn length(&self) -> usize

Get packet length in bytes.

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.

Panics

The method panics if the payload length including padding is not a multiple of four or if the payload length including padding is greater than 262_140.

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

Set the payload that already includes padding.

Panics

The method panics if the following conditions are not met:

• The payload must not be empty.
• The last byte of the payload (i.e. the length of the padding) must not be zero.
• The length of the padding must not be greater than the length of the payload itself.
• The payload length including padding must be a multiple of four.
• The payload length including padding must not be greater than 262_140.

pub fn raw_size(&self) -> usize

Get encoded size of the packet.

Trait Implementations

impl Clone for RtcpPacket

fn clone(&self) -> RtcpPacket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl From<RtcpPacket> for CompoundRtcpPacket

fn from(packet: RtcpPacket) -> Self

Converts to this type from the input type.

impl<P> From<RtcpPacket> for PacketMux<P>

fn from(packet: RtcpPacket) -> Self

Converts to this type from the input type.