Zoom Rooms Controller SDK Reference 7.0.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{
139
145{
154
160{
164};
165
171{
177
182{
187};
188
192{
193 uint32_t sampleRate = 0xffffffff;
194 std::vector<uint32_t> recSampleRates;
195};
196
200{
201 uint32_t fpsOfRecvMaxVideo = 0xffffffff;
202 uint32_t widthOfMaxRecvVideo = 0xffffffff;
203 uint32_t heightOfMaxRecvVideo = 0xffffffff;
204 uint32_t resolutionOfSend = 0xffffffff;
205 uint64_t fpsOfSend = 0xffffffff;
206};
207
211{
212 uint32_t fpsOfRecvShare = 0xffffffff;
213 uint32_t widthOfRecvShare = 0xffffffff;
214 uint32_t heightOfRecvShare = 0xffffffff;
215 uint32_t resolutionOfSend = 0xffffffff;
216 uint64_t fpsOfSend = 0xffffffff;
217};
218
222{
226};
227
231{
232 uint32_t avgLossRatio = 0xffffffff;
233 uint32_t maxLossRatio = 0xffffffff;
234 uint32_t rtt = 0xffffffff;
235 uint32_t jitter = 0xffffffff;
236 uint32_t rate = 0xffffffff;
237};
238
242{
246};
247
251{
252 int32_t cpuCoreNumber = 0;
253 float cpuFrequency = 0.0f;
254 int32_t cpuZRUsage = 0;
255 int32_t cpuOverallUsage = 0;
256 int32_t memorySize = 0;
257 int32_t memoryZRUsage = 0;
258 int32_t memoryOverallUsage = 0;
260 std::string proxy;
263 std::string encryption;
264};
265
269{
270 uint32_t packetsNumber = 0;
271 uint32_t frequency = 0;
272 float packetLoss = 0.0f;
273 float packetLossMax = 0.0f;
274 uint32_t jitter = 0;
275 float bandwidth = 0.0f;
276 std::string codec;
277};
278
282{
283 std::string peerNumber;
284 std::string localIp;
285 uint32_t localPort = 0;
286 std::string remoteIp;
287 uint32_t remotePort = 0;
288 uint32_t networkDelay = 0;
291};
292
296{
297 std::string registerId;
298 std::string registerServerIp;
299 uint32_t registerServerPort = 0;
300 std::string networkSwitch;
302 std::vector<StatisticalPhonePeerInfo> phonePeers;
303};
304
308{
309 std::string field;
310 std::string
312};
313
317{
318 std::string name;
319 std::vector<DiagnosticMsg> msgs;
320};
321
325{
326 std::vector<DiagnosticMsgGroup> groups;
327};
328
332{
338};
339
343{
349 int32_t aecLevel = -1;
350 std::string testTime;
351};
352
356{
357 std::string ID;
358 std::string name;
359 bool isSelected = false;
360 std::vector<int32_t> issueDevices;
361};
362
366{
367 std::vector<RoomProfile> roomProfileList;
368};
369
373{
374 bool supportAutoLoginOS = false;
375 bool supportRestartOS = false;
378};
379
383{
384 int32_t result = 0;
385 int32_t currentScreen = -1;
386 int32_t quantityOfScreens= -1;
388};
389
393{
394 int32_t quantityOfScreens = 1;
396 bool hasConfidenceMonitor = false;
398};
399
405{
413
414 // boundary
422};
423
427{
430 std::string deviceId;
431 std::string channelName;
432};
433
437{
439 std::vector<NetworkAudioChannelInfo> channels;
440 std::string ID;
441 std::string name;
442 bool identifiable = false;
443};
444
448{
449 std::string cameraDeviceID;
450 std::string networkDeviceName;
451 std::string networkChannelName;
452 int32_t rxChannelID = 0;
453};
454
458{
459 bool supportsDirectorMode = false;
462 bool isRegionLimited = false;
466};
467
471{
472 bool supportsBoundary = false;
473 bool isBoundaryConfigured = false;
476};
477
481{
483 std::string adapter;
484 std::string ip;
485};
486
490{
491 bool isSessionStarted = false;
492 bool isPlaybackMuted = false;
493};
494
498{
500 bool enable = false;
502};
503
507{
508public:
510
519 virtual void OnMicrophoneListChanged(const std::vector<Device>& microphones) = 0;
520
529 virtual void OnSpeakerListChanged(const std::vector<Device>& speakers) = 0;
530
539 virtual void OnCameraListChanged(const std::vector<Device>& cameras) = 0;
540
549 virtual void OnUpdateCOMList(const std::vector<Device>& comList) = 0;
550
560
570 virtual void OnCurrentMicrophoneChanged(bool exist, const Device& microphone) = 0;
571
581 virtual void OnCurrentSpeakerChanged(bool exist, const Device& speaker) = 0;
582
592 virtual void OnCurrentCameraChanged(bool exist, const Device& camera) = 0;
593
602 virtual void OnCurrentMicrophoneVolumeChanged(float volume) = 0;
603
612 virtual void OnCurrentSpeakerVolumeChanged(float volume) = 0;
613
624 virtual void OnUpdateHardwareStatus(const HardwareStatus& status) = 0;
625
634 virtual void OnUpdatedGenericSettings(const GenericSettings& genericSettings) = 0;
635
644 virtual void OnUpdateVoiceCommandStatus(const VoiceCommandStatus& status) = 0;
645
654 virtual void OnUpdateRoomProfileList(const RoomProfileList& list) = 0;
655
664 virtual void OnUpdateZoomRoomCapability(const RoomCapability& roomCapability) = 0;
665
674 virtual void OnCurrentSelectedMicrophoneMuted(bool muted) = 0;
675
684 virtual void OnMicrophoneTestingNotification(int32_t volume) = 0;
685
695
705 virtual void OnSpeakerTestingNotification(int32_t volume, bool isEnabled) = 0;
706
717 virtual void OnSpeakerTestingResult(int32_t result, float duration, bool isStopped) = 0;
718
727 virtual void OnStatisticalInfoNotification(const StatisticalInfo& info) = 0;
728
737 virtual void OnAudioCheckupNotification(const AudioCheckupInfo& info) = 0;
738
747 virtual void OnAudioSystemFailureNotification(bool isDismiss) = 0;
748
757 virtual void OnScreenInfosNotification(const ScreenInfos& screenInfos) = 0;
758
767 virtual void OnAdjustScreensResponse(const AdjustScreensRes& response) = 0;
768
777 virtual void OnZoomPresenceScreenSaverNotification(bool running) = 0;
778
787 virtual void OnUpdatedOperationTimeStatusNotification(bool shouldDimScreen) = 0;
788
798
808
818
827 virtual void OnUpdateDiagnosticInfo(const DiagnosticInfo& info) = 0;
828
837 virtual void OnChangeWindowsPasswordNotification(int32_t result) = 0;
838
850 virtual void OnUpdateNetworkAudioDeviceList(const std::string& virtualDeviceID, NetworkAudioDeviceListAction action,
851 const std::vector<NetworkAudioDevice>& networkAudioDeviceList, bool isUsedDanteController) = 0;
852
861 virtual void OnListAudioChannelAndCameraBindInfoNotification(const std::vector<AudioChannelAndCameraBindInfo>& bindInfoList) = 0;
862
871 virtual void OnBindAudioChannelAndCameraNotification(const std::vector<AudioChannelAndCameraBindInfo>& bindInfoList) = 0;
872
881 virtual void OnUnbindAudioChannelAndCameraNotification(const std::vector<AudioChannelAndCameraBindInfo>& bindInfoList) = 0;
882
891 virtual void OnUnbindAllAudioChannelAndCameraConnectionsNotification(const std::vector<AudioChannelAndCameraBindInfo>& bindInfoList) = 0;
892
901 virtual void OnNetworkAdapterUpdateInfo(const std::vector<NetworkAdapterInfo>& networkAdapterInfos) = 0;
902
911 virtual void OnUpdateMicStethoscopeModeEnabledStatus(bool isMicStethoscopeModeEnabled) = 0;
912
922};
923
927{
928public:
929 virtual ~ISettingService() {}
930
942
954
965 virtual ZRCSDKError GetMicrophoneList(std::vector<Device>& microphones) = 0;
966
977 virtual ZRCSDKError GetSpeakerList(std::vector<Device>& speakers) = 0;
978
989 virtual ZRCSDKError GetCameraList(std::vector<Device>& cameras) = 0;
990
1001 virtual ZRCSDKError GetCompanionZRList(std::vector<CompanionZRDeviceInfo>& CZRs) = 0;
1002
1016 virtual ZRCSDKError GetNetworkAudioDeviceList(const std::string& virtualDeviceID, std::vector<NetworkAudioDevice>& networkAudioDeviceList) = 0;
1017
1028 virtual ZRCSDKError GetCurrentMicrophone(Device& microphone) = 0;
1029
1040 virtual ZRCSDKError GetCurrentSpeaker(Device& speaker) = 0;
1041
1053
1064 virtual ZRCSDKError SetCurrentMicrophone(const Device& microphone) = 0;
1065
1076 virtual ZRCSDKError SetCurrentSpeaker(const Device& speaker) = 0;
1077
1091 virtual ZRCSDKError SetCurrentCamera(const Device& camera) = 0;
1092
1103 virtual ZRCSDKError GetMicrophoneVolume(float& volume) = 0;
1104
1115 virtual ZRCSDKError GetSpeakerVolume(float& volume) = 0;
1116
1127 virtual ZRCSDKError SetMicrophoneVolume(float volume) = 0;
1128
1139 virtual ZRCSDKError SetSpeakerVolume(float volume) = 0;
1140
1157
1158 // microphone
1159
1170 virtual ZRCSDKError TestMicrophone(bool on) = 0;
1171
1182
1193
1205
1217
1232
1244
1256
1272
1284
1296
1307 virtual ZRCSDKError IsAudioFramingAvailable(bool& available) = 0;
1308
1321 virtual ZRCSDKError EnableAudioFraming(bool enable) = 0;
1322
1333 virtual ZRCSDKError EnableVoiceCommand(bool enable) = 0;
1334
1345
1357
1358 // speaker
1359
1370
1381
1392 virtual ZRCSDKError IsSpatialAudioAvailable(bool& available) = 0;
1393
1404 virtual ZRCSDKError EnableSpatialAudio(bool enable) = 0;
1405
1406 // camera
1407
1423 virtual ZRCSDKError SelectMultipleCamera(const std::string& deviceID, bool isSelected, const std::string& companionZRID = "") = 0;
1424
1439 virtual ZRCSDKError SelectIntelligentDirectorCamera(const std::string& deviceID, bool isSelected) = 0;
1440
1467 virtual ZRCSDKError CalibrateIntelligentDirectorMode(CalibrationAction actionType, const std::string& deviceID = "", CameraBoundaryAdjustField boundaryAdjustField = CameraBoundaryAdjustFieldUnknown, int32_t boundaryAdjustValue = 0) = 0;
1468
1481 virtual ZRCSDKError SetCameraCOMId(const std::string& deviceID, int32_t comID, const std::string& companionZRID = "") = 0;
1482
1495 virtual ZRCSDKError SetCameraDisplayName(const std::string& deviceID, const std::string& displayName, const std::string& companionZRID = "") = 0;
1496
1497 // General room setting action
1498
1510 virtual ZRCSDKError SelectRoomProfile(const std::string& profileID, const std::string& profileName) = 0;
1511
1522 virtual ZRCSDKError EnableStatisticalInfo(bool enable) = 0;
1523
1536
1549
1560 virtual ZRCSDKError IdentifyZRConfidenceMonitor(int32_t positionOfConfidenceMonitor) = 0;
1561
1573 virtual ZRCSDKError IdentifyZRScreens(int32_t currentScreen, int32_t positionOfCurrentScreen) = 0;
1574
1585
1596
1607 virtual ZRCSDKError TurnCECScreensOn(bool on) = 0;
1608
1619
1630 virtual ZRCSDKError GetWindowsIoTAccountName(std::string& osAccountName) = 0;
1631
1643 virtual ZRCSDKError ChangeWindowsPassword(const std::string& oldPassword, const std::string& newPassword) = 0;
1644
1645 // virtual audio device
1646
1658 virtual ZRCSDKError ListVirtualAudioDevices(const std::string& virtualDeviceID, VirtualAudioDeviceType deviceType) = 0;
1659
1673 virtual ZRCSDKError SelectVirtualAudioDevice(const std::string& virtualDeviceID, VirtualAudioDeviceType deviceType,
1674 const std::string& networkDeviceID, const NetworkAudioChannelInfo& channel) = 0;
1675
1689 virtual ZRCSDKError UnselectVirtualAudioDevice(const std::string& virtualDeviceID, VirtualAudioDeviceType deviceType,
1690 const std::string& networkDeviceID, const NetworkAudioChannelInfo& channel) = 0;
1691
1704 virtual ZRCSDKError IdentifyVirtualAudioDevice(const std::string& virtualDeviceID, VirtualAudioDeviceType deviceType,
1705 const std::string& networkDeviceID) = 0;
1706
1721 virtual ZRCSDKError UseDanteController(const std::string& virtualDeviceID, VirtualAudioDeviceType deviceType, bool isUsedDanteController) = 0;
1722
1734 virtual ZRCSDKError IsUseDanteController(const std::string& virtualDeviceID, bool& isUseDanteController) = 0;
1735
1746
1759 virtual ZRCSDKError BindCameraToAudioChannel(const std::string& cameraDeviceID, int32_t rxChannelID) = 0;
1760
1772 virtual ZRCSDKError UnbindCameraFromAudioChannel(const std::string& cameraDeviceID) = 0;
1773
1785 virtual ZRCSDKError UnbindAudioChannelFromCamera(int32_t rxChannelID) = 0;
1786
1797
1809 virtual ZRCSDKError RenameCompanionZR(const std::string& czrID, const std::string& displayName) = 0;
1810
1821 virtual ZRCSDKError GetNetWorkAdapterInfo(std::vector<NetworkAdapterInfo>& networkAdapterInfos) = 0;
1822
1834
1846
1856
1865 virtual ZRCSDKError EnableMultiCameraOnlyMode(bool enable) = 0;
1866};
1867
1869
1870#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.
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:22
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 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.
NetworkConnectionType netWorkConnectionType
Network connection type.
std::string proxy
Proxy.
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.
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.