6#ifndef _MEETING_VIDEO_INTERFACE_H_
7#define _MEETING_VIDEO_INTERFACE_H_
virtual SDKError Decline()=0
Instance to decline the requirement and finally self-destroy.
virtual SDKError Approve()=0
Instance to accept the requirement.
virtual ~ICameraControlRequestHandler()
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 ~IMeetingCameraHelper()
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 SDKError HideOrShowNoVideoUserOnVideoWall(bool bHide)=0
Display or not the user who does not turn on the video in the video all mode.
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 PinVideoToSecondView(unsigned int userid)=0
Pin the video of the assigned user to the second view.
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 bool IsShowAvatar()=0
Determine if the meeting is showing the avatar.
virtual SDKError StopAttendeeVideo(unsigned int userid)=0
Turn off the video of the assigned user.
virtual ICameraController * GetMyCameraController()=0
Get camera controller interface.
virtual SDKError UnPinVideoFromSecondView(unsigned int userid)=0
Unpin the video of the assigned user from the second view.
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 UnPinAllVideosFromFirstView()=0
Unpin all the videos from the first view.
virtual ISetVideoOrderHelper * GetSetVideoOrderHelper()=0
Get set video order helper interface.
virtual SDKError UnSpotlightAllVideos()=0
Unpin all the videos from the first view.
virtual SDKError CanPinToFirstView(unsigned int userid, PinResult &result)=0
Determine if it is able to pin the video of the specified user to the first view.
virtual SDKError AskAttendeeToStartVideo(unsigned int userid)=0
Demand the assigned user to turn on the video.
virtual SDKError HideOrShowSelfView(bool bHide)=0
Display or not the userself's view.
virtual SDKError PinVideoToFirstView(unsigned int userid)=0
Pin the video of the assigned user to the first view.
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 IList< unsigned int > * GetPinnedUserListFromFirstView()=0
Get the list of all the pinned user in the first view.
virtual SDKError UnPinVideoFromFirstView(unsigned int userid)=0
Unpin the video of the assigned user from the first view.
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 CanPinToSecondView(unsigned int userid, PinResult &result)=0
Determine if it is able to pin the video of the specified user to the second view.
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 IList< unsigned int > * GetPinnedUserListFromSecondView()=0
Get the list of all the pinned user in the second view.
virtual SDKError EnableFollowHostVideoOrder(bool bEnable)=0
Enable or disable follow host video order mode.
virtual SDKError RevokeCameraControlPrivilege()=0
Revoke camera control privilege.
virtual SDKError ShowAvatar(bool bShow)=0
Determine if show the last used avatar in the meeting.
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.
virtual SDKError StopIncomingVideo(bool bStop)=0
Stop the incoming video.
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 ~IMeetingVideoCtrlEvent()
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 ~IRequestStartVideoHandler()
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
Enumeration of possible results for pinning a user.
@ PinResult_Fail_NoPrivilegeToPin
@ PinResult_Fail_TooManyUsers
@ 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.
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....
unsigned int maximumFrameRate
unsigned int minimumFrameRate
SDKVideoPreferenceMode mode
tagSDKVideoPreferenceSetting()
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
SDKError
Enumeration of common errors of SDK.