OpalH281Handler Class Reference

#include <h281handler.h>

Inheritance diagram for OpalH281Handler:

Public Types
enum	VideoSource {   CurrentVideoSource = 0x00, MainCamera = 0x01, AuxiliaryCamera = 0x02, DocumentCamera = 0x03,   AuxiliaryDocumentCamera = 0x04, VideoPlaybackSource = 0x05 }
Public Types inherited from OpalH224Client
enum	{ CMEClientID = 0x00, H281ClientID = 0x01, ExtendedClientID = 0x7e, NonStandardClientID = 0x7f }

Public Member Functions
	OpalH281Handler ()
	~OpalH281Handler ()
virtual BYTE	GetClientID () const
virtual PBoolean	HasExtraCapabilities () const
virtual void	OnReceivedExtraCapabilities (const BYTE *capabilities, PINDEX size)
virtual void	OnReceivedMessage (const H224_Frame &message)
BYTE	GetLocalNumberOfPresets () const
void	SetLocalNumberOfPresets (BYTE presets)
BYTE	GetRemoteNumberOfPresets () const
H281VideoSource &	GetLocalVideoSource (VideoSource source)
H281VideoSource &	GetRemoteVideoSource (VideoSource source)
void	StartAction (H281_Frame::PanDirection panDirection, H281_Frame::TiltDirection tiltDirection, H281_Frame::ZoomDirection zoomDireciton, H281_Frame::FocusDirection focusDirection)
void	StopAction ()
void	SelectVideoSource (BYTE videoSourceNumber, H281_Frame::VideoMode videoMode)
void	StoreAsPreset (BYTE presetNumber)
void	ActivatePreset (BYTE presetNumber)
void	SendExtraCapabilities () const
virtual void	OnRemoteCapabilitiesUpdated ()
virtual void	OnStartAction (H281_Frame::PanDirection panDirection, H281_Frame::TiltDirection tiltDirection, H281_Frame::ZoomDirection zoomDirection, H281_Frame::FocusDirection focusDirection)
virtual void	OnStopAction ()
virtual void	OnSelectVideoSource (BYTE videoSourceNumber, H281_Frame::VideoMode videoMode)
virtual void	OnStoreAsPreset (BYTE presetNumber)
virtual void	OnActivatePreset (BYTE presetNumber)
Public Member Functions inherited from OpalH224Client
	OpalH224Client ()
	~OpalH224Client ()
virtual BYTE	GetExtendedClientID () const
virtual BYTE	GetCountryCode () const
virtual BYTE	GetCountryCodeExtension () const
virtual WORD	GetManufacturerCode () const
virtual BYTE	GetManufacturerClientID () const
virtual Comparison	Compare (const PObject &obj)
void	SetH224Handler (OpalH224Handler *handler)
void	SetRemoteClientAvailable (PBoolean remoteClientAvailable, PBoolean remoteClientHasExtraCapabilities)
PBoolean	GetRemoteClientAvailable () const
PBoolean	GetRemoteClientHasExtraCapabilities () const

Protected Member Functions
	PDECLARE_NOTIFIER (PTimer, OpalH281Handler, ContinueAction)
	PDECLARE_NOTIFIER (PTimer, OpalH281Handler, StopActionLocally)

Protected Attributes
BYTE	localNumberOfPresets
BYTE	remoteNumberOfPresets
H281VideoSource	localVideoSources [6]
H281VideoSource	remoteVideoSources [6]
H281_Frame	transmitFrame
PTimer	transmitTimer
H281_Frame::PanDirection	requestedPanDirection
H281_Frame::TiltDirection	requestedTiltDirection
H281_Frame::ZoomDirection	requestedZoomDirection
H281_Frame::FocusDirection	requestedFocusDirection
PTimer	receiveTimer
Protected Attributes inherited from OpalH224Client
PBoolean	remoteClientAvailable
PBoolean	remoteClientHasExtraCapabilities
OpalH224Handler *	h224Handler

Detailed Description

This class implements a default H.281 handler

Member Enumeration Documentation

VideoSource

enum OpalH281Handler::VideoSource

Enumerator
CurrentVideoSource
MainCamera
AuxiliaryCamera
DocumentCamera
AuxiliaryDocumentCamera
VideoPlaybackSource

Constructor & Destructor Documentation

OpalH281Handler()

OpalH281Handler::OpalH281Handler

(

)

~OpalH281Handler()

OpalH281Handler::~OpalH281Handler

(

)

Member Function Documentation

ActivatePreset()

void OpalH281Handler::ActivatePreset

(

BYTE

presetNumber

)

Tells the remote side to activate the given preset

GetClientID()

virtual BYTE OpalH281Handler::GetClientID ( ) const

inlinevirtual

Overriding default OpalH224Client methods

Implements OpalH224Client.

References OpalH224Client::H281ClientID.

GetLocalNumberOfPresets()

BYTE OpalH281Handler::GetLocalNumberOfPresets ( ) const

inline

GetLocalVideoSource()

H281VideoSource& OpalH281Handler::GetLocalVideoSource

(

VideoSource

source

)

GetRemoteNumberOfPresets()

BYTE OpalH281Handler::GetRemoteNumberOfPresets ( ) const

inline

GetRemoteVideoSource()

H281VideoSource& OpalH281Handler::GetRemoteVideoSource

(

VideoSource

source

)

HasExtraCapabilities()

virtual PBoolean OpalH281Handler::HasExtraCapabilities ( ) const

inlinevirtual

Return whether this client has extra capabilities. Default returns FALSE.

Reimplemented from OpalH224Client.

OnActivatePreset()

virtual void OpalH281Handler::OnActivatePreset ( BYTE  presetNumber )

virtual

Indicates to activate the given preset number

OnReceivedExtraCapabilities()

virtual void OpalH281Handler::OnReceivedExtraCapabilities ( const BYTE *  capabilities, PINDEX  size  )

virtual

Process incoming frames. Overrides from OpalH224Client

Reimplemented from OpalH224Client.

OnReceivedMessage()

virtual void OpalH281Handler::OnReceivedMessage ( const H224_Frame &  )

virtual

Called if a PDU for this client was received. Default does nothing.

Reimplemented from OpalH224Client.

OnRemoteCapabilitiesUpdated()

virtual void OpalH281Handler::OnRemoteCapabilitiesUpdated ( )

virtual

Called each time a remote endpoint sends its capability list

OnSelectVideoSource()

virtual void OpalH281Handler::OnSelectVideoSource ( BYTE  videoSourceNumber, H281_Frame::VideoMode  videoMode  )

virtual

Indicates to select the desired video source

OnStartAction()

virtual void OpalH281Handler::OnStartAction ( H281_Frame::PanDirection  panDirection, H281_Frame::TiltDirection  tiltDirection, H281_Frame::ZoomDirection  zoomDirection, H281_Frame::FocusDirection  focusDirection  )

virtual

Indicates to start the action specified

OnStopAction()

virtual void OpalH281Handler::OnStopAction ( )

virtual

Indicates to stop the action stared with OnStartAction()

OnStoreAsPreset()

virtual void OpalH281Handler::OnStoreAsPreset ( BYTE  presetNumber )

virtual

Indicates to store the current camera settings as a preset

PDECLARE_NOTIFIER() [1/2]

OpalH281Handler::PDECLARE_NOTIFIER ( PTimer  , OpalH281Handler  , ContinueAction    )

protected

PDECLARE_NOTIFIER() [2/2]

OpalH281Handler::PDECLARE_NOTIFIER ( PTimer  , OpalH281Handler  , StopActionLocally    )

protected

SelectVideoSource()

void OpalH281Handler::SelectVideoSource	(	BYTE	videoSourceNumber,
		H281_Frame::VideoMode	videoMode
	)

Tells the remote side to select the desired video source using the mode specified. Does nothing if either video source or mode aren't available

SendExtraCapabilities()

void OpalH281Handler::SendExtraCapabilities ( ) const

virtual

Causes the H.281 handler to send its capabilities. Capabilities include the number of available cameras, (default one) the camera abilities (default none) and the number of presets that can be stored (default zero)

Reimplemented from OpalH224Client.

SetLocalNumberOfPresets()

void OpalH281Handler::SetLocalNumberOfPresets ( BYTE  presets )

inline

StartAction()

void OpalH281Handler::StartAction	(	H281_Frame::PanDirection	panDirection,
		H281_Frame::TiltDirection	tiltDirection,
		H281_Frame::ZoomDirection	zoomDireciton,
		H281_Frame::FocusDirection	focusDirection
	)

Causes the H.281 handler to start the desired action The action will continue until StopAction() is called.

StopAction()

void OpalH281Handler::StopAction

(

)

Stops any action currently ongoing

StoreAsPreset()

void OpalH281Handler::StoreAsPreset

(

BYTE

presetNumber

)

Tells the remote side to store the current camera settings as a preset with the preset number given

Field Documentation

localNumberOfPresets

BYTE OpalH281Handler::localNumberOfPresets

protected

localVideoSources

H281VideoSource OpalH281Handler::localVideoSources[6]

protected

receiveTimer

PTimer OpalH281Handler::receiveTimer

protected

remoteNumberOfPresets

BYTE OpalH281Handler::remoteNumberOfPresets

protected

remoteVideoSources

H281VideoSource OpalH281Handler::remoteVideoSources[6]

protected

requestedFocusDirection

H281_Frame::FocusDirection OpalH281Handler::requestedFocusDirection

protected

requestedPanDirection

H281_Frame::PanDirection OpalH281Handler::requestedPanDirection

protected

requestedTiltDirection

H281_Frame::TiltDirection OpalH281Handler::requestedTiltDirection

protected

requestedZoomDirection

H281_Frame::ZoomDirection OpalH281Handler::requestedZoomDirection

protected

transmitFrame

H281_Frame OpalH281Handler::transmitFrame

protected

transmitTimer

PTimer OpalH281Handler::transmitTimer

protected

---

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

• h281handler.h