ISettingService.h File Reference

Entrance of all the Setting Service. More...

#include "ZRCSDKTypes.h"

Go to the source code of this file.

Data Structures
struct	QualityStatisticalAudio
	Audio quality statistical. More...
struct	QualityStatisticalVideo
	Video quality statistical. More...
struct	QualityStatisticalShare
	Share content quality statistical. More...
struct	QualityStatisticalInfo
	Quality statistical info. More...
struct	StatisticalNetWorkStatusInfo
	Statistical network status info. More...
struct	StatisticalMediaInfo
	Statistical media info. More...
struct	StatisticalOverallInfo
	Statistical overall info. More...
struct	StatisticalPhoneNetworkInfo
	Statistical phone network info. More...
struct	StatisticalPhonePeerInfo
	Statistical phone peer info. More...
struct	StatisticalPhoneInfo
	Statistical phone info. More...
struct	DiagnosticMsg
	Statistical diagnostic msg. More...
struct	DiagnosticMsgGroup
	Statistical diagnostic group. More...
struct	DiagnosticInfo
	Statistical diagnostic info. More...
struct	StatisticalInfo
	Statistical info. More...
struct	AudioCheckupInfo
	Audio checkup info. More...
struct	RoomProfile
	Room profile item. More...
struct	RoomProfileList
	Room profile list. More...
struct	RoomCapability
	Room capability. More...
struct	AdjustScreensRes
	Adjust screens response. More...
struct	ScreenInfos
	Screen information. More...
struct	NetworkAudioChannelInfo
	Network audio channel info. More...
struct	NetworkAudioDevice
	Network audio device. More...
struct	IntelligentDirectorInfo
	Intelligent director info. More...
struct	CameraBoundaryConfigurationInfo
	Camera boundary configuration info. More...
struct	NetworkAdapterInfo
	Network adapter info. More...
class	ISettingServiceSink
	Setting service event callback. More...
class	ISettingService
	Setting service interface. More...

Enumerations
enum	AudioCheckupCommand { AudioCheckupCommandStart = 0 , AudioCheckupCommandCancel }
	Audio checkup command Here are more detailed structural descriptions. More...
enum	AudioCheckupStatus {   AudioCheckupStatusIdle = 0 , AudioCheckupStatusScheduled , AudioCheckupStatusStarting , AudioCheckupStatusChecking ,   AudioCheckupStatusSucceeded , AudioCheckupStatusFailed , AudioCheckupStatusFailedLikely }
	Audio checkup status Here are more detailed structural descriptions. More...
enum	AdvancedNoiseSuppressionMode { AdvancedNoiseSuppressionModeNone = -1 , AdvancedNoiseSuppressionModeAuto = 0 , AdvancedNoiseSuppressionModeHigh , AdvancedNoiseSuppressionModeOff }
	Advanced noise suppression mode. Here are more detailed structural descriptions. More...
enum	MicRecordTestStatus { MicRecordTestStatusNone = 1 , MicRecordTestStatusRecording = 2 , MicRecordTestStatusPlaying = 3 }
	Microphone record test status. Here are more detailed structural descriptions. More...
enum	ScreenResolutionStatus { ScreenResolutionStatusOptimizable = 0 , ScreenResolutionStatusOptimized = 1 }
	Screen resolution status Here are more detailed structural descriptions. More...
enum	ScreenSequenceCalibrationAction {   ScreenSequenceCalibrationNone = -1 , ScreenSequenceCalibrationStart = 0 , ScreenSequenceCalibrationIdentify , ScreenSequenceCalibrationConfirm ,   ScreenSequenceCalibrationCancel , ScreenSequenceCalibrationConfidenceStart , ScreenSequenceCalibrationConfidenceIdentify }
	Screen sequence calibration action type. Here are more detailed structural descriptions. More...
enum	ChannelSignalType { ChannelSignalTypeUnknown = -1 , ChannelSignalTypeMono = 0 , ChannelSignalTypeStereoLeft , ChannelSignalTypeStereoRight }
	Channel signal type Here are more detailed structural descriptions. More...
enum	NetworkType {   NetworkTypeUnknown = -1 , NetworkTypeWired = 0 , NetworkTypeWifi = 1 , NetworkTypePPP = 2 ,   NetworkType3G = 3 }
	Network type Here are more detailed structural descriptions. More...
enum	NetworkConnectionType { NetworkConnectionTypeUnknown = -1 , NetworkConnectionTypeDirect = 0 , NetworkConnectionTypeCloud = 1 }
	Network connection type Here are more detailed structural descriptions. More...
enum	NetworkAudioDeviceListAction {   NetworkAudioDeviceListActionUnknown = -1 , NetworkAudioDeviceListActionRefreshList , NetworkAudioDeviceListActionRemoveDevice , NetworkAudioDeviceListActionAddDevice ,   NetworkAudioDeviceListActionUpdateDevice , NetworkAudioDeviceListActionUseDanteController }
	Network audio device list action type. Here are more detailed structural descriptions. More...
enum	NetworkAudioDeviceState {   NetworkAudioDeviceStateNone = 0 , NetworkAudioDeviceStateAvailable , NetworkAudioDeviceStateConnecting , NetworkAudioDeviceStateConnected ,   NetworkAudioDeviceStateDisconnected , NetworkAudioDeviceStateError , NetworkAudioDeviceStateOccupied }
	Network audio device state Here are more detailed structural descriptions. More...
enum	NetworkAdapterUpdateType { NetworkAdapterUpdateTypeNone = -1 , NetworkAdapterUpdateTypeDante = 0 , NetworkAdapterUpdateTypeNRC = 1 }
	Network adapter update type Here are more detailed structural descriptions. More...
enum	CalibrationAction {   CalibrationActionPageAdjustCamera , CalibrationActionPageCameraControl , CalibrationActionPageReadyToMove , CalibrationActionEventStartToCalibrate ,   CalibrationActionEventFinishToCheckResult , CalibrationActionEventAcceptResult , CalibrationActionEventStop , CalibrationActionPageAskNeedSetCameraBoundary ,   CalibrationActionEventSwitchBoundaryCamera , CalibrationActionEventAdjustBoundary , CalibrationActionPageVerifyBoundary , CalibrationActionPagePreAcceptBoundary ,   CalibrationActionEventAcceptBoundaryResult , CalibrationActionPagePreviewIDBoundary }
	Calibration action type. Here are more detailed structural descriptions. More...

Detailed Description

Entrance of all the Setting Service.

Since

Added in ZRC SDK 6.0.0

Setting describes media device information.

Definition in file ISettingService.h.

Enumeration Type Documentation

AdvancedNoiseSuppressionMode

enum AdvancedNoiseSuppressionMode

Advanced noise suppression mode. Here are more detailed structural descriptions.

Enumerator
AdvancedNoiseSuppressionModeNone	None, no advanced noise suppression mode.
AdvancedNoiseSuppressionModeAuto	Auto, automatically adjusts noise suppression.
AdvancedNoiseSuppressionModeHigh	High, recommended for noisy environments.
AdvancedNoiseSuppressionModeOff	Off.

Definition at line 46 of file ISettingService.h.

{
    AdvancedNoiseSuppressionModeNone = -1,      
    AdvancedNoiseSuppressionModeAuto = 0,       
    AdvancedNoiseSuppressionModeHigh,           
    AdvancedNoiseSuppressionModeOff             
};

AudioCheckupCommand

enum AudioCheckupCommand

Audio checkup command Here are more detailed structural descriptions.

Enumerator
AudioCheckupCommandStart	Start audio checkup.
AudioCheckupCommandCancel	Cancel audio checkup.

Definition at line 21 of file ISettingService.h.

{
    AudioCheckupCommandStart = 0,       
    AudioCheckupCommandCancel           
};

AudioCheckupStatus

enum AudioCheckupStatus

Audio checkup status Here are more detailed structural descriptions.

Enumerator
AudioCheckupStatusIdle	Idle.
AudioCheckupStatusScheduled	Scheduled.
AudioCheckupStatusStarting	Starting.
AudioCheckupStatusChecking	Checking.
AudioCheckupStatusSucceeded	Succeeded.
AudioCheckupStatusFailed	Failed.
AudioCheckupStatusFailedLikely	Failed likely.

Definition at line 31 of file ISettingService.h.

{
    AudioCheckupStatusIdle = 0,         
    AudioCheckupStatusScheduled,        
    AudioCheckupStatusStarting,         
    AudioCheckupStatusChecking,         
    AudioCheckupStatusSucceeded,        
    AudioCheckupStatusFailed,           
    AudioCheckupStatusFailedLikely      
};

CalibrationAction

enum CalibrationAction

Calibration action type. Here are more detailed structural descriptions.

Enumerator
CalibrationActionPageAdjustCamera	Page adjust camera.
CalibrationActionPageCameraControl	Page camera layout.
CalibrationActionPageReadyToMove	Page ready to move.
CalibrationActionEventStartToCalibrate	Event, success and save the result, layout, preset, start to calibrate.
CalibrationActionEventFinishToCheckResult	Event, finish to check result.
CalibrationActionEventAcceptResult	Event, accept result.
CalibrationActionEventStop	Event, stop.
CalibrationActionPageAskNeedSetCameraBoundary	Page ask need set camera boundary.
CalibrationActionEventSwitchBoundaryCamera	Event, switch boundary camera.
CalibrationActionEventAdjustBoundary	Event, adjust boundary.
CalibrationActionPageVerifyBoundary	Page verify boundary.
CalibrationActionPagePreAcceptBoundary	Page pre-accept boundary.
CalibrationActionEventAcceptBoundaryResult	Event, accept boundary result.
CalibrationActionPagePreviewIDBoundary	Page preview ID boundary.

Definition at line 381 of file ISettingService.h.

{
    CalibrationActionPageAdjustCamera,              
    CalibrationActionPageCameraControl,             
    CalibrationActionPageReadyToMove,               
    CalibrationActionEventStartToCalibrate,         
    CalibrationActionEventFinishToCheckResult,      
    CalibrationActionEventAcceptResult,             
    CalibrationActionEventStop,                     
 
    // boundary
    CalibrationActionPageAskNeedSetCameraBoundary,  
    CalibrationActionEventSwitchBoundaryCamera,     
    CalibrationActionEventAdjustBoundary,           
    CalibrationActionPageVerifyBoundary,            
    CalibrationActionPagePreAcceptBoundary,         
    CalibrationActionEventAcceptBoundaryResult,     
    CalibrationActionPagePreviewIDBoundary,         
};

ChannelSignalType

enum ChannelSignalType

Channel signal type Here are more detailed structural descriptions.

Enumerator
ChannelSignalTypeUnknown	Unknown.
ChannelSignalTypeMono	Mono.
ChannelSignalTypeStereoLeft	StereoLeft.
ChannelSignalTypeStereoRight	StereoRight.

Definition at line 94 of file ISettingService.h.

{
    ChannelSignalTypeUnknown = -1,              
    ChannelSignalTypeMono = 0,                  
    ChannelSignalTypeStereoLeft,                
    ChannelSignalTypeStereoRight,               
};

MicRecordTestStatus

enum MicRecordTestStatus

Microphone record test status. Here are more detailed structural descriptions.

Enumerator
MicRecordTestStatusNone	None.
MicRecordTestStatusRecording	Microphone test is recording record.
MicRecordTestStatusPlaying	Microphone test is playing record.

Definition at line 58 of file ISettingService.h.

{
    MicRecordTestStatusNone = 1,            
    MicRecordTestStatusRecording = 2,       
    MicRecordTestStatusPlaying = 3,         
};

NetworkAdapterUpdateType

enum NetworkAdapterUpdateType

Network adapter update type Here are more detailed structural descriptions.

Enumerator
NetworkAdapterUpdateTypeNone	None.
NetworkAdapterUpdateTypeDante	Network audio devices (Dante)
NetworkAdapterUpdateTypeNRC	Native Room Controls (NRC)

Definition at line 159 of file ISettingService.h.

{
    NetworkAdapterUpdateTypeNone = -1,  
    NetworkAdapterUpdateTypeDante = 0,  
    NetworkAdapterUpdateTypeNRC = 1,    
};

NetworkAudioDeviceListAction

enum NetworkAudioDeviceListAction

Network audio device list action type. Here are more detailed structural descriptions.

Enumerator
NetworkAudioDeviceListActionUnknown	Unknown.
NetworkAudioDeviceListActionRefreshList	Refresh list.
NetworkAudioDeviceListActionRemoveDevice	Remove device.
NetworkAudioDeviceListActionAddDevice	Add device.
NetworkAudioDeviceListActionUpdateDevice	Update device.
NetworkAudioDeviceListActionUseDanteController	Action use Dante controller.

Definition at line 130 of file ISettingService.h.

{
    NetworkAudioDeviceListActionUnknown = -1,         
    NetworkAudioDeviceListActionRefreshList,          
    NetworkAudioDeviceListActionRemoveDevice,         
    NetworkAudioDeviceListActionAddDevice,            
    NetworkAudioDeviceListActionUpdateDevice,         
    NetworkAudioDeviceListActionUseDanteController    
};

NetworkAudioDeviceState

enum NetworkAudioDeviceState

Network audio device state Here are more detailed structural descriptions.

Enumerator
NetworkAudioDeviceStateNone	None.
NetworkAudioDeviceStateAvailable	Available.
NetworkAudioDeviceStateConnecting	Connecting.
NetworkAudioDeviceStateConnected	Connected.
NetworkAudioDeviceStateDisconnected	Disconnected.
NetworkAudioDeviceStateError	Error.
NetworkAudioDeviceStateOccupied	Occupied.

Definition at line 144 of file ISettingService.h.

{
    NetworkAudioDeviceStateNone = 0,        
    NetworkAudioDeviceStateAvailable,       
    NetworkAudioDeviceStateConnecting,      
    NetworkAudioDeviceStateConnected,       
    NetworkAudioDeviceStateDisconnected,    
    NetworkAudioDeviceStateError,           
    NetworkAudioDeviceStateOccupied         
};

NetworkConnectionType

enum NetworkConnectionType

Network connection type Here are more detailed structural descriptions.

Enumerator
NetworkConnectionTypeUnknown	Unknown.
NetworkConnectionTypeDirect	Direct.
NetworkConnectionTypeCloud	Cloud.

Definition at line 119 of file ISettingService.h.

{
    NetworkConnectionTypeUnknown = -1,          
    NetworkConnectionTypeDirect = 0,            
    NetworkConnectionTypeCloud = 1,             
};

NetworkType

enum NetworkType

Network type Here are more detailed structural descriptions.

Enumerator
NetworkTypeUnknown	Unknown.
NetworkTypeWired	Wired.
NetworkTypeWifi	Wi-Fi.
NetworkTypePPP	Point-to-Point Protocol.
NetworkType3G	3G.

Definition at line 106 of file ISettingService.h.

{
    NetworkTypeUnknown = -1,                
    NetworkTypeWired = 0,                   
    NetworkTypeWifi = 1,                    
    NetworkTypePPP = 2,                     
    NetworkType3G = 3                       
};

ScreenResolutionStatus

enum ScreenResolutionStatus

Screen resolution status Here are more detailed structural descriptions.

Enumerator
ScreenResolutionStatusOptimizable	Screen resolution status is optimizable.
ScreenResolutionStatusOptimized	Screen resolution status is optimized.

Definition at line 69 of file ISettingService.h.

{
    ScreenResolutionStatusOptimizable = 0,      
    ScreenResolutionStatusOptimized = 1         
};

ScreenSequenceCalibrationAction

enum ScreenSequenceCalibrationAction

Screen sequence calibration action type. Here are more detailed structural descriptions.

Enumerator
ScreenSequenceCalibrationNone	None.
ScreenSequenceCalibrationStart	Start calibration.
ScreenSequenceCalibrationIdentify	Identify screen sequence.
ScreenSequenceCalibrationConfirm	Confirm screen sequence calibration.
ScreenSequenceCalibrationCancel	Cancel screen sequence calibration.
ScreenSequenceCalibrationConfidenceStart	Start confidence monitor calibration.
ScreenSequenceCalibrationConfidenceIdentify	Cancel confidence monitor calibration.

Definition at line 79 of file ISettingService.h.

{
    ScreenSequenceCalibrationNone = -1,         
    ScreenSequenceCalibrationStart = 0,         
    ScreenSequenceCalibrationIdentify,          
    ScreenSequenceCalibrationConfirm,           
    ScreenSequenceCalibrationCancel,            
    ScreenSequenceCalibrationConfidenceStart,   
    ScreenSequenceCalibrationConfidenceIdentify 
};