meeting_video_interface.h File Reference

Meeting Service Video Interface. More...

#include "zoom_sdk_def.h"
#include "zoom_sdk_util_define.h"

Go to the source code of this file.

Data Structures
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	IMeetingVideoCtrlEvent
	Meeting video controller event callback. More...
class	IMeetingVideoController
	Meeting video controller interface. More...

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

Enumeration Type Documentation

PinResult

enum PinResult

Enumerator
PinResult_Success
PinResult_Fail_NotEnoughUsers
PinResult_Fail_ToMuchPinnedUsers	user counts less than 2
PinResult_Fail_UserCannotBePinned	pinned user counts more than 9
PinResult_Fail_VideoModeDoNotSupport	user in view only mode or silent mode or active
PinResult_Fail_NoPrivilegeToPin	other reasons
PinResult_Fail_MeetingDoNotSupport	current user has no privilege to pin
PinResult_Unknown	webinar and in view only meeting

Definition at line 126 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,
};

SpotlightResult

enum SpotlightResult

Enumerator
SpotResult_Success
SpotResult_Fail_NotEnoughUsers
SpotResult_Fail_ToMuchSpotlightedUsers	user counts less than 2
SpotResult_Fail_UserCannotBeSpotlighted	spotlighted user counts is more than 9
SpotResult_Fail_UserWithoutVideo	user in view only mode or silent mode or active
SpotResult_Fail_NoPrivilegeToSpotlight	user doesn't turn on video
SpotResult_Fail_UserNotSpotlighted	current user has no privilege to spotlight
SpotResult_Unknown	user is not spotlighted

Definition at line 138 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
VideoConnectionQuality_Bad
VideoConnectionQuality_Normal
VideoConnectionQuality_Good

Definition at line 26 of file meeting_video_interface.h.

{
    VideoConnectionQuality_Unknown = 0, //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.
};

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

{
    Video_ON, 
    Video_OFF, 
    Video_Mute_ByHost, 
};