Setting service event callback. More...

#include <ISettingService.h>

Public Member Functions
virtual	~ISettingServiceSink ()

virtual void	OnMicrophoneListChanged (const std::vector< Device > &microphones)=0
	Microphone list changed callback.

virtual void	OnSpeakerListChanged (const std::vector< Device > &speakers)=0
	Speaker list changed callback.

virtual void	OnCameraListChanged (const std::vector< Device > &cameras)=0
	Camera list changed callback.

virtual void	OnUpdateCOMList (const std::vector< Device > &comList)=0
	COM list changed callback.

virtual void	OnCompanionZRDeviceUpdateNotification (const CompanionZRDeviceUpdateNot &noti)=0
	Companion ZR device update notification.

virtual void	OnCurrentMicrophoneChanged (bool exist, const Device &microphone)=0
	Current microphone changed callback.

virtual void	OnCurrentSpeakerChanged (bool exist, const Device &speaker)=0
	Current speaker changed callback.

virtual void	OnCurrentCameraChanged (bool exist, const Device &camera)=0
	Current camera changed callback.

virtual void	OnCurrentMicrophoneVolumeChanged (float volume)=0
	Current microphone volume changed callback.

virtual void	OnCurrentSpeakerVolumeChanged (float volume)=0
	Current speaker volume changed callback.

virtual void	OnUpdateHardwareStatus (const HardwareStatus &status)=0
	Hardware status changed callback.

virtual void	OnUpdatedGenericSettings (const GenericSettings &genericSettings)=0
	Generic settings changed callback.

virtual void	OnUpdateRoomProfileList (const RoomProfileList &list)=0
	Update room profile list.

virtual void	OnUpdateZoomRoomCapability (const RoomCapability &roomCapability)=0
	Update room capability.

virtual void	OnCurrentSelectedMicrophoneMuted (bool muted)=0
	Current selected microphone muted notification.

virtual void	OnMicrophoneTestingNotification (int32_t volume)=0
	Microphone testing notification.

virtual void	OnMicrophoneRecordingNotification (MicRecordTestStatus status)=0
	Microphone testing recording notification.

virtual void	OnSpeakerTestingNotification (int32_t volume, bool isEnabled)=0
	Speaker testing notification.

virtual void	OnSpeakerTestingResult (int32_t result, float duration, bool isStopped)=0
	Speaker testing result.

virtual void	OnStatisticalInfoNotification (const StatisticalInfo &info)=0
	Statistical info notification.

virtual void	OnAudioCheckupNotification (const AudioCheckupInfo &info)=0
	Audio checkup info notification.

virtual void	OnAudioSystemFailureNotification (bool isDismiss)=0
	Audio system failure notification.

virtual void	OnScreenInfosNotification (const ScreenInfos &screenInfos)=0
	Screen infos notification.

virtual void	OnAdjustScreensResponse (const AdjustScreensRes &response)=0
	Adjust screen response.

virtual void	OnZoomPresenceScreenSaverNotification (bool running)=0
	Room screen saver running notification.

virtual void	OnUpdatedOperationTimeStatusNotification (bool shouldDimScreen)=0
	Operation time status notification.

virtual void	OnDirectorCalibrationNotification (const DirectorCalibrationNot &noti)=0
	Director calibration notification.

virtual void	OnIntelligentDirectorInfoNotification (const IntelligentDirectorInfo &info)=0
	Intelligent director info notification.

virtual void	OnCameraBoundaryConfigurationInfoNotification (const CameraBoundaryConfigurationInfo &info)=0
	Camera Boundary configuration info notification.

virtual void	OnUpdateDiagnosticInfo (const DiagnosticInfo &info)=0
	Diagnostic info notification.

virtual void	OnChangeWindowsPasswordNotification (int32_t result)=0
	Change windows password notification.

virtual void	OnUpdateNetworkAudioDeviceList (const std::string &virtualDeviceID, NetworkAudioDeviceListAction action, const std::vector< NetworkAudioDevice > &networkAudioDeviceList, bool isUsedDanteController)=0
	Network audio device list update notification.

virtual void	OnListAudioChannelAndCameraBindInfoNotification (const std::vector< AudioChannelAndCameraBindInfo > &bindInfoList)=0
	List audio channel and camera bind information notification.

virtual void	OnBindAudioChannelAndCameraNotification (const std::vector< AudioChannelAndCameraBindInfo > &bindInfoList)=0
	Bind audio channel and camera notification.

virtual void	OnUnbindAudioChannelAndCameraNotification (const std::vector< AudioChannelAndCameraBindInfo > &bindInfoList)=0
	Unbind audio channel and camera notification.

virtual void	OnUnbindAllAudioChannelAndCameraConnectionsNotification (const std::vector< AudioChannelAndCameraBindInfo > &bindInfoList)=0
	Unbind all audio channel and camera connections notification.

virtual void	OnNetworkAdapterUpdateInfo (const std::vector< NetworkAdapterInfo > &networkAdapterInfos)=0
	Network adapter info update notification.

virtual void	OnUpdateMicStethoscopeModeEnabledStatus (bool isMicStethoscopeModeEnabled)=0
	Update microphone stethoscope mode enabled status notification.

Detailed Description

Setting service event callback.

Definition at line 466 of file ISettingService.h.

Constructor & Destructor Documentation

◆ ~ISettingServiceSink()

virtual ISettingServiceSink::~ISettingServiceSink ( )

inlinevirtual

Definition at line 469 of file ISettingService.h.

469{}

Member Function Documentation

◆ OnAdjustScreensResponse()

virtual void ISettingServiceSink::OnAdjustScreensResponse ( const AdjustScreensRes & response )

pure virtual

Adjust screen response.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

response Response of adjust screen.

◆ OnAudioCheckupNotification()

virtual void ISettingServiceSink::OnAudioCheckupNotification ( const AudioCheckupInfo & info )

pure virtual

Audio checkup info notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

info	The audio checkup info.

◆ OnAudioSystemFailureNotification()

virtual void ISettingServiceSink::OnAudioSystemFailureNotification ( bool isDismiss )

pure virtual

Audio system failure notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

isDismiss TRUE indicates to dismiss the audio system failure alert. Otherwise to show the alert.

◆ OnBindAudioChannelAndCameraNotification()

virtual void ISettingServiceSink::OnBindAudioChannelAndCameraNotification ( const std::vector< AudioChannelAndCameraBindInfo > & bindInfoList )

pure virtual

Bind audio channel and camera notification.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

bindInfoList Updated list of audio channel and camera bindings, see AudioChannelAndCameraBindInfo struct.

◆ OnCameraBoundaryConfigurationInfoNotification()

virtual void ISettingServiceSink::OnCameraBoundaryConfigurationInfoNotification ( const CameraBoundaryConfigurationInfo & info )

pure virtual

Camera Boundary configuration info notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

info	The notification info.

◆ OnCameraListChanged()

virtual void ISettingServiceSink::OnCameraListChanged ( const std::vector< Device > & cameras )

pure virtual

Camera list changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

cameras Camera list.

◆ OnChangeWindowsPasswordNotification()

virtual void ISettingServiceSink::OnChangeWindowsPasswordNotification ( int32_t result )

pure virtual

Change windows password notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

result [0] Success. Otherwise failed.

◆ OnCompanionZRDeviceUpdateNotification()

virtual void ISettingServiceSink::OnCompanionZRDeviceUpdateNotification ( const CompanionZRDeviceUpdateNot & noti )

pure virtual

Companion ZR device update notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

noti	CZR update notification.

◆ OnCurrentCameraChanged()

virtual void ISettingServiceSink::OnCurrentCameraChanged	(	bool	exist,
		const Device &	camera
	)

pure virtual

Current camera changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

exist	TRUE indicates exist current camera.
camera	Camera device.

◆ OnCurrentMicrophoneChanged()

virtual void ISettingServiceSink::OnCurrentMicrophoneChanged	(	bool	exist,
		const Device &	microphone
	)

pure virtual

Current microphone changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

exist	TRUE indicates exist current microphone.
microphone	Microphone device.

◆ OnCurrentMicrophoneVolumeChanged()

virtual void ISettingServiceSink::OnCurrentMicrophoneVolumeChanged ( float volume )

pure virtual

Current microphone volume changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

volume Microphone volume.

◆ OnCurrentSelectedMicrophoneMuted()

virtual void ISettingServiceSink::OnCurrentSelectedMicrophoneMuted ( bool muted )

pure virtual

Current selected microphone muted notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

muted TRUE indicates microphone is mutes.

◆ OnCurrentSpeakerChanged()

virtual void ISettingServiceSink::OnCurrentSpeakerChanged	(	bool	exist,
		const Device &	speaker
	)

pure virtual

Current speaker changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

exist	TRUE indicates exist current speaker.
speaker	Speaker device.

◆ OnCurrentSpeakerVolumeChanged()

virtual void ISettingServiceSink::OnCurrentSpeakerVolumeChanged ( float volume )

pure virtual

Current speaker volume changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

volume Speaker volume

◆ OnDirectorCalibrationNotification()

virtual void ISettingServiceSink::OnDirectorCalibrationNotification ( const DirectorCalibrationNot & noti )

pure virtual

Director calibration notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

noti	The notification info.

◆ OnIntelligentDirectorInfoNotification()

virtual void ISettingServiceSink::OnIntelligentDirectorInfoNotification ( const IntelligentDirectorInfo & info )

pure virtual

Intelligent director info notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

info	The notification info.

◆ OnListAudioChannelAndCameraBindInfoNotification()

virtual void ISettingServiceSink::OnListAudioChannelAndCameraBindInfoNotification ( const std::vector< AudioChannelAndCameraBindInfo > & bindInfoList )

pure virtual

List audio channel and camera bind information notification.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

bindInfoList List of current audio channel and camera bindings, see AudioChannelAndCameraBindInfo struct.

◆ OnMicrophoneListChanged()

virtual void ISettingServiceSink::OnMicrophoneListChanged ( const std::vector< Device > & microphones )

pure virtual

Microphone list changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

microphones Microphone list.

◆ OnMicrophoneRecordingNotification()

virtual void ISettingServiceSink::OnMicrophoneRecordingNotification ( MicRecordTestStatus status )

pure virtual

Microphone testing recording notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

status Microphone testing recording status, see MicRecordTestStatus enum.

◆ OnMicrophoneTestingNotification()

virtual void ISettingServiceSink::OnMicrophoneTestingNotification ( int32_t volume )

pure virtual

Microphone testing notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

volume Microphone testing real time volume.

◆ OnNetworkAdapterUpdateInfo()

virtual void ISettingServiceSink::OnNetworkAdapterUpdateInfo ( const std::vector< NetworkAdapterInfo > & networkAdapterInfos )

pure virtual

Network adapter info update notification.

Since: 6.3.0

Zoom Rooms minimum version: 6.3.0

Parameters

networkAdapterInfos Network adapter info list.

◆ OnScreenInfosNotification()

virtual void ISettingServiceSink::OnScreenInfosNotification ( const ScreenInfos & screenInfos )

pure virtual

Screen infos notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

screenInfos The screen infos.

◆ OnSpeakerListChanged()

virtual void ISettingServiceSink::OnSpeakerListChanged ( const std::vector< Device > & speakers )

pure virtual

Speaker list changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

speakers Speaker list.

◆ OnSpeakerTestingNotification()

virtual void ISettingServiceSink::OnSpeakerTestingNotification	(	int32_t	volume,
		bool	isEnabled
	)

pure virtual

Speaker testing notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

volume	Speaker testing real time volume.
isEnabled	TRUE indicates speaker testing is enabled.

◆ OnSpeakerTestingResult()

virtual void ISettingServiceSink::OnSpeakerTestingResult	(	int32_t	result,
		float	duration,
		bool	isStopped
	)

pure virtual

Speaker testing result.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

result	[0] Success.
duration	Speaker testing duration.
isStopped	TRUE indicates speaker testing is stopped.

◆ OnStatisticalInfoNotification()

virtual void ISettingServiceSink::OnStatisticalInfoNotification ( const StatisticalInfo & info )

pure virtual

Statistical info notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

info	The statistical info.

◆ OnUnbindAllAudioChannelAndCameraConnectionsNotification()

virtual void ISettingServiceSink::OnUnbindAllAudioChannelAndCameraConnectionsNotification ( const std::vector< AudioChannelAndCameraBindInfo > & bindInfoList )

pure virtual

Unbind all audio channel and camera connections notification.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

bindInfoList Updated list of audio channel and camera bindings, see AudioChannelAndCameraBindInfo struct.

◆ OnUnbindAudioChannelAndCameraNotification()

virtual void ISettingServiceSink::OnUnbindAudioChannelAndCameraNotification ( const std::vector< AudioChannelAndCameraBindInfo > & bindInfoList )

pure virtual

Unbind audio channel and camera notification.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

bindInfoList Updated list of audio channel and camera bindings, see AudioChannelAndCameraBindInfo struct.

◆ OnUpdateCOMList()

virtual void ISettingServiceSink::OnUpdateCOMList ( const std::vector< Device > & comList )

pure virtual

COM list changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

comList COM list.

◆ OnUpdatedGenericSettings()

virtual void ISettingServiceSink::OnUpdatedGenericSettings ( const GenericSettings & genericSettings )

pure virtual

Generic settings changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

genericSettings Zoom Room generic settings.

◆ OnUpdateDiagnosticInfo()

virtual void ISettingServiceSink::OnUpdateDiagnosticInfo ( const DiagnosticInfo & info )

pure virtual

Diagnostic info notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

info	The diagnostic info.

◆ OnUpdatedOperationTimeStatusNotification()

virtual void ISettingServiceSink::OnUpdatedOperationTimeStatusNotification ( bool shouldDimScreen )

pure virtual

Operation time status notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

shouldDimScreen TRUE indicates to dim device screen.

◆ OnUpdateHardwareStatus()

virtual void ISettingServiceSink::OnUpdateHardwareStatus ( const HardwareStatus & status )

pure virtual

Hardware status changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Some TV and ZoomRooms Applicance have privacy mute buttons, sync disable status.

Parameters

status Hardware status

◆ OnUpdateMicStethoscopeModeEnabledStatus()

virtual void ISettingServiceSink::OnUpdateMicStethoscopeModeEnabledStatus ( bool isMicStethoscopeModeEnabled )

pure virtual

Update microphone stethoscope mode enabled status notification.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

isMicStethoscopeModeEnabled TRUE indicates microphone stethoscope mode is enabled, otherwise not.

◆ OnUpdateNetworkAudioDeviceList()

virtual void ISettingServiceSink::OnUpdateNetworkAudioDeviceList	(	const std::string &	virtualDeviceID,
		NetworkAudioDeviceListAction	action,
		const std::vector< NetworkAudioDevice > &	networkAudioDeviceList,
		bool	isUsedDanteController
	)

pure virtual

Network audio device list update notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

virtualDeviceID	Virtual device ID
action	List action type, see NetworkAudioDeviceListAction enum.
networkAudioDeviceList	The network audio device list.
isUsedDanteController	TRUE indicates is used Dante controller.

◆ OnUpdateRoomProfileList()

virtual void ISettingServiceSink::OnUpdateRoomProfileList ( const RoomProfileList & list )

pure virtual

Update room profile list.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

list	Room profile list.

◆ OnUpdateZoomRoomCapability()

virtual void ISettingServiceSink::OnUpdateZoomRoomCapability ( const RoomCapability & roomCapability )

pure virtual

Update room capability.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

roomCapability Room capability

◆ OnZoomPresenceScreenSaverNotification()

virtual void ISettingServiceSink::OnZoomPresenceScreenSaverNotification ( bool running )

pure virtual

Room screen saver running notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

running TRUE indicates screen saver is running.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ISettingServiceSink()

Member Function Documentation

◆ OnAdjustScreensResponse()

◆ OnAudioCheckupNotification()

◆ OnAudioSystemFailureNotification()

◆ OnBindAudioChannelAndCameraNotification()

◆ OnCameraBoundaryConfigurationInfoNotification()

◆ OnCameraListChanged()

◆ OnChangeWindowsPasswordNotification()

◆ OnCompanionZRDeviceUpdateNotification()

◆ OnCurrentCameraChanged()

◆ OnCurrentMicrophoneChanged()

◆ OnCurrentMicrophoneVolumeChanged()

◆ OnCurrentSelectedMicrophoneMuted()

◆ OnCurrentSpeakerChanged()

◆ OnCurrentSpeakerVolumeChanged()

◆ OnDirectorCalibrationNotification()

◆ OnIntelligentDirectorInfoNotification()

◆ OnListAudioChannelAndCameraBindInfoNotification()

◆ OnMicrophoneListChanged()

◆ OnMicrophoneRecordingNotification()

◆ OnMicrophoneTestingNotification()

◆ OnNetworkAdapterUpdateInfo()

◆ OnScreenInfosNotification()

◆ OnSpeakerListChanged()

◆ OnSpeakerTestingNotification()

◆ OnSpeakerTestingResult()

◆ OnStatisticalInfoNotification()

◆ OnUnbindAllAudioChannelAndCameraConnectionsNotification()

◆ OnUnbindAudioChannelAndCameraNotification()

◆ OnUpdateCOMList()

◆ OnUpdatedGenericSettings()

◆ OnUpdateDiagnosticInfo()

◆ OnUpdatedOperationTimeStatusNotification()

◆ OnUpdateHardwareStatus()

◆ OnUpdateMicStethoscopeModeEnabledStatus()

◆ OnUpdateNetworkAudioDeviceList()

◆ OnUpdateRoomProfileList()

◆ OnUpdateZoomRoomCapability()

◆ OnZoomPresenceScreenSaverNotification()