Class SPXMeetingTranscriber

  • Article

Declaration

@class SPXMeetingTranscriber : SPXRecognizer;

Description

Performs meeting transcribing for audio input streams, and gets transcribed text and user id as a result.

Methods

init

- (instancetype _Nullable)init

init:

Initializes a new instance of a meeting transcriber using the default configuration.

- (instancetype _Nullable)init:(NSError * _Nullable * _Nullable)outError

Parameters

  • outError - error information.

Returns

a meeting transcriber instance.

initWithAudioConfiguration:

Initializes a new instance of a meeting transcriber using the specified audio configuration.

- (instancetype _Nullable)initWithAudioConfiguration:(SPXAudioConfiguration * _Nonnull)audioConfiguration

Parameters

  • audioConfiguration - audio configuration.

Returns

a meeting transcriber instance.

initWithAudioConfiguration:error:

Initializes a new instance of a meeting transcriber using the specified audio configuration.

- (instancetype _Nullable)initWithAudioConfiguration:(SPXAudioConfiguration * _Nonnull)audioConfiguration
    error:(NSError * _Nullable * _Nullable)outError

Parameters

  • audioConfiguration - audio configuration.

Returns

a meeting transcriber instance.

joinMeetingAsync:meeting:

Join a meeting. A meeting transcriber must join a meeting before transcribing audio.

- (void)joinMeetingAsync:(void (^ _Nonnull)(BOOL, NSError * _Nullable))completedHandler
    meeting:(SPXMeeting * _Nonnull)meeting

Parameters

  • completedHandler - the block function to be called when async operation has been completed.
  • meeting - speech configuration.

joinMeetingAsync:meeting:error:

Join a meeting. A meeting transcriber must join a meeting before transcribing audio.

- (BOOL)joinMeetingAsync:(void (^ _Nonnull)(BOOL, NSError * _Nullable))completedHandler
    meeting:(SPXMeeting * _Nonnull)meeting error:(NSError * _Nullable * _Nullable)outError

Parameters

  • completedHandler - the block function to be called when async operation has been completed.
  • meeting - speech configuration.
  • outError - error information.

leaveMeetingAsync:

Leave a meeting. After leaving a meeting, no transcribing and transcribed events will be sent out.

- (void)leaveMeetingAsync:(void (^ _Nonnull)(BOOL, NSError * _Nullable))completedHandler

Parameters

  • completedHandler - the block function to be called when async operation has been completed.

leaveMeetingAsync:error:

Leave a meeting. After leaving a meeting, no transcribing and transcribed events will be sent out.

- (BOOL)leaveMeetingAsync:(void (^ _Nonnull)(BOOL, NSError * _Nullable))completedHandler
    error:(NSError * _Nullable * _Nullable)outError

Parameters

  • completedHandler - the block function to be called when async operation has been completed.
  • outError - error information.

startTranscribingAsync:

Starts meeting transcribing on a continuous audio stream, until stopTranscribingAsync() is called. User must subscribe to events to receive transcription results.

- (void)startTranscribingAsync:(void (^ _Nonnull)(BOOL, NSError * _Nullable))completedHandler

Parameters

  • completedHandler - the block function to be called when async operation has been completed.

startTranscribingAsync:error:

Starts meeting transcribing on a continuous audio stream, until stopTranscribingAsync() is called. User must subscribe to events to receive transcription results.

- (BOOL)startTranscribingAsync:(void (^ _Nonnull)(BOOL, NSError * _Nullable))completedHandler
    error:(NSError * _Nullable * _Nullable)outError

Parameters

  • completedHandler - the block function to be called when async operation has been completed.
  • outError - error information.

stopTranscribingAsync:

Stops meeting transcribing.

- (void)stopTranscribingAsync:(void (^ _Nonnull)(BOOL, NSError * _Nullable))completedHandler

Parameters

  • completedHandler - the block function to be called when async operation has been completed.

stopTranscribingAsync:error:

Stops meeting transcribing.

- (BOOL)stopTranscribingAsync:(void (^ _Nonnull)(BOOL, NSError * _Nullable))completedHandler
    error:(NSError * _Nullable * _Nullable)outError

Parameters

  • completedHandler - the block function to be called when async operation has been completed.
  • outError - error information.

addTranscribedEventHandler:

Subscribes to the Transcribed event which indicates that a final result has been transcribed.

- (void)addTranscribedEventHandler:(SPXMeetingTranscriptionEventHandler _Nonnull)eventHandler

addTranscribingEventHandler:

Subscribes to the Transcribing event which indicates an that intermediate result has been transcribed.

- (void)addTranscribingEventHandler:(SPXMeetingTranscriptionEventHandler _Nonnull)eventHandler

addCanceledEventHandler:

Subscribes to the Canceled event which indicates that an error occurred during transcription.

- (void)addCanceledEventHandler:(SPXMeetingTranscriptionCanceledEventHandler _Nonnull)eventHandler

Properties

authorizationToken

@property (readwrite, copy, nonatomic) NSString * _Nullable authorizationToken;

The authorization token used to communicate with the meeting transcription service. Note: The caller needs to ensure that the authorization token is valid. Before the authorization token expires, the caller needs to refresh it by calling this setter with a new valid token. Otherwise, the recognizer will encounter errors during recognition.