Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
meeting_ui_ctrl_interface.h File Reference

UI Controller of Meeting Service Interface Valid only for ZOOM style user interface mode. More...

#include "zoom_sdk_def.h"

Go to the source code of this file.

Data Structures

struct  tagVideoWallPageInfoParam
 Video wall page information. Here are more detailed structural descriptions. More...
 
struct  tagShowChatDlgParam
 The configuration of the parameters to display the dialog. Here are more detailed structural descriptions. More...
 
struct  tagSplitScreenInfo
 Split screen mode information. Here are more detailed structural descriptions. More...
 
struct  tagAudioBtnClickedCallbackInfo
 The suggested action information for user to handle after getting the callback event "IMeetingUIControllerEvent::onAudioBtnClicked()" Here are more detailed structural descriptions. More...
 
class  IMeetingUIControllerEvent
 Callback Event of Meeting UI Controller. More...
 
class  IMeetingUIController
 Meeting UI Controller Interface. More...
 

Typedefs

typedef struct tagVideoWallPageInfoParam VideoWallPageInfoParam
 
typedef struct tagShowChatDlgParam ShowChatDlgParam
 
typedef struct tagSplitScreenInfo SplitScreenInfo
 
typedef struct tagAudioBtnClickedCallbackInfo AudioBtnClickedCallbackInfo
 

Enumerations

enum  SDKMeetingUIType { SDK_Meeting_UI_None , SDK_Meeting_UI_VideoWall_Mode , SDK_Meeting_UI_ActiveRender_Mode }
 The displayed type of the user videos in the meeting. Here are more detailed structural descriptions. More...
 
enum  SDKFloatVideoType { FLOATVIDEO_List , FLOATVIDEO_Small , FLOATVIDEO_Large , FLOATVIDEO_Minimize }
 The user interface type of float video. Here are more detailed structural descriptions. More...
 
enum  SDKMinimizeUIMode { MinimizeUIMode_NONE , MinimizeUIMode_SHARE , MinimizeUIMode_VIDEO , MinimizeUIMode_ACTIVESPEAKER }
 The type of minimize user interface mode. Here are more detailed structural descriptions. More...
 
enum  AudioCallbackActionInfo {
  ACTION_NONE = 0 , ACTION_CHOOSE_AUDIO_DEVICE_NOAUDIODEVICECONNECTTED , ACTION_CHOOSE_AUDIO_DEVICE_COMPUTERAUDIODEVICEERROR , ACTION_CHOOSE_AUDIO_DEVICE_PHONECALLDEVICEERROR ,
  ACTION_NEED_JOIN_VOIP , ACTION_MUTE_UNMUTE_AUDIO , ACTION_SHOW_AUDIO_SETTING_WINDOW
}
 The action user suggested to take after getting the callback event "IMeetingUIControllerEvent::onAudioBtnClicked()" Here are more detailed structural descriptions. More...
 

Detailed Description

UI Controller of Meeting Service Interface Valid only for ZOOM style user interface mode.

Definition in file meeting_ui_ctrl_interface.h.

Typedef Documentation

◆ AudioBtnClickedCallbackInfo

◆ ShowChatDlgParam

◆ SplitScreenInfo

◆ VideoWallPageInfoParam

Enumeration Type Documentation

◆ AudioCallbackActionInfo

The action user suggested to take after getting the callback event "IMeetingUIControllerEvent::onAudioBtnClicked()" Here are more detailed structural descriptions.

Enumerator
ACTION_NONE 

For initialization.

ACTION_CHOOSE_AUDIO_DEVICE_NOAUDIODEVICECONNECTTED 

Choose audio device because no audio device is connected yet.

ACTION_CHOOSE_AUDIO_DEVICE_COMPUTERAUDIODEVICEERROR 

Choose audio device because there is an error in the connected computer audio device.

ACTION_CHOOSE_AUDIO_DEVICE_PHONECALLDEVICEERROR 

Choose audio device because there is an error in the connected phone call device.

ACTION_NEED_JOIN_VOIP 

Need to join voip.

ACTION_MUTE_UNMUTE_AUDIO 

Mute or unmute some user's audio according to the "AudioBtnClickedCallbackInfo::userid_MuteUnmute".

ACTION_SHOW_AUDIO_SETTING_WINDOW 

Show audio setting window.

Definition at line 101 of file meeting_ui_ctrl_interface.h.

102{
103 ACTION_NONE = 0,
110};
@ ACTION_CHOOSE_AUDIO_DEVICE_COMPUTERAUDIODEVICEERROR
Choose audio device because there is an error in the connected computer audio device.
@ ACTION_CHOOSE_AUDIO_DEVICE_PHONECALLDEVICEERROR
Choose audio device because there is an error in the connected phone call device.
@ ACTION_NEED_JOIN_VOIP
Need to join voip.
@ ACTION_SHOW_AUDIO_SETTING_WINDOW
Show audio setting window.
@ ACTION_NONE
For initialization.
@ ACTION_CHOOSE_AUDIO_DEVICE_NOAUDIODEVICECONNECTTED
Choose audio device because no audio device is connected yet.
@ ACTION_MUTE_UNMUTE_AUDIO
Mute or unmute some user's audio according to the "AudioBtnClickedCallbackInfo::userid_MuteUnmute".

◆ SDKFloatVideoType

The user interface type of float video. Here are more detailed structural descriptions.

Enumerator
FLOATVIDEO_List 

Type of list.

FLOATVIDEO_Small 

Small.

FLOATVIDEO_Large 

Large.

FLOATVIDEO_Minimize 

Minimized.

Definition at line 62 of file meeting_ui_ctrl_interface.h.

63{
68};
@ FLOATVIDEO_Minimize
Minimized.
@ FLOATVIDEO_List
Type of list.
@ FLOATVIDEO_Large
Large.
@ FLOATVIDEO_Small
Small.

◆ SDKMeetingUIType

The displayed type of the user videos in the meeting. Here are more detailed structural descriptions.

Enumerator
SDK_Meeting_UI_None 

For initialization.

SDK_Meeting_UI_VideoWall_Mode 

Video wall mode.

SDK_Meeting_UI_ActiveRender_Mode 

Active user mode.

Definition at line 15 of file meeting_ui_ctrl_interface.h.

16{
20};
@ SDK_Meeting_UI_ActiveRender_Mode
Active user mode.
@ SDK_Meeting_UI_VideoWall_Mode
Video wall mode.
@ SDK_Meeting_UI_None
For initialization.

◆ SDKMinimizeUIMode

The type of minimize user interface mode. Here are more detailed structural descriptions.

Enumerator
MinimizeUIMode_NONE 

For initialization.

MinimizeUIMode_SHARE 

Minimized mode for sharing.

MinimizeUIMode_VIDEO 

Minimized mode for video.

MinimizeUIMode_ACTIVESPEAKER 

Minimized mode for speaking.

Definition at line 74 of file meeting_ui_ctrl_interface.h.

75{
80};
@ MinimizeUIMode_VIDEO
Minimized mode for video.
@ MinimizeUIMode_NONE
For initialization.
@ MinimizeUIMode_SHARE
Minimized mode for sharing.
@ MinimizeUIMode_ACTIVESPEAKER
Minimized mode for speaking.