Meeting SDK for Linux API Reference
Loading...
Searching...
No Matches
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
42
43typedef struct tagVideoSize
44{
45 int width;
46 int height;
48 {
49 memset(this, 0, sizeof(tagVideoSize));
50 }
52
53
72
73
94
100{
101public:
108
117 virtual bool AddVideoToOrder(unsigned int userId, unsigned int position) = 0;
118
125};
126
132{
133public:
135
140 virtual unsigned int GetReqFromUserId() = 0;
141
145 virtual SDKError Ignore() = 0;
146
150 virtual SDKError Accept() = 0;
151
155 virtual SDKError Cancel() = 0;
156};
157
168
179
185{
186public:
191 virtual SDKError Approve() = 0;
192
196 virtual SDKError Decline() = 0;
197};
198
204{
205public:
207
214 virtual void onUserVideoStatusChange(unsigned int userId, VideoStatus status) = 0;
215
220 virtual void onSpotlightedUserListChangeNotification(IList<unsigned int >* lstSpotlightedUserID) = 0;
221
227
232 virtual void onActiveSpeakerVideoUserChanged(unsigned int userid) = 0;
233
238 virtual void onActiveVideoUserChanged(unsigned int userid) = 0;
239
244 virtual void onHostVideoOrderUpdated(IList<unsigned int >* orderList) = 0;
245
250 virtual void onLocalVideoOrderUpdated(IList<unsigned int >* localOrderList) = 0;
251
256 virtual void onFollowHostVideoOrderChanged(bool bFollow) = 0;
257
263 virtual void onUserVideoQualityChanged(VideoConnectionQuality quality, unsigned int userid) = 0;
264
269 virtual void onVideoAlphaChannelStatusChanged(bool isAlphaModeOn) = 0;
270
277 virtual void onCameraControlRequestReceived(unsigned int userId, CameraControlRequestType requestType, ICameraControlRequestHandler* pHandler) = 0;
278
284 virtual void onCameraControlRequestResult(unsigned int userId, CameraControlRequestResult result) = 0;
285};
286
304
322
328{
329public:
331
336 virtual unsigned int GetUserId() = 0;
337
342 virtual bool CanControlCamera() = 0;
343
349
355
361 virtual SDKError TurnLeft(unsigned int range = 50) = 0;
362
368 virtual SDKError TurnRight(unsigned int range = 50) = 0;
369
375 virtual SDKError TurnUp(unsigned int range = 50) = 0;
376
382 virtual SDKError TurnDown(unsigned int range = 50) = 0;
383
389 virtual SDKError ZoomIn(unsigned int range = 50) = 0;
390
396 virtual SDKError ZoomOut(unsigned int range = 50) = 0;
397};
398
404{
405public:
412
418 virtual SDKError MuteVideo() = 0;
419
425 virtual SDKError UnmuteVideo() = 0;
426
434 virtual SDKError CanSpotlight(unsigned int userid, SpotlightResult& result) = 0;
435
443 virtual SDKError CanUnSpotlight(unsigned int userid, SpotlightResult& result) = 0;
444
451 virtual SDKError SpotlightVideo(unsigned int userid) = 0;
452
459 virtual SDKError UnSpotlightVideo(unsigned int userid) = 0;
460
467
475
482 virtual SDKError CanAskAttendeeToStartVideo(unsigned int userid) = 0;
483
490 virtual SDKError AskAttendeeToStartVideo(unsigned int userid) = 0;
491
498 virtual SDKError CanStopAttendeeVideo(unsigned int userid) = 0;
499
506 virtual SDKError StopAttendeeVideo(unsigned int userid) = 0;
507
513
519 virtual SDKError EnableFollowHostVideoOrder(bool bEnable) = 0;
520
525 virtual bool IsFollowHostVideoOrderOn() = 0;
526
533
534
539 virtual bool IsIncomingVideoStopped() = 0;
540
541#if defined(WIN32)
549 virtual SDKError CanPinToFirstView(unsigned int userid, PinResult& result) = 0;
550
557 virtual SDKError PinVideoToFirstView(unsigned int userid) = 0;
558
565 virtual SDKError UnPinVideoFromFirstView(unsigned int userid) = 0;
566
572 virtual SDKError UnPinAllVideosFromFirstView() = 0;
573
580 virtual IList<unsigned int >* GetPinnedUserListFromFirstView() = 0;
581
589 virtual SDKError CanPinToSecondView(unsigned int userid, PinResult& result) = 0;
590
597 virtual SDKError PinVideoToSecondView(unsigned int userid) = 0;
598
605 virtual SDKError UnPinVideoFromSecondView(unsigned int userid) = 0;
606
613 virtual IList<unsigned int >* GetPinnedUserListFromSecondView() = 0;
614
621 virtual SDKError HideOrShowNoVideoUserOnVideoWall(bool bHide) = 0;
622
629 virtual SDKError HideOrShowSelfView(bool bHide) = 0;
630
635 virtual ISetVideoOrderHelper* GetSetVideoOrderHelper() = 0;
636
641 virtual ICameraController* GetMyCameraController() = 0;
642
649 virtual SDKError StopIncomingVideo(bool bStop) = 0;
650
657 virtual SDKError ShowAvatar(bool bShow) = 0;
658
663 virtual bool IsShowAvatar() = 0;
664#endif
665
670 virtual IMeetingCameraHelper* GetMeetingCameraHelper(unsigned int userid) = 0;
671
677
682 virtual bool CanEnableAlphaChannelMode() = 0;
683
689 virtual SDKError EnableAlphaChannelMode(bool enable) = 0;
690
695 virtual bool IsAlphaChannelModeEnabled() = 0;
696
702 virtual VideoSize GetUserVideoSize(unsigned int userid) = 0;
703
710
717 virtual SDKError EnableSpeakerContrastEnhance(bool enable) = 0;
718
724};
726#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 triggered...
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 wil...
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
When setting custom modes, the developer provides the maximum and minimum frame rates....
@ PinResult_Fail_NoPrivilegeToPin
@ PinResult_Fail_MeetingDoNotSupport
@ PinResult_Fail_UserCannotBePinned
@ PinResult_Fail_VideoModeDoNotSupport
@ PinResult_Fail_NotEnoughUsers
@ PinResult_Fail_ToMuchPinnedUsers
SDKVideoPreferenceMode
Select and use any of the defined preference mode below when initializing the SDKVideoPreferenceSetti...
@ SDKVideoPreferenceMode_Sharpness
@ SDKVideoPreferenceMode_Smoothness
@ SDKVideoPreferenceMode_Balance
@ SDKVideoPreferenceMode_Custom
@ SpotResult_Fail_NoPrivilegeToSpotlight
@ SpotResult_Fail_UserWithoutVideo
@ SpotResult_Fail_UserNotSpotlighted
@ SpotResult_Fail_NotEnoughUsers
@ SpotResult_Fail_ToMuchSpotlightedUsers
@ SpotResult_Fail_UserCannotBeSpotlighted
VideoStatus
The video status of the user. Here are more detailed structural descriptions.
@ Video_Mute_ByHost
VideoConnectionQuality
The video quality of the user. Here are more detailed structural descriptions.
@ VideoConnectionQuality_Normal
@ VideoConnectionQuality_Good
@ VideoConnectionQuality_Bad
@ VideoConnectionQuality_Unknown
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
When setting custom modes, the developer provides the maximum and minimum frame rates....
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
SDKError
Enumeration of common errors of SDK.