Meeting SDK for Linux API Reference
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
meeting_video_interface.h File Reference

Meeting Service Video Interface. More...

#include "zoom_sdk_def.h"

Go to the source code of this file.

Data Structures

struct  tagVideoSize
 
struct  tagSDKVideoPreferenceSetting
 
class  ISetVideoOrderHelper
 set video order helper interface. More...
 
class  IRequestStartVideoHandler
 Process after the user receives the requirement from the host to turn on the video. More...
 
class  ICameraControlRequestHandler
 Camera control request. More...
 
class  IMeetingVideoCtrlEvent
 Meeting video controller event callback. More...
 
class  IMeetingCameraHelper
 Meeting camera helper interface. More...
 
class  IMeetingVideoController
 Meeting video controller interface. More...
 

Typedefs

typedef struct tagVideoSize VideoSize
 
typedef struct tagSDKVideoPreferenceSetting SDKVideoPreferenceSetting
 

Enumerations

enum  VideoStatus { Video_ON , Video_OFF , Video_Mute_ByHost }
 The video status of the user. Here are more detailed structural descriptions. More...
 
enum  VideoConnectionQuality { VideoConnectionQuality_Unknown = 0 , VideoConnectionQuality_Bad , VideoConnectionQuality_Normal , VideoConnectionQuality_Good }
 The video quality of the user. Here are more detailed structural descriptions. More...
 
enum  SDKVideoPreferenceMode { SDKVideoPreferenceMode_Balance , SDKVideoPreferenceMode_Sharpness , SDKVideoPreferenceMode_Smoothness , SDKVideoPreferenceMode_Custom }
 Select and use any of the defined preference mode below when initializing the SDKVideoPreferenceSetting. Video preference modes determined the video frame rate and resolution based on the user's bandwidth. Here are more detailed structural descriptions. More...
 
enum  CameraControlRequestType { CameraControlRequestType_Unknown = 0 , CameraControlRequestType_RequestControl , CameraControlRequestType_GiveUpControl }
 The camera control request type. Here are more detailed structural descriptions. More...
 
enum  CameraControlRequestResult { CameraControlRequestResult_Approve , CameraControlRequestResult_Decline , CameraControlRequestResult_Revoke }
 The camera control request result. Here are more detailed structural descriptions. More...
 
enum  PinResult {
  PinResult_Success = 0 , PinResult_Fail_NotEnoughUsers , PinResult_Fail_ToMuchPinnedUsers , PinResult_Fail_UserCannotBePinned ,
  PinResult_Fail_VideoModeDoNotSupport , PinResult_Fail_NoPrivilegeToPin , PinResult_Fail_MeetingDoNotSupport , PinResult_Unknown = 100
}
 
enum  SpotlightResult {
  SpotResult_Success = 0 , SpotResult_Fail_NotEnoughUsers , SpotResult_Fail_ToMuchSpotlightedUsers , SpotResult_Fail_UserCannotBeSpotlighted ,
  SpotResult_Fail_UserWithoutVideo , SpotResult_Fail_NoPrivilegeToSpotlight , SpotResult_Fail_UserNotSpotlighted , SpotResult_Unknown = 100
}
 

Detailed Description

Meeting Service Video Interface.

Definition in file meeting_video_interface.h.

Typedef Documentation

◆ SDKVideoPreferenceSetting

typedef struct tagSDKVideoPreferenceSetting SDKVideoPreferenceSetting

◆ VideoSize

typedef struct tagVideoSize VideoSize

Enumeration Type Documentation

◆ CameraControlRequestResult

The camera control request result. Here are more detailed structural descriptions.

Enumerator
CameraControlRequestResult_Approve 
CameraControlRequestResult_Decline 
CameraControlRequestResult_Revoke 

Definition at line 138 of file meeting_video_interface.h.

◆ CameraControlRequestType

The camera control request type. Here are more detailed structural descriptions.

Enumerator
CameraControlRequestType_Unknown 
CameraControlRequestType_RequestControl 
CameraControlRequestType_GiveUpControl 

Definition at line 127 of file meeting_video_interface.h.

◆ PinResult

enum PinResult
Enumerator
PinResult_Success 
PinResult_Fail_NotEnoughUsers 

user counts less than 2

PinResult_Fail_ToMuchPinnedUsers 

pinned user counts more than 9

PinResult_Fail_UserCannotBePinned 

user in view only mode or silent mode or active

PinResult_Fail_VideoModeDoNotSupport 

other reasons

PinResult_Fail_NoPrivilegeToPin 

current user has no privilege to pin

PinResult_Fail_MeetingDoNotSupport 

webinar and in view only meeting

PinResult_Unknown 

Definition at line 223 of file meeting_video_interface.h.

224{
232 PinResult_Unknown = 100,
233};
@ PinResult_Fail_NoPrivilegeToPin
current user has no privilege to pin
@ PinResult_Fail_MeetingDoNotSupport
webinar and in view only meeting
@ PinResult_Fail_UserCannotBePinned
user in view only mode or silent mode or active
@ PinResult_Fail_VideoModeDoNotSupport
other reasons
@ PinResult_Fail_NotEnoughUsers
user counts less than 2
@ PinResult_Fail_ToMuchPinnedUsers
pinned user counts more than 9

◆ SDKVideoPreferenceMode

Select and use any of the defined preference mode below when initializing the SDKVideoPreferenceSetting. Video preference modes determined the video frame rate and resolution based on the user's bandwidth. Here are more detailed structural descriptions.

Enumerator
SDKVideoPreferenceMode_Balance 

Balance mode. Default Preference, no additional parameters needed. Zoom will do what is best under the current bandwidth situation and make adjustments as needed.

SDKVideoPreferenceMode_Sharpness 

Sharpness mode. Prioritizes a smooth video frame transition by preserving the frame rate as much as possible.

SDKVideoPreferenceMode_Smoothness 

Smoothness mode. Prioritizes a sharp video image by preserving the resolution as much as possible.

SDKVideoPreferenceMode_Custom 

Custom mode. Allows customization by providing the minimum and maximum frame rate. Use this mode if you have an understanding of your network behavior and a clear idea on how to adjust the frame rate to achieve the desired video quality.

Definition at line 52 of file meeting_video_interface.h.

53{
SDKVideoPreferenceMode
Select and use any of the defined preference mode below when initializing the SDKVideoPreferenceSetti...
@ SDKVideoPreferenceMode_Sharpness
Sharpness mode. Prioritizes a smooth video frame transition by preserving the frame rate as much as p...
@ SDKVideoPreferenceMode_Smoothness
Smoothness mode. Prioritizes a sharp video image by preserving the resolution as much as possible.
@ SDKVideoPreferenceMode_Balance
Balance mode. Default Preference, no additional parameters needed. Zoom will do what is best under th...
@ SDKVideoPreferenceMode_Custom
Custom mode. Allows customization by providing the minimum and maximum frame rate....

◆ SpotlightResult

Enumerator
SpotResult_Success 
SpotResult_Fail_NotEnoughUsers 

user counts less than 2

SpotResult_Fail_ToMuchSpotlightedUsers 

spotlighted user counts is more than 9

SpotResult_Fail_UserCannotBeSpotlighted 

user in view only mode or silent mode or active

SpotResult_Fail_UserWithoutVideo 

user doesn't turn on video

SpotResult_Fail_NoPrivilegeToSpotlight 

current user has no privilege to spotlight

SpotResult_Fail_UserNotSpotlighted 

user is not spotlighted

SpotResult_Unknown 

Definition at line 235 of file meeting_video_interface.h.

236{
244 SpotResult_Unknown = 100,
245};
@ SpotResult_Fail_NoPrivilegeToSpotlight
current user has no privilege to spotlight
@ SpotResult_Fail_UserWithoutVideo
user doesn't turn on video
@ SpotResult_Fail_UserNotSpotlighted
user is not spotlighted
@ SpotResult_Fail_NotEnoughUsers
user counts less than 2
@ SpotResult_Fail_ToMuchSpotlightedUsers
spotlighted user counts is more than 9
@ SpotResult_Fail_UserCannotBeSpotlighted
user in view only mode or silent mode or active

◆ VideoConnectionQuality

The video quality of the user. Here are more detailed structural descriptions.

Enumerator
VideoConnectionQuality_Unknown 

Unknown video quality status.

VideoConnectionQuality_Bad 

The video quality is poor.

VideoConnectionQuality_Normal 

The video quality is normal.

VideoConnectionQuality_Good 

The video quality is good.

Definition at line 28 of file meeting_video_interface.h.

29{
34};
@ VideoConnectionQuality_Normal
The video quality is normal.
@ VideoConnectionQuality_Good
The video quality is good.
@ VideoConnectionQuality_Bad
The video quality is poor.
@ VideoConnectionQuality_Unknown
Unknown video quality status.

◆ VideoStatus

The video status of the user. Here are more detailed structural descriptions.

Enumerator
Video_ON 

Video is on.

Video_OFF 

Video is off.

Video_Mute_ByHost 

Video is muted by host.

Definition at line 18 of file meeting_video_interface.h.

19{
20 Video_ON,
21 Video_OFF,
23};
@ Video_ON
Video is on.
@ Video_OFF
Video is off.
@ Video_Mute_ByHost
Video is muted by host.