macOS SDK API Reference
Loading...
Searching...
No Matches
ZoomSDKCloseCaptionController.h
Go to the documentation of this file.
1
2
3#import <Foundation/Foundation.h>
4#import "ZoomSDKErrors.h"
5
6
8@property(nonatomic, assign, readonly) int languageID;
9@property(nonatomic, copy, readonly) NSString* languageName;
10@end
11
12
13@protocol ZoomSDKCloseCaptionControllerDelegate <NSObject>
17- (void)onGetCCPrvilege;
18
22- (void)onLostCCPrvilege;
23
30- (void)onReceiveCCMessageWithString:(NSString*)inString senderID:(unsigned int)senderID;
31
36- (void)onReceiveCCRealtimeMessage:(NSString *)realtimeMessage;
37
42- (void)onLiveTranscriptionStatus:(ZoomSDKLiveTranscriptionStaus)status;
43
50- (void)onLiveTranscriptionMsgReceived:(NSString*)msgContent type:(ZoomSDKLiveTranscriptionOperationType)type speakerID:(unsigned int)speakerID;
51
57- (void)onLiveTranscriptionMsgError:(ZoomSDKLiveTranscriptionLanguage*)spokenLanguage transcriptLanguage:(ZoomSDKLiveTranscriptionLanguage*)transcriptLanguage;
58
65- (void)onRequestForLiveTranscriptReceived:(unsigned int)requesterID anonymous:(BOOL)bAnonymous;
66
71- (void)onRequestLiveTransciptionStatusChange:(BOOL)bEnabled;
72
77- (void)onCaptionStatusChanged:(BOOL)enable;
78@end
79
80@interface ZoomSDKCloseCaptionController : NSObject
81{
82 id<ZoomSDKCloseCaptionControllerDelegate> _delegate;
83
84}
85@property(nonatomic, assign)id<ZoomSDKCloseCaptionControllerDelegate> delegate;
86
91- (BOOL)isMeetingSupportCloseCaption;
92
97- (BOOL)canAssignOthersToSendCC;
98
104- (BOOL)canBeAssignedToSendCC:(unsigned int)userID;
105
110- (BOOL)canSendClosedCaption;
111
116- (BOOL)isCanSaveClosedCaption;
117
122- (BOOL)is3rdPartCCServerAvailable;
123
129- (ZoomSDKError)withdrawCCPriviledgeForUser:(unsigned int)userID;
130
136- (ZoomSDKError)assignCCPriviledgeTo:(unsigned int)userID;
137
143- (ZoomSDKError)sendClosedCaptionMessage:(NSString*)ccString;
144
149- (ZoomSDKError)saveCCHistory;
150
155- (NSString*)getClosedCaptionHistorySavedPath;
156
162- (ZoomSDKError)getClosedCaptionUrlFor3rdParty:(NSString**)thirdPartyURL;
163
168- (BOOL)isLiveTranscriptLegalNoticeAvailable;
169
174- (NSString *)getLiveTranscriptLegalNoticesPrompt;
175
180- (NSString *)getLiveTranscriptLegalNoticesExplained;
181
186- (BOOL)isLiveTranscriptionFeatureEnabled;
187
192- (BOOL)isMultiLanguageTranscriptionEnabled;
193
198- (BOOL)isTextLiveTranslationEnabled;
199
204- (ZoomSDKLiveTranscriptionStaus)getLiveTranscriptionStatus;
205
210- (ZoomSDKError)canStartLiveTranscription;
211
217- (ZoomSDKError)startLiveTranscription;
218
224- (ZoomSDKError)stopLiveTranscription;
225
232- (ZoomSDKError)enableRequestLiveTranscription:(BOOL)bEnable;
233
239- (ZoomSDKError)isRequestToStartLiveTranscriptionEnabled;
240
247- (ZoomSDKError)requestToStartLiveTranscription:(BOOL)bAnonymous;
248
254- (ZoomSDKError)enableMeetingManualCaption:(BOOL)bEnable;
255
260- (BOOL)isMeetingManualCaptionEnabled;
261
266- (NSArray<ZoomSDKLiveTranscriptionLanguage*>*)getAvailableMeetingSpokenLanguages;
267
273- (ZoomSDKError)setMeetingSpokenLanguage:(int)languageID;
274
279- (ZoomSDKLiveTranscriptionLanguage*)getMeetingSpokenLanguage;
280
285- (NSArray<ZoomSDKLiveTranscriptionLanguage*>*)getAvailableTranslationLanguages;
286
292- (ZoomSDKError)setTranslationLanguage:(int)languageID;
293
298- (ZoomSDKLiveTranscriptionLanguage*)getTranslationLanguage;
299
304- (ZoomSDKError)enableReceiveSpokenLanguageContent:(BOOL)enable;
305
310- (BOOL)isReceiveSpokenLanguageContentEnabled;
311
316- (BOOL)canDisableCaptions;
317
323- (ZoomSDKError)enableCaptions:(BOOL)enable;
324
329- (BOOL)isCaptionsEnabled;
330@end
ZoomSDKLiveTranscriptionStaus
Enumerations of the type for live transcription status.
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKLiveTranscriptionOperationType
Enumerations of the type for live transcription operation type.
id< ZoomSDKCloseCaptionControllerDelegate > _delegate