ZoomSDKCloseCaptionController.h

Go to the documentation of this file.

 
 
#import <Foundation/Foundation.h>
#import <ZoomSDK/ZoomSDKErrors.h>
 
NS_ASSUME_NONNULL_BEGIN
@interface ZoomSDKCCRequestHandler : NSObject
@property (nonatomic, assign, readonly) unsigned int senderUserID;

@property (nonatomic, assign, readonly) BOOL isRequestTranslationOn;
- (ZoomSDKError)deny;
@end
 

@interface ZoomSDKCCRequestTranslationOnHandler : ZoomSDKCCRequestHandler
- (ZoomSDKError)approveStartCaptionsRequest;
@end

@interface ZoomSDKCCRequestTranslationOffHandler : ZoomSDKCCRequestHandler
- (ZoomSDKError)approveStartCaptionsRequest:(int)languageID;
@end

@interface ZoomSDKLiveTranscriptionMessageInfo : NSObject
@property (nonatomic, copy, readonly, nullable) NSString *messageID;

@property (nonatomic, assign, readonly) unsigned int speakerID;

@property (nonatomic, copy, readonly, nullable) NSString *speakerName;

@property (nonatomic, copy, readonly, nullable) NSString *messageContent;

@property (nonatomic, assign, readonly) time_t timeStamp;

@property (nonatomic, assign, readonly) ZoomSDKLiveTranscriptionOperationType messageType;
 
@end
 

@interface ZoomSDKLiveTranscriptionLanguage : NSObject
@property(nonatomic, assign, readonly) int languageID;
@property(nonatomic, copy, readonly, nullable) NSString* languageName;
@end
 

@protocol ZoomSDKCloseCaptionControllerDelegate <NSObject>
@optional

- (void)onGetCCPrivilege;

- (void)onLostCCPrivilege;

- (void)onReceiveCCMessageWithString:(NSString*)inString senderID:(unsigned int)senderID;

- (void)onReceiveCCRealtimeMessage:(NSString *)realtimeMessage;

- (void)onLiveTranscriptionStatus:(ZoomSDKLiveTranscriptionStaus)status;

- (void)onLiveTranscriptionMsgInfoReceived:(ZoomSDKLiveTranscriptionMessageInfo*_Nullable)messageInfo;

- (void)onOriginalLanguageMsgReceived:(ZoomSDKLiveTranscriptionMessageInfo*_Nullable)messageInfo;

- (void)onLiveTranscriptionMsgError:(ZoomSDKLiveTranscriptionLanguage*_Nullable)spokenLanguage transcriptLanguage:(ZoomSDKLiveTranscriptionLanguage*_Nullable)transcriptLanguage;

- (void)onRequestForLiveTranscriptReceived:(unsigned int)requesterID anonymous:(BOOL)bAnonymous;

- (void)onRequestLiveTranscriptionStatusChange:(BOOL)bEnabled;

- (void)onCaptionStatusChanged:(BOOL)enable;

- (void)onStartCaptionsRequestReceived:(ZoomSDKCCRequestHandler *)handler;

- (void)onStartCaptionsRequestApproved;

- (void)onManualCaptionStatusChanged:(BOOL)bEnabled;

- (void)onSpokenLanguageChanged:(ZoomSDKLiveTranscriptionLanguage*_Nullable)spokenLanguage;
@end
 

@interface ZoomSDKCloseCaptionController : NSObject
{
    id<ZoomSDKCloseCaptionControllerDelegate> _delegate;
}

@property(nonatomic, assign, nullable)id<ZoomSDKCloseCaptionControllerDelegate> delegate;

- (BOOL)isMeetingSupportCloseCaption;

- (BOOL)canAssignOthersToSendCC;

- (BOOL)canBeAssignedToSendCC:(unsigned int)userID;

- (BOOL)canSendClosedCaption;

- (BOOL)isCanSaveClosedCaption;

- (BOOL)is3rdPartCCServerAvailable;

- (ZoomSDKError)withdrawCCPrivilegeForUser:(unsigned int)userID;

- (ZoomSDKError)assignCCPrivilegeTo:(unsigned int)userID;

- (ZoomSDKError)sendClosedCaptionMessage:(NSString*)ccString;

- (ZoomSDKError)saveCCHistory;

- (NSString*)getClosedCaptionHistorySavedPath;

- (ZoomSDKError)getClosedCaptionUrlFor3rdParty:(NSString*_Nullable*_Nonnull)thirdPartyURL;

- (BOOL)isLiveTranscriptLegalNoticeAvailable;

- (NSString *)getLiveTranscriptLegalNoticesPrompt;

- (NSString *)getLiveTranscriptLegalNoticesExplained;

- (BOOL)isLiveTranscriptionFeatureEnabled;

- (BOOL)isMultiLanguageTranscriptionEnabled;

- (BOOL)isTextLiveTranslationEnabled;

- (ZoomSDKLiveTranscriptionStaus)getLiveTranscriptionStatus;

- (ZoomSDKError)canStartLiveTranscription;

- (ZoomSDKError)startLiveTranscription;

- (ZoomSDKError)stopLiveTranscription;

- (ZoomSDKError)enableRequestLiveTranscription:(BOOL)bEnable;

- (ZoomSDKError)isRequestToStartLiveTranscriptionEnabled;

- (ZoomSDKError)requestToStartLiveTranscription:(BOOL)bAnonymous;

- (ZoomSDKError)enableMeetingManualCaption:(BOOL)bEnable;

- (BOOL)isMeetingManualCaptionEnabled;

- (NSArray<ZoomSDKLiveTranscriptionLanguage*>*)getAvailableMeetingSpokenLanguages;

- (ZoomSDKError)setMeetingSpokenLanguage:(int)languageID DEPRECATED_MSG_ATTRIBUTE("Use -setMeetingSpokenLanguage:isForAll: instead");

- (ZoomSDKError)setMeetingSpokenLanguage:(int)languageID isForAll:(BOOL)isForAll;

- (ZoomSDKLiveTranscriptionLanguage*)getMeetingSpokenLanguage;

- (NSArray<ZoomSDKLiveTranscriptionLanguage*>*)getAvailableTranslationLanguages;

- (ZoomSDKError)setTranslationLanguage:(int)languageID;

- (ZoomSDKLiveTranscriptionLanguage*)getTranslationLanguage;

- (ZoomSDKError)enableReceiveSpokenLanguageContent:(BOOL)enable;

- (BOOL)isReceiveSpokenLanguageContentEnabled;

- (BOOL)canDisableCaptions;

- (ZoomSDKError)enableCaptions:(BOOL)enable;

- (BOOL)isCaptionsEnabled;

- (BOOL)isSupportRequestCaptions;

- (BOOL)isSupportTranslationWhenRequestToStartCaptions;

- (ZoomSDKError)requestToStartCaptions:(BOOL)enableTranslation;
@end
NS_ASSUME_NONNULL_END