Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
customized_immersive.h
Go to the documentation of this file.
1
6#ifndef _MEETING_IMMERSIVE_INTERFACE_H_
7#define _MEETING_IMMERSIVE_INTERFACE_H_
8#include "zoom_sdk_def.h"
9
11
22
27{
28 unsigned int seat_id;
29 RECT position;
30
32 {
33 seat_id = 0;
34 position = { 0 };
35 }
36};
37
42{
44 unsigned int seat_id;
45 unsigned int user_id;
46 unsigned int z_order;
47 RECT position;
48
50 {
51 is_seat_free = false;
52 seat_id = 0;
53 user_id = 0;
54 z_order = 0;
55 position = { 0 };
56 }
57};
58
62{
63public:
66 virtual SIZE getCanvasSize() = 0;
67
71
73};
74
78{
79public:
82 virtual const zchar_t* getTemplateName() = 0;
83
86 virtual const void* getThumbnailBitmap() = 0;
87
90 virtual unsigned int getCapacity() = 0;
91
94 virtual bool isTemplateReady() = 0;
95
98 virtual bool isSupportFreeSeat() = 0;
99
103
107
111
113};
114
118{
119public:
125 virtual SDKError addUser(unsigned int userID, unsigned int seatID) = 0;
126
132 virtual SDKError addUser(unsigned int userID, RECT pos) = 0;
133
138 virtual SDKError removeUser(unsigned int userID) = 0;
139
144
148
152 virtual SDKError commit() = 0;
153
155};
156
160{
161public:
164 virtual void onImmersiveStatusChanged(bool bOn) = 0;
165
169
173
177 virtual void onTemplateDownloadProgress(ICustomImmersiveTemplate* immersiveTemplate, unsigned int progress) = 0;
178
182 virtual void onTemplateDownloadEnded(ICustomImmersiveTemplate* immersiveTemplate, bool bSuccess) = 0;
183
186 virtual void onTemplateThumbnailsDownloadEnded(bool bSuccess) = 0;
187
189};
190
194{
195public:
201
206 virtual SDKError isSupportImmersive(bool& bSupport) = 0;
207
212 virtual SDKError isImmersiveViewOn(bool& bOn) = 0;
213
218
223 virtual SDKError isTemplateThumbnailsReady(bool& bReady) = 0;
224
228
233 virtual SDKError downloadTemplate(ICustomImmersiveTemplate* immersiveTemplate) = 0;
234
240 virtual SDKError canStartImmersiveView(ICustomImmersiveTemplate* immersiveTemplate, bool& bCan) = 0;
241
247 virtual SDKError startImmersiveView(ICustomImmersiveTemplate* immersiveTemplate) = 0;
248
253 virtual SDKError changeTemplate(ICustomImmersiveTemplate* immersiveTemplate) = 0;
254
259
263
269 virtual SDKError canUserShowInImmersiveView(unsigned int userID, bool& bCan) = 0;
270
274
278
284 virtual SDKError assignUser(unsigned int userID, unsigned int seatID) = 0;
285
291 virtual SDKError putUserToFreeSeat(unsigned int userID, RECT pos) = 0;
292
297 virtual SDKError removeUser(unsigned int userID) = 0;
298
304 virtual SDKError isUserInImmersiveView(unsigned int userID, bool& bIn) = 0;
305
311 virtual SDKError addCustomImageTemplate(const zchar_t* filePath, ICustomImmersiveTemplate** immersiveTemplate) = 0;
312
318
323 virtual SDKError isInImmersiveShareMode(bool& bInShare) = 0;
324
329 virtual SDKError viewShare(unsigned int shareSourceID) = 0;
330
335 virtual SDKError getViewingShareSourceID(unsigned int& shareSourceID) = 0;
336
338};
339
340
341
343#endif
Meeting immersive controller interface. For more details on this feature, see https://support....
virtual SDKError putUserToFreeSeat(unsigned int userID, RECT pos)=0
Put the user in the free seat.
virtual SDKError removeCustomImageTemplate(ICustomImmersiveTemplate *immersiveTemplate)=0
Remove custom image template.
virtual SDKError getViewingShareSourceID(unsigned int &shareSourceID)=0
Query the share source ID when viewing share in immersive mode, only available for host.
virtual IList< ICustomImmersiveTemplate * > * getTemplates()=0
Get the list of templates.
virtual SDKError downloadTemplate(ICustomImmersiveTemplate *immersiveTemplate)=0
Download complete template resource.
virtual SDKError downloadTemplateThumbnails()=0
Download the template thumbnails. See /link ICustomImmersiveCtrlEvent /endlink for updates on the dow...
virtual SDKError canStartImmersiveView(ICustomImmersiveTemplate *immersiveTemplate, bool &bCan)=0
Determine if the immersive template can be started.
virtual SDKError assignUser(unsigned int userID, unsigned int seatID)=0
Put the user in the seat.
virtual SDKError startImmersiveView(ICustomImmersiveTemplate *immersiveTemplate)=0
Start immersive view.
virtual SDKError isInImmersiveShareMode(bool &bInShare)=0
Determine if displaying sharing contents in immersive mode.
virtual IList< CustomImmersiveLayoutData > * getLayoutData()=0
Get the immersive seat layout data.
virtual SDKError SetEvent(ICustomImmersiveCtrlEvent *pEvent)=0
Set immersive object callback event handler.
virtual SDKError isTemplateThumbnailsReady(bool &bReady)=0
Determine if the thumbnails are ready.
virtual SDKError changeTemplate(ICustomImmersiveTemplate *immersiveTemplate)=0
Change template in immersive view.
virtual SDKError endImmersiveView()=0
Exit immersive view.
virtual ICustomImmersivePreLayoutHelper * getImmersivePreLayoutHelper()=0
Get the immersive pre-layout helper pointer.
virtual SDKError isImmersiveViewOn(bool &bOn)=0
Determine if immersive view is active.
virtual SDKError isSupportImmersive(bool &bSupport)=0
Determine if immersive is supported.
virtual SDKError removeUser(unsigned int userID)=0
Remove user from immersive view.
virtual SDKError viewShare(unsigned int shareSourceID)=0
Update the share source ID to view share, only available for host.
virtual ICustomImmersiveTemplate * getCurrentTemplate()=0
Get the current template.
virtual SDKError addCustomImageTemplate(const zchar_t *filePath, ICustomImmersiveTemplate **immersiveTemplate)=0
Add a template based on a custom image.
virtual SDKError isUserInImmersiveView(unsigned int userID, bool &bIn)=0
Determine if the user is in immersive view.
virtual SDKError canUserShowInImmersiveView(unsigned int userID, bool &bCan)=0
Determine if the user can be shown in immersive view.
Immersive controller object interface.
virtual void onSelectedImmersiveTemplateChanged(ICustomImmersiveTemplate *immersiveTemplate)=0
Callback event that the selected immersive template changed.
virtual void onImmersiveStatusChanged(bool bOn)=0
Callback event that the immersive view was enabled/disabled.
virtual void onTemplateDownloadEnded(ICustomImmersiveTemplate *immersiveTemplate, bool bSuccess)=0
Callback event for the immersive template download end.
virtual void onTemplateDownloadProgress(ICustomImmersiveTemplate *immersiveTemplate, unsigned int progress)=0
Callback event for the immersive template download process.
virtual void onImmersiveSeatLayoutUpdated(IList< CustomImmersiveLayoutData > *seatList)=0
Callback event that the immersive seat layout changed.
virtual void onTemplateThumbnailsDownloadEnded(bool bSuccess)=0
Callback event that template thumbnails download end.
Immersive pre-layout helper interface to update immersive view layout at once.
virtual IList< CustomImmersiveLayoutData > * getPreLayoutData()=0
Get the pre-layout data.
virtual SDKError addUser(unsigned int userID, unsigned int seatID)=0
Add a user to the pre-layout with a seat ID.
virtual SDKError commit()=0
Commit pre-layout data to immersive view. This only works just after the immersive view starts.
virtual SDKError addUser(unsigned int userID, RECT pos)=0
Add a user to the pre-layout with a position.
virtual SDKError removeAllUsers()=0
Remove all users from the pre-layout.
virtual SDKError removeUser(unsigned int userID)=0
Remove a user from the pre-layout.
Immersive template data object interface.
virtual IList< SeatPlacementInfo > * getSeatList()=0
Get the list of template seats.
virtual SIZE getCanvasSize()=0
Get the size of this template.
Immersive template object interface.
virtual bool isTemplateReady()=0
Determine if this template is ready.
virtual CustomImmersiveTemplateType getType()=0
Get the type of this template.
virtual ICustomImmersiveTemplateData * getVideoTemplateData()=0
Get the template data of immersive when in default mode.
virtual const void * getThumbnailBitmap()=0
Get the bitmap of the thumbnail.
virtual unsigned int getCapacity()=0
Get the capacity of this template.
virtual ICustomImmersiveTemplateData * getShareTemplateData()=0
Get the template data of immersive when in share mode.
virtual bool isSupportFreeSeat()=0
Determine whether this template supports a free seat.
virtual const zchar_t * getTemplateName()=0
Get the name of this template.
CustomImmersiveTemplateType
Type of immersive template. View more detailed structural descriptions.
@ CustomImmersiveTemplateType_CustomImage
A template using a custom image. This kind of template can only be used after CustomImmersiveTemplate...
@ CustomImmersiveTemplateType_MyVideo
The my video template.
@ CustomImmersiveTemplateType_Default
The default template.
Layout data of immersive.
unsigned int user_id
The user ID.
unsigned int seat_id
The seat ID.
RECT position
The seat position.
bool is_seat_free
Whether this user is in seat.
unsigned int z_order
The seat z order. Higher numbers are displayed on top of lower ones.
Information of seat placement in a template.
unsigned int seat_id
The seat ID.
RECT position
The seat position.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
wchar_t zchar_t
#define BEGIN_ZOOM_SDK_NAMESPACE
SDKError
Enumeration of common errors of SDK.