HWIO helper event callback. More...

#include <IHWIOHelper.h>

Public Member Functions
virtual	~IHWIOHelperSink ()

virtual void	OnHWIOListDevicesResult (int32_t result, const HWIOInfo &info, const std::string &companionZRID)=0
	HWIO list device notification.

virtual void	OnHWIOConfigureDeviceResult (int32_t result, const HWIODeviceConfiguration &configuration, const std::string &companionZRID)=0
	HWIO configure device notification.

virtual void	OnHWIOAssignDeviceResult (int32_t result, const HWIOAssignDeviceInfo &assignDeviceInfo, const std::string &companionZRID)=0
	HWIO assign device notification.

virtual void	OnHWIODeviceUpdated (const HWIODeviceUpdate &deviceUpdate, const std::string &companionZRID)=0
	HWIO device update notification.

virtual void	OnHWIOServiceStatusUpdated (bool isServiceAvailable, bool isFeatureAllowed, const std::string &companionZRID)=0
	HWIO service status update notification.

virtual void	OnHWIOSetVideoConvertPreferenceResult (int32_t result, const HWIOVideoConvertPreference &preference, const std::string &companionZRID)=0
	HWIO set video convert preference notification.

virtual void	OnHWIOSetInputSignalDetectionResult (int32_t result, const HWIOInputSignalDetection &signalDetection, const std::string &companionZRID)=0
	HWIO set input signal detection result notification.

Detailed Description

HWIO helper event callback.

Definition at line 379 of file IHWIOHelper.h.

Constructor & Destructor Documentation

◆ ~IHWIOHelperSink()

virtual IHWIOHelperSink::~IHWIOHelperSink ( )

inlinevirtual

Definition at line 382 of file IHWIOHelper.h.

382{}

Member Function Documentation

◆ OnHWIOAssignDeviceResult()

virtual void IHWIOHelperSink::OnHWIOAssignDeviceResult	(	int32_t	result,
		const HWIOAssignDeviceInfo &	assignDeviceInfo,
		const std::string &	companionZRID
	)

pure virtual

HWIO assign device notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

result	Assign device result, see HWIODeviceResult enum.
assignDeviceInfo	HWIO assign device info, details HWIOAssignDeviceInfo struct.
companionZRID	CompanionZR's ID.

Changelog

6.7.0: support HWIO for Mac&Win CZR.

◆ OnHWIOConfigureDeviceResult()

virtual void IHWIOHelperSink::OnHWIOConfigureDeviceResult	(	int32_t	result,
		const HWIODeviceConfiguration &	configuration,
		const std::string &	companionZRID
	)

pure virtual

HWIO configure device notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

result	Configure device result, see HWIODeviceResult enum.
configuration	HWIO device configuration, details HWIODeviceConfiguration struct.
companionZRID	CompanionZR's ID.

Changelog

6.7.0: support HWIO for Mac&Win CZR.

◆ OnHWIODeviceUpdated()

virtual void IHWIOHelperSink::OnHWIODeviceUpdated	(	const HWIODeviceUpdate &	deviceUpdate,
		const std::string &	companionZRID
	)

pure virtual

HWIO device update notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

deviceUpdate	HWIO device update info, details HWIODeviceUpdate struct.
companionZRID	CompanionZR's ID.

Changelog

6.6.0: Added deviceID and channelID fields to update specific channel information.
6.6.0: Added activityStatus field to notify channel activity status changes.
6.6.0: Added detectedInputSignal field to notify channel detected input signal changes.
6.7.0: support HWIO for Mac&Win CZR.

◆ OnHWIOListDevicesResult()

virtual void IHWIOHelperSink::OnHWIOListDevicesResult	(	int32_t	result,
		const HWIOInfo &	info,
		const std::string &	companionZRID
	)

pure virtual

HWIO list device notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

result	List devices result, see HWIODeviceResult enum.
info	HWIO info, details HWIOInfo struct.
companionZRID	CompanionZR's ID.

Changelog

6.7.0: support HWIO for Mac&Win CZR.

◆ OnHWIOServiceStatusUpdated()

virtual void IHWIOHelperSink::OnHWIOServiceStatusUpdated	(	bool	isServiceAvailable,
		bool	isFeatureAllowed,
		const std::string &	companionZRID
	)

pure virtual

HWIO service status update notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

isServiceAvailable	TRUE indicates the Zoom Rooms HWIO service is available. Otherwise not.
isFeatureAllowed	TRUE indicates "Enable Custom AV input and output devices" in Zoom Web Portal is enabled. Otherwise not.
companionZRID	CompanionZR's ID.

Changelog

6.6.0: Add isFeatureAllowed field to indicate the Web Portal feature status.
6.7.0: support HWIO for Mac&Win CZR.

◆ OnHWIOSetInputSignalDetectionResult()

virtual void IHWIOHelperSink::OnHWIOSetInputSignalDetectionResult	(	int32_t	result,
		const HWIOInputSignalDetection &	signalDetection,
		const std::string &	companionZRID
	)

pure virtual

HWIO set input signal detection result notification.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

result	Set input signal detection result, see HWIODeviceResult enum.
signalDetection	Input signal detection, see HWIOInputSignalDetection struct.
companionZRID	CompanionZR's ID.

Changelog

6.7.0: support HWIO for Mac&Win CZR.

◆ OnHWIOSetVideoConvertPreferenceResult()

virtual void IHWIOHelperSink::OnHWIOSetVideoConvertPreferenceResult	(	int32_t	result,
		const HWIOVideoConvertPreference &	preference,
		const std::string &	companionZRID
	)

pure virtual

HWIO set video convert preference notification.

Since: 6.4.0

Zoom Rooms minimum version: 6.4.0

Parameters

result	Set video convert preference result, see HWIODeviceResult enum.
preference	video convert preference, see HWIOVideoConvertPreference struct.
companionZRID	CompanionZR's ID.

Changelog

6.7.0: support HWIO for Mac&Win CZR.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IHWIOHelperSink()

Member Function Documentation

◆ OnHWIOAssignDeviceResult()

◆ OnHWIOConfigureDeviceResult()

◆ OnHWIODeviceUpdated()

◆ OnHWIOListDevicesResult()

◆ OnHWIOServiceStatusUpdated()

◆ OnHWIOSetInputSignalDetectionResult()

◆ OnHWIOSetVideoConvertPreferenceResult()