ICameraController Class Reference

Camera controller interface. More...

#include <zoom_sdk_util_define.h>

Public Member Functions
virtual	~ICameraController ()
virtual SDKError	SetEvent (ICameraControllerEvent *pEvent)=0
	Sets the event handler for camera controller.
virtual bool	IsValid ()=0
	Determines whether the camera controller is valid.
virtual SDKError	BeginTurnLeft ()=0
	Begins turning the camera left.
virtual SDKError	ContinueTurnLeft ()=0
	Continues turning the camera left.
virtual SDKError	EndTurnLeft ()=0
	Ends turning the camera left.
virtual SDKError	BeginTurnRight ()=0
	Begins turning the camera right.
virtual SDKError	ContinueTurnRight ()=0
	Continues turning the camera right.
virtual SDKError	EndTurnRight ()=0
	Ends turning the camera right.
virtual SDKError	BeginTurnUp ()=0
	Begins turning the camera up.
virtual SDKError	ContinueTurnUp ()=0
	Continues turning the camera up.
virtual SDKError	EndTurnUp ()=0
	Ends turning the camera up.
virtual SDKError	BeginTurnDown ()=0
	Begins turning the camera down.
virtual SDKError	ContinueTurnDown ()=0
	Continues turning the camera down.
virtual SDKError	EndTurnDown ()=0
	Ends turning the camera down.
virtual SDKError	BeginZoomIn ()=0
	Begins zooming the camera in to move the camera angle closer to the subject.
virtual SDKError	ContinueZoomIn ()=0
	Continues zooming the camera in.
virtual SDKError	EndZoomIn ()=0
	Ends zooming the camera in.
virtual SDKError	BeginZoomOut ()=0
	Begins zooming the camera out to move the camera angle farther from the subject.
virtual SDKError	ContinueZoomOut ()=0
	Continues zooming the camera out.
virtual SDKError	EndZoomOut ()=0
	Ends zooming the camera out.
virtual SDKError	CanControlCamera (bool &bCan)=0
	Determines whether the camera can be controlled.

Detailed Description

Camera controller interface.

Definition at line 29 of file zoom_sdk_util_define.h.

Constructor & Destructor Documentation

~ICameraController()

virtual ICameraController::~ICameraController ( )

inlinevirtual

Definition at line 32 of file zoom_sdk_util_define.h.

{}

Member Function Documentation

BeginTurnDown()

virtual SDKError ICameraController::BeginTurnDown ( )

pure virtual

Begins turning the camera down.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

BeginTurnLeft()

virtual SDKError ICameraController::BeginTurnLeft ( )

pure virtual

Begins turning the camera left.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

BeginTurnRight()

virtual SDKError ICameraController::BeginTurnRight ( )

pure virtual

Begins turning the camera right.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

BeginTurnUp()

virtual SDKError ICameraController::BeginTurnUp ( )

pure virtual

Begins turning the camera up.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

BeginZoomIn()

virtual SDKError ICameraController::BeginZoomIn ( )

pure virtual

Begins zooming the camera in to move the camera angle closer to the subject.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

BeginZoomOut()

virtual SDKError ICameraController::BeginZoomOut ( )

pure virtual

Begins zooming the camera out to move the camera angle farther from the subject.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

CanControlCamera()

virtual SDKError ICameraController::CanControlCamera ( bool & bCan )

pure virtual

Determines whether the camera can be controlled.

Parameters

bCan	true if the camera can be controlled, false otherwise.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

ContinueTurnDown()

virtual SDKError ICameraController::ContinueTurnDown ( )

pure virtual

Continues turning the camera down.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

ContinueTurnLeft()

virtual SDKError ICameraController::ContinueTurnLeft ( )

pure virtual

Continues turning the camera left.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

ContinueTurnRight()

virtual SDKError ICameraController::ContinueTurnRight ( )

pure virtual

Continues turning the camera right.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

ContinueTurnUp()

virtual SDKError ICameraController::ContinueTurnUp ( )

pure virtual

Continues turning the camera up.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

ContinueZoomIn()

virtual SDKError ICameraController::ContinueZoomIn ( )

pure virtual

Continues zooming the camera in.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

ContinueZoomOut()

virtual SDKError ICameraController::ContinueZoomOut ( )

pure virtual

Continues zooming the camera out.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

EndTurnDown()

virtual SDKError ICameraController::EndTurnDown ( )

pure virtual

Ends turning the camera down.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

EndTurnLeft()

virtual SDKError ICameraController::EndTurnLeft ( )

pure virtual

Ends turning the camera left.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

EndTurnRight()

virtual SDKError ICameraController::EndTurnRight ( )

pure virtual

Ends turning the camera right.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

EndTurnUp()

virtual SDKError ICameraController::EndTurnUp ( )

pure virtual

Ends turning the camera up.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

EndZoomIn()

virtual SDKError ICameraController::EndZoomIn ( )

pure virtual

Ends zooming the camera in.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

EndZoomOut()

virtual SDKError ICameraController::EndZoomOut ( )

pure virtual

Ends zooming the camera out.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

IsValid()

virtual bool ICameraController::IsValid ( )

pure virtual

Determines whether the camera controller is valid.

Returns

true if the camera controller is valid. Otherwise, false.

SetEvent()

virtual SDKError ICameraController::SetEvent ( ICameraControllerEvent * pEvent )

pure virtual

Sets the event handler for camera controller.

Parameters

pEvent

A pointer to the ICameraControllerEvent that receives camera controller events.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.