zoom_video_sdk_subsession_interface.h

Go to the documentation of this file.

 
#ifndef _ZOOM_VIDEO_SDK_SUBSESSION_INTERFACE_H_
#define _ZOOM_VIDEO_SDK_SUBSESSION_INTERFACE_H_
#include "zoom_video_sdk_def.h"
#include "zoom_video_sdk_vector_interface.h"
 
BEGIN_ZOOM_VIDEO_SDK_NAMESPACE
 
enum ZoomVideoSDKSubSessionStatus
{
    ZoomVideoSDKSubSessionStatus_None = 0,
    ZoomVideoSDKSubSessionStatus_Committed,
    ZoomVideoSDKSubSessionStatus_Withdrawn,
    ZoomVideoSDKSubSessionStatus_Started,
    ZoomVideoSDKSubSessionStatus_Stopping,
    ZoomVideoSDKSubSessionStatus_Stopped,
    ZoomVideoSDKSubSessionStatus_CommitFailed,
    ZoomVideoSDKSubSessionStatus_WithdrawFailed,
    ZoomVideoSDKSubSessionStatus_StartFailed,
    ZoomVideoSDKSubSessionStatus_StopFailed,
};
 
enum ZoomVideoSDKUserHelpRequestResult
{
    ZoomVideoSDKUserHelpRequestResult_Idle = 0,
    ZoomVideoSDKUserHelpRequestResult_Busy,
    ZoomVideoSDKUserHelpRequestResult_Ignore,
    ZoomVideoSDKUserHelpRequestResult_HostAlreadyInSubSession
};
 
 
class ISubSessionUser
{
public:
    virtual ~ISubSessionUser() {};
 
    virtual const zchar_t* getUserName() = 0;
 
    virtual const zchar_t* getUserGUID() = 0;
};
 
 
class ISubSessionKit
{
public:
    virtual ~ISubSessionKit() {};
 
    virtual const zchar_t* getSubSessionName() = 0;
 
    virtual const zchar_t* getSubSessionID() = 0;
 
    virtual IVideoSDKVector<ISubSessionUser*>* getSubSessionUserList() = 0;
 
    virtual ZoomVideoSDKErrors joinSubSession() = 0;
};
 
 
class ISubSessionUserHelpRequestHandler
{
public:
    virtual ~ISubSessionUserHelpRequestHandler() {};
 
    virtual const zchar_t* getRequestUserName() = 0;
 
    virtual const zchar_t* getRequestSubSessionName() = 0;
 
    virtual ZoomVideoSDKErrors ignore() = 0;
 
    virtual ZoomVideoSDKErrors joinSubSessionByUserRequest() = 0;
};
 
 
class IZoomVideoSDKSubSessionManager
{
public:
    virtual ~IZoomVideoSDKSubSessionManager() {};
 
    virtual ZoomVideoSDKErrors startSubSession() = 0;
 
    virtual bool isSubSessionStarted() = 0;
 
    virtual ZoomVideoSDKErrors stopSubSession() = 0;
 
    virtual ZoomVideoSDKErrors broadcastMessage(const zchar_t* sMessage) = 0;
};
 
 
class IZoomVideoSDKSubSessionParticipant
{
public:
    virtual ~IZoomVideoSDKSubSessionParticipant() {};
 
    virtual ZoomVideoSDKErrors returnToMainSession() = 0;
 
    virtual ZoomVideoSDKErrors requestForHelp() = 0;
};
 
 
class IZoomVideoSDKSubSessionHelper
{
public:
    virtual ~IZoomVideoSDKSubSessionHelper() {};
 
    virtual ZoomVideoSDKErrors addSubSessionToPreList(const zchar_t* sSubSessionName) = 0;
 
    virtual ZoomVideoSDKErrors removeSubSessionFromPreList(const zchar_t* sSubSessionName) = 0;
 
    virtual ZoomVideoSDKErrors clearSubSessionPreList() = 0;
 
    virtual IVideoSDKVector<const zchar_t*>* getSubSessionPreList() = 0;
 
    virtual ZoomVideoSDKErrors commitSubSessionList() = 0;
 
    virtual ZoomVideoSDKErrors withdrawSubSessionList() = 0;
 
    virtual IVideoSDKVector<ISubSessionKit*>* getCommittedSubSessionList() = 0;
};
END_ZOOM_VIDEO_SDK_NAMESPACE
#endif