Setting service interface. More...

#include <ISettingService.h>

Public Member Functions
virtual	~ISettingService ()

virtual ZRCSDKError	RegisterSink (ISettingServiceSink *pSink)=0
	Register setting service callback sink.

virtual ZRCSDKError	DeregisterSink (ISettingServiceSink *pSink)=0
	Deregister setting service callback sink.

virtual ZRCSDKError	GetMicrophoneList (std::vector< Device > &microphones)=0
	Get microphone list.

virtual ZRCSDKError	GetSpeakerList (std::vector< Device > &speakers)=0
	Get speaker list.

virtual ZRCSDKError	GetCameraList (std::vector< Device > &cameras)=0
	Get camera list.

virtual ZRCSDKError	GetCompanionZRList (std::vector< CompanionZRDeviceInfo > &CZRs)=0
	Get Companion ZR list.

virtual ZRCSDKError	GetNetworkAudioDeviceList (const std::string &virtualDeviceID, std::vector< NetworkAudioDevice > &networkAudioDeviceList)=0
	Get network audio device list.

virtual ZRCSDKError	GetCurrentMicrophone (Device &microphone)=0
	Get current microphone.

virtual ZRCSDKError	GetCurrentSpeaker (Device &speaker)=0
	Get current speaker.

virtual ZRCSDKError	GetCurrentCamera (Device &camera)=0
	Get current camera.

virtual ZRCSDKError	SetCurrentMicrophone (const Device &microphone)=0
	Set current microphone.

virtual ZRCSDKError	SetCurrentSpeaker (const Device &speaker)=0
	Set current speaker.

virtual ZRCSDKError	SetCurrentCamera (const Device &camera)=0
	Set current camera.

virtual ZRCSDKError	GetMicrophoneVolume (float &volume)=0
	Get current microphone volume.

virtual ZRCSDKError	GetSpeakerVolume (float &volume)=0
	Get current speaker volume.

virtual ZRCSDKError	SetMicrophoneVolume (float volume)=0
	Set current microphone volume.

virtual ZRCSDKError	SetSpeakerVolume (float volume)=0
	Set current speaker volume.

virtual ZRCSDKError	SetSpeakerTempVolumeInMeeting (float volume)=0
	Set current speaker volume temperately in current meeting.

virtual ZRCSDKError	TestMicrophone (bool on)=0
	Test microphone record.

virtual ZRCSDKError	StartTestingMicrophoneVolume ()=0
	Start testing microphone volume.

virtual ZRCSDKError	StopTestingMicrophoneVolume ()=0
	Stop testing microphone volume.

virtual ZRCSDKError	ConfirmNumberOfCombinedMicrophone (int32_t number)=0
	Confirm detected microphone number.

virtual ZRCSDKError	IsSupportAcousticEchoCancellation (bool &support)=0
	Query if ZR support acoustic echo cancellation.

virtual ZRCSDKError	EnableAcousticEchoCancellation (bool enable)=0
	Enable acoustic echo cancellation.

virtual ZRCSDKError	IsSupportAdvancedNoiseSuppression (bool &support)=0
	Query if ZR support advanced noise suppression.

virtual ZRCSDKError	GetCurrentAdvancedNoiseSuppressionMode (AdvancedNoiseSuppressionMode &mode)=0
	Get current advanced noise suppression mode.

virtual ZRCSDKError	SelectAdvancedNoiseSuppressionMode (AdvancedNoiseSuppressionMode mode)=0
	Select advanced noise suppression mode.

virtual ZRCSDKError	EnableMicrophoneHardwareTroubleshooting (bool enable)=0
	Enable hardware troubleshooting for the selected microphone.

virtual ZRCSDKError	AudioCheckup (AudioCheckupCommand command)=0
	Audio echo test.

virtual ZRCSDKError	IsAudioFramingAvailable (bool &available)=0
	Query if ZR support audio framing.

virtual ZRCSDKError	EnableAudioFraming (bool enable)=0
	Enable audio framing.

virtual ZRCSDKError	StartTestingSpeaker ()=0
	Start testing speaker.

virtual ZRCSDKError	StopTestingSpeaker ()=0
	Stop testing speaker.

virtual ZRCSDKError	IsSpatialAudioAvailable (bool &available)=0
	Query if ZR support spatial audio.

virtual ZRCSDKError	EnableSpatialAudio (bool enable)=0
	Enable spatial audio. Requires stereo loudspeaker hardware.

virtual ZRCSDKError	SelectMultipleCamera (const std::string &deviceID, bool isSelected, const std::string &companionZRID="")=0
	Select multiple camera.

virtual ZRCSDKError	SelectIntelligentDirectorCamera (const std::string &deviceID, bool isSelected)=0
	Select director camera.

virtual ZRCSDKError	CalibrateIntelligentDirectorMode (CalibrationAction actionType, const std::string &deviceID="", CameraBoundaryAdjustField boundaryAdjustField=CameraBoundaryAdjustFieldUnknown, int32_t boundaryAdjustValue=0)=0
	Director calibrate.

virtual ZRCSDKError	SetCameraCOMId (const std::string &deviceID, int32_t comID, const std::string &companionZRID="")=0
	Set camera com ID.

virtual ZRCSDKError	SetCameraDisplayName (const std::string &deviceID, const std::string &displayName, const std::string &companionZRID="")=0
	Set camera display name.

virtual ZRCSDKError	SelectRoomProfile (const std::string &profileID, const std::string &profileName)=0
	Select room profile.

virtual ZRCSDKError	EnableStatisticalInfo (bool enable)=0
	Enable statistical info.

virtual ZRCSDKError	StartAdjustZRScreens ()=0
	Start to adjust zoom room screens.

virtual ZRCSDKError	StartOverAdjustZRScreens ()=0
	Start over adjust zoom room screens.

virtual ZRCSDKError	IdentifyZRConfidenceMonitor (int32_t positionOfConfidenceMonitor)=0
	Identify ZR confidence monitor, select a screen position to use as ZR confidence monitor.

virtual ZRCSDKError	IdentifyZRScreens (int32_t currentScreen, int32_t positionOfCurrentScreen)=0
	Identify zoom room screens.

virtual ZRCSDKError	ConfirmAdjustZRScreens ()=0
	Confirm adjust zoom room screens.

virtual ZRCSDKError	CancelAdjustZRScreens ()=0
	Cancel adjust zoom room screens.

virtual ZRCSDKError	TurnCECScreensOn (bool on)=0
	Turn CEC screen on.

virtual ZRCSDKError	RefreshDiagnosticInfo ()=0
	Manual refresh diagnostic info.

virtual ZRCSDKError	GetWindowsIoTAccountName (std::string &osAccountName)=0
	Get Windows IoT account name.

virtual ZRCSDKError	ChangeWindowsPassword (const std::string &oldPassword, const std::string &newPassword)=0
	Change windows password.

virtual ZRCSDKError	ListVirtualAudioDevices (const std::string &virtualDeviceID, VirtualAudioDeviceType deviceType)=0
	List virtual audio device.

virtual ZRCSDKError	SelectVirtualAudioDevice (const std::string &virtualDeviceID, VirtualAudioDeviceType deviceType, const std::string &networkDeviceID, const NetworkAudioChannelInfo &channel)=0
	Select virtual audio device.

virtual ZRCSDKError	UnselectVirtualAudioDevice (const std::string &virtualDeviceID, VirtualAudioDeviceType deviceType, const std::string &networkDeviceID, const NetworkAudioChannelInfo &channel)=0
	Unselect virtual audio device.

virtual ZRCSDKError	IdentifyVirtualAudioDevice (const std::string &virtualDeviceID, VirtualAudioDeviceType deviceType, const std::string &networkDeviceID)=0
	Identify virtual audio device.

virtual ZRCSDKError	UseDanteController (const std::string &virtualDeviceID, VirtualAudioDeviceType deviceType, bool isUsedDanteController)=0
	Use Dante controller.

virtual ZRCSDKError	IsUseDanteController (const std::string &virtualDeviceID, bool &isUseDanteController)=0
	Query if virtual audio device use Dante controller.

virtual ZRCSDKError	RenameCompanionZR (const std::string &czrID, const std::string &displayName)=0
	Rename CompanionZR.

virtual ZRCSDKError	GetNetWorkAdapterInfo (std::vector< NetworkAdapterInfo > &networkAdapterInfos)=0
	Get network adapter info.

virtual ICalibrationHelper *	GetCalibrationHelper ()=0
	Get the calibration helper.

Detailed Description

Setting service interface.

Definition at line 806 of file ISettingService.h.

Constructor & Destructor Documentation

◆ ~ISettingService()

virtual ISettingService::~ISettingService ( )

inlinevirtual

Definition at line 809 of file ISettingService.h.

809{}

Member Function Documentation

◆ AudioCheckup()

virtual ZRCSDKError ISettingService::AudioCheckup ( AudioCheckupCommand command )

pure virtual

Audio echo test.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

command See AudioCheckupCommand enum.

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

◆ CalibrateIntelligentDirectorMode()

virtual ZRCSDKError ISettingService::CalibrateIntelligentDirectorMode	(	CalibrationAction	actionType,
		const std::string &	deviceID = `""`,
		CameraBoundaryAdjustField	boundaryAdjustField = `CameraBoundaryAdjustFieldUnknown`,
		int32_t	boundaryAdjustValue = `0`
	)

pure virtual

Director calibrate.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Director calibrate work flow:

Page change:
    CalibrationActionPageAdjustCamera   --> CalibrationActionPageReadyToMove
    CalibrationActionPageAdjustCamera  <--> CalibrationActionPageCameraControl

Start the director calibration process:         actionType = CalibrationActionPageAdjustCamera.
In CalibrationActionPageAdjustCamera  page:     You can select the camera which you want to adjust(actionType = CalibrationActionPageCameraControl && deviceId = cameraID), and page will change to CalibrationActionPageCameraControl. If the cameras adjustment completed or the cameras don't need to adjust, you can change the page to CalibrationActionPageReadyToMove(actionType = CalibrationActionPageReadyToMove).
In CalibrationActionPageCameraControl page:     You can adjust the camera position using the \link ControlLocalCamera \endlink API. After adjusting the camera position, you need to return to CalibrationActionPageAdjustCamera page(actionType = CalibrationActionPageReadyToMove).
In CalibrationActionPageReadyToMove   page:     You can start the calibration(actionType = CalibrationActionEventStartToCalibrate), then you need to move and make sure the face appears in both cameras at the same time. After moving, you can finish moving(actionType = CalibrationActionEventFinishToCheckResult).
If director calibration successes, you can accept the result(actionType = CalibrationActionEventAcceptResult), otherwise you can adjust the cameras and start calibrate again.
And When you don't want to continue the calibration, you can stop the calibration(actionType = CalibrationActionEventStop).

Parameters

actionType	Action type, see CalibrationAction enum.
deviceID	Camera device ID. Only need when actionType is CalibrationActionPageCameraControl.
boundaryAdjustField	The field which you want to adjust, such as CameraBoundaryAdjustField.
boundaryAdjustValue	The value of the field. The range is [0, 100] when the filed is Left or Right. The range is [50, 150] when the field is Depth.

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

◆ CancelAdjustZRScreens()

virtual ZRCSDKError ISettingService::CancelAdjustZRScreens ( )

pure virtual

Cancel adjust zoom room screens.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ ChangeWindowsPassword()

virtual ZRCSDKError ISettingService::ChangeWindowsPassword	(	const std::string &	oldPassword,
		const std::string &	newPassword
	)

pure virtual

Change windows password.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

oldPassword	Windows old password.
newPassword	Windows new password.

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

◆ ConfirmAdjustZRScreens()

virtual ZRCSDKError ISettingService::ConfirmAdjustZRScreens ( )

pure virtual

Confirm adjust zoom room screens.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ ConfirmNumberOfCombinedMicrophone()

virtual ZRCSDKError ISettingService::ConfirmNumberOfCombinedMicrophone ( int32_t number )

pure virtual

Confirm detected microphone number.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

number The detected microphones' number.

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

◆ DeregisterSink()

virtual ZRCSDKError ISettingService::DeregisterSink ( ISettingServiceSink * pSink )

pure virtual

Deregister setting service callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the ISettingServiceSink that receives the setting service callback.

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

◆ EnableAcousticEchoCancellation()

virtual ZRCSDKError ISettingService::EnableAcousticEchoCancellation ( bool enable )

pure virtual

Enable acoustic echo cancellation.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

enable TRUE indicates to enable. Otherwise disable.

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

◆ EnableAudioFraming()

virtual ZRCSDKError ISettingService::EnableAudioFraming ( bool enable )

pure virtual

Enable audio framing.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Suppress audio outside a 60° arc in front of the device. Participants must be within this arc to be heard. Use this feature in noisy open plan offices and avoid enabling it in regular Zoom Rooms.

Parameters

enable TRUE indicates to enable. Otherwise disable.

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

◆ EnableMicrophoneHardwareTroubleshooting()

virtual ZRCSDKError ISettingService::EnableMicrophoneHardwareTroubleshooting ( bool enable )

pure virtual

Enable hardware troubleshooting for the selected microphone.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

enable TRUE indicates to enable. Otherwise disable.

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

◆ EnableSpatialAudio()

virtual ZRCSDKError ISettingService::EnableSpatialAudio ( bool enable )

pure virtual

Enable spatial audio. Requires stereo loudspeaker hardware.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

enable TRUE indicates to enable. Otherwise disable.

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

◆ EnableStatisticalInfo()

virtual ZRCSDKError ISettingService::EnableStatisticalInfo ( bool enable )

pure virtual

Enable statistical info.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

enable TRUE indicates to enable. Otherwise disable.

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

◆ GetCalibrationHelper()

virtual ICalibrationHelper * ISettingService::GetCalibrationHelper ( )

pure virtual

Get the calibration helper.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Returns: If the function succeeds, the return value is a pointer to ICalibrationHelper. Otherwise the function returns NULL.

◆ GetCameraList()

virtual ZRCSDKError ISettingService::GetCameraList ( std::vector< Device > & cameras )

pure virtual

Get camera list.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] cameras Camera list.

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

◆ GetCompanionZRList()

virtual ZRCSDKError ISettingService::GetCompanionZRList ( std::vector< CompanionZRDeviceInfo > & CZRs )

pure virtual

Get Companion ZR list.

Since: 6.2.0

Zoom Rooms minimum version: 6.2.0

Parameters

[out] CZRs Companion ZR list.

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

◆ GetCurrentAdvancedNoiseSuppressionMode()

virtual ZRCSDKError ISettingService::GetCurrentAdvancedNoiseSuppressionMode ( AdvancedNoiseSuppressionMode & mode )

pure virtual

Get current advanced noise suppression mode.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] mode Current advanced noise suppression mode.

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

◆ GetCurrentCamera()

virtual ZRCSDKError ISettingService::GetCurrentCamera ( Device & camera )

pure virtual

Get current camera.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] camera Current using camera.

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

◆ GetCurrentMicrophone()

virtual ZRCSDKError ISettingService::GetCurrentMicrophone ( Device & microphone )

pure virtual

Get current microphone.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] microphone Current using microphone.

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

◆ GetCurrentSpeaker()

virtual ZRCSDKError ISettingService::GetCurrentSpeaker ( Device & speaker )

pure virtual

Get current speaker.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] speaker Current using speaker.

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

◆ GetMicrophoneList()

virtual ZRCSDKError ISettingService::GetMicrophoneList ( std::vector< Device > & microphones )

pure virtual

Get microphone list.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] microphones Microphone list.

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

◆ GetMicrophoneVolume()

virtual ZRCSDKError ISettingService::GetMicrophoneVolume ( float & volume )

pure virtual

Get current microphone volume.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] volume Microphone volume.

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

◆ GetNetWorkAdapterInfo()

virtual ZRCSDKError ISettingService::GetNetWorkAdapterInfo ( std::vector< NetworkAdapterInfo > & networkAdapterInfos )

pure virtual

Get network adapter info.

Since: 6.3.0

Zoom Rooms minimum version: 6.3.0

Parameters

[out] networkAdapterInfos network adapter info list.

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

◆ GetNetworkAudioDeviceList()

virtual ZRCSDKError ISettingService::GetNetworkAudioDeviceList	(	const std::string &	virtualDeviceID,
		std::vector< NetworkAudioDevice > &	networkAudioDeviceList
	)

pure virtual

Get network audio device list.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

You need to ListVirtualAudioDevices first before query the list.

Parameters

[in]	virtualDeviceID	Specify the virtual device ID.
[out]	networkAudioDeviceList	Camera list.

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

◆ GetSpeakerList()

virtual ZRCSDKError ISettingService::GetSpeakerList ( std::vector< Device > & speakers )

pure virtual

Get speaker list.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] speakers Speaker list.

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

◆ GetSpeakerVolume()

virtual ZRCSDKError ISettingService::GetSpeakerVolume ( float & volume )

pure virtual

Get current speaker volume.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] volume Speaker volume.

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

◆ GetWindowsIoTAccountName()

virtual ZRCSDKError ISettingService::GetWindowsIoTAccountName ( std::string & osAccountName )

pure virtual

Get Windows IoT account name.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] osAccountName IoT account name.

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

◆ IdentifyVirtualAudioDevice()

virtual ZRCSDKError ISettingService::IdentifyVirtualAudioDevice	(	const std::string &	virtualDeviceID,
		VirtualAudioDeviceType	deviceType,
		const std::string &	networkDeviceID
	)

pure virtual

Identify virtual audio device.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

virtualDeviceID	The virtual device ID
deviceType	The virtual audio device type.
networkDeviceID	The network device device ID.

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

◆ IdentifyZRConfidenceMonitor()

virtual ZRCSDKError ISettingService::IdentifyZRConfidenceMonitor ( int32_t positionOfConfidenceMonitor )

pure virtual

Identify ZR confidence monitor, select a screen position to use as ZR confidence monitor.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

positionOfConfidenceMonitor Position, cannot set main display position. Range [2, quantityOfScreens]

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

◆ IdentifyZRScreens()

virtual ZRCSDKError ISettingService::IdentifyZRScreens	(	int32_t	currentScreen,
		int32_t	positionOfCurrentScreen
	)

pure virtual

Identify zoom room screens.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

currentScreen	Current in adjust screen.
positionOfCurrentScreen	The position you want to set as current screen. Range [1, quantityOfScreens]

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

◆ IsAudioFramingAvailable()

virtual ZRCSDKError ISettingService::IsAudioFramingAvailable ( bool & available )

pure virtual

Query if ZR support audio framing.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] available TRUE indicates ZR supports audio framing. Otherwise not.

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

◆ IsSpatialAudioAvailable()

virtual ZRCSDKError ISettingService::IsSpatialAudioAvailable ( bool & available )

pure virtual

Query if ZR support spatial audio.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] available TRUE indicates ZR supports spatial audio. Otherwise not.

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

◆ IsSupportAcousticEchoCancellation()

virtual ZRCSDKError ISettingService::IsSupportAcousticEchoCancellation ( bool & support )

pure virtual

Query if ZR support acoustic echo cancellation.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] support TRUE indicates support. Otherwise disable.

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

◆ IsSupportAdvancedNoiseSuppression()

virtual ZRCSDKError ISettingService::IsSupportAdvancedNoiseSuppression ( bool & support )

pure virtual

Query if ZR support advanced noise suppression.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] support TRUE indicates support. Otherwise disable.

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

◆ IsUseDanteController()

virtual ZRCSDKError ISettingService::IsUseDanteController	(	const std::string &	virtualDeviceID,
		bool &	isUseDanteController
	)

pure virtual

Query if virtual audio device use Dante controller.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[in]	virtualDeviceID	Specify the virtual device ID
[out]	isUseDanteController	TRUE indicates virtual audio device uses Dante controller

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

◆ ListVirtualAudioDevices()

virtual ZRCSDKError ISettingService::ListVirtualAudioDevices	(	const std::string &	virtualDeviceID,
		VirtualAudioDeviceType	deviceType
	)

pure virtual

List virtual audio device.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

virtualDeviceID	The virtual device ID
deviceType	The virtual audio device type.

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

◆ RefreshDiagnosticInfo()

virtual ZRCSDKError ISettingService::RefreshDiagnosticInfo ( )

pure virtual

Manual refresh diagnostic info.

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 ISettingService::RegisterSink ( ISettingServiceSink * pSink )

pure virtual

Register setting service callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the ISettingServiceSink that receives the setting service callback.

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

◆ RenameCompanionZR()

virtual ZRCSDKError ISettingService::RenameCompanionZR	(	const std::string &	czrID,
		const std::string &	displayName
	)

pure virtual

Rename CompanionZR.

Since: 6.2.0

Zoom Rooms minimum version: 6.2.0

Parameters

czrID	CompanionZR ID
displayName	Specify the CompanionZR name.

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

◆ SelectAdvancedNoiseSuppressionMode()

virtual ZRCSDKError ISettingService::SelectAdvancedNoiseSuppressionMode ( AdvancedNoiseSuppressionMode mode )

pure virtual

Select advanced noise suppression mode.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

mode	See AdvancedNoiseSuppressionMode enum.

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

Changelog

6.3.5: May be unavailable while enable HIFI mode in some vendor device since zr 6.3.0

◆ SelectIntelligentDirectorCamera()

virtual ZRCSDKError ISettingService::SelectIntelligentDirectorCamera	(	const std::string &	deviceID,
		bool	isSelected
	)

pure virtual

Select director camera.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

deviceID	Camera device ID.
isSelected	TRUE indicates to select the camera as director camera.

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

Changelog

6.4.0: Added a restriction preventing an NDI camera that is currently being shared from being selected as the intelligent director camera.

◆ SelectMultipleCamera()

virtual ZRCSDKError ISettingService::SelectMultipleCamera	(	const std::string &	deviceID,
		bool	isSelected,
		const std::string &	companionZRID = `""`
	)

pure virtual

Select multiple camera.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

deviceID	Camera device ID.
isSelected	TRUE indicates to select the camera as multiple camera.
companionZRID	Specify the CZR ID if you want to control CZR's camera.

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

Changelog

6.4.0: Added a restriction preventing an NDI camera that is currently being shared from being selected as the multiple camera.

◆ SelectRoomProfile()

virtual ZRCSDKError ISettingService::SelectRoomProfile	(	const std::string &	profileID,
		const std::string &	profileName
	)

pure virtual

Select room profile.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

profileID	The room profile ID
profileName	The room profile name

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

◆ SelectVirtualAudioDevice()

virtual ZRCSDKError ISettingService::SelectVirtualAudioDevice	(	const std::string &	virtualDeviceID,
		VirtualAudioDeviceType	deviceType,
		const std::string &	networkDeviceID,
		const NetworkAudioChannelInfo &	channel
	)

pure virtual

Select virtual audio device.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

virtualDeviceID	The virtual device ID
deviceType	The virtual audio device type.
networkDeviceID	The network device device ID.
channel	Specify the channel info to select. If channel is default struct, this API will select one of the virtual audio device's channel.

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

◆ SetCameraCOMId()

virtual ZRCSDKError ISettingService::SetCameraCOMId	(	const std::string &	deviceID,
		int32_t	comID,
		const std::string &	companionZRID = `""`
	)

pure virtual

Set camera com ID.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

deviceID	Camera device ID.
comID	com ID. You can get com id from OnUpdateCOMList sink. If you want to restore after you have already set COM ID, you can set com id to -1. When set camera com id in companion zr, you should find com id in comDeviceList in CompanionZRDeviceInfo struct.
companionZRID	Specify the CZR ID if you want to control CZR's camera.

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

◆ SetCameraDisplayName()

virtual ZRCSDKError ISettingService::SetCameraDisplayName	(	const std::string &	deviceID,
		const std::string &	displayName,
		const std::string &	companionZRID = `""`
	)

pure virtual

Set camera display name.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

deviceID	Camera device ID.
displayName	Specify the camera display name.
companionZRID	Specify the CZR ID if you want to control CZR's camera.

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

◆ SetCurrentCamera()

virtual ZRCSDKError ISettingService::SetCurrentCamera ( const Device & camera )

pure virtual

Set current camera.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

camera Specify the camera to use.

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

Changelog

6.4.0: Added a restriction preventing an NDI camera that is currently being shared from being selected as the main camera.

◆ SetCurrentMicrophone()

virtual ZRCSDKError ISettingService::SetCurrentMicrophone ( const Device & microphone )

pure virtual

Set current microphone.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

microphone Specify the microphone to use.

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

◆ SetCurrentSpeaker()

virtual ZRCSDKError ISettingService::SetCurrentSpeaker ( const Device & speaker )

pure virtual

Set current speaker.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

speaker Specify the speaker to use.

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

◆ SetMicrophoneVolume()

virtual ZRCSDKError ISettingService::SetMicrophoneVolume ( float volume )

pure virtual

Set current microphone volume.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

volume Specify the volume to set.

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

◆ SetSpeakerTempVolumeInMeeting()

virtual ZRCSDKError ISettingService::SetSpeakerTempVolumeInMeeting ( float volume )

pure virtual

Set current speaker volume temperately in current meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

When meeting ends, speaker volume will fall back to the original volume.

Parameters

volume Specify the volume to set.

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

◆ SetSpeakerVolume()

virtual ZRCSDKError ISettingService::SetSpeakerVolume ( float volume )

pure virtual

Set current speaker volume.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

volume Specify the volume to set.

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

◆ StartAdjustZRScreens()

virtual ZRCSDKError ISettingService::StartAdjustZRScreens ( )

pure virtual

Start to adjust zoom room screens.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

If ZR has confidence monitor, always first adjust confidence monitor, then adjust ZR screens.

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

◆ StartOverAdjustZRScreens()

virtual ZRCSDKError ISettingService::StartOverAdjustZRScreens ( )

pure virtual

Start over adjust zoom room screens.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

If ZR has confidence monitor, always first adjust confidence monitor, then adjust ZR screens.

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

◆ StartTestingMicrophoneVolume()

virtual ZRCSDKError ISettingService::StartTestingMicrophoneVolume ( )

pure virtual

Start testing microphone volume.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ StartTestingSpeaker()

virtual ZRCSDKError ISettingService::StartTestingSpeaker ( )

pure virtual

Start testing speaker.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ StopTestingMicrophoneVolume()

virtual ZRCSDKError ISettingService::StopTestingMicrophoneVolume ( )

pure virtual

Stop testing microphone volume.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ StopTestingSpeaker()

virtual ZRCSDKError ISettingService::StopTestingSpeaker ( )

pure virtual

Stop testing speaker.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ TestMicrophone()

virtual ZRCSDKError ISettingService::TestMicrophone ( bool on )

pure virtual

Test microphone record.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

on	TRUE indicates to start testing microphone record.

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

◆ TurnCECScreensOn()

virtual ZRCSDKError ISettingService::TurnCECScreensOn ( bool on )

pure virtual

Turn CEC screen on.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

on	TRUE indicates to turn on. Otherwise to turn off.

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

◆ UnselectVirtualAudioDevice()

virtual ZRCSDKError ISettingService::UnselectVirtualAudioDevice	(	const std::string &	virtualDeviceID,
		VirtualAudioDeviceType	deviceType,
		const std::string &	networkDeviceID,
		const NetworkAudioChannelInfo &	channel
	)

pure virtual

Unselect virtual audio device.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

virtualDeviceID	The virtual device ID
deviceType	The virtual audio device type.
networkDeviceID	The network device device ID.
channel	Specify the channel info to unselect. If channel is default, this API will unselect all the virtual audio device's channels.

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

◆ UseDanteController()

virtual ZRCSDKError ISettingService::UseDanteController	(	const std::string &	virtualDeviceID,
		VirtualAudioDeviceType	deviceType,
		bool	isUsedDanteController
	)

pure virtual

Use Dante controller.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Toggle this option is only available for VirtualAudioDeviceTypeMicrophone, for VirtualAudioDeviceTypeSpeaker isUsedDanteController always should be TRUE.

Parameters

virtualDeviceID	The virtual device ID
deviceType	The virtual audio device type.
isUsedDanteController	TRUE indicates to use Dante controller.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ISettingService()

Member Function Documentation

◆ AudioCheckup()

◆ CalibrateIntelligentDirectorMode()

◆ CancelAdjustZRScreens()

◆ ChangeWindowsPassword()

◆ ConfirmAdjustZRScreens()

◆ ConfirmNumberOfCombinedMicrophone()

◆ DeregisterSink()

◆ EnableAcousticEchoCancellation()

◆ EnableAudioFraming()

◆ EnableMicrophoneHardwareTroubleshooting()

◆ EnableSpatialAudio()

◆ EnableStatisticalInfo()

◆ GetCalibrationHelper()

◆ GetCameraList()

◆ GetCompanionZRList()

◆ GetCurrentAdvancedNoiseSuppressionMode()

◆ GetCurrentCamera()

◆ GetCurrentMicrophone()

◆ GetCurrentSpeaker()

◆ GetMicrophoneList()

◆ GetMicrophoneVolume()

◆ GetNetWorkAdapterInfo()

◆ GetNetworkAudioDeviceList()

◆ GetSpeakerList()

◆ GetSpeakerVolume()

◆ GetWindowsIoTAccountName()

◆ IdentifyVirtualAudioDevice()

◆ IdentifyZRConfidenceMonitor()

◆ IdentifyZRScreens()

◆ IsAudioFramingAvailable()

◆ IsSpatialAudioAvailable()

◆ IsSupportAcousticEchoCancellation()

◆ IsSupportAdvancedNoiseSuppression()

◆ IsUseDanteController()

◆ ListVirtualAudioDevices()

◆ RefreshDiagnosticInfo()

◆ RegisterSink()

◆ RenameCompanionZR()

◆ SelectAdvancedNoiseSuppressionMode()

◆ SelectIntelligentDirectorCamera()

◆ SelectMultipleCamera()

◆ SelectRoomProfile()

◆ SelectVirtualAudioDevice()

◆ SetCameraCOMId()

◆ SetCameraDisplayName()

◆ SetCurrentCamera()

◆ SetCurrentMicrophone()

◆ SetCurrentSpeaker()

◆ SetMicrophoneVolume()

◆ SetSpeakerTempVolumeInMeeting()

◆ SetSpeakerVolume()

◆ StartAdjustZRScreens()

◆ StartOverAdjustZRScreens()

◆ StartTestingMicrophoneVolume()

◆ StartTestingSpeaker()

◆ StopTestingMicrophoneVolume()

◆ StopTestingSpeaker()

◆ TestMicrophone()

◆ TurnCECScreensOn()

◆ UnselectVirtualAudioDevice()

◆ UseDanteController()