OPAL  Version 3.14.3
PluginCodec_VideoFormat< NAME > Class Template Reference

#include <opalplugin.hpp>

Inheritance diagram for PluginCodec_VideoFormat< NAME >:
Collaboration diagram for PluginCodec_VideoFormat< NAME >:

Public Types

typedef
PluginCodec_MediaFormat< NAME > 
Parent
 
typedef Parent::OptionsTable OptionsTable
 
- Public Types inherited from PluginCodec_MediaFormat< NAME >
typedef struct
PluginCodec_Option const
*const * 
OptionsTable
 
typedef PluginCodec_OptionMap OptionMap
 

Public Member Functions

__inline unsigned GetMaxWidth () const
 
__inline unsigned GetMaxHeight () const
 
- Public Member Functions inherited from PluginCodec_MediaFormat< NAME >
virtual ~PluginCodec_MediaFormat ()
 
__inline const char * GetRawFormat () const
 
__inline const char * GetFormatName () const
 
__inline const char * GetPayloadName () const
 
__inline unsigned char GetPayloadType () const
 
__inline const char * GetDescription () const
 
__inline unsigned GetMaxBandwidth () const
 
__inline unsigned char GetH323CapabilityType () const
 
__inline const void * GetH323CapabilityData () const
 
__inline unsigned GetFlags () const
 
__inline const void * GetOptionsTable () const
 
__inline void SetFlags (unsigned b, unsigned m=0)
 
__inline void SetPayloadType (unsigned p)
 
__inline void SetH323Capability (unsigned type, const void *data=NULL)
 
virtual bool IsValidForProtocol (const char *) const =0
 Determine if codec is valid for the specified protocol. More...
 
bool AdjustOptions (void *parm, unsigned *parmLen, bool(PluginCodec_MediaFormat::*adjuster)(OptionMap &original, OptionMap &changed) const) const
 Utility function to adjust option strings, used by ToNormalised()/ToCustomised(). More...
 
virtual bool ToNormalised (OptionMap &, OptionMap &) const =0
 Adjust normalised options calculated from codec specific options. More...
 
virtual bool ToCustomised (OptionMap &, OptionMap &) const =0
 
virtual void AdjustForVersion (unsigned version, const PluginCodec_Definition *) const
 

Protected Member Functions

 PluginCodec_VideoFormat (const char *formatName, const char *payloadName, const char *description, unsigned maxBandwidth, OptionsTable options=NULL)
 
__inline PluginCodec_VideoFormatSetFlags (unsigned b, unsigned m=0)
 
__inline PluginCodec_VideoFormatSetPayloadType (unsigned p)
 
__inline PluginCodec_VideoFormatSetH323Capability (unsigned type, const void *data=NULL)
 
- Protected Member Functions inherited from PluginCodec_MediaFormat< NAME >
 PluginCodec_MediaFormat (const char *rawFormat, const char *formatName, const char *payloadName, const char *description, unsigned maxBandwidth, OptionsTable options, unsigned flags=PluginCodec_RTPTypeDynamic)
 

Protected Attributes

unsigned m_maxWidth
 
unsigned m_maxHeight
 
- Protected Attributes inherited from PluginCodec_MediaFormat< NAME >
const char * m_rawFormat
 
const char * m_formatName
 
const char * m_payloadName
 
unsigned m_payloadType
 
const char * m_description
 
unsigned m_maxBandwidth
 
unsigned m_h323CapabilityType
 
const void * m_h323CapabilityData
 
unsigned m_flags
 
OptionsTable m_options
 

Additional Inherited Members

- Static Public Member Functions inherited from PluginCodec_MediaFormat< NAME >
static void AdjustAllForVersion (unsigned version, const PluginCodec_Definition *definitions, size_t size)
 

Member Typedef Documentation

template<typename NAME >
typedef Parent::OptionsTable PluginCodec_VideoFormat< NAME >::OptionsTable
template<typename NAME >
typedef PluginCodec_MediaFormat<NAME> PluginCodec_VideoFormat< NAME >::Parent

Constructor & Destructor Documentation

template<typename NAME >
PluginCodec_VideoFormat< NAME >::PluginCodec_VideoFormat ( const char *  formatName,
const char *  payloadName,
const char *  description,
unsigned  maxBandwidth,
OptionsTable  options = NULL 
)
inlineprotected

Member Function Documentation

template<typename NAME >
__inline unsigned PluginCodec_VideoFormat< NAME >::GetMaxHeight ( ) const
inline
template<typename NAME >
__inline unsigned PluginCodec_VideoFormat< NAME >::GetMaxWidth ( ) const
inline
template<typename NAME >
__inline PluginCodec_VideoFormat& PluginCodec_VideoFormat< NAME >::SetFlags ( unsigned  b,
unsigned  m = 0 
)
inlineprotected
template<typename NAME >
__inline PluginCodec_VideoFormat& PluginCodec_VideoFormat< NAME >::SetH323Capability ( unsigned  type,
const void *  data = NULL 
)
inlineprotected
template<typename NAME >
__inline PluginCodec_VideoFormat& PluginCodec_VideoFormat< NAME >::SetPayloadType ( unsigned  p)
inlineprotected

Field Documentation

template<typename NAME >
unsigned PluginCodec_VideoFormat< NAME >::m_maxHeight
protected
template<typename NAME >
unsigned PluginCodec_VideoFormat< NAME >::m_maxWidth
protected

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