Zoom Rooms Controller SDK Reference 6.6.0
Loading...
Searching...
No Matches
Public Member Functions
IHWIOHelperSink Class Referenceabstract

HWIO helper event callback. More...

#include <IHWIOHelper.h>

Public Member Functions

virtual ~IHWIOHelperSink ()
 
virtual void OnHWIOListDevicesResult (int32_t result, const HWIOInfo &info)=0
 HWIO list device notification.
 
virtual void OnHWIOConfigureDeviceResult (int32_t result, const HWIODeviceConfiguration &configuration)=0
 HWIO configure device notification.
 
virtual void OnHWIOAssignDeviceResult (int32_t result, const HWIOAssignDeviceInfo &assignDeviceInfo)=0
 HWIO assign device notification.
 
virtual void OnHWIODeviceUpdated (const HWIODeviceUpdate &deviceUpdate)=0
 HWIO device update notification.
 
virtual void OnHWIOServiceStatusUpdated (bool isServiceAvailable, bool isFeatureAllowed)=0
 HWIO service status update notification.
 
virtual void OnHWIOSetVideoConvertPreferenceResult (int32_t result, const HWIOVideoConvertPreference &preference)=0
 HWIO set video convert preference notification.
 
virtual void OnHWIOSetInputSignalDetectionResult (int32_t result, const HWIOInputSignalDetection &signalDetection)=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 
)
pure virtual

HWIO assign device notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
resultAssign device result, see HWIODeviceResult enum.
assignDeviceInfoHWIO assign device info, details HWIOAssignDeviceInfo struct.

◆ OnHWIOConfigureDeviceResult()

virtual void IHWIOHelperSink::OnHWIOConfigureDeviceResult ( int32_t  result,
const HWIODeviceConfiguration &  configuration 
)
pure virtual

HWIO configure device notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
resultConfigure device result, see HWIODeviceResult enum.
configurationHWIO device configuration, details HWIODeviceConfiguration struct.

◆ OnHWIODeviceUpdated()

virtual void IHWIOHelperSink::OnHWIODeviceUpdated ( const HWIODeviceUpdate &  deviceUpdate)
pure virtual

HWIO device update notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
deviceUpdateHWIO device update info, details HWIODeviceUpdate struct.
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.

◆ OnHWIOListDevicesResult()

virtual void IHWIOHelperSink::OnHWIOListDevicesResult ( int32_t  result,
const HWIOInfo &  info 
)
pure virtual

HWIO list device notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
resultList devices result, see HWIODeviceResult enum.
infoHWIO info, details HWIOInfo struct.

◆ OnHWIOServiceStatusUpdated()

virtual void IHWIOHelperSink::OnHWIOServiceStatusUpdated ( bool  isServiceAvailable,
bool  isFeatureAllowed 
)
pure virtual

HWIO service status update notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
isServiceAvailableTRUE indicates the Zoom Rooms HWIO service is available. Otherwise not.
isFeatureAllowedTRUE indicates "Enable Custom AV input and output devices" in Zoom Web Portal is enabled. Otherwise not.
Changelog
  • 6.6.0: Add isFeatureAllowed field to indicate the Web Portal feature status.

◆ OnHWIOSetInputSignalDetectionResult()

virtual void IHWIOHelperSink::OnHWIOSetInputSignalDetectionResult ( int32_t  result,
const HWIOInputSignalDetection &  signalDetection 
)
pure virtual

HWIO set input signal detection result notification.

Since
6.6.0
Zoom Rooms minimum version
6.6.0
Parameters
resultSet input signal detection result, see HWIODeviceResult enum.
signalDetectionInput signal detection, see HWIOInputSignalDetection struct.

◆ OnHWIOSetVideoConvertPreferenceResult()

virtual void IHWIOHelperSink::OnHWIOSetVideoConvertPreferenceResult ( int32_t  result,
const HWIOVideoConvertPreference &  preference 
)
pure virtual

HWIO set video convert preference notification.

Since
6.4.0
Zoom Rooms minimum version
6.4.0
Parameters
resultSet video convert preference result, see HWIODeviceResult enum.
preferencevideo convert preference, see HWIOVideoConvertPreference struct.