#include <h323caps.h>

Inheritance diagram for H323GenericAudioCapability:

Collaboration diagram for H323GenericAudioCapability:

Public Member Functions
Construction
	H323GenericAudioCapability (const PString &capabilityId, unsigned fixedBitRate)

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_Object &subTypePDU, const PString &mediaPacketization) 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)

Public Member Functions inherited from H323RealTimeCapability
	H323RealTimeCapability ()

	H323RealTimeCapability (const H323RealTimeCapability &rtc)

virtual	~H323RealTimeCapability ()

virtual H323Channel *	CreateChannel (H323Connection &connection, H323Channel::Directions dir, unsigned sessionID, const H245_H2250LogicalChannelParameters *param) const

Public Member Functions inherited from H323Capability
	H323Capability ()

	H323Capability (const H323Capability &other)

H323Capability &	operator= (const H323Capability &other)

	~H323Capability ()

Comparison	Compare (const PObject &obj) const

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. More...

void	SetCapabilityNumber (unsigned num)
	Set unique capability number. More...

OpalMediaFormat	GetMediaFormat () const

bool	UpdateMediaFormat (const OpalMediaFormat &format)

RTP_DataFrame::PayloadTypes	GetPayloadType () const
	Get the payload type for the capaibility. More...

void	SetPayloadType (RTP_DataFrame::PayloadTypes pt)
	Set the payload type for the capaibility. More...

Public Member Functions inherited from H323GenericCapabilityInfo
	H323GenericCapabilityInfo (const PString &id, unsigned maxBitRate, bool fixedBitRate)

virtual	~H323GenericCapabilityInfo ()

Additional Inherited Members
Public Types inherited from H323Capability
enum	MainTypes { e_Audio, e_Video, e_Data, e_UserInput, e_GenericControl, e_H235Security, e_FEC, e_NumMainTypes }

enum	{ DefaultAudioSessionID = 1, DefaultVideoSessionID = 2, DefaultDataSessionID = 3, MasterAllocatedBaseSessionID, DeferredSessionID = 1000000 }

enum	CommandType { e_TCS, e_OLC, e_ReqMode }

enum	CapabilityDirection { e_Unknown, e_Receive, e_Transmit, e_ReceiveAndTransmit, e_NoDirection, NumCapabilityDirections }

Static Public Member Functions inherited from H323Capability
static H323Capability *	Create (const PString &name)

Protected Types inherited from H323GenericCapabilityInfo
enum	{ e_VariableBitRate, e_FixedBitRateStandard, e_FixedBitRateG7221 }

Protected Member Functions inherited from H323Capability
OpalMediaFormat &	GetWritableMediaFormat () const

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 OpalMediaFormat &mediaFormat, const H245_GenericCapability &param) const

PObject::Comparison	CompareInfo (const H323GenericCapabilityInfo &obj) const

Protected Attributes inherited from H323Capability
unsigned	assignedCapabilityNumber

CapabilityDirection	capabilityDirection
	Unique ID assigned to capability. More...

OpalMediaFormat	m_mediaFormat

Protected Attributes inherited from H323GenericCapabilityInfo
PString	m_identifier

OpalBandwidth	m_maxBitRate

enum H323GenericCapabilityInfo:: { ... }	m_bitRateMode

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,
		unsigned	fixedBitRate
	)

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

Parameters

capabilityId	generic codec identifier
fixedBitRate	Fixed bit rate for audio

Member Function Documentation

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

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

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_Object &	subTypePDU,
		const PString &	mediaPacketization
	)		const

virtual

Compare the generic part of the capability, if applicable.

Parameters

subTypePDU	sub-type PDU of H323Capability
mediaPacketization	Media packetization used

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

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

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

pdu	PDU to set information on

Reimplemented from H323AudioCapability.

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

h323caps.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation