IHWIOHelper Class Reference

HWIO helper interface. More...

#include <IHWIOHelper.h>

Public Member Functions
virtual	~IHWIOHelper ()
virtual ZRCSDKError	RegisterSink (IHWIOHelperSink *pSink)=0
	Register HWIO helper callback sink.
virtual ZRCSDKError	DeregisterSink (IHWIOHelperSink *pSink)=0
	Deregister meeting HWIO callback sink.
virtual ZRCSDKError	ListHWIODevices ()=0
	List HWIO devices.
virtual ZRCSDKError	ConfigureHWIODevice (const HWIODeviceConfiguration &configuration)=0
	Configure HWIO device.
virtual ZRCSDKError	AssignHWIODevice (const HWIOAssignDeviceInfo &assignDevice)=0
	Assign HWIO device.
virtual ZRCSDKError	IsHWIOServiceAvailable (bool &available)=0
	Query HWIO service available.
virtual ZRCSDKError	IsHWIOFeatureAllowed (bool &allow)=0
	Query HWIO feature status.
virtual ZRCSDKError	SetHWIOVideoConvertPreference (const HWIOVideoConvertPreference &preference)=0
	Set HWIO video convert preference.
virtual ZRCSDKError	SetHWIOInputSignalDetection (const HWIOInputSignalDetection &signalDetection)=0
	Set HWIO input signal detection.

Detailed Description

HWIO helper interface.

Definition at line 471 of file IHWIOHelper.h.

Constructor & Destructor Documentation

~IHWIOHelper()

virtual IHWIOHelper::~IHWIOHelper ( )

inlinevirtual

Definition at line 475 of file IHWIOHelper.h.

{}

Member Function Documentation

AssignHWIODevice()

virtual ZRCSDKError IHWIOHelper::AssignHWIODevice ( const HWIOAssignDeviceInfo &  assignDevice )

pure virtual

Assign HWIO device.

Since

6.1.0

Zoom Rooms minimum version

6.1.0

Parameters

assignDevice

assign device, see HWIOAssignDeviceInfo struct.

Returns

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

ConfigureHWIODevice()

virtual ZRCSDKError IHWIOHelper::ConfigureHWIODevice ( const HWIODeviceConfiguration &  configuration )

pure virtual

Configure HWIO device.

Since

6.1.0

Zoom Rooms minimum version

6.1.0

Parameters

configuration

device configure, see HWIODeviceConfiguration struct.

Returns

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

DeregisterSink()

virtual ZRCSDKError IHWIOHelper::DeregisterSink ( IHWIOHelperSink *  pSink )

pure virtual

Deregister meeting HWIO callback sink.

Since

6.1.0

Zoom Rooms minimum version

6.1.0

Parameters

pSink

A pointer to the IHWIOHelperSink that receives the HWIO helper callback.

Returns

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

IsHWIOFeatureAllowed()

virtual ZRCSDKError IHWIOHelper::IsHWIOFeatureAllowed ( bool &  allow )

pure virtual

Query HWIO feature status.

Since

6.6.0

Zoom Rooms minimum version

6.1.0

Parameters

[out]

allow

TRUE indicates "Enable Custom AV input and output devices" in Zoom Web Portal is enabled. Otherwise not.

Returns

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

IsHWIOServiceAvailable()

virtual ZRCSDKError IHWIOHelper::IsHWIOServiceAvailable ( bool &  available )

pure virtual

Query HWIO service available.

Since

6.1.0

Zoom Rooms minimum version

6.1.0

Parameters

[out]

available

TRUE indicates the Zoom Rooms HWIO service is available. Otherwise not.

Returns

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

ListHWIODevices()

virtual ZRCSDKError IHWIOHelper::ListHWIODevices ( )

pure virtual

List HWIO devices.

Since

6.1.0

Zoom Rooms minimum version

6.1.0

Returns

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

RegisterSink()

virtual ZRCSDKError IHWIOHelper::RegisterSink ( IHWIOHelperSink *  pSink )

pure virtual

Register HWIO helper callback sink.

Since

6.1.0

Zoom Rooms minimum version

6.1.0

Parameters

pSink

A pointer to the IHWIOHelperSink that receives the HWIO helper callback.

Returns

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

SetHWIOInputSignalDetection()

virtual ZRCSDKError IHWIOHelper::SetHWIOInputSignalDetection ( const HWIOInputSignalDetection &  signalDetection )

pure virtual

Set HWIO input signal detection.

Since

6.6.0

Zoom Rooms minimum version

6.6.0

Parameters

signalDetection

Input signal detection, see HWIOInputSignalDetection struct.

Returns

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

SetHWIOVideoConvertPreference()

virtual ZRCSDKError IHWIOHelper::SetHWIOVideoConvertPreference ( const HWIOVideoConvertPreference &  preference )

pure virtual

Set HWIO video convert preference.

Since

6.4.0

Zoom Rooms minimum version

6.4.0

Parameters

preference

Video convert preference, see HWIOVideoConvertPreference struct.

Returns

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