# OpalMediaFormatInternal Class Reference

`#include <mediafmt.h>`

Inheritance diagram for OpalMediaFormatInternal:

[legend]
Collaboration diagram for OpalMediaFormatInternal:
[legend]

## Public Member Functions

| OpalMediaFormatInternal (const char *fullName, const OpalMediaType &mediaType, RTP_DataFrame::PayloadTypes rtpPayloadType, const char *encodingName, bool needsJitter, OpalBandwidth 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 Member Functions

bool | AdjustByOptionMaps (bool(*adjuster)(PluginCodec_OptionMap &original, PluginCodec_OptionMap &changed))

## 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,
|  | bool | needsJitter,
|  | OpalBandwidth | bandwidth,
|  | PINDEX | frameSize,
|  | unsigned | frameTime,
|  | unsigned | clockRate,
|  | time_t | timeStamp |
| ) |  |  |

## Member Function Documentation

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

bool OpalMediaFormatInternal::AdjustByOptionMaps | ( | bool(*)(PluginCodec_OptionMap &original, PluginCodec_OptionMap &changed) | adjuster | ) | `[protected]`

virtual PObject* OpalMediaFormatInternal::Clone | ( |  | ) | const`[virtual]`

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

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

const PCaselessString& OpalMediaFormatInternal::GetName | ( |  | ) | const`[inline]`

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

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

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

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

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

virtual PStringToString OpalMediaFormatInternal::GetOptions | ( |  | ) | const`[virtual]`

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

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

virtual bool OpalMediaFormatInternal::IsTransportable | ( |  | ) | const`[virtual]`

virtual bool OpalMediaFormatInternal::IsValid | ( |  | ) | const`[virtual]`

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

Reimplemented in OpalPluginAudioFormatInternal, OpalPluginVideoFormatInternal, and OpalPluginFaxFormatInternal.

virtual bool OpalMediaFormatInternal::Merge | ( | const OpalMediaFormatInternal & | mediaFormat | ) | `[virtual]`

Reimplemented in OpalAudioFormatInternal, and OpalVideoFormatInternal.

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

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

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

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

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

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

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

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

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

virtual bool OpalMediaFormatInternal::ToCustomisedOptions | ( |  | ) | `[virtual]`

Reimplemented in OpalPluginAudioFormatInternal, and OpalPluginVideoFormatInternal.

virtual bool OpalMediaFormatInternal::ToNormalisedOptions | ( |  | ) | `[virtual]`

Reimplemented in OpalPluginAudioFormatInternal, and OpalPluginVideoFormatInternal.

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 PString & | other,
|  | const OpalMediaFormat & | fmt |
| ) |  |  | `[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]`

## Field Documentation

time_t OpalMediaFormatInternal::codecVersionTime `[protected]`

bool OpalMediaFormatInternal::forceIsTransportable `[protected]`

PCaselessString OpalMediaFormatInternal::formatName `[protected]`

int OpalMediaFormatInternal::m_channels `[protected]`

PMutex OpalMediaFormatInternal::media_format_mutex `[protected]`

OpalMediaType OpalMediaFormatInternal::mediaType `[protected]`

PSortedList<OpalMediaOption> OpalMediaFormatInternal::options `[protected]`

PString OpalMediaFormatInternal::rtpEncodingName `[protected]`

RTP_DataFrame::PayloadTypes OpalMediaFormatInternal::rtpPayloadType `[protected]`

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

- mediafmt.h