IControlSystemHelper Class Reference

Control System helper interface. More...

#include <IControlSystemHelper.h>

Public Member Functions
virtual	~IControlSystemHelper ()
virtual ZRCSDKError	RegisterSink (IControlSystemHelperSink *pSink)=0
	Register ControlSystem helper callback sink.
virtual ZRCSDKError	DeregisterSink (IControlSystemHelperSink *pSink)=0
	Deregister meeting ControlSystem callback sink.
virtual ZRCSDKError	IsZRCSEnabled (bool &enabled)=0
	Query if control system is enabled currently.
virtual ZRCSDKError	OpenRoomControls (bool open)=0
	Notify ZR controller enter room control system state.
virtual ZRCSDKError	GetZRCSDeviceList (ControlSystemDeviceList &deviceList)=0
	Query current control system device list info.
virtual ZRCSDKError	ConnectZRCSDevice (const std::string &deviceID)=0
	Connect to ZRCS device.
virtual ZRCSDKError	ControlZRCSDevice (const std::string &deviceID, const std::string &methodID, const std::string &paramID, const std::string &value)=0
	Control ZRCS device, execute the action with specified params.
virtual ZRCSDKError	GetZRCSSceneList (std::vector< ControlSystemSceneInfo > &scenes)=0
	Query current control system scene list.
virtual ZRCSDKError	ExecuteZRCSScene (const std::string &sceneID)=0
	Execute control system scene.

Detailed Description

Control System helper interface.

Definition at line 161 of file IControlSystemHelper.h.

Constructor & Destructor Documentation

~IControlSystemHelper()

virtual IControlSystemHelper::~IControlSystemHelper ( )

inlinevirtual

Definition at line 164 of file IControlSystemHelper.h.

{}

Member Function Documentation

ConnectZRCSDevice()

virtual ZRCSDKError IControlSystemHelper::ConnectZRCSDevice ( const std::string &  deviceID )

pure virtual

Connect to ZRCS device.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

deviceID

Device ID.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

ControlZRCSDevice()

virtual ZRCSDKError IControlSystemHelper::ControlZRCSDevice ( const std::string &  deviceID, const std::string &  methodID, const std::string &  paramID, const std::string &  value  )

pure virtual

Control ZRCS device, execute the action with specified params.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

deviceID	Device ID
methodID	Method ID
paramID	Param ID
value	Param value

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

DeregisterSink()

virtual ZRCSDKError IControlSystemHelper::DeregisterSink ( IControlSystemHelperSink *  pSink )

pure virtual

Deregister meeting ControlSystem callback sink.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

pSink

A pointer to the IControlSystemHelperSink that receives the ControlSystem helper callback.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

ExecuteZRCSScene()

virtual ZRCSDKError IControlSystemHelper::ExecuteZRCSScene ( const std::string &  sceneID )

pure virtual

Execute control system scene.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

sceneID

Specify the scene ID to execute.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

GetZRCSDeviceList()

virtual ZRCSDKError IControlSystemHelper::GetZRCSDeviceList ( ControlSystemDeviceList &  deviceList )

pure virtual

Query current control system device list info.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

[out]

deviceList

The device list info.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

GetZRCSSceneList()

virtual ZRCSDKError IControlSystemHelper::GetZRCSSceneList ( std::vector< ControlSystemSceneInfo > &  scenes )

pure virtual

Query current control system scene list.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

[out]

scenes

The config scenes.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

IsZRCSEnabled()

virtual ZRCSDKError IControlSystemHelper::IsZRCSEnabled ( bool &  enabled )

pure virtual

Query if control system is enabled currently.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

[out]

enabled

TRUE indicates control system is enabled.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

OpenRoomControls()

virtual ZRCSDKError IControlSystemHelper::OpenRoomControls ( bool  open )

pure virtual

Notify ZR controller enter room control system state.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

If Room control config some events when controller opens room control system, it will be triggered.

Parameters

open	TRUE indicates controller has entered room control system state.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

RegisterSink()

virtual ZRCSDKError IControlSystemHelper::RegisterSink ( IControlSystemHelperSink *  pSink )

pure virtual

Register ControlSystem helper callback sink.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

pSink

A pointer to the IControlSystemHelperSink that receives the ControlSystem helper callback.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.