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 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)
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

Detailed Description

This class implements a default H.281 handler

Member Enumeration Documentation

enum OpalH281Handler::VideoSource

Enumerator:

CurrentVideoSource
MainCamera
AuxiliaryCamera
DocumentCamera
AuxiliaryDocumentCamera
VideoPlaybackSource

Constructor & Destructor Documentation

OpalH281Handler::OpalH281Handler ( )

OpalH281Handler::~OpalH281Handler ( )

Member Function Documentation

virtual BYTE OpalH281Handler::GetClientID ( ) const [inline, virtual]

Overriding default OpalH224Client methods

Implements OpalH224Client.

virtual PBoolean OpalH281Handler::HasExtraCapabilities ( ) const [inline, virtual]

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

Reimplemented from OpalH224Client.

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

Process incoming frames. Overrides from OpalH224Client

Reimplemented from OpalH224Client.

virtual void OpalH281Handler::OnReceivedMessage ( const H224_Frame & message ) [virtual]

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

Reimplemented from OpalH224Client.

BYTE OpalH281Handler::GetLocalNumberOfPresets ( ) const [inline]

void OpalH281Handler::SetLocalNumberOfPresets ( BYTE presets ) [inline]

BYTE OpalH281Handler::GetRemoteNumberOfPresets ( ) const [inline]

H281VideoSource& OpalH281Handler::GetLocalVideoSource ( VideoSource source )

H281VideoSource& OpalH281Handler::GetRemoteVideoSource ( VideoSource source )

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.

void OpalH281Handler::StopAction ( )

Stops any action currently ongoing

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

void OpalH281Handler::StoreAsPreset ( BYTE presetNumber )

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

void OpalH281Handler::ActivatePreset ( BYTE presetNumber )

Tells the remote side to activate the given preset

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.

virtual void OpalH281Handler::OnRemoteCapabilitiesUpdated ( ) [virtual]

Called each time a remote endpoint sends its capability list

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