zoom_video_sdk_share_helper_interface.h

Go to the documentation of this file.

 
#ifndef _ZOOM_VIDEO_SDK_SHARE_HELPER_INTERFACE_H_
#define _ZOOM_VIDEO_SDK_SHARE_HELPER_INTERFACE_H_
#include "zoom_video_sdk_def.h"
#include "zoom_video_sdk_vector_interface.h"
#include "zoom_video_sdk_user_helper_interface.h"
 
BEGIN_ZOOM_VIDEO_SDK_NAMESPACE
struct ZoomVideoSDKShareOption
{
    bool isWithDeviceAudio;            
    bool isOptimizeForSharedVideo;     
 
    ZoomVideoSDKShareOption()
    {
        isWithDeviceAudio = false;
        isOptimizeForSharedVideo = false;
    }
 
    ZoomVideoSDKShareOption(const ZoomVideoSDKShareOption& option)
    {
        isWithDeviceAudio = option.isWithDeviceAudio;
        isOptimizeForSharedVideo = option.isOptimizeForSharedVideo;
    }
 
    ZoomVideoSDKShareOption(bool bWithAudio, bool optimize)
    {
        isWithDeviceAudio = bWithAudio;
        isOptimizeForSharedVideo = optimize;
    }
};
 
 
class IZoomVideoSDKShareSender
{
public:
    virtual ~IZoomVideoSDKShareSender() {}
    virtual ZoomVideoSDKErrors sendShareFrame(char* frameBuffer, int width, int height, int frameLength, FrameDataFormat format = FrameDataFormat_I420_FULL) = 0;
};
 
class IZoomVideoSDKShareSource
{
public:
    virtual ~IZoomVideoSDKShareSource() {}
    virtual void onShareSendStarted(IZoomVideoSDKShareSender* pSender) = 0; 
    
    virtual void onShareSendStopped() = 0; 
};
 
class IZoomVideoSDKShareAudioSender
{
public:
    virtual ~IZoomVideoSDKShareAudioSender() {}
    virtual ZoomVideoSDKErrors sendShareAudio(char* data, unsigned int data_length, int sample_rate, ZoomVideoSDKAudioChannel channel) = 0;
};
 
class IZoomVideoSDKShareAudioSource
{
public:
    virtual ~IZoomVideoSDKShareAudioSource() {}
    virtual void onStartSendAudio(IZoomVideoSDKShareAudioSender* pShareAudioSender) = 0;
    
    virtual void onStopSendAudio() = 0;
};
 
class IMonitorListBuilder
{
public:
    virtual ~IMonitorListBuilder() {}
    virtual ZoomVideoSDKErrors addMonitorID(const zchar_t* monitorID) = 0;
    
    virtual ZoomVideoSDKErrors removeMonitorID(const zchar_t* monitorID) = 0;
    
    virtual ZoomVideoSDKErrors clear() = 0;
    
    virtual IVideoSDKVector<const zchar_t*>* getMonitorIDs() = 0;
};
 
 
#if defined(WIN32) || defined(__MACOS__)
class IZoomVideoSDKRemoteControlRequestHandler
{
public:
    virtual ~IZoomVideoSDKRemoteControlRequestHandler() {}
    virtual ZoomVideoSDKErrors approve() = 0;
    
    virtual ZoomVideoSDKErrors deny() = 0;
};
 
class IZoomVideoSDKRemoteControlHelper
{
public:
    virtual ~IZoomVideoSDKRemoteControlHelper() {}
    virtual bool canRequestControl() = 0;
    
    virtual ZoomVideoSDKErrors requestRemoteControl() = 0;
    
    virtual ZoomVideoSDKErrors endRemoteControl() = 0;
    
    virtual bool canRemoteControl() = 0;
    
    virtual ZoomVideoSDKErrors enterRemoteControl() = 0;
    
    virtual bool isRemoteControlling() = 0;
    
    virtual ZoomVideoSDKErrors leaveRemoteControl() = 0;
};
#endif
 
struct ZoomVideoSDKViewSize
{
    unsigned int width; 
    unsigned int height; 
    
    ZoomVideoSDKViewSize()
    {
        width = 0;
        height = 0;
    }
    
    ZoomVideoSDKViewSize(const ZoomVideoSDKViewSize& resolution)
    {
        width = resolution.width;
        height = resolution.height;
    }
 
    ZoomVideoSDKViewSize(unsigned int new_width, unsigned int new_height)
    {
        width = new_width;
        height = new_height;
    }
};
 
class IZoomVideoSDKShareAction
{
public:
    virtual ~IZoomVideoSDKShareAction() {}
    virtual unsigned int getShareSourceId() = 0;
    
 
#if !defined __linux && !defined ANDROID
    virtual IZoomVideoSDKCanvas* getShareCanvas() = 0;
#endif
    virtual IZoomVideoSDKRawDataPipe* getSharePipe() = 0;
    
    virtual ZoomVideoSDKShareStatus getShareStatus() = 0;
    
    virtual ZoomVideoSDKSubscribeFailReason getSubscribeFailReason() = 0;
    
    virtual bool isAnnotationPrivilegeEnabled() = 0;
    
    virtual ZoomVideoSDKShareType getShareType() = 0;
    
    virtual ZoomVideoSDKViewSize getShareSourceContentSize() = 0;
 
#if defined(WIN32) || defined(__MACOS__)
    virtual IZoomVideoSDKRemoteControlHelper* getRemoteControlHelper() = 0;
    
    virtual IVideoSDKVector<IZoomVideoSDKUser*>* getRemoteControlApprovedUserList() = 0;
    
    virtual ZoomVideoSDKErrors revokeRemoteControl() = 0;
    
    virtual IZoomVideoSDKUser* getCurrentRemoteController() = 0;
#endif
};
 
enum ZoomVideoSDKSharePreprocessType
{
    ZoomVideoSDKSharePreprocessType_none,    
    ZoomVideoSDKSharePreprocessType_screen,  
    ZoomVideoSDKSharePreprocessType_view     
};
 
struct ZoomVideoSDKSharePreprocessParam
{
    ZoomVideoSDKSharePreprocessType type; 
    void* handle;                          
    const zchar_t* monitorID;             
 
    ZoomVideoSDKSharePreprocessParam()
    {
        type = ZoomVideoSDKSharePreprocessType_none;
        handle = nullptr;
        monitorID = nullptr;
    }
};
 
class IZoomVideoSDKSharePreprocessSender
{
public:
    virtual ~IZoomVideoSDKSharePreprocessSender() {}
    virtual ZoomVideoSDKErrors sendPreprocessedData(YUVRawDataI420* pRawData) = 0;
};
 
class IZoomVideoSDKSharePreprocessor
{
public:
    virtual ~IZoomVideoSDKSharePreprocessor() {}
    virtual void onCapturedRawDataReceived(YUVRawDataI420* pRawData, IZoomVideoSDKSharePreprocessSender* pSender) = 0;
    
    virtual void onShareStopped() = 0;
};
 
class IZoomVideoSDKRawDataPipeDelegate;
class IZoomVideoSDKAnnotationHelper;
class IZoomVideoSDKShareHelper
{
public:
    virtual ZoomVideoSDKErrors startShareView(void* handle, ZoomVideoSDKShareOption option = {false, false}) = 0;
    
    virtual bool isShareViewValid(void* handle) = 0;
    
    virtual ZoomVideoSDKErrors startShareScreen(const zchar_t* monitorID, ZoomVideoSDKShareOption option = { false, false }) = 0;
    
    virtual IMonitorListBuilder* getMonitorListBuilder() = 0;
    
    virtual ZoomVideoSDKErrors startShareMultiScreen(ZoomVideoSDKShareOption option = { false, false }) = 0;
    
    virtual ZoomVideoSDKErrors startShareComputerAudio() = 0;
    
    virtual ZoomVideoSDKErrors startSharePureAudioSource(IZoomVideoSDKShareAudioSource* pShareAudioSource, bool isPlaying = true) = 0;
    
    virtual ZoomVideoSDKErrors stopShare() = 0;
    
    virtual ZoomVideoSDKErrors pauseShare() = 0;
    
    virtual ZoomVideoSDKErrors resumeShare() = 0;
    
    virtual bool isSharingOut() = 0;
    
    virtual bool isScreenSharingOut() = 0;
    
    virtual bool isOtherSharing() = 0;
    
    virtual ZoomVideoSDKErrors lockShare(bool lock) = 0;
    
    virtual bool isShareLocked() = 0;
    
    virtual ZoomVideoSDKErrors enableMultiShare(bool enable) = 0;
    
    virtual bool isMultiShareEnabled() = 0;
    
    virtual ZoomVideoSDKErrors enableShareDeviceAudio(bool enable) = 0;
    
    virtual bool isShareDeviceAudioEnabled() = 0;
    
    virtual ZoomVideoSDKErrors enableOptimizeForSharedVideo(bool enable) = 0;
    
    virtual bool isOptimizeForSharedVideoEnabled() = 0;
    
    virtual ZoomVideoSDKErrors startShare2ndCamera(const zchar_t* cameraID) = 0;
    
    virtual ZoomVideoSDKErrors subscribeMyShareCamera(IZoomVideoSDKRawDataPipeDelegate* data_handler) = 0;
    
    virtual ZoomVideoSDKErrors unSubscribeMyShareCamera() = 0;
    
     virtual ZoomVideoSDKErrors startSharingExternalSource(IZoomVideoSDKShareSource* pSource, IZoomVideoSDKShareAudioSource* pAudioSource = nullptr, bool isPlaying = true) = 0;
     
    virtual bool isAnnotationFeatureSupport() = 0;
    
    virtual ZoomVideoSDKErrors disableViewerAnnotation(bool bDisable) = 0;
    
    virtual bool isViewerAnnotationDisabled() = 0;
    
    virtual IZoomVideoSDKAnnotationHelper* createAnnotationHelper(void* handle) = 0;
    
    virtual ZoomVideoSDKErrors destroyAnnotationHelper(IZoomVideoSDKAnnotationHelper* helper) = 0;
    
    virtual ZoomVideoSDKErrors enablePlaySharingAudioRawdata(bool isPlaying) = 0;
    
    virtual ZoomVideoSDKErrors startShareWithPreprocessing(const ZoomVideoSDKSharePreprocessParam& param, IZoomVideoSDKSharePreprocessor* preprocessor) = 0;
};
END_ZOOM_VIDEO_SDK_NAMESPACE
#endif