zoom_video_sdk_user_helper_interface.h

Go to the documentation of this file.

 
#ifndef _ZOOM_VIDEO_SDK_USER_HELPER_INTERFACE_H_
#define _ZOOM_VIDEO_SDK_USER_HELPER_INTERFACE_H_
#include "zoom_video_sdk_def.h"
#include "zoom_video_sdk_vector_interface.h"
 
BEGIN_ZOOM_VIDEO_SDK_NAMESPACE
struct ZoomVideoSDKVideoStatus
{
    bool isHasVideoDevice;  
    bool isOn;  
 
    ZoomVideoSDKVideoStatus()
    {
        isHasVideoDevice = false;
        isOn = false;
    }
};
 
typedef enum
{
    ZoomVideoSDKNetwork_None,
    ZoomVideoSDKNetwork_Bad,
    ZoomVideoSDKNetwork_Normal,
    ZoomVideoSDKNetwork_Good,
}ZoomVideoSDKNetworkStatus;

typedef enum
{
    ZoomVideoSDKStatisticsDirection_Send = 0,
    ZoomVideoSDKStatisticsDirection_Receive = 1,
} ZoomVideoSDKStatisticsDirection;

typedef enum {
    ZoomVideoSDKAudioType_VOIP,
    ZoomVideoSDKAudioType_TELEPHONY,
    ZoomVideoSDKAudioType_None,
}ZoomVideoSDKAudioType;

struct ZoomVideoSDKAudioStatus
{
    ZoomVideoSDKAudioType audioType;
    bool isMuted;
    bool isTalking;
 
    ZoomVideoSDKAudioStatus()
    {
        audioType = ZoomVideoSDKAudioType_None;
        isMuted = false;
        isTalking = false;
    }
};

struct ZoomVideoSDKQOSStatistics
{
    ZoomVideoSDKStatisticsDirection direction;
    unsigned int timestamp;
    const zchar_t* codecName;
    unsigned int rtt;
    double jitter;
    unsigned int width;
    unsigned int height;
    unsigned int fps;
    unsigned int bps;
    int bpf;
    unsigned int bytesTransferred;
    unsigned int packetsLost;
    unsigned int packetsTransferred;
    ZoomVideoSDKNetworkStatus networkLevel;
    ZoomVideoSDKDataType statisticsType;
    unsigned int avg_loss;
    unsigned int max_loss;
    unsigned int bandwidth;
 
    ZoomVideoSDKQOSStatistics()
    {
        reset();
    }
 
    void reset()
    {
        direction = ZoomVideoSDKStatisticsDirection_Send;
        timestamp = 0;
        codecName = nullptr;
        rtt = 0;
        jitter = 0.0;
        width = 0;
        height = 0;
        fps = 0;
        bps = 0;
        bpf = 0;
        bytesTransferred = 0;
        packetsLost = 0;
        packetsTransferred = 0;
        networkLevel = ZoomVideoSDKNetwork_None;
        statisticsType = ZoomVideoSDKDataType_Unknown;
        avg_loss = 0;
        max_loss = 0;
        bandwidth = 0;
    }
};

struct ZoomVideoSDKQOSSendStatistics : ZoomVideoSDKQOSStatistics
{
    unsigned int frameWidthInput;
    unsigned int frameHeightInput;
    unsigned int frameRateInput;
    unsigned int bytesSent;
    unsigned int packetsSent;
    unsigned int totalPacketSendDelay;
    unsigned int totalEncodeTime;
    unsigned int framesEncoded;
    unsigned int headerBytesSent;
 
    ZoomVideoSDKQOSSendStatistics()
    {
        ZoomVideoSDKQOSStatistics::direction = ZoomVideoSDKStatisticsDirection_Send;
        reset();
    }
 
    void reset()
    {
        ZoomVideoSDKQOSStatistics::reset();
        direction = ZoomVideoSDKStatisticsDirection_Send;
        frameWidthInput = 0;
        frameHeightInput = 0;
        frameRateInput = 0;
        bytesSent = 0;
        packetsSent = 0;
        totalPacketSendDelay = 0;
        totalEncodeTime = 0;
        framesEncoded = 0;
        headerBytesSent = 0;
    }
};

struct ZoomVideoSDKQOSRecvStatistics : ZoomVideoSDKQOSStatistics
{
    unsigned long long bytesReceived;
    unsigned int packetsReceived;
    unsigned int estimatedPlayoutTimestamp;
    unsigned int totalDecodeTime;
    unsigned int framesDecoded;
    double jitterBufferDelay;
    unsigned long long jitterBufferEmittedCount;
    unsigned long long headerBytesReceived;
    unsigned int packetsDiscarded;
    unsigned int fecPacketsReceived;
    unsigned int fecPacketsDiscarded;
    double jitterBufferTargetDelay;
    double jitterBufferMinimumDelay;
    unsigned long long totalSamplesReceived;
    unsigned long long concealedSamples;
    unsigned long long silentConcealedSamples;
    unsigned long long concealmentEvents;
    unsigned long long insertedSamplesForDeceleration;
    unsigned long long removedSamplesForAcceleration;
    double totalSamplesDuration;
    double audioLevel;
    double totalAudioEnergy;
 
    ZoomVideoSDKQOSRecvStatistics()
    {
        ZoomVideoSDKQOSStatistics::direction = ZoomVideoSDKStatisticsDirection_Receive;
        reset();
    }
 
    void reset()
    {
        ZoomVideoSDKQOSStatistics::reset();
        direction = ZoomVideoSDKStatisticsDirection_Receive;
        bytesReceived = 0;
        packetsReceived = 0;
        estimatedPlayoutTimestamp = 0;
        totalDecodeTime = 0;
        framesDecoded = 0;
        jitterBufferDelay = 0.0;
        jitterBufferEmittedCount = 0;
        headerBytesReceived = 0;
        packetsDiscarded = 0;
        fecPacketsReceived = 0;
        fecPacketsDiscarded = 0;
        jitterBufferTargetDelay = 0.0;
        jitterBufferMinimumDelay = 0.0;
        totalSamplesReceived = 0;
        concealedSamples = 0;
        silentConcealedSamples = 0;
        concealmentEvents = 0;
        insertedSamplesForDeceleration = 0;
        removedSamplesForAcceleration = 0;
        totalSamplesDuration = 0.0;
        audioLevel = 0.0;
        totalAudioEnergy = 0.0;
    }
};

struct ZoomVideoSDKVideoStatisticInfo : ZoomVideoSDKQOSStatistics
{
    ZoomVideoSDKNetworkStatus videoNetworkStatus;
 
    ZoomVideoSDKVideoStatisticInfo()
    {
        reset();
    }
 
    void reset()
    {
        ZoomVideoSDKQOSStatistics::reset();
        videoNetworkStatus = ZoomVideoSDKNetwork_None;
    }
};

struct ZoomVideoSDKShareStatisticInfo : ZoomVideoSDKQOSStatistics
{
    ZoomVideoSDKNetworkStatus shareNetworkStatus;
 
    ZoomVideoSDKShareStatisticInfo()
    {
        reset();
    }
 
    void reset()
    {
        ZoomVideoSDKQOSStatistics::reset();
        shareNetworkStatus = ZoomVideoSDKNetwork_None;
    }
};

struct ZoomVideoSDKShareCursorData
{
    unsigned int source_id;
    int x;
    int y;
 
    ZoomVideoSDKShareCursorData()
    {
        source_id = 0;
        x = 0;
        y = 0;
    }
};
 
typedef enum
{
    ZoomVideoSDKResolution_90P = 0,
    ZoomVideoSDKResolution_180P,
    ZoomVideoSDKResolution_360P,
    ZoomVideoSDKResolution_720P,
    ZoomVideoSDKResolution_1080P,
    ZoomVideoSDKResolution_Auto = 100, 
}ZoomVideoSDKResolution;
 
typedef enum 
{
    RawData_On,
    RawData_Off,
}RawDataStatus;

class IZoomVideoSDKRawDataPipeDelegate
{
public:
    virtual void onRawDataFrameReceived(YUVRawDataI420* data_) = 0;
    
    virtual void onRawDataStatusChanged(RawDataStatus status) = 0;
    
    virtual void onShareCursorDataReceived(ZoomVideoSDKShareCursorData info) = 0;
 
    virtual ~IZoomVideoSDKRawDataPipeDelegate() {};
};

class IZoomVideoSDKRawDataPipe
{
public:
    
    virtual ~IZoomVideoSDKRawDataPipe() {}
    
    virtual ZoomVideoSDKErrors subscribe(ZoomVideoSDKResolution resolution, IZoomVideoSDKRawDataPipeDelegate* listener) = 0;
    
    virtual ZoomVideoSDKErrors unSubscribe(IZoomVideoSDKRawDataPipeDelegate* listener) = 0;
    
    virtual ZoomVideoSDKRawDataType getRawdataType() = 0;
    
    virtual ZoomVideoSDKVideoStatus getVideoStatus() = 0;
    
    virtual const zchar_t* getVideoDeviceName() = 0;
    
    virtual ZoomVideoSDKShareStatus getShareStatus() = 0;
    
    virtual ZoomVideoSDKShareCapturePauseReason getShareCapturePauseReason() = 0;
    
    virtual ZoomVideoSDKShareType getShareType() = 0;
    
    virtual ZoomVideoSDKVideoStatisticInfo getVideoStatisticInfo() = 0;
};

class IZoomVideoSDKCameraControlRequestHandler
{
public:
    virtual ~IZoomVideoSDKCameraControlRequestHandler() {}
    virtual ZoomVideoSDKErrors approve() = 0;
    
    virtual ZoomVideoSDKErrors decline() = 0;
};
 
class IZoomVideoSDKRemoteCameraControlHelper
{
public:
    virtual ~IZoomVideoSDKRemoteCameraControlHelper() {}
    virtual ZoomVideoSDKErrors requestControlRemoteCamera() = 0;
    
    virtual ZoomVideoSDKErrors giveUpControlRemoteCamera() = 0;
    
    virtual ZoomVideoSDKErrors turnLeft(unsigned int range = 50) = 0;
    
    virtual ZoomVideoSDKErrors turnRight(unsigned int range = 50) = 0;
    
    virtual ZoomVideoSDKErrors turnUp(unsigned int range = 50) = 0;
    
    virtual ZoomVideoSDKErrors turnDown(unsigned int range = 50) = 0;
    
    virtual ZoomVideoSDKErrors zoomIn(unsigned int range = 50) = 0;
    
    virtual ZoomVideoSDKErrors zoomOut(unsigned int range = 50) = 0;
};
 
 
typedef enum
{
    ZoomVideoSDKVideoAspect_Original, 
    ZoomVideoSDKVideoAspect_Full_Filled, 
    ZoomVideoSDKVideoAspect_LetterBox, 
    ZoomVideoSDKVideoAspect_PanAndScan, 
}ZoomVideoSDKVideoAspect;
 
typedef enum
{
    ZoomVideoSDKSubscribeFailReason_None = 0,
    ZoomVideoSDKSubscribeFailReason_HasSubscribe1080POr720P,
    ZoomVideoSDKSubscribeFailReason_HasSubscribeTwo720P,
    ZoomVideoSDKSubscribeFailReason_HasSubscribeExceededLimit,
    ZoomVideoSDKSubscribeFailReason_HasSubscribeTwoShare,
    ZoomVideoSDKSubscribeFailReason_HasSubscribeVideo1080POr720PAndOneShare,
    ZoomVideoSDKSubscribeFailReason_TooFrequentCall,
#if defined ANDROID || defined __IOS__
    ZoomVideoSDKSubscribeFailReason_HasSubscribeOneShare,
#endif
}ZoomVideoSDKSubscribeFailReason;
 
typedef enum
{   
    ZoomVideoSDKCanvasType_VideoData = 1, 
    ZoomVideoSDKCanvasType_ShareData, 
}ZoomVideoSDKCanvasType;
 
#if !defined __linux && !defined ANDROID
class IZoomVideoSDKCanvas
{
public:
    virtual ~IZoomVideoSDKCanvas() {}
    virtual ZoomVideoSDKErrors subscribeWithView(void* handle, ZoomVideoSDKVideoAspect videoAspect, ZoomVideoSDKResolution resolution = ZoomVideoSDKResolution_Auto) = 0;
    
    virtual ZoomVideoSDKErrors unSubscribeWithView(void* handle) = 0;
    
    virtual ZoomVideoSDKErrors setAspectMode(void* handle, ZoomVideoSDKVideoAspect aspect) = 0;
    
    virtual ZoomVideoSDKErrors setResolution(void* handle, ZoomVideoSDKResolution resolution) = 0;
    
    virtual ZoomVideoSDKCanvasType canvasType() = 0;

    virtual void* takeSnapshot(void* handle) = 0;
};
#endif 
 
class IZoomVideoSDKShareAction;
class IZoomVideoSDKUser
{
public:
    virtual ~IZoomVideoSDKUser(){}
    virtual const zchar_t* getCustomIdentity() = 0;
    
    virtual const zchar_t* getUserKey() = 0;
    
    virtual const zchar_t* getUserName() = 0;
    
    virtual const zchar_t* getUserID() = 0;
    
    virtual ZoomVideoSDKAudioStatus getAudioStatus() = 0;
    
    virtual const zchar_t* getUserReference() = 0;
    
    virtual bool isHost() = 0;
    
    virtual bool isManager() = 0;
    
    virtual bool isVideoSpotLighted() = 0;
    
    virtual ZoomVideoSDKVideoStatisticInfo getVideoStatisticInfo() = 0;
    
    virtual ZoomVideoSDKShareStatisticInfo getShareStatisticInfo() = 0;
    
    virtual IZoomVideoSDKRawDataPipe* GetVideoPipe() = 0;
 
#if !defined __linux && !defined ANDROID
    virtual IZoomVideoSDKCanvas* GetVideoCanvas() = 0;
#endif
    virtual IVideoSDKVector<IZoomVideoSDKShareAction*>* getShareActionList() = 0;
    
    virtual IZoomVideoSDKRemoteCameraControlHelper* getRemoteCameraControlHelper() = 0;
    
    virtual IVideoSDKVector<IZoomVideoSDKRawDataPipe*>* getMultiCameraStreamList() = 0;

    virtual unsigned int getAudioLevel() = 0;
    
    virtual bool getUserVolume(float& volume, bool isShareAudio = false) = 0;

    virtual bool canSetUserVolume(bool isShareAudio = false) = 0;
    
    virtual bool hasIndividualRecordingConsent() = 0;

    virtual bool setUserVolume(float volume, bool isShareAudio = false) = 0;
    
    virtual bool getUserPlaybackVolume(float& volume, bool isShareAudio = false) = 0;
    
    virtual bool canSetUserPlaybackVolume(bool isShareAudio = false) = 0;
    
    virtual bool setUserPlaybackVolume(float volume, bool isShareAudio = false) = 0;
    
    virtual ZoomVideoSDKErrors transferFile(const zchar_t* filePath) = 0;
    

    virtual bool isIncomingLiveStreamUser() = 0;
    
    virtual bool isInSubSession() = 0;

    virtual bool isInFailover() = 0;
 
#if !defined (__linux) || defined ANDROID
    virtual ZoomVideoSDKWhiteboardStatus getWhiteboardStatus() = 0;
#endif
    
    virtual ZoomVideoSDKNetworkStatus getNetworkLevel(ZoomVideoSDKDataType type) = 0;
    
    virtual ZoomVideoSDKNetworkStatus getOverallNetworkLevel() = 0;
};

class IZoomVideoSDKUserHelper
{
public:
    virtual bool changeName(const zchar_t* name, IZoomVideoSDKUser* pUser) = 0;
    
    virtual bool makeHost(IZoomVideoSDKUser* pUser) = 0;
    
    virtual bool makeManager(IZoomVideoSDKUser* pUser) = 0;
    
    virtual ZoomVideoSDKErrors revokeManager(IZoomVideoSDKUser* pUser) = 0;

    virtual bool removeUser(IZoomVideoSDKUser* pUser) = 0;
    
    virtual bool reclaimHost() = 0;
};
END_ZOOM_VIDEO_SDK_NAMESPACE
#endif