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 (const std::string &companionZRID="")=0
	List HWIO devices.

virtual ZRCSDKError	ConfigureHWIODevice (const HWIODeviceConfiguration &configuration, const std::string &companionZRID="")=0
	Configure HWIO device.

virtual ZRCSDKError	AssignHWIODevice (const HWIOAssignDeviceInfo &assignDevice, const std::string &companionZRID="")=0
	Assign HWIO device.

virtual ZRCSDKError	IsHWIOServiceAvailable (bool &available, const std::string &companionZRID="")=0
	Query HWIO service available.

virtual ZRCSDKError	IsHWIOFeatureAllowed (bool &allow)=0
	Query HWIO feature status.

virtual ZRCSDKError	SetHWIOVideoConvertPreference (const HWIOVideoConvertPreference &preference, const std::string &companionZRID="")=0
	Set HWIO video convert preference.

virtual ZRCSDKError	SetHWIOInputSignalDetection (const HWIOInputSignalDetection &signalDetection, const std::string &companionZRID="")=0
	Set HWIO input signal detection.

Detailed Description

HWIO helper interface.

Definition at line 497 of file IHWIOHelper.h.

Constructor & Destructor Documentation

◆ ~IHWIOHelper()

virtual IHWIOHelper::~IHWIOHelper ( )

inlinevirtual

Definition at line 501 of file IHWIOHelper.h.

501{}

Member Function Documentation

◆ AssignHWIODevice()

virtual ZRCSDKError IHWIOHelper::AssignHWIODevice	(	const HWIOAssignDeviceInfo &	assignDevice,
		const std::string &	companionZRID = `""`
	)

pure virtual

Assign HWIO device.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

assignDevice	assign device, see HWIOAssignDeviceInfo struct.
companionZRID	CompanionZR's ID.

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

Changelog

6.7.0: support HWIO for Mac&Win CZR.

◆ ConfigureHWIODevice()

virtual ZRCSDKError IHWIOHelper::ConfigureHWIODevice	(	const HWIODeviceConfiguration &	configuration,
		const std::string &	companionZRID = `""`
	)

pure virtual

Configure HWIO device.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

configuration	device configure, see HWIODeviceConfiguration struct.
companionZRID	CompanionZR's ID.

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

Changelog

6.7.0: support HWIO for Mac&Win CZR.

◆ 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,
		const std::string &	companionZRID = `""`
	)

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.
	companionZRID	CompanionZR's ID.

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

Changelog

6.7.0: support HWIO for Mac&Win CZR.

◆ ListHWIODevices()

virtual ZRCSDKError IHWIOHelper::ListHWIODevices ( const std::string & companionZRID = "" )

pure virtual

List HWIO devices.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

companionZRID CompanionZR's ID.

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

Changelog

6.7.0: support HWIO for Mac&Win CZR.

◆ 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,
		const std::string &	companionZRID = `""`
	)

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.
companionZRID	CompanionZR's ID.

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

Changelog

6.7.0: support HWIO for Mac&Win CZR.

◆ SetHWIOVideoConvertPreference()

virtual ZRCSDKError IHWIOHelper::SetHWIOVideoConvertPreference	(	const HWIOVideoConvertPreference &	preference,
		const std::string &	companionZRID = `""`
	)

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.
companionZRID	CompanionZR's ID.

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

Changelog

6.7.0: support HWIO for Mac&Win CZR.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IHWIOHelper()

Member Function Documentation

◆ AssignHWIODevice()

◆ ConfigureHWIODevice()

◆ DeregisterSink()

◆ IsHWIOFeatureAllowed()

◆ IsHWIOServiceAvailable()

◆ ListHWIODevices()

◆ RegisterSink()

◆ SetHWIOInputSignalDetection()

◆ SetHWIOVideoConvertPreference()