meeting_closedcaption_interface.h

Go to the documentation of this file.

 
#ifndef _MEETING_CLOSEDCAPTION_INTERFACE_H_
#define _MEETING_CLOSEDCAPTION_INTERFACE_H_
#include "zoom_sdk_def.h"
 
BEGIN_ZOOM_SDK_NAMESPACE
typedef enum
{
    SDK_LiveTranscription_Status_Stop = 0,   
    SDK_LiveTranscription_Status_Start = 1,  
    SDK_LiveTranscription_Status_User_Sub = 2,  
    SDK_LiveTranscription_Status_Connecting = 10,    
}SDKLiveTranscriptionStatus;
 
typedef enum
{
    SDK_LiveTranscription_OperationType_None = 0,
    SDK_LiveTranscription_OperationType_Add,
    SDK_LiveTranscription_OperationType_Update,
    SDK_LiveTranscription_OperationType_Delete,
    SDK_LiveTranscription_OperationType_Complete,
    SDK_LiveTranscription_OperationType_NotSupported,
}SDKLiveTranscriptionOperationType;
 
class ILiveTranscriptionLanguage
{
public:
    virtual int GetLTTLanguageID() = 0;
    virtual const zchar_t* GetLTTLanguageName() = 0;
    virtual ~ILiveTranscriptionLanguage() {};
};
 
class ILiveTranscriptionMessageInfo
{
public:
    virtual const zchar_t* GetMessageID() = 0;
 
    virtual unsigned int GetSpeakerID() = 0;
 
    virtual const zchar_t* GetSpeakerName() = 0;
 
    virtual const zchar_t* GetMessageContent() = 0;
 
    virtual time_t GetTimeStamp() = 0;
 
    virtual SDKLiveTranscriptionOperationType GetMessageOperationType() = 0;
 
    virtual ~ILiveTranscriptionMessageInfo() {};
};
 
class ICCRequestHandler
{
public:
    virtual bool IsRequestTranslationOn() = 0;
 
    virtual unsigned int GetSenderUserId() = 0;
 
    virtual SDKError Deny() = 0;
 
    virtual ~ICCRequestHandler() {};
};
 
class ICCRequestTranslationOnHandler : public ICCRequestHandler
{
public:
    virtual SDKError ApproveStartCaptionsRequest() = 0;
 
    virtual ~ICCRequestTranslationOnHandler() {};
};
 
class ICCRequestTranslationOffHandler : public ICCRequestHandler
{
public:
    virtual SDKError ApproveStartCaptionsRequest(int languageId) = 0;
 
    virtual ~ICCRequestTranslationOffHandler() {};
};
 
 
class IClosedCaptionControllerEvent
{
public:
    virtual ~IClosedCaptionControllerEvent() {}
 
    virtual void onAssignedToSendCC(bool bAssigned) = 0;
 
    virtual void onClosedCaptionMsgReceived(const zchar_t* ccMsg, unsigned int sender_id, time_t time) = 0;
 
    virtual void onLiveTranscriptionStatus(SDKLiveTranscriptionStatus status) = 0;
 
    virtual void onOriginalLanguageMsgReceived(ILiveTranscriptionMessageInfo* messageInfo) = 0;
 
    virtual void onLiveTranscriptionMsgInfoReceived(ILiveTranscriptionMessageInfo* messageInfo) = 0;
 
    virtual void onLiveTranscriptionMsgError(ILiveTranscriptionLanguage* spokenLanguage, ILiveTranscriptionLanguage* transcriptLanguage) = 0;
 
    virtual void onRequestForLiveTranscriptReceived(unsigned int requester_id, bool bAnonymous) = 0;
 
    virtual void onRequestLiveTranscriptionStatusChange(bool bEnabled) = 0;
 
    virtual void onCaptionStatusChanged(bool bEnabled) = 0;
 
    virtual void onStartCaptionsRequestReceived(ICCRequestHandler* handler) = 0;
 
    virtual void onStartCaptionsRequestApproved() = 0;
 
    virtual void onManualCaptionStatusChanged(bool bEnabled) = 0;
};
 
class IClosedCaptionController
{
public:
    virtual SDKError SetEvent(IClosedCaptionControllerEvent* pEvent) = 0;
 
    virtual bool IsMeetingSupportCC() = 0;
 
    virtual bool CanAssignOthersToSendCC() = 0;
 
    virtual SDKError AssignCCPrivilege(unsigned int userid, bool bAssigned) = 0;
 
    virtual bool CanBeAssignedToSendCC(unsigned int userid) = 0;
 
    virtual bool CanSendClosedCaption() = 0;
 
    virtual SDKError SendClosedCaption(const zchar_t* ccMsg) = 0;
 
    virtual bool IsSaveCCEnabled() = 0;
 
    virtual SDKError SaveCCHistory() = 0;
 
    virtual const zchar_t* GetClosedCaptionHistorySavedPath() = 0;
 
    virtual const zchar_t* GetClosedCaptionUrlFor3rdParty() = 0;
 
    virtual SDKError EnableMeetingManualCaption(bool bEnable) = 0;
 
    virtual bool IsMeetingManualCaptionEnabled() = 0;
 
    virtual bool IsLiveTranscriptLegalNoticeAvailable() = 0;
 
    virtual SDKError EnableReceiveSpokenLanguageContent(bool bEnable) = 0;
 
    virtual bool CanDisableCaptions() = 0;
 
    virtual SDKError EnableCaptions(bool bEnable) = 0;
 
    virtual bool IsCaptionsEnabled() = 0;
 
    virtual bool IsReceiveSpokenLanguageContentEnabled() = 0;
 
    virtual const zchar_t* getLiveTranscriptLegalNoticesPrompt() = 0;
 
    virtual const zchar_t* getLiveTranscriptLegalNoticesExplained() = 0;
 
    virtual bool IsLiveTranscriptionFeatureEnabled() = 0;
 
    virtual bool IsMultiLanguageTranscriptionEnabled() = 0;
 
    virtual bool IsTextLiveTranslationEnabled() = 0;
 
    //  \return type: the current live transcription status type. For more details, see \link SDKLiveTranscriptionStatus \endlink.
    virtual SDKLiveTranscriptionStatus GetLiveTranscriptionStatus() = 0;
 
    virtual bool CanStartLiveTranscription() = 0;
 
    virtual SDKError StartLiveTranscription() = 0;
 
    virtual SDKError StopLiveTranscription() = 0;
 
    virtual SDKError EnableRequestLiveTranscription(bool bEnable) = 0;
 
    virtual bool IsRequestToStartLiveTranscriptionEnabled() = 0;
 
    virtual SDKError RequestToStartLiveTranscription(bool bRequestAnonymous) = 0;
 
    virtual IList<ILiveTranscriptionLanguage*>* GetAvailableMeetingSpokenLanguages() = 0;
 
    virtual SDKError SetMeetingSpokenLanguage(int languageID) = 0;
 
    virtual ILiveTranscriptionLanguage* GetMeetingSpokenLanguage() = 0;
 
    virtual IList<ILiveTranscriptionLanguage*>* GetAvailableTranslationLanguages() = 0;
 
    virtual SDKError SetTranslationLanguage(int languageID) = 0;
 
    virtual ILiveTranscriptionLanguage* GetTranslationLanguage() = 0;
 
    virtual bool IsSupportRequestCaptions() = 0;
 
    virtual bool IsSupportTranslationWhenRequestToStartCaptions() = 0;
 
    virtual SDKError RequestToStartCaptions(bool bEnableTranslation) = 0;
 
    virtual SDKError SetMeetingSpokenLanguage(int languageID, bool bIsForAll) = 0;
};
 
END_ZOOM_SDK_NAMESPACE
#endif