Video SDK for Windows API Reference
Loading...
Searching...
No Matches
zoom_video_sdk_user_helper_interface.h
Go to the documentation of this file.
1
6#ifndef _ZOOM_VIDEO_SDK_USER_HELPER_INTERFACE_H_
7#define _ZOOM_VIDEO_SDK_USER_HELPER_INTERFACE_H_
10
16{
20 bool isOn;
21
23 {
24 isHasVideoDevice = false;
25 isOn = false;
26 }
27};
28
36
45
62
83
104
109{
110 unsigned int source_id;
111 int x;
112 int y;
113
115 {
116 source_id = 0;
117 x = 0;
118 y = 0;
119 }
120};
121
132
138
166
232
253
255{
256public:
263
269
275 virtual ZoomVideoSDKErrors turnLeft(unsigned int range = 50) = 0;
276
282 virtual ZoomVideoSDKErrors turnRight(unsigned int range = 50) = 0;
283
289 virtual ZoomVideoSDKErrors turnUp(unsigned int range = 50) = 0;
290
296 virtual ZoomVideoSDKErrors turnDown(unsigned int range = 50) = 0;
297
303 virtual ZoomVideoSDKErrors zoomIn(unsigned int range = 50) = 0;
304
310 virtual ZoomVideoSDKErrors zoomOut(unsigned int range = 50) = 0;
311};
312
313
325
339
347
348#if !defined __linux && !defined ANDROID
354{
355public:
365
371 virtual ZoomVideoSDKErrors unSubscribeWithView(void* handle) = 0;
372
380
387 virtual ZoomVideoSDKErrors setResolution(void* handle, ZoomVideoSDKResolution resolution) = 0;
388
394};
395#endif
403{
404public:
410 virtual const zchar_t* getCustomIdentity() = 0;
411
416 virtual const zchar_t* getUserName() = 0;
417
422 virtual const zchar_t* getUserID() = 0;
423
429
434 virtual const zchar_t* getUserReference() = 0;
435
440 virtual bool isHost() = 0;
441
446 virtual bool isManager() = 0;
447
452 virtual bool isVideoSpotLighted() = 0;
453
459
465
471
472#if !defined __linux && !defined ANDROID
478#endif
484
490
496
501 virtual unsigned int getAudioLevel() = 0;
502
510 virtual bool getUserVolume(float& volume, bool isShareAudio = false) = 0;
511
518 virtual bool canSetUserVolume(bool isShareAudio = false) = 0;
519
525
533 virtual bool setUserVolume(float volume, bool isShareAudio = false) = 0;
534
541 virtual bool getUserPlaybackVolume(float& volume, bool isShareAudio = false) = 0;
542
548 virtual bool canSetUserPlaybackVolume(bool isShareAudio = false) = 0;
549
556 virtual bool setUserPlaybackVolume(float volume, bool isShareAudio = false) = 0;
557
563 virtual ZoomVideoSDKErrors transferFile(const zchar_t* filePath) = 0;
564
565
570 virtual bool isIncomingLiveStreamUser() = 0;
571
576 virtual bool isInSubSession() = 0;
577
578#if !defined (__linux) || defined ANDROID
584#endif
585
592
598};
604{
605public:
612 virtual bool changeName(const zchar_t* name, IZoomVideoSDKUser* pUser) = 0;
613
619 virtual bool makeHost(IZoomVideoSDKUser* pUser) = 0;
620
626 virtual bool makeManager(IZoomVideoSDKUser* pUser) = 0;
627
634
640 virtual bool removeUser(IZoomVideoSDKUser* pUser) = 0;
641
646 virtual bool reclaimHost() = 0;
647};
649#endif
SDK defined vector interface.
virtual ZoomVideoSDKErrors decline()=0
Decline the remote camera control request.
virtual ZoomVideoSDKErrors approve()=0
Approve the remote camera control request.
video or share canvas interface.
virtual ZoomVideoSDKErrors setResolution(void *handle, ZoomVideoSDKResolution resolution)=0
Sets the resolution for the user's video. Once you specify the value, the resolution will not change ...
virtual ZoomVideoSDKErrors unSubscribeWithView(void *handle)=0
Unsubscribes to the user's video or share view.
virtual ZoomVideoSDKErrors subscribeWithView(void *handle, ZoomVideoSDKVideoAspect videoAspect, ZoomVideoSDKResolution resolution=ZoomVideoSDKResolution_Auto)=0
Subscribes to the user's video or share view.
virtual ZoomVideoSDKCanvasType canvasType()=0
Gets the canvas type.
virtual ZoomVideoSDKErrors setAspectMode(void *handle, ZoomVideoSDKVideoAspect aspect)=0
Set the render video or share aspect ratio.
virtual void onRawDataStatusChanged(RawDataStatus status)=0
Call when subscribed data status changed.
virtual void onShareCursorDataReceived(ZoomVideoSDKShareCursorData info)=0
Call when the cursor data of share received.
virtual void onRawDataFrameReceived(YUVRawDataI420 *data_)=0
Call when subscribed data received.
Video/share raw data pipe interface.
virtual ZoomVideoSDKShareCapturePauseReason getShareCapturePauseReason()=0
Gets the reason why the share capture is paused.
virtual ZoomVideoSDKErrors subscribe(ZoomVideoSDKResolution resolution, IZoomVideoSDKRawDataPipeDelegate *listener)=0
Subscribe video/share.
virtual ZoomVideoSDKVideoStatus getVideoStatus()=0
Get video status.
virtual const zchar_t * getVideoDeviceName()=0
Get video device name.
virtual ZoomVideoSDKErrors unSubscribe(IZoomVideoSDKRawDataPipeDelegate *listener)=0
Unsubscribe video/share.
virtual ZoomVideoSDKRawDataType getRawdataType()=0
Get the raw data data type.
virtual ZoomVideoSDKVideoStatisticInfo getVideoStatisticInfo()=0
Get video statistic information.
virtual ZoomVideoSDKShareType getShareType()=0
Get share type.
virtual ZoomVideoSDKShareStatus getShareStatus()=0
Get share status.
virtual ZoomVideoSDKErrors giveUpControlRemoteCamera()=0
Give up control of the remote camera.
virtual ZoomVideoSDKErrors requestControlRemoteCamera()=0
Request to control remote camera.
virtual ZoomVideoSDKErrors zoomIn(unsigned int range=50)=0
Zoom the camera in.
virtual ZoomVideoSDKErrors turnDown(unsigned int range=50)=0
Turn the camera down.
virtual ZoomVideoSDKErrors zoomOut(unsigned int range=50)=0
Zoom the camera out.
virtual ZoomVideoSDKErrors turnRight(unsigned int range=50)=0
Turn the camera to the right.
virtual ZoomVideoSDKErrors turnUp(unsigned int range=50)=0
Turn the camera up.
virtual ZoomVideoSDKErrors turnLeft(unsigned int range=50)=0
Turn the camera to the left.
virtual bool removeUser(IZoomVideoSDKUser *pUser)=0
Remove user from session.
virtual bool makeManager(IZoomVideoSDKUser *pUser)=0
Assign a user as the session manager.
virtual bool reclaimHost()=0
Reclaim host permission.
virtual ZoomVideoSDKErrors revokeManager(IZoomVideoSDKUser *pUser)=0
Revoke manager rights from a user.
virtual bool changeName(const zchar_t *name, IZoomVideoSDKUser *pUser)=0
Change a specific user's name.
virtual bool makeHost(IZoomVideoSDKUser *pUser)=0
Assign a user as the session host.
virtual unsigned int getAudioLevel()=0
Gets the current audio level of a remote user.
virtual IZoomVideoSDKRawDataPipe * GetVideoPipe()=0
Get the user's video raw data pipe.
virtual bool isHost()=0
Determine whether the user is the host.
virtual bool canSetUserPlaybackVolume(bool isShareAudio=false)=0
Checks whether you can set the volume for shared audio or microphone.
virtual bool canSetUserVolume(bool isShareAudio=false)=0
Determine which audio you can set, shared audio or microphone.
virtual bool isVideoSpotLighted()=0
Determine whether the user is spotLighted.
virtual ZoomVideoSDKAudioStatus getAudioStatus()=0
Get the user's audio status.
virtual bool setUserVolume(float volume, bool isShareAudio=false)=0
Set the user's local volume. This does not affect how other participants hear the user.
virtual bool isManager()=0
Determine whether the user is the manager(coHost)
virtual ZoomVideoSDKWhiteboardStatus getWhiteboardStatus()=0
Get the whiteboard sharing status of the user.
virtual bool getUserPlaybackVolume(float &volume, bool isShareAudio=false)=0
Gets the local volume.
virtual ZoomVideoSDKErrors transferFile(const zchar_t *filePath)=0
Send file to current user object.
virtual const zchar_t * getUserReference()=0
Get the user's reference info.
virtual bool isIncomingLiveStreamUser()=0
Determine whether the user is incoming live stream user.
virtual ZoomVideoSDKNetworkStatus getNetworkLevel(ZoomVideoSDKDataType type)=0
Gets the network quality level of the specified data type for the user.
virtual const zchar_t * getUserID()=0
Get the user's id.
virtual ZoomVideoSDKVideoStatisticInfo getVideoStatisticInfo()=0
Get the user's video statistic information.
virtual const zchar_t * getUserName()=0
Get the user's name.
virtual IZoomVideoSDKCanvas * GetVideoCanvas()=0
Gets the user's video render canvas object.
virtual bool getUserVolume(float &volume, bool isShareAudio=false)=0
Get user volume.
virtual IVideoSDKVector< IZoomVideoSDKShareAction * > * getShareActionList()=0
Get the user's share-action list.
virtual ZoomVideoSDKNetworkStatus getOverallNetworkLevel()=0
Gets the overall network quality level of the user.
virtual IVideoSDKVector< IZoomVideoSDKRawDataPipe * > * getMultiCameraStreamList()=0
Get the user's multi-camera stream list.
virtual bool setUserPlaybackVolume(float volume, bool isShareAudio=false)=0
Sets the user's local volume. This does not affect how other participants hear the user.
virtual IZoomVideoSDKRemoteCameraControlHelper * getRemoteCameraControlHelper()=0
Get the helper class instance to access the remote camera control.
virtual bool isInSubSession()=0
Determine whether the user is in a subsession.
virtual bool hasIndividualRecordingConsent()=0
Used to determine whether I agree to individual video recording.
virtual const zchar_t * getCustomIdentity()=0
Get the user's custom id.
virtual ZoomVideoSDKShareStatisticInfo getShareStatisticInfo()=0
Get the user's share statistic information.
The YUV raw data handler interface.
Video status information on the user's video device (the detected compatible video camera device),...
Zoom Video SDK Common Definition File.
ZoomVideoSDKDataType
Enumeration of the data type for network quality monitoring.
ZoomVideoSDKWhiteboardStatus
Enumeration of the status of whiteboard sharing.
#define BEGIN_ZOOM_VIDEO_SDK_NAMESPACE
ZoomVideoSDKRawDataType
Enumeration of raw data types in Zoom Video SDK.
ZoomVideoSDKShareCapturePauseReason
Enumeration of reasons why screen sharing capture is paused in the Zoom Video SDK.
ZoomVideoSDKShareType
Enumeration of sharing types in Zoom Video SDK.
#define END_ZOOM_VIDEO_SDK_NAMESPACE
ZoomVideoSDKShareStatus
Enumeration of sharing status in Zoom Video SDK.
ZoomVideoSDKErrors
Enumeration of common Zoom Video SDK errors.
wchar_t zchar_t
@ ZoomVideoSDKSubscribeFailReason_HasSubscribeTwo720P
@ ZoomVideoSDKSubscribeFailReason_TooFrequentCall
@ ZoomVideoSDKSubscribeFailReason_HasSubscribeTwoShare
@ ZoomVideoSDKSubscribeFailReason_HasSubscribeVideo1080POr720PAndOneShare
@ ZoomVideoSDKSubscribeFailReason_HasSubscribe1080POr720P
@ ZoomVideoSDKSubscribeFailReason_HasSubscribeExceededLimit
ZoomVideoSDKAudioType
Audio type: VOIP (Voice over IP), Telephony, or None.