Meeting Service Video Interface. More...

#include "zoom_sdk_def.h"

Data Structures
struct	tagVideoSize

struct	tagSDKVideoPreferenceSetting
	When setting custom modes, the developer provides the maximum and minimum frame rates. If the current bandwidth cannot maintain the minimum frame rate, the video system will drop to the next lower resolution. The default maximum and minimum frame rates for other modes are 0. More...

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
	When setting custom modes, the developer provides the maximum and minimum frame rates. If the current bandwidth cannot maintain the minimum frame rate, the video system will drop to the next lower resolution. The default maximum and minimum frame rates for other modes are 0.

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

When setting custom modes, the developer provides the maximum and minimum frame rates. If the current bandwidth cannot maintain the minimum frame rate, the video system will drop to the next lower resolution. The default maximum and minimum frame rates for other modes are 0.

◆ VideoSize

typedef struct tagVideoSize VideoSize

Enumeration Type Documentation

◆ CameraControlRequestResult

enum CameraControlRequestResult

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

Enumerator
CameraControlRequestResult_Approve
CameraControlRequestResult_Decline
CameraControlRequestResult_Revoke

Definition at line 173 of file meeting_video_interface.h.

{
    CameraControlRequestResult_Approve,
    CameraControlRequestResult_Decline,
    CameraControlRequestResult_Revoke,
};

◆ CameraControlRequestType

enum CameraControlRequestType

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

Enumerator
CameraControlRequestType_Unknown
CameraControlRequestType_RequestControl
CameraControlRequestType_GiveUpControl

Definition at line 162 of file meeting_video_interface.h.

{
    CameraControlRequestType_Unknown = 0,
    CameraControlRequestType_RequestControl,
    CameraControlRequestType_GiveUpControl,
};

◆ 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 287 of file meeting_video_interface.h.

{
    PinResult_Success = 0,
    PinResult_Fail_NotEnoughUsers,  
    PinResult_Fail_ToMuchPinnedUsers, 
    PinResult_Fail_UserCannotBePinned, 
    PinResult_Fail_VideoModeDoNotSupport, 
    PinResult_Fail_NoPrivilegeToPin, 
    PinResult_Fail_MeetingDoNotSupport, 
    PinResult_Unknown = 100,
};

◆ SDKVideoPreferenceMode

enum 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 59 of file meeting_video_interface.h.

{
    SDKVideoPreferenceMode_Balance, 
    SDKVideoPreferenceMode_Sharpness, 
    SDKVideoPreferenceMode_Smoothness, 
    SDKVideoPreferenceMode_Custom   
}SDKVideoPreferenceMode;

◆ SpotlightResult

enum 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 305 of file meeting_video_interface.h.

{
    SpotResult_Success = 0,
    SpotResult_Fail_NotEnoughUsers,  
    SpotResult_Fail_ToMuchSpotlightedUsers,
    SpotResult_Fail_UserCannotBeSpotlighted, 
    SpotResult_Fail_UserWithoutVideo, 
    SpotResult_Fail_NoPrivilegeToSpotlight,  
    SpotResult_Fail_UserNotSpotlighted, 
    SpotResult_Unknown = 100,
};

◆ VideoConnectionQuality

enum 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 31 of file meeting_video_interface.h.

{
    VideoConnectionQuality_Unknown = 0, 
    VideoConnectionQuality_Bad,  
    VideoConnectionQuality_Normal, 
    VideoConnectionQuality_Good,
};

◆ VideoStatus

enum 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.

{
    Video_ON, 
    Video_OFF, 
    Video_Mute_ByHost, 
};

Data Structures

Typedefs

Enumerations