IClosedCaptionHelper.h

Go to the documentation of this file.

 
#ifndef ZRC_ICLOSEDCAPTIONHELPER_H
#define ZRC_ICLOSEDCAPTIONHELPER_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum ClosedCaptionFontSize
{
    ClosedCaptionFontSizeSmall,     
    ClosedCaptionFontSizeMedium,    
    ClosedCaptionFontSizeLarge      
};
 
enum NewLTTCaptionNotificationType
{
    NewLTTCaptionNotificationTypeCaptionStart,
    NewLTTCaptionNotificationTypeEnableCaptionRequestReceived,
    NewLTTCaptionNotificationTypeEnableCaptionRequestDeclined,
    NewLTTCaptionNotificationTypeSpeakerLanguageMismatch
};
 
enum LTTCaptionWritingDirection
{
    LTTCaptionWritingDirectionLeftToRight = 0,    
    LTTCaptionWritingDirectionRightToLeft = 1     
};
 
enum LTTCaptionMessageResultType
{
    LTTCaptionMessageResultTypeSuccess = 0,                 
    LTTCaptionMessageResultTypeTranslationNotSupport = 1    
};
 
struct ClosedCaptionInfo
{
    bool                  available = false;                        
    bool                  visible = false;                          
    ClosedCaptionFontSize fontSize = ClosedCaptionFontSizeSmall;    
};
 
struct NewLTTCaptionLanguage
{
    int32_t     languageID = -1;    
    std::string displayName;        
    std::string abbreviatedName;    
};
 
struct NewLTTCaptionSpeakerLanguageInfo
{
    NewLTTCaptionLanguage              currentLanguage;       
    std::vector<NewLTTCaptionLanguage> availableLanguages;    
};
 
struct NewLTTCaptionTranslationInfo
{
    NewLTTCaptionLanguage              currentLanguage;          
    std::vector<NewLTTCaptionLanguage> availableLanguages;       
    std::vector<NewLTTCaptionLanguage> recentlyUsedLanguages;    
};
 
struct NewLTTCaptionInfo
{
    bool                  isNewLttCaptionFeatureOn = false;         
    bool                  isAutomatedCaptionFeatureOn = false;      
    bool                  isTranslatedCaptionFeatureOn = false;     
    bool                  isShowCaptionOn = false;                  
    ClosedCaptionFontSize fontSize = ClosedCaptionFontSizeSmall;    
    bool                  isManualCaptionerEnabled = false;         
    bool                  isShowOriginalAndTranslated = false;      
    NewLTTCaptionSpeakerLanguageInfo speakingLanguageInfo;          
    NewLTTCaptionTranslationInfo     translationInfo;               
    bool                  isMmrSupportDisableLttCaption = false;    
    bool                  isCaptionDisabled = false;                
    bool                  isAllowShowCaption = false;               
    bool                  isAllowRequestCaption = false;            
    bool                  isShowTranscriptPanelOnZR = false;        
    bool                  isAllowViewFullTranscript = false;        
};
 
struct InterpretLanguageInfoList
{
    bool                               isAvailable = false;             
    bool                               isOriginalAudioMuted = false;    
    std::vector<InterpretLanguageInfo> languages;                       
    InterpretLanguageInfo              activeLanguage;                  
};
 
struct LTTCaptionMessage
{
    LTTCaptionMessageResultType result = LTTCaptionMessageResultTypeSuccess;          
    std::string                 messageID;                                            
    int32_t                     userNodeID = 0;                                       
    std::string                 userName;                                             
    int64_t                     messageTime = 0;                                      
    std::string                 messageContent;                                       
    LTTCaptionWritingDirection  direction = LTTCaptionWritingDirectionLeftToRight;    
    int32_t                     speakerTagID = 0;                                     
    std::string                 speakerTagName;                                       
    SmartTagUser                instanceOnlySpeakerTag;                               
    std::string                 attendeeJid;                                          
};
 
class IClosedCaptionHelperSink
{
public:
    virtual ~IClosedCaptionHelperSink() {}
 
    virtual void OnUpdateClosedCaptionNotification(const ClosedCaptionInfo& closedCaptionInfo) = 0;
 
    virtual void OnClosedCaptionResponse(int32_t result, ClosedCaptionFontSize fontSize) = 0;
 
    virtual void OnNewLTTLanguageNotification(const NewLTTCaptionInfo& newLttCaptionInfo) = 0;
 
     virtual void OnNewLTTCaptionNotification(NewLTTCaptionNotificationType type) = 0;
 
    virtual void OnUpdateInterpretLanguageNotification(const InterpretLanguageInfoList& infoList) = 0;
 
    virtual void OnMessageAdd(const LTTCaptionMessage& message) = 0;
 
    virtual void OnMessageUpdate(const LTTCaptionMessage& message) = 0;
 
    virtual void OnMessageNotSupported(const LTTCaptionMessage& message) = 0;
 
    virtual void OnMessageLoad(const std::vector<LTTCaptionMessage>& messages, bool hasMoreHistory) = 0;
    
    virtual void OnMessageInstanceOnlySpeakerTagUpdate(const LTTCaptionMessage& message) = 0;
};
 
class IClosedCaptionHelper
{
public:
    virtual ~IClosedCaptionHelper() {}
 
    virtual ZRCSDKError RegisterSink(IClosedCaptionHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IClosedCaptionHelperSink* pSink) = 0;
 
    // CLOSED CAPTION
 
    virtual ZRCSDKError ControlClosedCaptionVisible(bool show, ClosedCaptionFontSize fontSize) = 0;
 
    virtual ZRCSDKError AssignClosedCaption(int32_t userID, bool assign) = 0;
 
    // Next Generation Language Transcription Translation
 
    virtual ZRCSDKError ShowCaption(bool show) = 0;
 
    virtual ZRCSDKError SetNewLTTCaptionFontSize(ClosedCaptionFontSize fontSize) = 0;
 
    virtual ZRCSDKError EnableNewLTTManualCaptioner(bool enable) = 0;
 
    virtual ZRCSDKError SetNewLTTSpeakerLanguage(int32_t languageID) = 0;
 
    virtual ZRCSDKError SetNewLTTTranslationLanguage(int32_t languageID) = 0;
 
    virtual ZRCSDKError ShowNewLTTOriginalAndTranslated(bool show) = 0;
 
    virtual ZRCSDKError SendEnableCaptionRequest() = 0;
 
    virtual ZRCSDKError ApproveEnableCaptionRequest(bool approve) = 0;
 
    virtual ZRCSDKError EnableCaption(bool enable) = 0;
 
    // Interpret Language
 
    virtual ZRCSDKError MuteOriginalAudio(bool mute) = 0;
 
    virtual ZRCSDKError SelectInterpretLanguage(const InterpretLanguageInfo& languageInfo) = 0;
 
    //LTT Caption message
 
    virtual ZRCSDKError ShowTranscriptPanelOnZR(bool show) = 0;
 
    virtual ZRCSDKError ShowTranscriptPanelOnZRC(bool show) = 0;
 
    virtual ZRCSDKError LoadLTTCaptionMessage() = 0;
 
    virtual ZRCSDKError IsAllowViewFullTranscript(bool& isAllow) = 0;
 
    virtual ZRCSDKError GetLTTCaptionMessageList(std::vector<LTTCaptionMessage>& messages) = 0;
 
    virtual ZRCSDKError HasMoreMessageHistoryOnZR(bool& hasMore) = 0;
};
 
NS_ZRCSDK_END
 
#endif    //ZRC_ICLOSEDCAPTIONHELPER_H