Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
roc::packet::RTP Struct Reference

RTP packet. More...

#include <rtp.h>

Collaboration diagram for roc::packet::RTP:

Public Member Functions

 RTP ()
 Construct zero RTP packet. More...
 
int compare (const RTP &) const
 Determine packet order. More...
 

Public Attributes

source_t source
 Packet source ID identifying packet stream. More...
 
seqnum_t seqnum
 Packet sequence number in packet stream. More...
 
timestamp_t timestamp
 Packet timestamp. More...
 
timestamp_t duration
 Packet duration. More...
 
bool marker
 Packet marker bit. More...
 
unsigned int payload_type
 Packet payload type. More...
 
core::Slice< uint8_t > header
 Packet header. More...
 
core::Slice< uint8_t > payload
 Packet payload. More...
 
core::Slice< uint8_t > padding
 Packet padding. More...
 

Detailed Description

RTP packet.

Definition at line 23 of file rtp.h.

Constructor & Destructor Documentation

roc::packet::RTP::RTP ( )

Construct zero RTP packet.

Member Function Documentation

int roc::packet::RTP::compare ( const RTP ) const

Determine packet order.

Member Data Documentation

timestamp_t roc::packet::RTP::duration

Packet duration.

Remarks
Duration is measured in the same units as timestamp.

Definition at line 46 of file rtp.h.

core::Slice<uint8_t> roc::packet::RTP::header

Packet header.

Definition at line 57 of file rtp.h.

bool roc::packet::RTP::marker

Packet marker bit.

Remarks
Marker bit meaning depends on packet type.

Definition at line 51 of file rtp.h.

core::Slice<uint8_t> roc::packet::RTP::padding

Packet padding.

Remarks
Not included in header and payload, but affects overall packet size.

Definition at line 67 of file rtp.h.

core::Slice<uint8_t> roc::packet::RTP::payload

Packet payload.

Remarks
Doesn't include RTP headers and padding.

Definition at line 62 of file rtp.h.

unsigned int roc::packet::RTP::payload_type

Packet payload type.

Definition at line 54 of file rtp.h.

seqnum_t roc::packet::RTP::seqnum

Packet sequence number in packet stream.

Remarks
Packets are numbered sequentaly in every stream, starting from some random value. May overflow.

Definition at line 34 of file rtp.h.

source_t roc::packet::RTP::source

Packet source ID identifying packet stream.

Remarks
Sequence numbers and timestamp are numbered independently inside different packet streams.

Definition at line 28 of file rtp.h.

timestamp_t roc::packet::RTP::timestamp

Packet timestamp.

Remarks
Timestamp units and exact meaning depends on packet type. For example, it may be used to define the number of the first sample in packet, or the time when the packet were generated.

Definition at line 41 of file rtp.h.


The documentation for this struct was generated from the following file: