Zoom Rooms Controller SDK Reference 7.1.0
Loading...
Searching...
No Matches
IMeetingVideoHelper.h File Reference

Meeting Video interfaces. More...

#include "ZRCSDKTypes.h"

Go to the source code of this file.

Data Structures

struct  ScreenStatusForPin
 Screen status for pin video or pin share. More...
 
struct  SpotlightStatus
 Spotlight status. More...
 
struct  MyVideoTouchUpSettings
 My video touch up settings. More...
 
struct  MyVideoLowLightSettings
 My video low light settings. More...
 
struct  MyVideoSettings
 My video settings. More...
 
struct  MyMeetingVideoSettings
 My meeting video settings of the specific meeting, which includes my video settings and the specific meeting. More...
 
class  IMeetingVideoHelperSink
 Meeting Video helper event callback. More...
 
class  IMeetingVideoHelper
 Meeting Video helper interface. More...
 

Enumerations

enum  PinShareWarningType {
  PinShareWarningTypeNone = 0 , PinShareWarningTypeNoAnnotationForSelf , PinShareWarningTypeStopSelfShare , PinShareWarningTypeStopCameraShare ,
  PinShareWarningTypeStopWhiteboard
}
 Screen pin share warning type. Here are more detailed structural descriptions. More...
 
enum  CanNotPinShareReason { CanNotPinShareReasonUnknown = 1 , CanNotPinShareReasonContentOnly }
 Screen cannot pin share reason. Here are more detailed structural descriptions. More...
 
enum  PreviewVideoType { PreviewVideoTypeCameraSettings = 0 , PreviewVideoTypeVirtualBackground , PreviewVideoTypeMeetingAlert }
 Preview video type. Here are more detailed structural descriptions. More...
 
enum  MyVideoSettingsDisableReason {
  MyVideoSettingsDisableReasonNone = -1 , MyVideoSettingsDisableReasonNotDisable = 0 , MyVideoSettingsDisableReasonMultiStreamEnable = 1 , MyVideoSettingsDisableReasonIntelligentDirectorEnable = 2 ,
  MyVideoSettingsDisableReasonMultiCameraEnable = 3
}
 Indicates whether Touch Up My Appearance conflicts with other features. More...
 

Detailed Description

Meeting Video interfaces.

Since
Added in ZRC SDK 6.0.0

Definition in file IMeetingVideoHelper.h.

Enumeration Type Documentation

◆ CanNotPinShareReason

Screen cannot pin share reason. Here are more detailed structural descriptions.

Enumerator
CanNotPinShareReasonUnknown 

Unclassified reason.

CanNotPinShareReasonContentOnly 

Content only not enabled, current ScreenLayoutSourceType is not ScreenLayoutSourceTypeSharedContent.

Definition at line 30 of file IMeetingVideoHelper.h.

31{
34};
@ CanNotPinShareReasonUnknown
Unclassified reason.
@ CanNotPinShareReasonContentOnly
Content only not enabled, current ScreenLayoutSourceType is not ScreenLayoutSourceTypeSharedContent.

◆ MyVideoSettingsDisableReason

Indicates whether Touch Up My Appearance conflicts with other features.

MyVideoSettingsDisableReasonNone means there is no conflict with other features. A non-None value means Touch Up My Appearance conflicts with another feature.

Enumerator
MyVideoSettingsDisableReasonNone 

Touch Up My Appearance does not conflict with other features.

MyVideoSettingsDisableReasonNotDisable 

Touch Up My Appearance is available because the conflicting feature is not enabled at the same time.

MyVideoSettingsDisableReasonMultiStreamEnable 

Touch Up My Appearance is unavailable because Smart Gallery is enabled.

MyVideoSettingsDisableReasonIntelligentDirectorEnable 

Touch Up My Appearance is unavailable because Intelligent Director is enabled.

MyVideoSettingsDisableReasonMultiCameraEnable 

Touch Up My Appearance is unavailable because Multi-camera is enabled.

Definition at line 99 of file IMeetingVideoHelper.h.

100{
106};
@ MyVideoSettingsDisableReasonNone
Touch Up My Appearance does not conflict with other features.
@ MyVideoSettingsDisableReasonMultiStreamEnable
Touch Up My Appearance is unavailable because Smart Gallery is enabled.
@ MyVideoSettingsDisableReasonMultiCameraEnable
Touch Up My Appearance is unavailable because Multi-camera is enabled.
@ MyVideoSettingsDisableReasonNotDisable
Touch Up My Appearance is available because the conflicting feature is not enabled at the same time.
@ MyVideoSettingsDisableReasonIntelligentDirectorEnable
Touch Up My Appearance is unavailable because Intelligent Director is enabled.

◆ PinShareWarningType

Screen pin share warning type. Here are more detailed structural descriptions.

Enumerator
PinShareWarningTypeNone 

None.

PinShareWarningTypeNoAnnotationForSelf 

Warning that the annotation will be lost if pin share on the screen.

PinShareWarningTypeStopSelfShare 

Warning that the user's share will be stopped if pin share on the screen.

PinShareWarningTypeStopCameraShare 

Warning that the camera share will be stopped if pin share on the screen.

PinShareWarningTypeStopWhiteboard 

Warning that the classic whiteboard share will be stopped if pin share on the screen.

Definition at line 17 of file IMeetingVideoHelper.h.

18{
24};
@ PinShareWarningTypeNoAnnotationForSelf
Warning that the annotation will be lost if pin share on the screen.
@ PinShareWarningTypeStopWhiteboard
Warning that the classic whiteboard share will be stopped if pin share on the screen.
@ PinShareWarningTypeStopSelfShare
Warning that the user's share will be stopped if pin share on the screen.
@ PinShareWarningTypeStopCameraShare
Warning that the camera share will be stopped if pin share on the screen.
@ PinShareWarningTypeNone
None.

◆ PreviewVideoType

Preview video type. Here are more detailed structural descriptions.

Enumerator
PreviewVideoTypeCameraSettings 

Preview video type camera settings.

PreviewVideoTypeVirtualBackground 

Preview video type virtual background.

PreviewVideoTypeMeetingAlert 

Preview video type meeting alert.

Definition at line 40 of file IMeetingVideoHelper.h.

41{
45};
@ PreviewVideoTypeVirtualBackground
Preview video type virtual background.
@ PreviewVideoTypeMeetingAlert
Preview video type meeting alert.
@ PreviewVideoTypeCameraSettings
Preview video type camera settings.