Meeting SDK for Linux API Reference
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
meeting_video_interface.h
Go to the documentation of this file.
1
6#ifndef _MEETING_VIDEO_INTERFACE_H_
7#define _MEETING_VIDEO_INTERFACE_H_
8#include "zoom_sdk_def.h"
9#if defined(WIN32)
10#include "zoom_sdk_util_define.h"
11#endif
13
35
36typedef struct tagVideoSize
37{
38 int width;
39 int height;
41 {
42 memset(this, 0, sizeof(tagVideoSize)); //checked safe
43 }
45
46
59
60
78
79
83{
84public:
90
97 virtual bool AddVideoToOrder(unsigned int userId, unsigned int position) = 0;
98
104};
105
108{
109public:
113 virtual unsigned int GetReqFromUserId() = 0;
115 virtual SDKError Ignore() = 0;
117 virtual SDKError Accept() = 0;
118
120 virtual SDKError Cancel() = 0;
121};
122
133
144
147{
148public:
150
152 virtual SDKError Approve() = 0;
153
155 virtual SDKError Decline() = 0;
156};
157
161{
162public:
164
169 virtual void onUserVideoStatusChange(unsigned int userId, VideoStatus status) = 0;
170
175 virtual void onSpotlightedUserListChangeNotification(IList<unsigned int >* lstSpotlightedUserID) = 0;
176
180
183 virtual void onActiveSpeakerVideoUserChanged(unsigned int userid) = 0;
184
187 virtual void onActiveVideoUserChanged(unsigned int userid) = 0;
188
191 virtual void onHostVideoOrderUpdated(IList<unsigned int >* orderList) = 0;
192
195 virtual void onLocalVideoOrderUpdated(IList<unsigned int >* localOrderList) = 0;
196
199 virtual void onFollowHostVideoOrderChanged(bool bFollow) = 0;
200
204 virtual void onUserVideoQualityChanged(VideoConnectionQuality quality, unsigned int userid) = 0;
205
208 virtual void onVideoAlphaChannelStatusChanged(bool isAlphaModeOn) = 0;
209
215 virtual void onCameraControlRequestReceived(unsigned int userId, CameraControlRequestType requestType, ICameraControlRequestHandler* pHandler) = 0;
216
220 virtual void onCameraControlRequestResult(unsigned int userId, CameraControlRequestResult result) = 0;
221};
222
234
246
250{
251public:
253
256 virtual unsigned int GetUserId() = 0;
257
260 virtual bool CanControlCamera() = 0;
261
266
271
276 virtual SDKError TurnLeft(unsigned int range = 50) = 0;
277
282 virtual SDKError TurnRight(unsigned int range = 50) = 0;
283
288 virtual SDKError TurnUp(unsigned int range = 50) = 0;
289
294 virtual SDKError TurnDown(unsigned int range = 50) = 0;
295
300 virtual SDKError ZoomIn(unsigned int range = 50) = 0;
301
306 virtual SDKError ZoomOut(unsigned int range = 50) = 0;
307};
308
312{
313public:
319
324 virtual SDKError MuteVideo() = 0;
325
330 virtual SDKError UnmuteVideo() = 0;
331
338 virtual SDKError CanSpotlight(unsigned int userid, SpotlightResult& result) = 0;
339
346 virtual SDKError CanUnSpotlight(unsigned int userid, SpotlightResult& result) = 0;
347
353 virtual SDKError SpotlightVideo(unsigned int userid) = 0;
354
360 virtual SDKError UnSpotlightVideo(unsigned int userid) = 0;
361
367
373
379 virtual SDKError CanAskAttendeeToStartVideo(unsigned int userid) = 0;
380
386 virtual SDKError AskAttendeeToStartVideo(unsigned int userid) = 0;
387
393 virtual SDKError CanStopAttendeeVideo(unsigned int userid) = 0;
394
400 virtual SDKError StopAttendeeVideo(unsigned int userid) = 0;
401
405
410 virtual SDKError EnableFollowHostVideoOrder(bool bEnable) = 0;
411
414 virtual bool IsFollowHostVideoOrderOn() = 0;
415
420
421
424 virtual bool IsIncomingVideoStopped() = 0;
425#if defined(WIN32)
432 virtual SDKError CanPinToFirstView(unsigned int userid, PinResult& result) = 0;
433
439 virtual SDKError PinVideoToFirstView(unsigned int userid) = 0;
440
446 virtual SDKError UnPinVideoFromFirstView(unsigned int userid) = 0;
447
452 virtual SDKError UnPinAllVideosFromFirstView() = 0;
453
458 virtual IList<unsigned int >* GetPinnedUserListFromFirstView() = 0;
459
466 virtual SDKError CanPinToSecondView(unsigned int userid, PinResult& result) = 0;
467
473 virtual SDKError PinVideoToSecondView(unsigned int userid) = 0;
474
480 virtual SDKError UnPinVideoFromSecondView(unsigned int userid) = 0;
481
486 virtual IList<unsigned int >* GetPinnedUserListFromSecondView() = 0;
487
492 virtual SDKError HideOrShowNoVideoUserOnVideoWall(bool bHide) = 0;
493
498 virtual SDKError HideOrShowSelfView(bool bHide) = 0;
499
502 virtual ISetVideoOrderHelper* GetSetVideoOrderHelper() = 0;
503
506 virtual ICameraController* GetMyCameraController() = 0;
507
512 virtual SDKError StopIncomingVideo(bool bStop) = 0;
513
518 virtual SDKError ShowAvatar(bool bShow) = 0;
519
522 virtual bool IsShowAvatar() = 0;
523#endif
524
527 virtual IMeetingCameraHelper* GetMeetingCameraHelper(unsigned int userid) = 0;
528
533
536 virtual bool CanEnableAlphaChannelMode() = 0;
537
542 virtual SDKError EnableAlphaChannelMode(bool enable) = 0;
543
546 virtual bool IsAlphaChannelModeEnabled() = 0;
547
551 virtual VideoSize GetUserVideoSize(unsigned int userid) = 0;
552
558
563 virtual SDKError EnableSpeakerContrastEnhance(bool enable) = 0;
564
568};
570#endif
virtual SDKError Decline()=0
Instance to decline the requirement and finally self-destroy.
virtual SDKError Approve()=0
Instance to accept the requirement.
Meeting camera helper interface.
virtual SDKError TurnLeft(unsigned int range=50)=0
Turn the camera to the left.
virtual SDKError ZoomIn(unsigned int range=50)=0
Zoom the camera in.
virtual SDKError ZoomOut(unsigned int range=50)=0
Zoom the camera out.
virtual unsigned int GetUserId()=0
Gets the current controlled user ID.
virtual SDKError TurnRight(unsigned int range=50)=0
Turn the camera to the right.
virtual SDKError TurnDown(unsigned int range=50)=0
Turn the camera down.
virtual SDKError GiveUpControlRemoteCamera()=0
Give up control of the remote camera.
virtual bool CanControlCamera()=0
Whether the camera can be controlled or not.
virtual SDKError TurnUp(unsigned int range=50)=0
Turn the camera up.
virtual SDKError RequestControlRemoteCamera()=0
Request to control remote camera.
Meeting video controller interface.
virtual SDKError UnSpotlightVideo(unsigned int userid)=0
Unspotlight the video of the assigned user to the first view.
virtual SDKError MuteVideo()=0
Turn off the user's own video.
virtual IMeetingCameraHelper * GetMeetingCameraHelper(unsigned int userid)=0
Get camera helper interface.
virtual SDKError CanAskAttendeeToStartVideo(unsigned int userid)=0
Query if it is able to demand the specified user to turn on the video.
virtual bool CanEnableAlphaChannelMode()=0
Determine if alpha channel mode can be enabled.
virtual SDKError SetEvent(IMeetingVideoCtrlEvent *pEvent)=0
Set the meeting video controller callback event handler.
virtual IList< unsigned int > * GetVideoOrderList()=0
Get the video order list.
virtual SDKError StopAttendeeVideo(unsigned int userid)=0
Turn off the video of the assigned user.
virtual VideoSize GetUserVideoSize(unsigned int userid)=0
Get the size of user's video.
virtual SDKError EnableSpeakerContrastEnhance(bool enable)=0
Enable or disable contrast enhancement effect for speaker video.
virtual SDKError UnSpotlightAllVideos()=0
Unpin all the videos from the first view.
virtual SDKError AskAttendeeToStartVideo(unsigned int userid)=0
Demand the assigned user to turn on the video.
virtual bool IsSpeakerContrastEnhanceEnabled()=0
Determine if contrast enhancement effect for speaker video is enabled.
virtual IList< unsigned int > * GetSpotlightedUserList()=0
Get the list of all the spotlighted user in the meeting.
virtual SDKError CanStopAttendeeVideo(unsigned int userid)=0
Query if it is able to demand the specified user to turn off the video.
virtual bool IsFollowHostVideoOrderOn()=0
Determine if the follow host video mode is enabled.
virtual bool IsSupportFollowHostVideoOrder()=0
Determine if the following host video order feature is supported.
virtual SDKError EnableAlphaChannelMode(bool enable)=0
Enable or disable video alpha channel mode.
virtual SDKError SpotlightVideo(unsigned int userid)=0
Spotlight the video of the assigned user to the first view.
virtual SDKError CanSpotlight(unsigned int userid, SpotlightResult &result)=0
Determine if it is able to spotlight the video of the specified user in the meeting.
virtual bool IsIncomingVideoStopped()=0
Determine if the incoming video is stopped.
virtual SDKError SetVideoQualityPreference(SDKVideoPreferenceSetting preferenceSetting)=0
Set the video quality preference that automatically adjust user's video to prioritize frame rate vers...
virtual SDKError UnmuteVideo()=0
Turn on the user's own video.
virtual bool IsAlphaChannelModeEnabled()=0
Determine if alpha channel mode is enabled.
virtual SDKError EnableFollowHostVideoOrder(bool bEnable)=0
Enable or disable follow host video order mode.
virtual SDKError RevokeCameraControlPrivilege()=0
Revoke camera control privilege.
virtual SDKError CanUnSpotlight(unsigned int userid, SpotlightResult &result)=0
Determine if it is able to unspotlight the video of the specified user in the meeting.
Meeting video controller event callback.
virtual void onCameraControlRequestReceived(unsigned int userId, CameraControlRequestType requestType, ICameraControlRequestHandler *pHandler)=0
Callback for when the current user receives a camera control request. \This callback will be triggere...
virtual void onLocalVideoOrderUpdated(IList< unsigned int > *localOrderList)=0
Callback event of the local video order changes.
virtual void onHostRequestStartVideo(IRequestStartVideoHandler *handler_)=0
Callback event of the requirement to turn on the video from the host.
virtual void onSpotlightedUserListChangeNotification(IList< unsigned int > *lstSpotlightedUserID)=0
Callback event for when the video spotlight user list changes. \Spotlight user means that the view wi...
virtual void onFollowHostVideoOrderChanged(bool bFollow)=0
Notification the status of following host's video order changed.
virtual void onUserVideoStatusChange(unsigned int userId, VideoStatus status)=0
Callback event of the user video status changes.
virtual void onActiveVideoUserChanged(unsigned int userid)=0
Callback event of the active video user changes.
virtual void onHostVideoOrderUpdated(IList< unsigned int > *orderList)=0
Callback event of the video order changes.
virtual void onVideoAlphaChannelStatusChanged(bool isAlphaModeOn)=0
Callback event of video alpha channel mode changes.
virtual void onActiveSpeakerVideoUserChanged(unsigned int userid)=0
Callback event of the active speaker video user changes.
virtual void onUserVideoQualityChanged(VideoConnectionQuality quality, unsigned int userid)=0
Callback event of the user video quality changes.
virtual void onCameraControlRequestResult(unsigned int userId, CameraControlRequestResult result)=0
Callback for when the current user is granted camera control access.
Process after the user receives the requirement from the host to turn on the video.
virtual SDKError Cancel()=0
Ignore the request to enable the video in the meeting and finally the instance self-destroys.
virtual SDKError Accept()=0
Instance to accept the requirement, turn on the video and finally self-destroy.
virtual unsigned int GetReqFromUserId()=0
Get the user ID who asks to turn on the video.
virtual SDKError Ignore()=0
Instance to ignore the requirement, return nothing and finally self-destroy.
set video order helper interface.
virtual SDKError SetVideoOrderTransactionCommit()=0
make a new video order.
virtual SDKError SetVideoOrderTransactionBegin()=0
Prepare to make a new video order.
virtual bool AddVideoToOrder(unsigned int userId, unsigned int position)=0
Add the assigned user into the prepared video order.
struct tagSDKVideoPreferenceSetting SDKVideoPreferenceSetting
@ 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 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....
@ 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
VideoStatus
The video status of the user. Here are more detailed structural descriptions.
@ Video_ON
Video is on.
@ Video_OFF
Video is off.
@ Video_Mute_ByHost
Video is muted by host.
VideoConnectionQuality
The video quality of the user. Here are more detailed structural descriptions.
@ 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.
struct tagVideoSize VideoSize
CameraControlRequestResult
The camera control request result. Here are more detailed structural descriptions.
@ CameraControlRequestResult_Approve
@ CameraControlRequestResult_Decline
@ CameraControlRequestResult_Revoke
CameraControlRequestType
The camera control request type. Here are more detailed structural descriptions.
@ CameraControlRequestType_RequestControl
@ CameraControlRequestType_Unknown
@ CameraControlRequestType_GiveUpControl
unsigned int maximumFrameRate
0 for the default value,maximum_frame_rate should be less and equal than 30, range: from 0 to 30....
unsigned int minimumFrameRate
0 for the default value,minimum_frame_rate should be less than maximum_frame_rate,...
SDKVideoPreferenceMode mode
0: Balance mode; 1: Smoothness mode; 2: Sharpness mode; 3: Custom mode
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
SDKError
SDK error types. Here are more detailed structural descriptions.