H323VideoCapability Class Reference

#include <h323caps.h>

Inheritance diagram for H323VideoCapability:

H323RealTimeCapability H323Capability H323GenericVideoCapability H323NonStandardVideoCapability OpalDynaCodecStandardVideoCapability List of all members.

Public Member Functions

Construction
 H323VideoCapability ()
Identification functions
virtual MainTypes GetMainType () const
Operations
virtual unsigned GetDefaultSessionID () const
Protocol manipulation
virtual BOOL OnSendingPDU (H245_Capability &pdu) const
virtual BOOL OnSendingPDU (H245_DataType &pdu) const
virtual BOOL OnSendingPDU (H245_ModeElement &pdu) const
virtual BOOL OnSendingPDU (H245_VideoCapability &pdu) const
virtual BOOL OnSendingPDU (H245_VideoCapability &pdu, CommandType type) const
virtual BOOL OnSendingPDU (H245_VideoMode &pdu) const =0
virtual BOOL OnReceivedPDU (const H245_Capability &pdu)
virtual BOOL OnReceivedPDU (const H245_DataType &pdu, BOOL receiver)
virtual BOOL OnReceivedPDU (const H245_VideoCapability &pdu)
virtual BOOL OnReceivedPDU (const H245_VideoCapability &pdu, CommandType type)

Detailed Description

This class describes the interface to a video 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 a codec.

Definition at line 1211 of file h323caps.h.


Constructor & Destructor Documentation

H323VideoCapability::H323VideoCapability (  ) 

Create an Video based capability.

Definition at line 1546 of file h323caps.cxx.

References H323RealTimeCapability::rtpqos.


Member Function Documentation

H323Capability::MainTypes H323VideoCapability::GetMainType (  )  const [virtual]

Get the main type of the capability. Always returns e_Video.

Implements H323Capability.

Definition at line 1561 of file h323caps.cxx.

References H323Capability::e_Video.

unsigned H323VideoCapability::GetDefaultSessionID (  )  const [virtual]

Get the default RTP session. This function gets the default RTP session ID for the capability type. For example audio capabilities return the value RTP_Session::DefaultAudioSessionID etc.

The default behaviour returns zero, indicating it is not an RTP based capability.

Reimplemented from H323Capability.

Definition at line 1643 of file h323caps.cxx.

References RTP_Session::DefaultVideoSessionID.

BOOL H323VideoCapability::OnSendingPDU ( H245_Capability pdu  )  const [virtual]

This function is called whenever and outgoing TerminalCapabilitySet 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 the OnSendingPDU() function with a more specific PDU type.

Parameters:
pdu  PDU to set information on

Implements H323Capability.

Definition at line 1567 of file h323caps.cxx.

References H323Capability::capabilityDirection, H323Capability::e_Receive, H323Capability::e_ReceiveAndTransmit, H245_Capability::e_receiveAndTransmitVideoCapability, H245_Capability::e_receiveVideoCapability, H323Capability::e_TCS, H323Capability::e_Transmit, and H245_Capability::e_transmitVideoCapability.

Referenced by OnSendingPDU().

BOOL H323VideoCapability::OnSendingPDU ( H245_DataType pdu  )  const [virtual]

This function is called whenever and outgoing 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 the OnSendingPDU() function with a more specific PDU type.

Parameters:
pdu  PDU to set information on

Implements H323Capability.

Definition at line 1584 of file h323caps.cxx.

References H323Capability::e_OLC, H245_DataType::e_videoData, and OnSendingPDU().

BOOL H323VideoCapability::OnSendingPDU ( H245_ModeElement 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 calls the OnSendingPDU() function with a more specific PDU type.

Parameters:
pdu  PDU to set information on

Implements H323Capability.

Definition at line 1603 of file h323caps.cxx.

References H245_ModeElementType::e_videoMode, H245_ModeElement::m_type, and OnSendingPDU().

BOOL H323VideoCapability::OnSendingPDU ( H245_VideoCapability pdu  )  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 is pure.

Parameters:
pdu  PDU to set information on

Reimplemented in OpalDynaCodecStandardVideoCapability, and H323NonStandardVideoCapability.

Definition at line 1591 of file h323caps.cxx.

BOOL H323VideoCapability::OnSendingPDU ( H245_VideoCapability pdu,
CommandType  type 
) const [virtual]

Parameters:
pdu  PDU to set information on
type  Type of PDU to send in

Reimplemented in H323GenericVideoCapability.

Definition at line 1597 of file h323caps.cxx.

References OnSendingPDU().

virtual BOOL H323VideoCapability::OnSendingPDU ( H245_VideoMode pdu  )  const [pure 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

Implemented in OpalDynaCodecStandardVideoCapability, H323NonStandardVideoCapability, and H323GenericVideoCapability.

BOOL H323VideoCapability::OnReceivedPDU ( const H245_Capability pdu  )  [virtual]

This function is called whenever and incoming TerminalCapabilitySet PDU is received on the control channel, and a new H323Capability descendent was created. This completes reading fields from the PDU into the classes members.

If the function returns FALSE then the received PDU codec description is not supported, so will be ignored. The default behaviour simply returns TRUE.

Parameters:
pdu  PDU to get information from

Reimplemented from H323Capability.

Definition at line 1610 of file h323caps.cxx.

References H245_Capability::e_receiveAndTransmitVideoCapability, H245_Capability::e_receiveVideoCapability, H323Capability::e_TCS, and H323Capability::OnReceivedPDU().

Referenced by OnReceivedPDU().

BOOL H323VideoCapability::OnReceivedPDU ( const H245_DataType pdu,
BOOL  receiver 
) [virtual]

This function is called whenever and incoming 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 is pure.

Parameters:
pdu  PDU to get information from
receiver  Is receiver OLC

Implements H323Capability.

Definition at line 1622 of file h323caps.cxx.

References H323Capability::e_OLC, H245_DataType::e_videoData, and OnReceivedPDU().

BOOL H323VideoCapability::OnReceivedPDU ( const H245_VideoCapability pdu  )  [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 is pure.

Parameters:
pdu  PDU to set information on

Reimplemented in OpalDynaCodecStandardVideoCapability, and H323NonStandardVideoCapability.

Definition at line 1631 of file h323caps.cxx.

BOOL H323VideoCapability::OnReceivedPDU ( const H245_VideoCapability pdu,
CommandType  type 
) [virtual]

Parameters:
pdu  PDU to get information from
type  Type of PDU to send in

Reimplemented in H323GenericVideoCapability.

Definition at line 1637 of file h323caps.cxx.

References OnReceivedPDU().


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