OPAL  Version 3.10.4
OpalAudioFormat Class Reference

#include <mediafmt.h>

Inheritance diagram for OpalAudioFormat:
OpalMediaFormat

Public Member Functions

 OpalAudioFormat (OpalMediaFormatInternal *info=NULL)
 OpalAudioFormat (const char *fullName, RTP_DataFrame::PayloadTypes rtpPayloadType, const char *encodingName, PINDEX frameSize, unsigned frameTime, unsigned rxFrames, unsigned txFrames, unsigned maxFrames=256, unsigned clockRate=8000, time_t timeStamp=0)
- Public Member Functions inherited from OpalMediaFormat
 OpalMediaFormat (const OpalMediaFormat &c)
virtual ~OpalMediaFormat ()
OpalMediaFormatoperator= (const OpalMediaFormat &c)
virtual PBoolean MakeUnique ()
 OpalMediaFormat (OpalMediaFormatInternal *info=NULL)
 OpalMediaFormat (const char *fullName, const OpalMediaType &mediaType, RTP_DataFrame::PayloadTypes rtpPayloadType, const char *encodingName, PBoolean needsJitter, unsigned bandwidth, PINDEX frameSize, unsigned frameTime, unsigned clockRate, time_t timeStamp=0)
 OpalMediaFormat (RTP_DataFrame::PayloadTypes rtpPayloadType, unsigned clockRate, const char *rtpEncodingName=NULL, const char *protocol=NULL)
 OpalMediaFormat (const char *wildcard)
 OpalMediaFormat (const PString &wildcard)
OpalMediaFormatoperator= (RTP_DataFrame::PayloadTypes rtpPayloadType)
OpalMediaFormatoperator= (const char *wildcard)
OpalMediaFormatoperator= (const PString &wildcard)
virtual PObject * Clone () const
virtual Comparison Compare (const PObject &obj) const
virtual void PrintOn (ostream &strm) const
virtual void ReadFrom (istream &strm)
bool ToNormalisedOptions ()
bool ToCustomisedOptions ()
bool Update (const OpalMediaFormat &mediaFormat)
bool Merge (const OpalMediaFormat &mediaFormat)
bool ValidateMerge (const OpalMediaFormat &mediaFormat) const
PString GetName () const
PBoolean IsValid () const
PBoolean IsTransportable () const
RTP_DataFrame::PayloadTypes GetPayloadType () const
void SetPayloadType (RTP_DataFrame::PayloadTypes type)
const char * GetEncodingName () const
OpalMediaType GetMediaType () const
bool NeedsJitterBuffer () const
unsigned GetBandwidth () const
PINDEX GetFrameSize () const
unsigned GetFrameTime () const
unsigned GetTimeUnits () const
unsigned GetClockRate () const
PStringToString GetOptions () const
PINDEX GetOptionCount () const
const OpalMediaOptionGetOption (PINDEX index) const
bool GetOptionValue (const PString &name, PString &value) const
bool SetOptionValue (const PString &name, const PString &value)
bool GetOptionBoolean (const PString &name, bool dflt=false) const
bool SetOptionBoolean (const PString &name, bool value)
int GetOptionInteger (const PString &name, int dflt=0) const
bool SetOptionInteger (const PString &name, int value)
double GetOptionReal (const PString &name, double dflt=0) const
bool SetOptionReal (const PString &name, double value)
PINDEX GetOptionEnum (const PString &name, PINDEX dflt=0) const
bool SetOptionEnum (const PString &name, PINDEX value)
PString GetOptionString (const PString &name, const PString &dflt=PString::Empty()) const
bool SetOptionString (const PString &name, const PString &value)
bool GetOptionOctets (const PString &name, PBYTEArray &octets) const
bool SetOptionOctets (const PString &name, const PBYTEArray &octets)
bool SetOptionOctets (const PString &name, const BYTE *data, PINDEX length)
bool AddOption (OpalMediaOption *option, PBoolean overwrite=false)
bool HasOption (const PString &name) const
OpalMediaOptionFindOption (const PString &name) const
template<class T >
T * FindOptionAs (const PString &name) const
bool IsValidForProtocol (const PString &protocol) const
time_t GetCodecVersionTime () const
ostream & PrintOptions (ostream &strm) const
void AdjustVideoArgs (PVideoDevice::OpenArgs &args) const
virtual PBoolean IsEmpty () const
 operator PString () const
 operator const char * () const
bool operator== (const char *other) const
bool operator!= (const char *other) const
bool operator== (const PString &other) const
bool operator!= (const PString &other) const
bool operator== (const OpalMediaFormat &other) const
bool operator!= (const OpalMediaFormat &other) const

Static Public Member Functions

static const PString & RxFramesPerPacketOption ()
static const PString & TxFramesPerPacketOption ()
static const PString & MaxFramesPerPacketOption ()
static const PString & ChannelsOption ()
- Static Public Member Functions inherited from OpalMediaFormat
static const PString & NeedsJitterOption ()
static const PString & MaxBitRateOption ()
static const PString & TargetBitRateOption ()
static const PString & MaxFrameSizeOption ()
static const PString & FrameTimeOption ()
static const PString & ClockRateOption ()
static const PString & ProtocolOption ()
static const PString & MaxTxPacketSizeOption ()
static OpalMediaFormatList GetAllRegisteredMediaFormats ()
static void GetAllRegisteredMediaFormats (OpalMediaFormatList &copy)
static bool SetRegisteredMediaFormat (const OpalMediaFormat &mediaFormat)
static bool RemoveRegisteredMediaFormat (const OpalMediaFormat &mediaFormat)
static const PString & MediaPacketizationOption ()
static const PString & MediaPacketizationsOption ()

Additional Inherited Members

- Public Types inherited from OpalMediaFormat
enum  StandardClockRate { AudioClockRate = 8000, VideoClockRate = 90000 }
- Protected Member Functions inherited from OpalMediaFormat
virtual void DestroyContents ()
virtual void AssignContents (const PContainer &c)
void Construct (OpalMediaFormatInternal *info)
- Protected Attributes inherited from OpalMediaFormat
OpalMediaFormatInternalm_info
PMutex m_mutex

Constructor & Destructor Documentation

OpalAudioFormat::OpalAudioFormat ( OpalMediaFormatInternal info = NULL)
inline
OpalAudioFormat::OpalAudioFormat ( const char *  fullName,
RTP_DataFrame::PayloadTypes  rtpPayloadType,
const char *  encodingName,
PINDEX  frameSize,
unsigned  frameTime,
unsigned  rxFrames,
unsigned  txFrames,
unsigned  maxFrames = 256,
unsigned  clockRate = 8000,
time_t  timeStamp = 0 
)
Parameters:
fullNameFull name of media format
rtpPayloadTypeRTP payload type code
encodingNameRTP encoding name
frameSizeSize of frame in bytes (if applicable)
frameTimeTime for frame in RTP units (if applicable)
rxFramesMaximum number of frames per packet we can receive
txFramesDesired number of frames per packet we transmit
maxFramesMaximum possible frames per packet
clockRateClock Rate
timeStamptimestamp (for versioning)

Member Function Documentation

static const PString& OpalAudioFormat::ChannelsOption ( )
static
static const PString& OpalAudioFormat::MaxFramesPerPacketOption ( )
static
static const PString& OpalAudioFormat::RxFramesPerPacketOption ( )
static
static const PString& OpalAudioFormat::TxFramesPerPacketOption ( )
static

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