Zoom Rooms Controller SDK Reference 7.1.0
Loading...
Searching...
No Matches
ISettingService.h
Go to the documentation of this file.
1
8#ifndef ZRC_ISETTINGSERVICE_H
9#define ZRC_ISETTINGSERVICE_H
10
11#include "ZRCSDKTypes.h"
12
14
16
22{
25};
26
32{
40};
41
47{
52};
53
59{
63};
64
70{
73};
74
80{
88};
89
95{
100};
101
107{
112 NetworkType3G = 3
114
120{
124};
125
131{
136};
137
143{
151
157{
166
172{
176};
177
183{
189
194{
199};
200
204{
205 uint32_t sampleRate = 0xffffffff;
206 std::vector<uint32_t> recSampleRates;
207};
208
212{
213 uint32_t fpsOfRecvMaxVideo = 0xffffffff;
214 uint32_t widthOfMaxRecvVideo = 0xffffffff;
215 uint32_t heightOfMaxRecvVideo = 0xffffffff;
216 uint32_t resolutionOfSend = 0xffffffff;
217 uint64_t fpsOfSend = 0xffffffff;
218};
219
223{
224 uint32_t fpsOfRecvShare = 0xffffffff;
225 uint32_t widthOfRecvShare = 0xffffffff;
226 uint32_t heightOfRecvShare = 0xffffffff;
227 uint32_t resolutionOfSend = 0xffffffff;
228 uint64_t fpsOfSend = 0xffffffff;
229};
230
234{
238};
239
243{
244 uint32_t avgLossRatio = 0xffffffff;
245 uint32_t maxLossRatio = 0xffffffff;
246 uint32_t rtt = 0xffffffff;
247 uint32_t jitter = 0xffffffff;
248 uint32_t rate = 0xffffffff;
249};
250
254{
258};
259
263{
264 std::string name;
265 std::string driverVersion;
266 int32_t utilization = 0;
268};
269
273{
274 int32_t cpuCoreNumber = 0;
275 float cpuFrequency = 0.0f;
276 int32_t cpuZRUsage = 0;
277 int32_t cpuOverallUsage = 0;
278 int32_t memorySize = 0;
279 int32_t memoryZRUsage = 0;
280 int32_t memoryOverallUsage = 0;
282 std::string proxy;
285 std::string encryption;
286 int32_t storageTotalMB = 0;
287 int32_t storageUsedMB = 0;
289 std::vector<StatisticalGPUInfo> gpuInfoList;
290};
291
295{
296 uint32_t packetsNumber = 0;
297 uint32_t frequency = 0;
298 float packetLoss = 0.0f;
299 float packetLossMax = 0.0f;
300 uint32_t jitter = 0;
301 float bandwidth = 0.0f;
302 std::string codec;
303};
304
308{
309 std::string peerNumber;
310 std::string localIp;
311 uint32_t localPort = 0;
312 std::string remoteIp;
313 uint32_t remotePort = 0;
314 uint32_t networkDelay = 0;
317};
318
322{
323 std::string registerId;
324 std::string registerServerIp;
325 uint32_t registerServerPort = 0;
326 std::string networkSwitch;
328 std::vector<StatisticalPhonePeerInfo> phonePeers;
329};
330
334{
335 std::string field;
336 std::string
338};
339
343{
344 std::string name;
345 std::vector<DiagnosticMsg> msgs;
346};
347
351{
352 std::vector<DiagnosticMsgGroup> groups;
353};
354
358{
364};
365
369{
375 int32_t aecLevel = -1;
376 std::string testTime;
377};
378
382{
383 std::string ID;
384 std::string name;
385 bool isSelected = false;
386 std::vector<int32_t> issueDevices;
387};
388
392{
393 std::vector<RoomProfile> roomProfileList;
394};
395
399{
400 bool supportAutoLoginOS = false;
401 bool supportRestartOS = false;
404};
405
409{
410 int32_t result = 0;
411 int32_t currentScreen = -1;
412 int32_t quantityOfScreens= -1;
414};
415
419{
420 int32_t quantityOfScreens = 1;
422 bool hasConfidenceMonitor = false;
424};
425
431{
439
440 // boundary
448};
449
453{
456 std::string deviceId;
457 std::string channelName;
458};
459
463{
465 std::vector<NetworkAudioChannelInfo> channels;
466 std::string ID;
467 std::string name;
468 bool identifiable = false;
469};
470
474{
475 std::string cameraDeviceID;
476 std::string networkDeviceName;
477 std::string networkChannelName;
478 int32_t rxChannelID = 0;
479};
480
484{
485 bool supportsDirectorMode = false;
488 bool isRegionLimited = false;
492};
493
497{
498 bool supportsBoundary = false;
499 bool isBoundaryConfigured = false;
502};
503
507{
509 std::string adapter;
510 std::string ip;
511};
512
516{
517 bool isSessionStarted = false;
518 bool isPlaybackMuted = false;
519};
520
524{
526 bool enable = false;
528};
529
533{
534public:
536
545 virtual void OnMicrophoneListChanged(const std::vector<Device>& microphones) = 0;
546
555 virtual void OnSpeakerListChanged(const std::vector<Device>& speakers) = 0;
556
565 virtual void OnCameraListChanged(const std::vector<Device>& cameras) = 0;
566
575 virtual void OnUpdateCOMList(const std::vector<Device>& comList) = 0;
576
586
596 virtual void OnCurrentMicrophoneChanged(bool exist, const Device& microphone) = 0;
597
607 virtual void OnCurrentSpeakerChanged(bool exist, const Device& speaker) = 0;
608
618 virtual void OnCurrentCameraChanged(bool exist, const Device& camera) = 0;
619
628 virtual void OnCurrentMicrophoneVolumeChanged(float volume) = 0;
629
638 virtual void OnCurrentSpeakerVolumeChanged(float volume) = 0;
639
650 virtual void OnUpdateHardwareStatus(const HardwareStatus& status) = 0;
651
660 virtual void OnUpdatedGenericSettings(const GenericSettings& genericSettings) = 0;
661
670 virtual void OnUpdateVoiceCommandStatus(const VoiceCommandStatus& status) = 0;
671
680 virtual void OnUpdateRoomProfileList(const RoomProfileList& list) = 0;
681
690 virtual void OnUpdateZoomRoomCapability(const RoomCapability& roomCapability) = 0;
691
700 virtual void OnCurrentSelectedMicrophoneMuted(bool muted) = 0;
701
710 virtual void OnMicrophoneTestingNotification(int32_t volume) = 0;
711
721
731 virtual void OnSpeakerTestingNotification(int32_t volume, bool isEnabled) = 0;
732
743 virtual void OnSpeakerTestingResult(int32_t result, float duration, bool isStopped) = 0;
744
753 virtual void OnStatisticalInfoNotification(const StatisticalInfo& info) = 0;
754
763 virtual void OnAudioCheckupNotification(const AudioCheckupInfo& info) = 0;
764
773 virtual void OnAudioSystemFailureNotification(bool isDismiss) = 0;
774
783 virtual void OnScreenInfosNotification(const ScreenInfos& screenInfos) = 0;
784
793 virtual void OnAdjustScreensResponse(const AdjustScreensRes& response) = 0;
794
803 virtual void OnZoomPresenceScreenSaverNotification(bool running) = 0;
804
813 virtual void OnUpdatedOperationTimeStatusNotification(bool shouldDimScreen) = 0;
814
824
834
844
853 virtual void OnUpdateDiagnosticInfo(const DiagnosticInfo& info) = 0;
854
863 virtual void OnChangeWindowsPasswordNotification(int32_t result) = 0;
864
876 virtual void OnUpdateNetworkAudioDeviceList(const std::string& virtualDeviceID, NetworkAudioDeviceListAction action,
877 const std::vector<NetworkAudioDevice>& networkAudioDeviceList, bool isUsedDanteController) = 0;
878
887 virtual void OnListAudioChannelAndCameraBindInfoNotification(const std::vector<AudioChannelAndCameraBindInfo>& bindInfoList) = 0;
888
897 virtual void OnBindAudioChannelAndCameraNotification(const std::vector<AudioChannelAndCameraBindInfo>& bindInfoList) = 0;
898
907 virtual void OnUnbindAudioChannelAndCameraNotification(const std::vector<AudioChannelAndCameraBindInfo>& bindInfoList) = 0;
908
917 virtual void OnUnbindAllAudioChannelAndCameraConnectionsNotification(const std::vector<AudioChannelAndCameraBindInfo>& bindInfoList) = 0;
918
927 virtual void OnNetworkAdapterUpdateInfo(const std::vector<NetworkAdapterInfo>& networkAdapterInfos) = 0;
928
937 virtual void OnUpdateMicStethoscopeModeEnabledStatus(bool isMicStethoscopeModeEnabled) = 0;
938
948};
949
953{
954public:
955 virtual ~ISettingService() {}
956
968
980
991 virtual ZRCSDKError GetMicrophoneList(std::vector<Device>& microphones) = 0;
992
1003 virtual ZRCSDKError GetSpeakerList(std::vector<Device>& speakers) = 0;
1004
1015 virtual ZRCSDKError GetCameraList(std::vector<Device>& cameras) = 0;
1016
1027 virtual ZRCSDKError GetCompanionZRList(std::vector<CompanionZRDeviceInfo>& CZRs) = 0;
1028
1042 virtual ZRCSDKError GetNetworkAudioDeviceList(const std::string& virtualDeviceID, std::vector<NetworkAudioDevice>& networkAudioDeviceList) = 0;
1043
1054 virtual ZRCSDKError GetCurrentMicrophone(Device& microphone) = 0;
1055
1066 virtual ZRCSDKError GetCurrentSpeaker(Device& speaker) = 0;
1067
1079
1090 virtual ZRCSDKError SetCurrentMicrophone(const Device& microphone) = 0;
1091
1102 virtual ZRCSDKError SetCurrentSpeaker(const Device& speaker) = 0;
1103
1117 virtual ZRCSDKError SetCurrentCamera(const Device& camera) = 0;
1118
1129 virtual ZRCSDKError GetMicrophoneVolume(float& volume) = 0;
1130
1141 virtual ZRCSDKError GetSpeakerVolume(float& volume) = 0;
1142
1153 virtual ZRCSDKError SetMicrophoneVolume(float volume) = 0;
1154
1165 virtual ZRCSDKError SetSpeakerVolume(float volume) = 0;
1166
1183
1184 // microphone
1185
1196 virtual ZRCSDKError TestMicrophone(bool on) = 0;
1197
1208
1219
1231
1243
1258
1270
1282
1298
1310
1322
1333 virtual ZRCSDKError IsAudioFramingAvailable(bool& available) = 0;
1334
1347 virtual ZRCSDKError EnableAudioFraming(bool enable) = 0;
1348
1359 virtual ZRCSDKError EnableVoiceCommand(bool enable) = 0;
1360
1371
1383
1384 // speaker
1385
1396
1407
1418 virtual ZRCSDKError IsSpatialAudioAvailable(bool& available) = 0;
1419
1430 virtual ZRCSDKError EnableSpatialAudio(bool enable) = 0;
1431
1432 // camera
1433
1449 virtual ZRCSDKError SelectMultipleCamera(const std::string& deviceID, bool isSelected, const std::string& companionZRID = "") = 0;
1450
1465 virtual ZRCSDKError SelectIntelligentDirectorCamera(const std::string& deviceID, bool isSelected) = 0;
1466
1493 virtual ZRCSDKError CalibrateIntelligentDirectorMode(CalibrationAction actionType, const std::string& deviceID = "", CameraBoundaryAdjustField boundaryAdjustField = CameraBoundaryAdjustFieldUnknown, int32_t boundaryAdjustValue = 0) = 0;
1494
1507 virtual ZRCSDKError SetCameraCOMId(const std::string& deviceID, int32_t comID, const std::string& companionZRID = "") = 0;
1508
1521 virtual ZRCSDKError SetCameraDisplayName(const std::string& deviceID, const std::string& displayName, const std::string& companionZRID = "") = 0;
1522
1523 // General room setting action
1524
1536 virtual ZRCSDKError SelectRoomProfile(const std::string& profileID, const std::string& profileName) = 0;
1537
1548 virtual ZRCSDKError EnableStatisticalInfo(bool enable) = 0;
1549
1562
1575
1586 virtual ZRCSDKError IdentifyZRConfidenceMonitor(int32_t positionOfConfidenceMonitor) = 0;
1587
1599 virtual ZRCSDKError IdentifyZRScreens(int32_t currentScreen, int32_t positionOfCurrentScreen) = 0;
1600
1611
1622
1633 virtual ZRCSDKError TurnCECScreensOn(bool on) = 0;
1634
1645
1656 virtual ZRCSDKError GetWindowsIoTAccountName(std::string& osAccountName) = 0;
1657
1669 virtual ZRCSDKError ChangeWindowsPassword(const std::string& oldPassword, const std::string& newPassword) = 0;
1670
1671 // virtual audio device
1672
1684 virtual ZRCSDKError ListVirtualAudioDevices(const std::string& virtualDeviceID, VirtualAudioDeviceType deviceType) = 0;
1685
1699 virtual ZRCSDKError SelectVirtualAudioDevice(const std::string& virtualDeviceID, VirtualAudioDeviceType deviceType,
1700 const std::string& networkDeviceID, const NetworkAudioChannelInfo& channel) = 0;
1701
1715 virtual ZRCSDKError UnselectVirtualAudioDevice(const std::string& virtualDeviceID, VirtualAudioDeviceType deviceType,
1716 const std::string& networkDeviceID, const NetworkAudioChannelInfo& channel) = 0;
1717
1730 virtual ZRCSDKError IdentifyVirtualAudioDevice(const std::string& virtualDeviceID, VirtualAudioDeviceType deviceType,
1731 const std::string& networkDeviceID) = 0;
1732
1747 virtual ZRCSDKError UseDanteController(const std::string& virtualDeviceID, VirtualAudioDeviceType deviceType, bool isUsedDanteController) = 0;
1748
1760 virtual ZRCSDKError IsUseDanteController(const std::string& virtualDeviceID, bool& isUseDanteController) = 0;
1761
1772
1785 virtual ZRCSDKError BindCameraToAudioChannel(const std::string& cameraDeviceID, int32_t rxChannelID) = 0;
1786
1798 virtual ZRCSDKError UnbindCameraFromAudioChannel(const std::string& cameraDeviceID) = 0;
1799
1811 virtual ZRCSDKError UnbindAudioChannelFromCamera(int32_t rxChannelID) = 0;
1812
1823
1835 virtual ZRCSDKError RenameCompanionZR(const std::string& czrID, const std::string& displayName) = 0;
1836
1847 virtual ZRCSDKError GetNetWorkAdapterInfo(std::vector<NetworkAdapterInfo>& networkAdapterInfos) = 0;
1848
1860
1872
1882
1891 virtual ZRCSDKError EnableMultiCameraOnlyMode(bool enable) = 0;
1892};
1893
1895
1896#endif //ZRC_ISETTINGSERVICE_H
ChannelSignalType
Channel signal type Here are more detailed structural descriptions.
@ ChannelSignalTypeStereoRight
StereoRight.
@ ChannelSignalTypeStereoLeft
StereoLeft.
@ ChannelSignalTypeMono
Mono.
@ ChannelSignalTypeUnknown
Unknown.
ScreenResolutionStatus
Screen resolution status Here are more detailed structural descriptions.
@ ScreenResolutionStatusOptimizable
Screen resolution status is optimizable.
@ ScreenResolutionStatusOptimized
Screen resolution status is optimized.
NetworkType
Network type Here are more detailed structural descriptions.
@ NetworkTypeWired
Wired.
@ NetworkTypeUnknown
Unknown.
@ NetworkType3G
3G.
@ NetworkTypePPP
Point-to-Point Protocol.
@ NetworkTypeWifi
Wi-Fi.
NetworkConnectionType
Network connection type Here are more detailed structural descriptions.
@ NetworkConnectionTypeUnknown
Unknown.
@ NetworkConnectionTypeDirect
Direct.
@ NetworkConnectionTypeCloud
Cloud.
AudioCheckupCommand
Audio checkup command Here are more detailed structural descriptions.
@ AudioCheckupCommandStart
Start audio checkup.
@ AudioCheckupCommandCancel
Cancel audio checkup.
VoiceCommandProvider
Voice command provider.
@ VoiceCommandProviderAIC
AIC voice command.
@ VoiceCommandProviderAlexa
Alexa voice command.
@ VoiceCommandProviderSensory
Sensory voice command.
@ VoiceCommandProviderNone
Voice command is disabled.
CalibrationAction
Calibration action type. Here are more detailed structural descriptions.
@ CalibrationActionEventSwitchBoundaryCamera
Event, switch boundary camera.
@ CalibrationActionEventStop
Event, stop.
@ CalibrationActionPageReadyToMove
Page ready to move.
@ CalibrationActionEventFinishToCheckResult
Event, finish to check result.
@ CalibrationActionEventAcceptBoundaryResult
Event, accept boundary result.
@ CalibrationActionPagePreAcceptBoundary
Page pre-accept boundary.
@ CalibrationActionEventAcceptResult
Event, accept result.
@ CalibrationActionPageAskNeedSetCameraBoundary
Page ask need set camera boundary.
@ CalibrationActionPagePreviewIDBoundary
Page preview ID boundary.
@ CalibrationActionPageVerifyBoundary
Page verify boundary.
@ CalibrationActionEventStartToCalibrate
Event, success and save the result, layout, preset, start to calibrate.
@ CalibrationActionPageCameraControl
Page camera layout.
@ CalibrationActionPageAdjustCamera
Page adjust camera.
@ CalibrationActionEventAdjustBoundary
Event, adjust boundary.
ScreenSequenceCalibrationAction
Screen sequence calibration action type. Here are more detailed structural descriptions.
@ ScreenSequenceCalibrationStart
Start calibration.
@ ScreenSequenceCalibrationConfirm
Confirm screen sequence calibration.
@ ScreenSequenceCalibrationConfidenceStart
Start confidence monitor calibration.
@ ScreenSequenceCalibrationNone
None.
@ ScreenSequenceCalibrationCancel
Cancel screen sequence calibration.
@ ScreenSequenceCalibrationConfidenceIdentify
Cancel confidence monitor calibration.
@ ScreenSequenceCalibrationIdentify
Identify screen sequence.
AdvancedNoiseSuppressionMode
Advanced noise suppression mode. Here are more detailed structural descriptions.
@ AdvancedNoiseSuppressionModeAuto
Auto, automatically adjusts noise suppression.
@ AdvancedNoiseSuppressionModeOff
Off.
@ AdvancedNoiseSuppressionModeNone
None, no advanced noise suppression mode.
@ AdvancedNoiseSuppressionModeHigh
High, recommended for noisy environments.
MicRecordTestStatus
Microphone record test status. Here are more detailed structural descriptions.
@ MicRecordTestStatusRecording
Microphone test is recording record.
@ MicRecordTestStatusPlaying
Microphone test is playing record.
@ MicRecordTestStatusNone
None.
NetworkAudioDeviceState
Network audio device state Here are more detailed structural descriptions.
@ NetworkAudioDeviceStateDisconnected
Disconnected.
@ NetworkAudioDeviceStateConnected
Connected.
@ NetworkAudioDeviceStateError
Error.
@ NetworkAudioDeviceStateOccupied
Occupied.
@ NetworkAudioDeviceStateAvailable
Available.
@ NetworkAudioDeviceStateConnecting
Connecting.
@ NetworkAudioDeviceStateNone
None.
StatisticalDataStatus
Statistical data status reported by ZR/ZRCSDK. ThirdParty exposes this status only and does not apply...
@ StatisticalDataStatusNone
No status is reported or the status is unknown.
@ StatisticalDataStatusWarning
The statistical data status is warning.
@ StatisticalDataStatusNormal
The statistical data status is normal.
@ StatisticalDataStatusError
The statistical data status is error.
NetworkAdapterUpdateType
Network adapter update type Here are more detailed structural descriptions.
@ NetworkAdapterUpdateTypeNRC
Native Room Controls (NRC)
@ NetworkAdapterUpdateTypeNone
None.
@ NetworkAdapterUpdateTypeDante
Network audio devices (Dante)
AudioCheckupStatus
Audio checkup status Here are more detailed structural descriptions.
@ AudioCheckupStatusSucceeded
Succeeded.
@ AudioCheckupStatusScheduled
Scheduled.
@ AudioCheckupStatusIdle
Idle.
@ AudioCheckupStatusFailedLikely
Failed likely.
@ AudioCheckupStatusChecking
Checking.
@ AudioCheckupStatusStarting
Starting.
@ AudioCheckupStatusFailed
Failed.
NetworkAudioDeviceListAction
Network audio device list action type. Here are more detailed structural descriptions.
@ NetworkAudioDeviceListActionRefreshList
Refresh list.
@ NetworkAudioDeviceListActionRemoveDevice
Remove device.
@ NetworkAudioDeviceListActionUpdateDevice
Update device.
@ NetworkAudioDeviceListActionAddDevice
Add device.
@ NetworkAudioDeviceListActionUnknown
Unknown.
@ NetworkAudioDeviceListActionUseDanteController
Action use Dante controller.
SystemAudioEnhancementsMode
System audio enhancements mode. Here are more detailed structural descriptions.
@ SystemAudioEnhancementsModeOff
System audio enhancements mode is Off.
@ SystemAudioEnhancementsModeOn
System audio enhancements mode is On.
@ SystemAudioEnhancementsModeAuto
System audio enhancements mode is Auto.
@ SystemAudioEnhancementsModeNone
System audio enhancements mode is None, indicates the system audio enhancements feature is not availa...
#define NS_ZRCSDK_END
#define NS_ZRCSDK_BEG
ZRC SDK Types.
ZRCSDKError
SDK error types. Here are more detailed structural descriptions.
Definition ZRCSDKTypes.h:23
VirtualAudioDeviceType
Virtual audio device type Here are more detailed structural descriptions.
CameraBoundaryAdjustField
Camera boundary adjust field Here are more detailed structural descriptions.
@ CameraBoundaryAdjustFieldUnknown
Unknown.
Calibration helper interface.
Setting service interface.
virtual ZRCSDKError EnableAcousticEchoCancellation(bool enable)=0
Enable acoustic echo cancellation.
virtual ZRCSDKError EnableSpatialAudio(bool enable)=0
Enable spatial audio. Requires stereo loudspeaker hardware.
virtual ZRCSDKError ChangeWindowsPassword(const std::string &oldPassword, const std::string &newPassword)=0
Change windows password.
virtual ICalibrationHelper * GetCalibrationHelper()=0
Get the calibration helper.
virtual ZRCSDKError SetCurrentCamera(const Device &camera)=0
Set current camera.
virtual ZRCSDKError IdentifyZRConfidenceMonitor(int32_t positionOfConfidenceMonitor)=0
Identify ZR confidence monitor, select a screen position to use as ZR confidence monitor.
virtual ZRCSDKError IsUseDanteController(const std::string &virtualDeviceID, bool &isUseDanteController)=0
Query if virtual audio device use Dante controller.
virtual ZRCSDKError RegisterSink(ISettingServiceSink *pSink)=0
Register setting service callback sink.
virtual ZRCSDKError EnableStatisticalInfo(bool enable)=0
Enable statistical info.
virtual ZRCSDKError StopTestingSpeaker()=0
Stop testing speaker.
virtual ZRCSDKError SetCameraCOMId(const std::string &deviceID, int32_t comID, const std::string &companionZRID="")=0
Set camera com ID.
virtual ZRCSDKError BindCameraToAudioChannel(const std::string &cameraDeviceID, int32_t rxChannelID)=0
Binds a camera to a specific input audio channel.
virtual ZRCSDKError GetCurrentAdvancedNoiseSuppressionMode(AdvancedNoiseSuppressionMode &mode)=0
Get current advanced noise suppression mode.
virtual ZRCSDKError SetSpeakerVolume(float volume)=0
Set current speaker volume.
virtual ZRCSDKError UnbindAudioChannelFromCamera(int32_t rxChannelID)=0
Unbind audio channel from its associated camera.
virtual ZRCSDKError GetCurrentSystemAudioEnhancementsMode(SystemAudioEnhancementsMode &mode)=0
Get current system audio enhancements mode.
virtual ZRCSDKError EnableMultiCameraOnlyMode(bool enable)=0
Make ZR work in multi camera only mode.
virtual ZRCSDKError StartTestingSpeaker()=0
Start testing speaker.
virtual ZRCSDKError GetCurrentSpeaker(Device &speaker)=0
Get current speaker.
virtual ZRCSDKError GetCurrentCamera(Device &camera)=0
Get current camera.
virtual ZRCSDKError GetMicrophoneVolume(float &volume)=0
Get current microphone volume.
virtual ZRCSDKError GetCompanionZRList(std::vector< CompanionZRDeviceInfo > &CZRs)=0
Get Companion ZR list.
virtual ZRCSDKError CloseAICVoiceCommandSession()=0
Close current AIC voice command session.
virtual ZRCSDKError SelectRoomProfile(const std::string &profileID, const std::string &profileName)=0
Select room profile.
virtual ZRCSDKError IsSupportAdvancedNoiseSuppression(bool &support)=0
Query if ZR support advanced noise suppression.
virtual ZRCSDKError EnableVoiceCommand(bool enable)=0
Enable or disable voice command with current provider.
virtual ZRCSDKError SetSpeakerTempVolumeInMeeting(float volume)=0
Set current speaker volume temperately in current meeting.
virtual ZRCSDKError EnableMicrophoneHardwareTroubleshooting(bool enable)=0
Enable hardware troubleshooting for the selected microphone.
virtual ZRCSDKError SelectMultipleCamera(const std::string &deviceID, bool isSelected, const std::string &companionZRID="")=0
Select multiple camera.
virtual ZRCSDKError ConfirmAdjustZRScreens()=0
Confirm adjust zoom room screens.
virtual ZRCSDKError UnselectVirtualAudioDevice(const std::string &virtualDeviceID, VirtualAudioDeviceType deviceType, const std::string &networkDeviceID, const NetworkAudioChannelInfo &channel)=0
Unselect virtual audio device.
virtual ZRCSDKError GetWindowsIoTAccountName(std::string &osAccountName)=0
Get Windows IoT account name.
virtual ZRCSDKError SetCurrentSpeaker(const Device &speaker)=0
Set current speaker.
virtual ZRCSDKError StartTestingMicrophoneVolume()=0
Start testing microphone volume.
virtual ZRCSDKError StopTestingMicrophoneVolume()=0
Stop testing microphone volume.
virtual ZRCSDKError GetSpeakerVolume(float &volume)=0
Get current speaker volume.
virtual ZRCSDKError MuteAICVoiceCommandPlayback(bool mute)=0
Mute or unmute AIC voice command playback.
virtual ZRCSDKError TestMicrophone(bool on)=0
Test microphone record.
virtual ZRCSDKError UnbindCameraFromAudioChannel(const std::string &cameraDeviceID)=0
Unbind cameral from its associated audio channels.
virtual ZRCSDKError UnbindAllAudioChannelAndCameraConnections()=0
Unbind all audio channel and camera connections.
virtual ZRCSDKError ListVirtualAudioDevices(const std::string &virtualDeviceID, VirtualAudioDeviceType deviceType)=0
List virtual audio device.
virtual ZRCSDKError SetMicrophoneVolume(float volume)=0
Set current microphone volume.
virtual ZRCSDKError AudioCheckup(AudioCheckupCommand command)=0
Audio echo test.
virtual ZRCSDKError TurnCECScreensOn(bool on)=0
Turn CEC screen on.
virtual ZRCSDKError RefreshDiagnosticInfo()=0
Manual refresh diagnostic info.
virtual ZRCSDKError GetSpeakerList(std::vector< Device > &speakers)=0
Get speaker list.
virtual ZRCSDKError CancelAdjustZRScreens()=0
Cancel adjust zoom room screens.
virtual ZRCSDKError IsSpatialAudioAvailable(bool &available)=0
Query if ZR support spatial audio.
virtual ZRCSDKError SelectVirtualAudioDevice(const std::string &virtualDeviceID, VirtualAudioDeviceType deviceType, const std::string &networkDeviceID, const NetworkAudioChannelInfo &channel)=0
Select virtual audio device.
virtual ZRCSDKError ListAudioChannelAndCameraBindInfo()=0
List audio channel and camera binding information.
virtual ZRCSDKError CalibrateIntelligentDirectorMode(CalibrationAction actionType, const std::string &deviceID="", CameraBoundaryAdjustField boundaryAdjustField=CameraBoundaryAdjustFieldUnknown, int32_t boundaryAdjustValue=0)=0
Director calibrate.
virtual ZRCSDKError IsSupportAcousticEchoCancellation(bool &support)=0
Query if ZR support acoustic echo cancellation.
virtual ZRCSDKError GetCameraList(std::vector< Device > &cameras)=0
Get camera list.
virtual ZRCSDKError GetCurrentMicrophone(Device &microphone)=0
Get current microphone.
virtual ZRCSDKError IdentifyVirtualAudioDevice(const std::string &virtualDeviceID, VirtualAudioDeviceType deviceType, const std::string &networkDeviceID)=0
Identify virtual audio device.
virtual ZRCSDKError GetNetWorkAdapterInfo(std::vector< NetworkAdapterInfo > &networkAdapterInfos)=0
Get network adapter info.
virtual ZRCSDKError SelectSystemAudioEnhancementsMode(SystemAudioEnhancementsMode mode)=0
Select system audio enhancements mode.
virtual ZRCSDKError SelectIntelligentDirectorCamera(const std::string &deviceID, bool isSelected)=0
Select director camera.
virtual ZRCSDKError ConfirmNumberOfCombinedMicrophone(int32_t number)=0
Confirm detected microphone number.
virtual ZRCSDKError SelectAdvancedNoiseSuppressionMode(AdvancedNoiseSuppressionMode mode)=0
Select advanced noise suppression mode.
virtual ZRCSDKError UseDanteController(const std::string &virtualDeviceID, VirtualAudioDeviceType deviceType, bool isUsedDanteController)=0
Use Dante controller.
virtual ~ISettingService()
virtual ZRCSDKError SetCurrentMicrophone(const Device &microphone)=0
Set current microphone.
virtual ZRCSDKError SetCameraDisplayName(const std::string &deviceID, const std::string &displayName, const std::string &companionZRID="")=0
Set camera display name.
virtual ZRCSDKError IdentifyZRScreens(int32_t currentScreen, int32_t positionOfCurrentScreen)=0
Identify zoom room screens.
virtual ZRCSDKError GetMicrophoneList(std::vector< Device > &microphones)=0
Get microphone list.
virtual ZRCSDKError GetNetworkAudioDeviceList(const std::string &virtualDeviceID, std::vector< NetworkAudioDevice > &networkAudioDeviceList)=0
Get network audio device list.
virtual ZRCSDKError StartOverAdjustZRScreens()=0
Start over adjust zoom room screens.
virtual ZRCSDKError IsAudioFramingAvailable(bool &available)=0
Query if ZR support audio framing.
virtual ZRCSDKError RenameCompanionZR(const std::string &czrID, const std::string &displayName)=0
Rename CompanionZR.
virtual ZRCSDKError DeregisterSink(ISettingServiceSink *pSink)=0
Deregister setting service callback sink.
virtual ZRCSDKError EnableAudioFraming(bool enable)=0
Enable audio framing.
virtual ZRCSDKError StartAdjustZRScreens()=0
Start to adjust zoom room screens.
Setting service event callback.
virtual void OnCameraBoundaryConfigurationInfoNotification(const CameraBoundaryConfigurationInfo &info)=0
Camera Boundary configuration info notification.
virtual void OnUpdateVoiceCommandStatus(const VoiceCommandStatus &status)=0
Voice command status changed callback.
virtual void OnStatisticalInfoNotification(const StatisticalInfo &info)=0
Statistical info notification.
virtual void OnCameraListChanged(const std::vector< Device > &cameras)=0
Camera list changed callback.
virtual void OnCurrentCameraChanged(bool exist, const Device &camera)=0
Current camera changed callback.
virtual void OnMicrophoneListChanged(const std::vector< Device > &microphones)=0
Microphone list changed callback.
virtual void OnZoomPresenceScreenSaverNotification(bool running)=0
Room screen saver running notification.
virtual void OnDirectorCalibrationNotification(const DirectorCalibrationNot &noti)=0
Director calibration notification.
virtual void OnCurrentSpeakerVolumeChanged(float volume)=0
Current speaker volume changed callback.
virtual void OnUpdatedOperationTimeStatusNotification(bool shouldDimScreen)=0
Operation time status notification.
virtual void OnSpeakerListChanged(const std::vector< Device > &speakers)=0
Speaker list 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 OnCurrentMicrophoneChanged(bool exist, const Device &microphone)=0
Current microphone changed callback.
virtual void OnIntelligentDirectorInfoNotification(const IntelligentDirectorInfo &info)=0
Intelligent director info notification.
virtual void OnAudioCheckupNotification(const AudioCheckupInfo &info)=0
Audio checkup info notification.
virtual void OnUpdateHardwareStatus(const HardwareStatus &status)=0
Hardware status changed callback.
virtual void OnUpdateCOMList(const std::vector< Device > &comList)=0
COM list changed callback.
virtual void OnUnbindAudioChannelAndCameraNotification(const std::vector< AudioChannelAndCameraBindInfo > &bindInfoList)=0
Unbind audio channel and camera notification.
virtual void OnUpdateDiagnosticInfo(const DiagnosticInfo &info)=0
Diagnostic info notification.
virtual void OnNetworkAdapterUpdateInfo(const std::vector< NetworkAdapterInfo > &networkAdapterInfos)=0
Network adapter info update notification.
virtual void OnAudioSystemFailureNotification(bool isDismiss)=0
Audio system failure 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 OnMicrophoneRecordingNotification(MicRecordTestStatus status)=0
Microphone testing recording notification.
virtual void OnSpeakerTestingResult(int32_t result, float duration, bool isStopped)=0
Speaker testing result.
virtual void OnCompanionZRDeviceUpdateNotification(const CompanionZRDeviceUpdateNot &noti)=0
Companion ZR device update notification.
virtual void OnCurrentMicrophoneVolumeChanged(float volume)=0
Current microphone volume changed callback.
virtual void OnUpdatedGenericSettings(const GenericSettings &genericSettings)=0
Generic settings changed callback.
virtual void OnChangeWindowsPasswordNotification(int32_t result)=0
Change windows password notification.
virtual void OnCurrentSelectedMicrophoneMuted(bool muted)=0
Current selected microphone muted notification.
virtual void OnCurrentSpeakerChanged(bool exist, const Device &speaker)=0
Current speaker changed callback.
virtual void OnSpeakerTestingNotification(int32_t volume, bool isEnabled)=0
Speaker testing notification.
virtual void OnAdjustScreensResponse(const AdjustScreensRes &response)=0
Adjust screen response.
virtual void OnScreenInfosNotification(const ScreenInfos &screenInfos)=0
Screen infos notification.
virtual void OnUpdateSystemAudioEnhancementsMode(SystemAudioEnhancementsMode mode)=0
Update system audio enhancements mode notification.
virtual void OnBindAudioChannelAndCameraNotification(const std::vector< AudioChannelAndCameraBindInfo > &bindInfoList)=0
Bind audio channel and camera notification.
virtual void OnListAudioChannelAndCameraBindInfoNotification(const std::vector< AudioChannelAndCameraBindInfo > &bindInfoList)=0
List audio channel and camera bind information notification.
virtual void OnUnbindAllAudioChannelAndCameraConnectionsNotification(const std::vector< AudioChannelAndCameraBindInfo > &bindInfoList)=0
Unbind all audio channel and camera connections notification.
virtual void OnUpdateMicStethoscopeModeEnabledStatus(bool isMicStethoscopeModeEnabled)=0
Update microphone stethoscope mode enabled status notification.
virtual void OnMicrophoneTestingNotification(int32_t volume)=0
Microphone testing notification.
AIC voice command runtime info.
bool isPlaybackMuted
TRUE indicates AIC voice playback muted.
bool isSessionStarted
TRUE indicates AIC voice session started.
Adjust screens response.
int32_t currentScreen
Current screen index.
ScreenSequenceCalibrationAction action
Screen sequence calibration action, see ScreenSequenceCalibrationAction enum.
int32_t quantityOfScreens
Quantity of screens.
int32_t result
Result, [0] success, otherwise failed.
Binding information for audio channel and camera device.
std::string networkChannelName
Network audio device channel name.
int32_t rxChannelID
Room input audio channel ID (range: 1–8) for Dante or similar systems.
std::string cameraDeviceID
Camera device ID.
std::string networkDeviceName
Network audio device name.
Audio checkup info.
int32_t intervalAfterFinished
Interval after finished.
AudioCheckupStatus status
Audio checkup status, see AudioCheckupStatus enum.
std::string testTime
Test time.
bool canRestartZoomRoomsSystem
TRUE indicates can restart ZR system.
int32_t aecLevel
AEC level.
int32_t percentageOfCheckup
Percentage of checkup progress.
int32_t intervalAfterScheduled
Interval after scheduled.
Camera boundary configuration info.
bool isBoundaryConfigured
TRUE indicates the Camera Boundary has been configured. Otherwise not.
bool supportsBoundary
TRUE indicates support Camera Boundary. Otherwise not.
int32_t cameraBoundaryEnableStatus
Camera boundary enable status.
uint32_t cameraBoundaryCapability
Camera boundary capability.
Companion ZR device update notification.
Device item interface. Device describes speaker, microphone, camera.
Statistical diagnostic info.
std::vector< DiagnosticMsgGroup > groups
groups
Statistical diagnostic group.
std::string name
name
std::vector< DiagnosticMsg > msgs
msgs
Statistical diagnostic msg.
std::string field
field, For example: "Camera Capture Resolution"
std::string description
description, For example: "3840×2160", may be empty since it might be binary or something else that i...
Director calibration notification.
Zoom Room generic settings.
Zoom Room hardware status Some TV and ZoomRooms Applicance have privacy mute buttons,...
Intelligent director info.
bool supportsDirectorMode
TRUE indicates support director mode.
bool isRegionLimited
TRUE indicates the current region is limited.
bool supportSavePresetImage
TRUE indicates support save preset image.
int32_t multiCameraParallelNumInDirector
The parallel number of multi camera in director.
bool allowDirectorAndMultiCameraParallel
TRUE indicates allow director and multiCamera parallel.
bool isCalibrationConfigured
TRUE indicates calibration is configured.
int32_t supportedCameraNumber
The number of support camera.
Network adapter info.
NetworkAdapterUpdateType updateType
Network adapter update type, see NetworkAdapterUpdateType enum.
std::string ip
IP address.
std::string adapter
Adapter name.
Network audio channel info.
std::string channelName
Channel Name.
NetworkAudioDeviceState state
Network audio device state, see NetworkAudioDeviceState enum.
std::string deviceId
Device ID.
ChannelSignalType signalType
Channel signal type, see ChannelSignalType enum.
Network audio device.
std::string ID
Device ID.
std::string name
Device name.
NetworkAudioDeviceState state
Network audio device state, see NetworkAudioDeviceState enum.
bool identifiable
TRUE indicates this device is identifiable.
std::vector< NetworkAudioChannelInfo > channels
Network audio channel info.
Audio quality statistical.
uint32_t sampleRate
Send sample rate.
std::vector< uint32_t > recSampleRates
Receive sample rates if has multiple sources.
Quality statistical info.
QualityStatisticalAudio audioStatisticalInfo
Audio quality statistical info.
QualityStatisticalVideo videoStatisticalInfo
Video quality statistical info.
QualityStatisticalShare shareStatisticalInfo
Share quality statistical info.
Share content quality statistical.
uint32_t fpsOfRecvShare
FPS of receive share content.
uint32_t resolutionOfSend
Resolution of send share content. width: resolutionOfSend & 0xFFFF, height: (resolutionOfSend >> 16) ...
uint64_t fpsOfSend
FPS of send share content.
uint32_t heightOfRecvShare
Height of receive share content.
uint32_t widthOfRecvShare
Width of receive share content.
Video quality statistical.
uint32_t widthOfMaxRecvVideo
Width of receive video.
uint64_t fpsOfSend
FPS of send video.
uint32_t fpsOfRecvMaxVideo
FPS of receive video .
uint32_t resolutionOfSend
Resolution of send video. width: resolutionOfSend & 0xFFFF, height: (resolutionOfSend >> 16) & 0xFFFF...
uint32_t heightOfMaxRecvVideo
Height of receive video.
Room capability.
bool supportRestartOS
TRUE indicates room supports restart os.
bool supportAutoLoginOS
TRUE indicates room supports auto login os.
bool notSupportDigitalSignage
TRUE indicates room not supports digital signage.
bool notSupportMicAdvancedOption
TRUE indicates room not supports microphone advance option.
Room profile item.
bool isSelected
TRUE indicates current selected.
std::string name
Name.
std::string ID
ID.
std::vector< int32_t > issueDevices
Issue devices. Device type see DeviceType enum.
Room profile list.
std::vector< RoomProfile > roomProfileList
Room profile list.
Screen information.
int32_t mainDisplayPosition
Main display position.
int32_t quantityOfScreens
Quantity of screens.
bool hasConfidenceMonitor
TRUE indicates has confidence monitor.
int32_t quantityOfCecAdapterAttachedScreens
Quantity of CEC adapter attached screen.
Statistical GPU info.
int32_t utilization
GPU utilization percentage.
std::string driverVersion
GPU driver version.
StatisticalDataStatus utilizationStatus
GPU utilization status, see StatisticalDataStatus enum.
std::string name
GPU device name.
Statistical info.
StatisticalPhoneInfo phoneInfo
Phone statistical info.
StatisticalOverallInfo overallInfo
Overall statistical info.
StatisticalMediaInfo shareInfo
Share statistical info.
StatisticalMediaInfo videoInfo
Video statistical info.
StatisticalMediaInfo audioInfo
Audio statistical info.
Statistical media info.
StatisticalNetWorkStatusInfo networkSendingStatus
Network sending statistical info.
QualityStatisticalInfo qualityStatisticalInfo
Quality statistical info.
StatisticalNetWorkStatusInfo networkReceivingStatus
Network receiving statistical info.
Statistical network status info.
uint32_t rate
Bandwidth rate.
uint32_t maxLossRatio
Max packet loss ratio.
uint32_t avgLossRatio
Average packet loss ratio.
Statistical overall info.
std::string dataCenterRegionMessage
Data center region message.
int32_t cpuZRUsage
CPU ZR usage.
int32_t memoryOverallUsage
Memory overall usage.
int32_t cpuCoreNumber
CPU core number.
std::vector< StatisticalGPUInfo > gpuInfoList
GPU statistical info list.
NetworkConnectionType netWorkConnectionType
Network connection type.
std::string proxy
Proxy.
int32_t storageUsedMB
Used storage size in MB.
std::string encryption
Encryption type.
NetworkType networkType
Network type, see NetworkType enum.
int32_t memoryZRUsage
Memory ZR usage.
int32_t cpuOverallUsage
CPU overall usage.
int32_t memorySize
Memory size.
StatisticalDataStatus storageStatus
Storage usage status, see StatisticalDataStatus enum.
int32_t storageTotalMB
Total storage size in MB.
float cpuFrequency
CPU frequency.
Statistical phone info.
std::string registerId
Register ID.
std::string localNetworkInterface
Local network interface.
std::vector< StatisticalPhonePeerInfo > phonePeers
Phone peer info.
std::string registerServerIp
Register server IP.
std::string networkSwitch
Network switch.
uint32_t registerServerPort
Register server port.
Statistical phone network info.
uint32_t packetsNumber
Packets number.
float packetLossMax
Packet loss max.
Statistical phone peer info.
uint32_t localPort
Local port.
StatisticalPhoneNetworkInfo networkReceivingStatus
network receiving status
std::string localIp
Local IP.
std::string remoteIp
Remote IP.
uint32_t networkDelay
Network delay.
std::string peerNumber
Peer number.
uint32_t remotePort
Remote port.
StatisticalPhoneNetworkInfo networkSendingStatus
Network sending status.
Voice command status.
AICVoiceCommandInfo aicVoiceCommandInfo
AIC voice command runtime info.
bool enable
TRUE indicates voice command enabled.
VoiceCommandProvider provider
Current voice command provider.