OPAL  Version 3.10.10
OpalMediaOption Class Referenceabstract

#include <mediafmt.h>

Inheritance diagram for OpalMediaOption:
OpalMediaOptionEnum OpalMediaOptionOctets OpalMediaOptionString OpalMediaOptionValue< T > OpalMediaOptionNumericalValue< T >

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)
 
const H245GenericInfoGetH245Generic () 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

◆ MergeType

Enumerator
NoMerge 
MinMerge 
MaxMerge 
EqualMerge 
NotEqualMerge 
AlwaysMerge 
CustomMerge 
IntersectionMerge 
AndMerge 
OrMerge 

Constructor & Destructor Documentation

◆ OpalMediaOption() [1/2]

OpalMediaOption::OpalMediaOption ( const PString &  name)
protected

◆ OpalMediaOption() [2/2]

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

Member Function Documentation

◆ Assign()

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

◆ AsString()

PString OpalMediaOption::AsString ( ) const

◆ Compare()

virtual Comparison OpalMediaOption::Compare ( const PObject &  obj) const
virtual

◆ CompareValue()

virtual Comparison OpalMediaOption::CompareValue ( const OpalMediaOption option) const
pure virtual

◆ FromString()

bool OpalMediaOption::FromString ( const PString &  value)

◆ GetFMTPDefault()

const PString& OpalMediaOption::GetFMTPDefault ( ) const
inline

◆ GetFMTPName()

const PString& OpalMediaOption::GetFMTPName ( ) const
inline

◆ GetH245Generic()

const H245GenericInfo& OpalMediaOption::GetH245Generic ( ) const
inline

◆ GetMerge()

MergeType OpalMediaOption::GetMerge ( ) const
inline

◆ GetName()

const PString& OpalMediaOption::GetName ( ) const
inline

◆ IsReadOnly()

bool OpalMediaOption::IsReadOnly ( ) const
inline

◆ Merge()

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

◆ SetFMTPDefault()

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

◆ SetFMTPName()

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

◆ SetH245Generic()

void OpalMediaOption::SetH245Generic ( const H245GenericInfo genericInfo)
inline

◆ SetMerge()

void OpalMediaOption::SetMerge ( MergeType  merge)
inline

◆ SetReadOnly()

void OpalMediaOption::SetReadOnly ( bool  readOnly)
inline

◆ ValidateMerge()

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

Field Documentation

◆ m_FMTPDefault

PString OpalMediaOption::m_FMTPDefault
protected

◆ m_FMTPName

PCaselessString OpalMediaOption::m_FMTPName
protected

◆ m_H245Generic

H245GenericInfo OpalMediaOption::m_H245Generic
protected

◆ m_merge

MergeType OpalMediaOption::m_merge
protected

◆ m_name

PCaselessString OpalMediaOption::m_name
protected

◆ m_readOnly

bool OpalMediaOption::m_readOnly
protected

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