OPAL  Version 3.10.4
H323GenericAudioCapability Class Reference

#include <h323caps.h>

Inheritance diagram for H323GenericAudioCapability:
H323AudioCapability H323GenericCapabilityInfo H323RealTimeCapability H323Capability H323CodecPluginGenericAudioCapability

Public Member Functions

Construction
 H323GenericAudioCapability (const PString &capabilityId, PINDEX maxBitRate=0)
Overrides from class PObject
Comparison Compare (const PObject &obj) const
Identification functions
virtual unsigned GetSubType () const
Protocol manipulation
virtual PBoolean OnSendingPDU (H245_AudioCapability &pdu, unsigned packetSize, CommandType type) const
virtual PBoolean OnSendingPDU (H245_AudioMode &pdu) const
virtual PBoolean OnReceivedPDU (const H245_AudioCapability &pdu, unsigned &packetSize, CommandType type)
virtual PBoolean IsMatch (const PASN_Choice &subTypePDU) const
- Public Member Functions inherited from H323AudioCapability
 H323AudioCapability ()
virtual MainTypes GetMainType () const
virtual unsigned GetDefaultSessionID () const
virtual void SetTxFramesInPacket (unsigned frames)
virtual unsigned GetTxFramesInPacket () const
virtual unsigned GetRxFramesInPacket () const
virtual PBoolean OnSendingPDU (H245_Capability &pdu) const
virtual PBoolean OnSendingPDU (H245_DataType &pdu) const
virtual PBoolean OnSendingPDU (H245_ModeElement &pdu) const
virtual PBoolean OnSendingPDU (H245_AudioCapability &pdu, unsigned packetSize) const
virtual PBoolean OnReceivedPDU (const H245_Capability &pdu)
virtual PBoolean OnReceivedPDU (const H245_DataType &pdu, PBoolean receiver)
virtual PBoolean OnReceivedPDU (const H245_AudioCapability &pdu, unsigned &packetSize)
virtual H323ChannelCreateChannel (H323Connection &connection, H323Channel::Directions dir, unsigned sessionID, const H245_H2250LogicalChannelParameters *param) const
 H323RealTimeCapability ()
 H323RealTimeCapability (const H323RealTimeCapability &rtc)
virtual ~H323RealTimeCapability ()
void AttachQoS (RTP_QOS *_rtpqos)
 Attach a QoS specification to this channel.
- Public Member Functions inherited from H323Capability
 H323Capability ()
void PrintOn (ostream &strm) const
virtual PString GetFormatName () const =0
virtual PBoolean IsUsable (const H323Connection &connection) const
CapabilityDirection GetCapabilityDirection () const
void SetCapabilityDirection (CapabilityDirection dir)
unsigned GetCapabilityNumber () const
 Get unique capability number.
void SetCapabilityNumber (unsigned num)
 Set unique capability number.
OpalMediaFormat GetMediaFormat () const
bool UpdateMediaFormat (const OpalMediaFormat &format)
RTP_DataFrame::PayloadTypes GetPayloadType () const
 Get the payload type for the capaibility.
void SetPayloadType (RTP_DataFrame::PayloadTypes pt)
 Set the payload type for the capaibility.
- Public Member Functions inherited from H323GenericCapabilityInfo
 H323GenericCapabilityInfo (const PString &id, unsigned maxBitRate=0)
virtual ~H323GenericCapabilityInfo ()

Additional Inherited Members

- Protected Member Functions inherited from H323GenericCapabilityInfo
virtual PBoolean OnSendingGenericPDU (H245_GenericCapability &pdu, const OpalMediaFormat &mediaFormat, H323Capability::CommandType type) const
virtual PBoolean OnReceivedGenericPDU (OpalMediaFormat &mediaFormat, const H245_GenericCapability &pdu, H323Capability::CommandType type)
PBoolean IsMatch (const H245_GenericCapability &param) const
PObject::Comparison CompareInfo (const H323GenericCapabilityInfo &obj) const
- Protected Attributes inherited from H323GenericCapabilityInfo
PString m_identifier
unsigned maxBitRate

Detailed Description

This class describes the interface to a generic audio codec used to transfer data via the logical channels opened and managed by the H323 control channel.

An application may create a descendent off this class and override functions as required for descibing the codec.


Constructor & Destructor Documentation

H323GenericAudioCapability::H323GenericAudioCapability ( const PString &  capabilityId,
PINDEX  maxBitRate = 0 
)

Create a new set of information about a non-standard codec.

Parameters:
capabilityIdgeneric codec identifier
maxBitRatemaxBitRate parameter for the GenericCapability

Member Function Documentation

Comparison H323GenericAudioCapability::Compare ( const PObject &  obj) const

Compare two capability instances. This compares the main and sub-types of the capability.

Reimplemented from H323Capability.

virtual unsigned H323GenericAudioCapability::GetSubType ( ) const
virtual

Get the sub-type of the capability. This is a code dependent on the main type of the capability.

This returns H245_AudioCapability::e_genericCapability.

Implements H323Capability.

virtual PBoolean H323GenericAudioCapability::IsMatch ( const PASN_Choice &  subTypePDU) const
virtual

Compare the generic part of the capability, if applicable.

Parameters:
subTypePDUsub-type PDU of H323Capability

Reimplemented from H323Capability.

virtual PBoolean H323GenericAudioCapability::OnReceivedPDU ( const H245_AudioCapability &  pdu,
unsigned &  packetSize,
CommandType  type 
)
virtual

This function is called whenever and incoming TerminalCapabilitySet or OpenLogicalChannel PDU has been used to construct the control channel. It allows the capability to set from the PDU fields, information in members specific to the class.

The default behaviour calls H323GenericCapabilityinfo::OnReceivedPDU() to handle the provided PDU.

Parameters:
pduPDU to get information from
packetSizePacket size to use in capability
typeType of PDU to send in

Reimplemented from H323AudioCapability.

virtual PBoolean H323GenericAudioCapability::OnSendingPDU ( H245_AudioCapability &  pdu,
unsigned  packetSize,
CommandType  type 
) const
virtual

This function is called whenever and outgoing TerminalCapabilitySet or OpenLogicalChannel PDU is being constructed for the control channel. It allows the capability to set the PDU fields from information in members specific to the class.

The default behaviour calls H323GenericCapabilityinfo::OnSendingPDU() to handle the PDU.

Parameters:
pduPDU to set information on
packetSizePacket size to use in capability
typeType of PDU to send in

Reimplemented from H323AudioCapability.

virtual PBoolean H323GenericAudioCapability::OnSendingPDU ( H245_AudioMode &  pdu) const
virtual

This function is called whenever and outgoing RequestMode PDU is being constructed for the control channel. It allows the capability to set the PDU fields from information in members specific to the class.

The default behaviour sets the PDUs tag according to the GetSubType() function (translated to different enum).

Parameters:
pduPDU to set information on

Reimplemented from H323AudioCapability.


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