Class SPXTranslationRecognizer

  • Статья

Declaration

@class SPXTranslationRecognizer : SPXRecognizer;

Description

Performs translation on the specified speech input, and gets transcribed and translated texts as result.

Methods

init:

Initializes a new instance of translation recognizer.

- (instancetype _Nullable)init:(SPXSpeechTranslationConfiguration * _Nonnull)translationConfiguration

Parameters

  • translationConfiguration - translation recognition configuration.

Returns

an instance of translation recognizer.

init:error:

Initializes a new instance of translation recognizer.

Added in version 1.6.0.

- (instancetype _Nullable)init:(SPXSpeechTranslationConfiguration * _Nonnull)translationConfiguration
    error:(NSError * _Nullable * _Nullable)outError

Parameters

  • translationConfiguration - translation recognition configuration.
  • outError - error information.

Returns

an instance of translation recognizer.

initWithSpeechTranslationConfiguration:audioConfiguration:

Initializes a new instance of translation recognizer using the specified speech and audio configurations.

- (instancetype _Nullable)initWithSpeechTranslationConfiguration:(SPXSpeechTranslationConfiguration * _Nonnull)translationConfiguration
    audioConfiguration:(SPXAudioConfiguration * _Nonnull)audioConfiguration

Parameters

  • translationConfiguration - speech translation recognition configuration.
  • audioConfiguration - audio configuration.

Returns

an instance of translation recognizer.

initWithSpeechTranslationConfiguration:audioConfiguration:error:

Initializes a new instance of translation recognizer using the specified speech and audio configurations.

Added in version 1.6.0.

- (instancetype _Nullable)initWithSpeechTranslationConfiguration:(SPXSpeechTranslationConfiguration * _Nonnull)translationConfiguration
    audioConfiguration:(SPXAudioConfiguration * _Nonnull)audioConfiguration
    error:(NSError * _Nullable * _Nullable)outError

Parameters

  • translationConfiguration - speech translation recognition configuration.
  • audioConfiguration - audio configuration.
  • outError - error information.

Returns

an instance of translation recognizer.

initWithEmbeddedSpeechConfiguration:

Initializes a new instance of translation recognizer.

- (instancetype _Nullable)initWithEmbeddedSpeechConfiguration:(SPXEmbeddedSpeechConfiguration * _Nonnull)embeddedSpeechConfiguration

Parameters

  • embeddedSpeechConfiguration - embedded speech configuration.

Returns

an instance of translation recognizer.

initWithEmbeddedSpeechConfiguration:error:

Initializes a new instance of translation recognizer.

- (instancetype _Nullable)initWithEmbeddedSpeechConfiguration:(SPXEmbeddedSpeechConfiguration * _Nonnull)embeddedSpeechConfiguration
    error:(NSError * _Nullable * _Nullable)outError

Parameters

  • embeddedSpeechConfiguration - embedded speech configuration.
  • outError - error information.

Returns

an instance of translation recognizer.

initWithEmbeddedSpeechConfiguration:audioConfiguration:

Initializes a new instance of translation recognizer using the specified speech and audio configurations.

- (instancetype _Nullable)initWithEmbeddedSpeechConfiguration:(SPXEmbeddedSpeechConfiguration * _Nonnull)embeddedSpeechConfiguration
    audioConfiguration:(SPXAudioConfiguration * _Nonnull)audioConfiguration

Parameters

  • embeddedSpeechConfiguration - embedded speech configuration.
  • audioConfiguration - audio configuration.

Returns

an instance of translation recognizer.

initWithEmbeddedSpeechConfiguration:audioConfiguration:error:

Initializes a new instance of translation recognizer using the specified speech and audio configurations.

- (instancetype _Nullable)initWithEmbeddedSpeechConfiguration:(SPXEmbeddedSpeechConfiguration * _Nonnull)embeddedSpeechConfiguration
    audioConfiguration:(SPXAudioConfiguration * _Nonnull)audioConfiguration
    error:(NSError * _Nullable * _Nullable)outError

Parameters

  • embeddedSpeechConfiguration - embedded speech configuration.
  • audioConfiguration - audio configuration.
  • outError - error information.

Returns

an instance of translation recognizer.

recognizeOnce

Starts speech translation, and returns after a single utterance is recognized. The end of a single utterance is determined by listening for silence at the end or until a maximum of 15 seconds of audio is processed. The task returns the recognition text as result.

Note: Since recognizeOnce() returns only a single utterance, it is suitable only for single shot recognition like command or query. For long-running multi-utterance recognition, use startContinuousRecognition() instead.

- (SPXTranslationRecognitionResult * _Nonnull)recognizeOnce

Returns

the result of translation.

recognizeOnce:

Starts speech translation, and returns after a single utterance is recognized. The end of a single utterance is determined by listening for silence at the end or until a maximum of 15 seconds of audio is processed. The task returns the recognition text as result.

Note: Since recognizeOnce() returns only a single utterance, it is suitable only for single shot recognition like command or query. For long-running multi-utterance recognition, use startContinuousRecognition() instead.

Added in version 1.6.0.

- (SPXTranslationRecognitionResult * _Nullable)recognizeOnce:(NSError * _Nullable * _Nullable)outError

Parameters

  • outError - error information.

Returns

the result of translation.

recognizeOnceAsync:

Starts translation, and returns after a single utterance is recognized. The end of a single utterance is determined by listening for silence at the end or until a maximum of 15 seconds of audio is processed. The task returns the recognition text as result.

Note: Since recognizeOnceAsync() returns only a single utterance, it is suitable only for single shot recognition like command or query. For long-running multi-utterance recognition, use startContinuousRecognition() instead.

- (void)recognizeOnceAsync:(void (^ _Nonnull)(SPXTranslationRecognitionResult * _Nonnull))resultReceivedHandler

Parameters

  • resultReceivedHandler - the block function to be called when the first utterance has been recognized.

recognizeOnceAsync:error:

Starts translation, and returns after a single utterance is recognized. The end of a single utterance is determined by listening for silence at the end or until a maximum of 15 seconds of audio is processed. The task returns the recognition text as result.

Note: Since recognizeOnceAsync() returns only a single utterance, it is suitable only for single shot recognition like command or query. For long-running multi-utterance recognition, use startContinuousRecognition() instead.

Added in version 1.6.0.

- (BOOL)recognizeOnceAsync:(void (^ _Nonnull)(SPXTranslationRecognitionResult * _Nonnull))resultReceivedHandler
    error:(NSError * _Nullable * _Nullable)outError

Parameters

  • resultReceivedHandler - the block function to be called when the first utterance has been recognized.
  • outError - error information.

startContinuousRecognition

Starts speech translation on a continuous audio stream, until stopContinuousRecognition() is called. The user must subscribe to events to receive translation results.

- (void)startContinuousRecognition

startContinuousRecognition:

Starts speech translation on a continuous audio stream, until stopContinuousRecognition() is called. The user must subscribe to events to receive translation results.

Added in version 1.6.0.

- (BOOL)startContinuousRecognition:(NSError * _Nullable * _Nullable)outError

Parameters

  • outError - error information.

stopContinuousRecognition

Stops continuous translation.

- (void)stopContinuousRecognition

stopContinuousRecognition:

Stops continuous translation.

Added in version 1.6.0.

- (BOOL)stopContinuousRecognition:(NSError * _Nullable * _Nullable)outError

Parameters

  • outError - error information.

addRecognizedEventHandler:

Subscribes to the Recognized event which indicates that a final result has been recognized.

- (void)addRecognizedEventHandler:(SPXTranslationRecognitionEventHandler _Nonnull)eventHandler

addRecognizingEventHandler:

Subscribes to the Recognizing event which indicates that an intermediate result has been recognized.

- (void)addRecognizingEventHandler:(SPXTranslationRecognitionEventHandler _Nonnull)eventHandler

addSynthesizingEventHandler:

Subscribes to the Synthesizing event which indicates that a synthesis voice output has been received.

- (void)addSynthesizingEventHandler:(SPXTranslationSynthesisEventHandler _Nonnull)eventHandler

addCanceledEventHandler:

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

- (void)addCanceledEventHandler:(SPXTranslationRecognitionCanceledEventHandler _Nonnull)eventHandler

addTargetLanguage:

Adds a target language for translation.

Added in version 1.7.0.

- (void)addTargetLanguage:(NSString * _Nonnull)lang

Parameters

  • lang - the language identifier in BCP-47 format.

removeTargetLanguage:

Removes a target language for translation.

Added in version 1.7.0.

- (void)removeTargetLanguage:(NSString * _Nonnull)lang

Parameters

  • lang - the language identifier in BCP-47 format.

Properties

authorizationToken

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

Authorization token used to communicate with the translation recognition 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.

targetLanguages

@property (readonly, copy, nonatomic) NSArray * _Nonnull targetLanguages;

All target languages that have been configured for translation.

Added in version 1.7.0.