H323GenericAudioCapability Class Reference

#include <h323caps.h>

Inheritance diagram for H323GenericAudioCapability:

H323AudioCapability H323GenericCapabilityInfo H323RealTimeCapability H323Capability H323CodecPluginGenericAudioCapability List of all members.

Public Member Functions

Construction
 H323GenericAudioCapability (unsigned maxPacketSize, unsigned desiredPacketSize, 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 BOOL OnSendingPDU (H245_AudioCapability &pdu, unsigned packetSize, CommandType type) const
virtual BOOL OnSendingPDU (H245_AudioMode &pdu) const
virtual BOOL OnReceivedPDU (const H245_AudioCapability &pdu, unsigned &packetSize, CommandType type)
virtual BOOL IsMatch (const PASN_Choice &subTypePDU) 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.

Definition at line 1114 of file h323caps.h.


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

Definition at line 1369 of file h323caps.cxx.


Member Function Documentation

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

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

Reimplemented from H323Capability.

Definition at line 1379 of file h323caps.cxx.

References H323GenericCapabilityInfo::CompareInfo().

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.

Definition at line 1388 of file h323caps.cxx.

References H245_AudioCapability::e_genericAudioCapability.

BOOL 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:
pdu  PDU to set information on
packetSize  Packet size to use in capability
type  Type of PDU to send in

Reimplemented from H323AudioCapability.

Definition at line 1394 of file h323caps.cxx.

References H245_AudioCapability::e_genericAudioCapability, H323Capability::GetMediaFormat(), and H323GenericCapabilityInfo::OnSendingGenericPDU().

BOOL 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:
pdu  PDU to set information on

Reimplemented from H323AudioCapability.

Definition at line 1400 of file h323caps.cxx.

References H245_VideoMode::e_genericVideoMode, H323Capability::e_ReqMode, H323Capability::GetMediaFormat(), and H323GenericCapabilityInfo::OnSendingGenericPDU().

BOOL 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:
pdu  PDU to get information from
packetSize  Packet size to use in capability
type  Type of PDU to send in

Reimplemented from H323AudioCapability.

Definition at line 1406 of file h323caps.cxx.

References H245_AudioCapability::e_genericAudioCapability, H323Capability::GetWritableMediaFormat(), and H323GenericCapabilityInfo::OnReceivedGenericPDU().

BOOL H323GenericAudioCapability::IsMatch ( const PASN_Choice &  subTypePDU  )  const [virtual]

Compare the generic part of the capability, if applicable.

Parameters:
subTypePDU  sub-type PDU of H323Capability

Reimplemented from H323Capability.

Definition at line 1413 of file h323caps.cxx.

References H323GenericCapabilityInfo::IsMatch(), and H323Capability::IsMatch().


The documentation for this class was generated from the following files:
Generated on Thu Oct 25 13:45:28 2007 for h323plus by  doxygen 1.5.2