ACSCallCaptions Class

  • Article

Declaration

@interface ACSCallCaptions : NSObject;

Description

Call captions for managing common captions functionality.

Methods

startCaptions

Starts the captions.

-(void)startCaptions:(ACSStartCaptionsOptions *)options withCompletionHandler:(void (^)(NSError *error))completionHandler;

Parameters

  • options -
  • completionHandler - A block to be invoked asynchronously after the operation has finished.

Returns

  • void

stopCaptions

Stop the captions.

-(void)stopCaptionsWithCompletionHandler:(void (^)(NSError *error))completionHandler;

Parameters

  • completionHandler - A block to be invoked asynchronously after the operation has finished.

Returns

  • void

setSpokenLanguage

Set the spoken language.

-(void)setSpokenLanguage:(NSString *)language withCompletionHandler:(void (^)(NSError *error))completionHandler;

Parameters

  • language -
  • completionHandler - A block to be invoked asynchronously after the operation has finished.

Returns

  • void

Properties

supportedSpokenLanguages

List of supported spoken languages for Captions.

@property (copy, nonnull, readonly) NSArray<NSString *> * supportedSpokenLanguages;

isEnabled

Indicates if captions is enabled in current call.

@property (readonly) BOOL isEnabled;

type

Get captions type.

@property (readonly) ACSCaptionsType type;

activeSpokenLanguage

Get active spoken language.

@property (retain, nonnull, readonly) NSString * activeSpokenLanguage;