OPAL  Version 3.14.3
Data Structures | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
OpalMediaOption Class Referenceabstract

#include <mediafmt.h>

Inheritance diagram for OpalMediaOption:
Inheritance graph
[legend]
Collaboration diagram for OpalMediaOption:
Collaboration graph
[legend]

Data Structures

struct  H245GenericInfo
 

Public Types

enum  MergeType {
  NoMerge, MinMerge, MaxMerge, EqualMerge,
  NotEqualMerge, AlwaysMerge, CustomMerge, IntersectionMerge,
  AndMerge = MinMerge, OrMerge = MaxMerge
}
 

Public Member Functions

virtual Comparison Compare (const PObject &obj) const
 
virtual bool Merge (const OpalMediaOption &option)
 
virtual bool ValidateMerge (const OpalMediaOption &option) const
 
virtual Comparison CompareValue (const OpalMediaOption &option) const =0
 
virtual void Assign (const OpalMediaOption &option)=0
 
PString AsString () const
 
bool FromString (const PString &value)
 
const PString & GetName () const
 
bool IsReadOnly () const
 
void SetReadOnly (bool readOnly)
 
MergeType GetMerge () const
 
void SetMerge (MergeType merge)
 
const PString & GetFMTPName () const
 
void SetFMTPName (const char *name)
 
const PString & GetFMTPDefault () const
 
void SetFMTPDefault (const char *value)
 
void SetFMTP (const char *name, const char *dflt)
 
const H245GenericInfo & GetH245Generic () const
 
void SetH245Generic (const H245GenericInfo &genericInfo)
 

Protected Member Functions

 OpalMediaOption (const PString &name)
 
 OpalMediaOption (const char *name, bool readOnly, MergeType merge)
 

Protected Attributes

PCaselessString m_name
 
bool m_readOnly
 
MergeType m_merge
 
PCaselessString m_FMTPName
 
PString m_FMTPDefault
 
H245GenericInfo m_H245Generic
 

Detailed Description

Base class for options attached to an OpalMediaFormat.

Member Enumeration Documentation

enum OpalMediaOption::MergeType
Enumerator
NoMerge 
MinMerge 
MaxMerge 
EqualMerge 
NotEqualMerge 
AlwaysMerge 
CustomMerge 
IntersectionMerge 
AndMerge 
OrMerge 

Constructor & Destructor Documentation

OpalMediaOption::OpalMediaOption ( const PString &  name)
protected
OpalMediaOption::OpalMediaOption ( const char *  name,
bool  readOnly,
MergeType  merge 
)
protected

Member Function Documentation

virtual void OpalMediaOption::Assign ( const OpalMediaOption &  option)
pure virtual

Implemented in OpalMediaOptionOctets, OpalMediaOptionString, OpalMediaOptionEnum, and OpalMediaOptionValue< T >.

PString OpalMediaOption::AsString ( ) const
virtual Comparison OpalMediaOption::Compare ( const PObject &  obj) const
virtual
virtual Comparison OpalMediaOption::CompareValue ( const OpalMediaOption &  option) const
pure virtual

Implemented in OpalMediaOptionOctets, OpalMediaOptionString, OpalMediaOptionEnum, and OpalMediaOptionValue< T >.

bool OpalMediaOption::FromString ( const PString &  value)
const PString& OpalMediaOption::GetFMTPDefault ( ) const
inline

References m_FMTPDefault.

const PString& OpalMediaOption::GetFMTPName ( ) const
inline

References m_FMTPName.

const H245GenericInfo& OpalMediaOption::GetH245Generic ( ) const
inline

References m_H245Generic.

MergeType OpalMediaOption::GetMerge ( ) const
inline

References m_merge.

const PString& OpalMediaOption::GetName ( ) const
inline

References m_name.

bool OpalMediaOption::IsReadOnly ( ) const
inline

References m_readOnly.

virtual bool OpalMediaOption::Merge ( const OpalMediaOption &  option)
virtual

Reimplemented in OpalMediaOptionString, OpalMediaOptionEnum, and OpalMediaOptionValue< T >.

Referenced by OpalMediaOptionValue< T >::Merge().

void OpalMediaOption::SetFMTP ( const char *  name,
const char *  dflt 
)
inline

References m_FMTPDefault, and m_FMTPName.

void OpalMediaOption::SetFMTPDefault ( const char *  value)
inline

References m_FMTPDefault.

void OpalMediaOption::SetFMTPName ( const char *  name)
inline

References m_FMTPName.

void OpalMediaOption::SetH245Generic ( const H245GenericInfo &  genericInfo)
inline

References m_H245Generic.

void OpalMediaOption::SetMerge ( MergeType  merge)
inline

References m_merge.

void OpalMediaOption::SetReadOnly ( bool  readOnly)
inline

References m_readOnly.

virtual bool OpalMediaOption::ValidateMerge ( const OpalMediaOption &  option) const
virtual

Field Documentation

PString OpalMediaOption::m_FMTPDefault
protected

Referenced by GetFMTPDefault(), SetFMTP(), and SetFMTPDefault().

PCaselessString OpalMediaOption::m_FMTPName
protected

Referenced by GetFMTPName(), SetFMTP(), and SetFMTPName().

H245GenericInfo OpalMediaOption::m_H245Generic
protected

Referenced by GetH245Generic(), and SetH245Generic().

MergeType OpalMediaOption::m_merge
protected

Referenced by GetMerge(), OpalMediaOptionValue< T >::Merge(), and SetMerge().

PCaselessString OpalMediaOption::m_name
protected

Referenced by GetName().

bool OpalMediaOption::m_readOnly
protected

Referenced by IsReadOnly(), and SetReadOnly().

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