zoom_video_sdk_user_helper_interface.h File Reference

user helper More...

#include "zoom_video_sdk_def.h"
#include "zoom_video_sdk_vector_interface.h"

Go to the source code of this file.

Data Structures
struct	ZoomVideoSDKVideoStatus
	Video status information on the user's video device (the detected compatible video camera device), and status (whether video is turned on or off). More...
struct	ZoomVideoSDKAudioStatus
	Audio status information. More...
struct	ZoomVideoSDKVideoStatisticInfo
	Video statistic information. More...
struct	ZoomVideoSDKShareStatisticInfo
	Share statistic information. More...
struct	ZoomVideoSDKShareCursorData
	Share cursor information. More...
class	IZoomVideoSDKRawDataPipeDelegate
	Video/share raw data sink interface. More...
class	IZoomVideoSDKRawDataPipe
	Video/share raw data pipe interface. More...
class	IZoomVideoSDKCameraControlRequestHandler
	Camera control interface. More...
class	IZoomVideoSDKRemoteCameraControlHelper
class	IZoomVideoSDKCanvas
	video or share canvas interface. More...
class	IZoomVideoSDKUser
	User object interface. More...
class	IZoomVideoSDKUserHelper
	User helper interface. More...

Enumerations
enum	ZoomVideoSDKNetworkStatus { ZoomVideoSDKNetwork_None , ZoomVideoSDKNetwork_Bad , ZoomVideoSDKNetwork_Normal , ZoomVideoSDKNetwork_Good }
enum	ZoomVideoSDKAudioType { ZoomVideoSDKAudioType_VOIP , ZoomVideoSDKAudioType_TELEPHONY , ZoomVideoSDKAudioType_None }
	Audio type: VOIP (Voice over IP), Telephony, or None. More...
enum	ZoomVideoSDKResolution {   ZoomVideoSDKResolution_90P = 0 , ZoomVideoSDKResolution_180P , ZoomVideoSDKResolution_360P , ZoomVideoSDKResolution_720P ,   ZoomVideoSDKResolution_1080P , ZoomVideoSDKResolution_Auto = 100 }
enum	RawDataStatus { RawData_On , RawData_Off }
enum	ZoomVideoSDKVideoAspect { ZoomVideoSDKVideoAspect_Original , ZoomVideoSDKVideoAspect_Full_Filled , ZoomVideoSDKVideoAspect_LetterBox , ZoomVideoSDKVideoAspect_PanAndScan }
enum	ZoomVideoSDKSubscribeFailReason {   ZoomVideoSDKSubscribeFailReason_None = 0 , ZoomVideoSDKSubscribeFailReason_HasSubscribe1080POr720P , ZoomVideoSDKSubscribeFailReason_HasSubscribeTwo720P , ZoomVideoSDKSubscribeFailReason_HasSubscribeExceededLimit ,   ZoomVideoSDKSubscribeFailReason_HasSubscribeTwoShare , ZoomVideoSDKSubscribeFailReason_HasSubscribeVideo1080POr720PAndOneShare , ZoomVideoSDKSubscribeFailReason_TooFrequentCall }
enum	ZoomVideoSDKCanvasType { ZoomVideoSDKCanvasType_VideoData = 1 , ZoomVideoSDKCanvasType_ShareData }

Detailed Description

user helper

Definition in file zoom_video_sdk_user_helper_interface.h.

Enumeration Type Documentation

RawDataStatus

enum RawDataStatus

Enumerator
RawData_On
RawData_Off

Definition at line 133 of file zoom_video_sdk_user_helper_interface.h.

{
    RawData_On,
    RawData_Off,
}RawDataStatus;

ZoomVideoSDKAudioType

enum ZoomVideoSDKAudioType

Audio type: VOIP (Voice over IP), Telephony, or None.

Enumerator
ZoomVideoSDKAudioType_VOIP
ZoomVideoSDKAudioType_TELEPHONY
ZoomVideoSDKAudioType_None

Definition at line 40 of file zoom_video_sdk_user_helper_interface.h.

             {
    ZoomVideoSDKAudioType_VOIP,
    ZoomVideoSDKAudioType_TELEPHONY,
    ZoomVideoSDKAudioType_None,
}ZoomVideoSDKAudioType;

ZoomVideoSDKCanvasType

enum ZoomVideoSDKCanvasType

Enumerator
ZoomVideoSDKCanvasType_VideoData	Video camera data
ZoomVideoSDKCanvasType_ShareData	Share data

Definition at line 333 of file zoom_video_sdk_user_helper_interface.h.

{   
 
    ZoomVideoSDKCanvasType_VideoData = 1, 
 
    ZoomVideoSDKCanvasType_ShareData, 
}ZoomVideoSDKCanvasType;

ZoomVideoSDKNetworkStatus

enum ZoomVideoSDKNetworkStatus

Enumerator
ZoomVideoSDKNetwork_None
ZoomVideoSDKNetwork_Bad
ZoomVideoSDKNetwork_Normal
ZoomVideoSDKNetwork_Good

Definition at line 29 of file zoom_video_sdk_user_helper_interface.h.

{
    ZoomVideoSDKNetwork_None,
    ZoomVideoSDKNetwork_Bad,
    ZoomVideoSDKNetwork_Normal,
    ZoomVideoSDKNetwork_Good,
}ZoomVideoSDKNetworkStatus;

ZoomVideoSDKResolution

enum ZoomVideoSDKResolution

Enumerator
ZoomVideoSDKResolution_90P
ZoomVideoSDKResolution_180P
ZoomVideoSDKResolution_360P
ZoomVideoSDKResolution_720P
ZoomVideoSDKResolution_1080P
ZoomVideoSDKResolution_Auto	Just for video canvas.

Definition at line 122 of file zoom_video_sdk_user_helper_interface.h.

{
    ZoomVideoSDKResolution_90P = 0,
    ZoomVideoSDKResolution_180P,
    ZoomVideoSDKResolution_360P,
    ZoomVideoSDKResolution_720P,
    ZoomVideoSDKResolution_1080P,
 
    ZoomVideoSDKResolution_Auto = 100, 
}ZoomVideoSDKResolution;

ZoomVideoSDKSubscribeFailReason

enum ZoomVideoSDKSubscribeFailReason

Enumerator
ZoomVideoSDKSubscribeFailReason_None
ZoomVideoSDKSubscribeFailReason_HasSubscribe1080POr720P
ZoomVideoSDKSubscribeFailReason_HasSubscribeTwo720P
ZoomVideoSDKSubscribeFailReason_HasSubscribeExceededLimit
ZoomVideoSDKSubscribeFailReason_HasSubscribeTwoShare
ZoomVideoSDKSubscribeFailReason_HasSubscribeVideo1080POr720PAndOneShare
ZoomVideoSDKSubscribeFailReason_TooFrequentCall

Definition at line 319 of file zoom_video_sdk_user_helper_interface.h.

{
    ZoomVideoSDKSubscribeFailReason_None = 0,
    ZoomVideoSDKSubscribeFailReason_HasSubscribe1080POr720P,
    ZoomVideoSDKSubscribeFailReason_HasSubscribeTwo720P,
    ZoomVideoSDKSubscribeFailReason_HasSubscribeExceededLimit,
    ZoomVideoSDKSubscribeFailReason_HasSubscribeTwoShare,
    ZoomVideoSDKSubscribeFailReason_HasSubscribeVideo1080POr720PAndOneShare,
    ZoomVideoSDKSubscribeFailReason_TooFrequentCall,
#if defined ANDROID || defined __IOS__
    ZoomVideoSDKSubscribeFailReason_HasSubscribeOneShare,
#endif
}ZoomVideoSDKSubscribeFailReason;

ZoomVideoSDKVideoAspect

enum ZoomVideoSDKVideoAspect

Enumerator
ZoomVideoSDKVideoAspect_Original	Original aspect ratio.
ZoomVideoSDKVideoAspect_Full_Filled	Full filled aspect ratio.
ZoomVideoSDKVideoAspect_LetterBox	Letterbox aspect ratio.
ZoomVideoSDKVideoAspect_PanAndScan	Pan and scan aspect ratio.

Definition at line 307 of file zoom_video_sdk_user_helper_interface.h.

{
 
    ZoomVideoSDKVideoAspect_Original, 
 
    ZoomVideoSDKVideoAspect_Full_Filled, 
 
    ZoomVideoSDKVideoAspect_LetterBox, 
 
    ZoomVideoSDKVideoAspect_PanAndScan, 
}ZoomVideoSDKVideoAspect;