H323GenericAudioCapability Class Reference

#include <h323caps.h>

Inheritance diagram for H323GenericAudioCapability:

H323AudioCapability H323GenericCapabilityInfo H323RealTimeCapability H323Capability List of all members.

Public Member Functions

Overrides from class PObject
Comparison Compare (const PObject &obj) const
Identification functions
virtual unsigned GetSubType () const
Protocol manipulation
virtual BOOL OnSendingPDU (H245_AudioCapability &pdu, unsigned packetSize) const
virtual BOOL OnReceivedPDU (const H245_AudioCapability &pdu, unsigned &packetSize)
virtual BOOL IsGenericMatch (const H245_GenericCapability &param) const

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 ( unsigned  maxPacketSize,
unsigned  desiredPacketSize,
const PString &  capabilityId,
PINDEX  maxBitRate = 0 
)

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

Parameters:
maxPacketSize  Maximum size of an audio packet in frames
desiredPacketSize  Desired transmit size of an audio packet in frames
capabilityId  generic codec identifier
maxBitRate  maxBitRate parameter for the GenericCapability

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

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

Parameters:
maxPacketSize  Maximum size of an audio packet in frames
desiredPacketSize  Desired transmit size of an audio packet in frames
capabilityId  generic codec identifier
maxBitRate  maxBitRate 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 BOOL H323GenericAudioCapability::OnSendingPDU ( H245_AudioCapability pdu,
unsigned  packetSize 
) 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:
pdu  PDU to set information on
packetSize  Packet size to use in capability

Reimplemented from H323AudioCapability.

virtual BOOL H323GenericAudioCapability::OnReceivedPDU ( const H245_AudioCapability pdu,
unsigned &  packetSize 
) [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:
pdu  PDU to get information from
packetSize  Packet size to use in capability

Reimplemented from H323AudioCapability.

virtual BOOL H323GenericAudioCapability::IsGenericMatch ( const H245_GenericCapability param  )  const [inline, virtual]

Compare the generic part of the capability, if applicable.

Parameters:
param  Generic field in PDU received

Reimplemented from H323GenericCapabilityInfo.


The documentation for this class was generated from the following file:
Generated on Fri Nov 17 03:03:47 2006 for OpenH323 by  doxygen 1.5.1