Participants and synchronization sources.(3) Library Functions Manual Participants and synchronization sources.(3)NAME
Participants and synchronization sources. -
Classes
class SDESItemsHolder
Holds the SDES items and related information from a participant in an RTP application.
class Participant
A class of objects representing remote participants (RTP applications) in a multimedia session.
class SyncSource
Synchronization source in an RTP session.
class RTPApplication
An RTP application, holding identifying RTCP SDES item values.
Functions
__EXPORT RTPApplication & defaultApplication ()
Get the RTPApplication object for the 'default' application (the only one used by common applications -those that only implement one
'RTP application').
Detailed DescriptionFunction Documentation
__EXPORT RTPApplication& defaultApplication ()
Get the RTPApplication object for the 'default' application (the only one used by common applications -those that only implement one 'RTP
application'). Note that this application object differs from all the others that may be defined in that it is automatically constructed by
the ccRTP stack and its CNAME is automatically assigned (as user@host), whereas the other application objects' CNAME is provided to its
constructor.
Examples:
ccrtptest.cpp, rtphello.cpp, rtplisten.cpp, and rtpsend.cpp.
Author
Generated automatically by Doxygen for ccRTP from the source code.
ccRTP Sat Jun 23 2012 Participants and synchronization sources.(3)
Check Out this Related Man Page
AppDataUnit(3) Library Functions Manual AppDataUnit(3)NAME
AppDataUnit -
Interface (envelope) to data received over RTP packets.
SYNOPSIS
#include <queuebase.h>
Public Member Functions
AppDataUnit (const IncomingRTPPkt &packet, const SyncSource &src)
~AppDataUnit ()
AppDataUnit (const AppDataUnit &src)
AppDataUnit & operator= (const AppDataUnit &source)
Assignment operator.
PayloadType getType () const
const uint8 *const getData () const
Get data as it is received in RTP packets (i.e.
size_t getSize () const
const SyncSource & getSource () const
bool isMarked () const
Is this data unit marked?.
uint16 getSeqNum () const
Get data unit sequence number.
uint8 getContributorsCount () const
Get the number of contributing sources in the CSRC list.
const uint32 * getContributorsID () const
Get the array of 32-bit CSRC identifiers.
Detailed Description
Interface (envelope) to data received over RTP packets.
A class of objects representing data transmitted over RTP packets. Tipically, this object will apply to received data. Data blocks received
via RTP connections as well as its related objects (source, etc), are accessed through the methods of this class.
Author:
Federico Montesino Pouzols fedemp@altern.org
Examples:
audiorx.cpp, ccrtptest.cpp, rtpduphello.cpp, rtphello.cpp, and rtplisten.cpp.
Constructor & Destructor Documentation
AppDataUnit::AppDataUnit (const IncomingRTPPkt &packet, const SyncSource &src)
AppDataUnit::~AppDataUnit () [inline]
AppDataUnit::AppDataUnit (const AppDataUnit &src)
Parameters:
src the AppDataUnit object being copied
Member Function Documentation
uint8 AppDataUnit::getContributorsCount () const [inline]
Get the number of contributing sources in the CSRC list.
const uint32* AppDataUnit::getContributorsID () const [inline]
Get the array of 32-bit CSRC identifiers. Returns:
NULL if (getContributorsCount() == 0)
const uint8* const AppDataUnit::getData () const [inline]
Get data as it is received in RTP packets (i.e. for multi-octet encodings, octets are in network order.
Returns:
Raw pointer to data block.
Examples:
audiorx.cpp, ccrtptest.cpp, rtpduphello.cpp, and rtphello.cpp.
uint16 AppDataUnit::getSeqNum () const [inline]
Get data unit sequence number.
size_t AppDataUnit::getSize () const [inline]
Returns:
length of data in octets
Examples:
audiorx.cpp, and rtplisten.cpp.
const SyncSource& AppDataUnit::getSource () const [inline]
Returns:
Source that sent this data
Examples:
rtplisten.cpp.
PayloadType AppDataUnit::getType () const [inline]
Returns:
type of this data
Examples:
rtplisten.cpp.
bool AppDataUnit::isMarked () const [inline]
Is this data unit marked?. Returns:
true if marked.
AppDataUnit& AppDataUnit::operator= (const AppDataUnit &source)
Assignment operator. Parameters:
source the AppDataUnit object being assigned
Returns:
the result of the assignment
Author
Generated automatically by Doxygen for ccRTP from the source code.
ccRTP Sat Jun 23 2012 AppDataUnit(3)