OPAL  Version 3.12.9
PluginCodec_AudioFormat< NAME > Class Template Reference

#include <opalplugin.hpp>

Inheritance diagram for PluginCodec_AudioFormat< NAME >:
Collaboration diagram for PluginCodec_AudioFormat< 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

 PluginCodec_AudioFormat (const char *formatName, const char *payloadName, const char *description, unsigned samplesPerFrame, unsigned bytesPerFrame, unsigned sampleRate, OptionsTable options)
 
__inline unsigned GetSamplesPerFrame () const
 
__inline unsigned GetBytesPerFrame () const
 
__inline unsigned GetSampleRate () const
 
__inline unsigned GetFrameTime () const
 
__inline unsigned GetRecommendedFramesPerPacket () const
 
__inline unsigned GetMaxFramesPerPacket () const
 
- Public Member Functions inherited from PluginCodec_MediaFormat< NAME >
virtual ~PluginCodec_MediaFormat ()
 
__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
 
virtual bool IsValidForProtocol (const char *)
 Determine if codec is valid for the specified protocol. More...
 
bool AdjustOptions (void *parm, unsigned *parmLen, bool(PluginCodec_MediaFormat::*adjuster)(OptionMap &original, OptionMap &changed))
 Utility function to adjust option strings, used by ToNormalised()/ToCustomised(). More...
 
virtual bool ToNormalised (OptionMap &, OptionMap &)
 Adjust normalised options calculated from codec specific options. More...
 
virtual bool ToCustomised (OptionMap &, OptionMap &)
 
virtual void AdjustForVersion (unsigned version, const PluginCodec_Definition *)
 

Protected Attributes

unsigned m_samplesPerFrame
 
unsigned m_bytesPerFrame
 
unsigned m_sampleRate
 
unsigned m_recommendedFramesPerPacket
 
unsigned m_maxFramesPerPacket
 
- Protected Attributes inherited from PluginCodec_MediaFormat< NAME >
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)
 
- Protected Member Functions inherited from PluginCodec_MediaFormat< NAME >
 PluginCodec_MediaFormat (const char *formatName, const char *payloadName, const char *description, unsigned maxBandwidth, OptionsTable options)
 

Member Typedef Documentation

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

Constructor & Destructor Documentation

template<typename NAME >
PluginCodec_AudioFormat< NAME >::PluginCodec_AudioFormat ( const char *  formatName,
const char *  payloadName,
const char *  description,
unsigned  samplesPerFrame,
unsigned  bytesPerFrame,
unsigned  sampleRate,
OptionsTable  options 
)
inline

Member Function Documentation

template<typename NAME >
__inline unsigned PluginCodec_AudioFormat< NAME >::GetBytesPerFrame ( ) const
inline
template<typename NAME >
__inline unsigned PluginCodec_AudioFormat< NAME >::GetFrameTime ( ) const
inline
template<typename NAME >
__inline unsigned PluginCodec_AudioFormat< NAME >::GetMaxFramesPerPacket ( ) const
inline
template<typename NAME >
__inline unsigned PluginCodec_AudioFormat< NAME >::GetRecommendedFramesPerPacket ( ) const
inline
template<typename NAME >
__inline unsigned PluginCodec_AudioFormat< NAME >::GetSampleRate ( ) const
inline
template<typename NAME >
__inline unsigned PluginCodec_AudioFormat< NAME >::GetSamplesPerFrame ( ) const
inline

Field Documentation

template<typename NAME >
unsigned PluginCodec_AudioFormat< NAME >::m_bytesPerFrame
protected
template<typename NAME >
unsigned PluginCodec_AudioFormat< NAME >::m_maxFramesPerPacket
protected
template<typename NAME >
unsigned PluginCodec_AudioFormat< NAME >::m_recommendedFramesPerPacket
protected
template<typename NAME >
unsigned PluginCodec_AudioFormat< NAME >::m_sampleRate
protected
template<typename NAME >
unsigned PluginCodec_AudioFormat< NAME >::m_samplesPerFrame
protected

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