OpalMediaFormatInternal Class Reference

`#include <mediafmt.h>`

Inheritance diagram for OpalMediaFormatInternal:

## Public Member Functions

| OpalMediaFormatInternal (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)
const PCaselessString & | GetName () const
virtual PObject * | Clone () const
virtual void | PrintOn (ostream &strm) const
virtual bool | IsValid () const
virtual bool | IsTransportable () const
virtual PStringToString | GetOptions () const
virtual bool | GetOptionValue (const PString &name, PString &value) const
virtual bool | SetOptionValue (const PString &name, const PString &value)
virtual bool | GetOptionBoolean (const PString &name, bool dflt) const
virtual bool | SetOptionBoolean (const PString &name, bool value)
virtual int | GetOptionInteger (const PString &name, int dflt) const
virtual bool | SetOptionInteger (const PString &name, int value)
virtual double | GetOptionReal (const PString &name, double dflt) const
virtual bool | SetOptionReal (const PString &name, double value)
virtual PINDEX | GetOptionEnum (const PString &name, PINDEX dflt) const
virtual bool | SetOptionEnum (const PString &name, PINDEX value)
virtual PString | GetOptionString (const PString &name, const PString &dflt) const
virtual bool | SetOptionString (const PString &name, const PString &value)
virtual bool | GetOptionOctets (const PString &name, PBYTEArray &octets) const
virtual bool | SetOptionOctets (const PString &name, const PBYTEArray &octets)
virtual bool | SetOptionOctets (const PString &name, const BYTE *data, PINDEX length)
virtual bool | AddOption (OpalMediaOption *option, PBoolean overwrite=false)
virtual OpalMediaOption * | FindOption (const PString &name) const
virtual bool | ToNormalisedOptions ()
virtual bool | ToCustomisedOptions ()
virtual bool | Merge (const OpalMediaFormatInternal &mediaFormat)
virtual bool | ValidateMerge (const OpalMediaFormatInternal &mediaFormat) const
virtual bool | IsValidForProtocol (const PString &protocol) const

## Protected Attributes

PCaselessString | formatName
RTP_DataFrame::PayloadTypes | rtpPayloadType
PString | rtpEncodingName
OpalMediaType | mediaType
PMutex | media_format_mutex
PSortedList< OpalMediaOption > | options
time_t | codecVersionTime
bool | forceIsTransportable
int | m_channels

## Friends

class | OpalMediaFormat
class | OpalMediaFormatList
class | OpalAudioFormatInternal
bool | operator== (const char *other, const OpalMediaFormat &fmt)
bool | operator!= (const char *other, const OpalMediaFormat &fmt)
bool | operator== (const PString &other, const OpalMediaFormat &fmt)
bool | operator!= (const PString &other, const OpalMediaFormat &fmt)

## Constructor & Destructor Documentation

OpalMediaFormatInternal::OpalMediaFormatInternal | ( | 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
| ) |  |

## Member Function Documentation

virtual bool OpalMediaFormatInternal::AddOption | ( | OpalMediaOption * | option,
|  | PBoolean | overwrite = `false`
| ) |  |

virtual

Referenced by OpalMediaFormat::AddOption().

virtual PObject* OpalMediaFormatInternal::Clone | ( |  | ) | const

virtual

Reimplemented in OpalVideoFormatInternal, OpalAudioFormatInternal, OpalPluginFaxFormatInternal, OpalPluginVideoFormatInternal, and OpalPluginAudioFormatInternal.

virtual OpalMediaOption* OpalMediaFormatInternal::FindOption | ( | const PString & | name | ) | const

virtual

Referenced by OpalMediaFormat::FindOption(), and OpalMediaFormat::HasOption().

const PCaselessString& OpalMediaFormatInternal::GetName | ( |  | ) | const

inline

References formatName.

virtual bool OpalMediaFormatInternal::GetOptionBoolean | ( | const PString & | name,
|  | bool | dflt
| ) |  | const

virtual

Referenced by OpalMediaFormat::GetOptionBoolean(), and OpalMediaFormat::NeedsJitterBuffer().

virtual PINDEX OpalMediaFormatInternal::GetOptionEnum | ( | const PString & | name,
|  | PINDEX | dflt
| ) |  | const

virtual

Referenced by OpalMediaFormat::GetOptionEnum().

virtual int OpalMediaFormatInternal::GetOptionInteger | ( | const PString & | name,
|  | int | dflt
| ) |  | const

virtual

Referenced by OpalMediaFormat::GetBandwidth(), OpalMediaFormat::GetClockRate(), OpalMediaFormat::GetFrameSize(), OpalMediaFormat::GetFrameTime(), and OpalMediaFormat::GetOptionInteger().

virtual bool OpalMediaFormatInternal::GetOptionOctets | ( | const PString & | name,
|  | PBYTEArray & | octets
| ) |  | const

virtual

Referenced by OpalMediaFormat::GetOptionOctets().

virtual double OpalMediaFormatInternal::GetOptionReal | ( | const PString & | name,
|  | double | dflt
| ) |  | const

virtual

Referenced by OpalMediaFormat::GetOptionReal().

virtual PStringToString OpalMediaFormatInternal::GetOptions | ( |  | ) | const

virtual

Referenced by OpalMediaFormat::GetOptions().

virtual PString OpalMediaFormatInternal::GetOptionString | ( | const PString & | name,
|  | const PString & | dflt
| ) |  | const

virtual

Referenced by OpalMediaFormat::GetOptionString().

virtual bool OpalMediaFormatInternal::GetOptionValue | ( | const PString & | name,
|  | PString & | value
| ) |  | const

virtual

Referenced by OpalMediaFormat::GetOptionValue().

virtual bool OpalMediaFormatInternal::IsTransportable | ( |  | ) | const

virtual

Referenced by OpalMediaFormat::IsTransportable().

virtual bool OpalMediaFormatInternal::IsValid | ( |  | ) | const

virtual

Referenced by OpalMediaFormat::IsEmpty(), and OpalMediaFormat::IsValid().

virtual bool OpalMediaFormatInternal::IsValidForProtocol | ( | const PString & | protocol | ) | const

virtual

Reimplemented in OpalPluginFaxFormatInternal, OpalPluginVideoFormatInternal, and OpalPluginAudioFormatInternal.

Referenced by OpalMediaFormat::IsValidForProtocol().

virtual bool OpalMediaFormatInternal::Merge | ( | const OpalMediaFormatInternal & | mediaFormat | ) |

virtual

Reimplemented in OpalVideoFormatInternal, and OpalAudioFormatInternal.

virtual void OpalMediaFormatInternal::PrintOn | ( | ostream & | strm | ) | const

virtual

virtual bool OpalMediaFormatInternal::SetOptionBoolean | ( | const PString & | name,
|  | bool | value
| ) |  |

virtual

Referenced by OpalMediaFormat::SetOptionBoolean().

virtual bool OpalMediaFormatInternal::SetOptionEnum | ( | const PString & | name,
|  | PINDEX | value
| ) |  |

virtual

Referenced by OpalMediaFormat::SetOptionEnum().

virtual bool OpalMediaFormatInternal::SetOptionInteger | ( | const PString & | name,
|  | int | value
| ) |  |

virtual

Referenced by OpalMediaFormat::SetOptionInteger().

virtual bool OpalMediaFormatInternal::SetOptionOctets | ( | const PString & | name,
|  | const PBYTEArray & | octets
| ) |  |

virtual

Referenced by OpalMediaFormat::SetOptionOctets().

virtual bool OpalMediaFormatInternal::SetOptionOctets | ( | const PString & | name,
|  | const BYTE * | data,
|  | PINDEX | length
| ) |  |

virtual

virtual bool OpalMediaFormatInternal::SetOptionReal | ( | const PString & | name,
|  | double | value
| ) |  |

virtual

Referenced by OpalMediaFormat::SetOptionReal().

virtual bool OpalMediaFormatInternal::SetOptionString | ( | const PString & | name,
|  | const PString & | value
| ) |  |

virtual

Referenced by OpalMediaFormat::SetOptionString().

virtual bool OpalMediaFormatInternal::SetOptionValue | ( | const PString & | name,
|  | const PString & | value
| ) |  |

virtual

Referenced by OpalMediaFormat::SetOptionValue().

virtual bool OpalMediaFormatInternal::ToCustomisedOptions | ( |  | ) |

virtual

Reimplemented in OpalPluginVideoFormatInternal, and OpalPluginAudioFormatInternal.

virtual bool OpalMediaFormatInternal::ToNormalisedOptions | ( |  | ) |

virtual

Reimplemented in OpalPluginVideoFormatInternal, and OpalPluginAudioFormatInternal.

virtual bool OpalMediaFormatInternal::ValidateMerge | ( | const OpalMediaFormatInternal & | mediaFormat | ) | const

virtual

## Friends And Related Function Documentation

friend class OpalAudioFormatInternal

friend

friend class OpalMediaFormat

friend

friend class OpalMediaFormatList

friend

bool operator!= | ( | const char * | other,
|  | const OpalMediaFormat & | fmt
| ) |  |

friend

bool operator!= | ( | const PString & | other,
|  | const OpalMediaFormat & | fmt
| ) |  |

friend

bool operator== | ( | const char * | other,
|  | const OpalMediaFormat & | fmt
| ) |  |

friend

bool operator== | ( | const PString & | other,
|  | const OpalMediaFormat & | fmt
| ) |  |

friend

## Field Documentation

time_t OpalMediaFormatInternal::codecVersionTime

protected

Referenced by OpalMediaFormat::GetCodecVersionTime().

bool OpalMediaFormatInternal::forceIsTransportable

protected

PCaselessString OpalMediaFormatInternal::formatName

protected

Referenced by GetName(), OpalMediaFormat::GetName(), OpalMediaFormat::operator const char *(), OpalMediaFormat::operator PString(), OpalMediaFormat::operator!=(), and OpalMediaFormat::operator==().

int OpalMediaFormatInternal::m_channels

protected

PMutex OpalMediaFormatInternal::media_format_mutex

protected

OpalMediaType OpalMediaFormatInternal::mediaType

protected

Referenced by OpalMediaFormat::GetMediaType().

PSortedList<OpalMediaOption> OpalMediaFormatInternal::options

protected

Referenced by OpalMediaFormat::GetOption(), and OpalMediaFormat::GetOptionCount().

PString OpalMediaFormatInternal::rtpEncodingName

protected

Referenced by OpalMediaFormat::GetEncodingName().

RTP_DataFrame::PayloadTypes OpalMediaFormatInternal::rtpPayloadType

protected

Referenced by OpalMediaFormat::GetPayloadType(), and OpalMediaFormat::SetPayloadType().

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

- mediafmt.h