Share via

class Translation::TranslationRecognizer

  • Article
class Translation::TranslationRecognizer
  : public AsyncRecognizer< TranslationRecognitionResult, TranslationRecognitionEventArgs, TranslationRecognitionCanceledEventArgs >

Performs translation on the speech input.

Members

Properties

Syntax: public PropertyCollection & Properties;

The collection of properties and their values defined for this TranslationRecognizer.

Synthesizing

Syntax: public EventSignal< const TranslationSynthesisEventArgs & > Synthesizing;

The event signals that a translation synthesis result is received.

TranslationRecognizer

Syntax: public inline explicit TranslationRecognizer ( SPXRECOHANDLE hreco );

It is intended for internal use only. It creates an instance of TranslationRecognizer.

It is recommended to use SpeechTranslationConfig to create an instance of TranslationRecognizer. This method is mainly used in case where a recognizer handle has been created by methods via C-API.

Parameters

  • hreco The handle of the recognizer that is returned by C-API.

~TranslationRecognizer

Syntax: public inline ~TranslationRecognizer ( );

Deconstruct the instance.

RecognizeOnceAsync

Syntax: public inline virtual std::future< std::shared_ptr< TranslationRecognitionResult > > RecognizeOnceAsync ( );

Starts translation recognition, 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 recognized text as well as the translation. 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 StartContinuousRecognitionAsync() instead.

Returns

An asynchronous operation representing the recognition. It returns a value of TranslationRecognitionResult as result.

StartContinuousRecognitionAsync

Syntax: public inline virtual std::future< void > StartContinuousRecognitionAsync ( );

Starts translation on a continous audio stream, until StopContinuousRecognitionAsync() is called. User must subscribe to events to receive recognition results.

Returns

An asynchronous operation that starts the translation.

StopContinuousRecognitionAsync

Syntax: public inline virtual std::future< void > StopContinuousRecognitionAsync ( );

Stops continuous translation.

Returns

A task representing the asynchronous operation that stops the translation.

StartKeywordRecognitionAsync

Syntax: public inline virtual std::future< void > StartKeywordRecognitionAsync ( std::shared_ptr< KeywordRecognitionModel > model );

Starts keyword recognition on a continuous audio stream, until StopKeywordRecognitionAsync() is called.

Parameters

  • model Specifies the keyword model to be used.

Returns

An asynchronous operation that starts the keyword recognition.

StopKeywordRecognitionAsync

Syntax: public inline virtual std::future< void > StopKeywordRecognitionAsync ( );

Stops continuous keyword recognition.

Returns

A task representing the asynchronous operation that stops the keyword recognition.

SetAuthorizationToken

Syntax: public inline void SetAuthorizationToken ( const std::string & token );

Sets the authorization token that will be used for connecting to the 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.

Parameters

  • token A string that represents the endpoint id.

GetAuthorizationToken

Syntax: public inline std::string GetAuthorizationToken ( );

Gets the authorization token.

Returns

Authorization token

AddTargetLanguage

Syntax: public inline void AddTargetLanguage ( const std::string & language );

Adds a target language for translation. Added in version 1.7.0.

Parameters

  • language Translation target language to add.

RemoveTargetLanguage

Syntax: public inline void RemoveTargetLanguage ( const std::string & language );

Removes a target language for translation. Added in version 1.7.0.

Parameters

  • language Translation target language to remove.

GetTargetLanguages

Syntax: public inline std::vector< std::string > GetTargetLanguages ( ) const;

Gets target languages for translation. Added in version 1.7.0.

Returns

Vector of translation target languages.

FromConfig

Syntax: public inline static std::shared_ptr< TranslationRecognizer > FromConfig ( std::shared_ptr< SpeechTranslationConfig > speechconfig , std::nullptr_t );

Create a translation recognizer from a speech config.

Parameters

  • speechconfig Speech configuration.

Returns

A smart pointer wrapped speech recognizer pointer.

FromConfig

Syntax: public inline static std::shared_ptr< TranslationRecognizer > FromConfig ( std::shared_ptr< EmbeddedSpeechConfig > speechConfig , std::nullptr_t );

Create a translation recognizer from an embedded speech config.

Parameters

  • speechConfig Embedded speech configuration.

Returns

A smart pointer wrapped translation recognizer pointer.

FromConfig

Syntax: public inline static std::shared_ptr< TranslationRecognizer > FromConfig ( std::shared_ptr< HybridSpeechConfig > speechConfig , std::nullptr_t );

Create a translation recognizer from a hybrid speech config.

Parameters

  • speechConfig Hybrid speech configuration.

Returns

A smart pointer wrapped translation recognizer pointer.

FromConfig

Syntax: public inline static std::shared_ptr< TranslationRecognizer > FromConfig ( std::shared_ptr< SpeechTranslationConfig > speechconfig , std::shared_ptr< Audio::AudioConfig > audioInput );

Create a translation recognizer from a translation config and an audio config. Users should use this function to create a translation recognizer.

Parameters

  • speechconfig Speech translation config.

  • audioInput Audio config.

Returns

The shared smart pointer of the created translation recognizer.

FromConfig

Syntax: public inline static std::shared_ptr< TranslationRecognizer > FromConfig ( std::shared_ptr< EmbeddedSpeechConfig > speechConfig , std::shared_ptr< Audio::AudioConfig > audioConfig );

Create a translation recognizer from an embedded speech config and audio config.

Parameters

  • speechConfig Embedded speech config.

  • audioConfig Audio config.

Returns

A smart pointer wrapped translation recognizer pointer.

FromConfig

Syntax: public inline static std::shared_ptr< TranslationRecognizer > FromConfig ( std::shared_ptr< HybridSpeechConfig > speechConfig , std::shared_ptr< Audio::AudioConfig > audioConfig );

Create a translation recognizer from a hybrid speech config and audio config.

Parameters

  • speechConfig Hybrid speech config.

  • audioConfig Audio config.

Returns

A smart pointer wrapped translation recognizer pointer.

FromConfig

Syntax: public inline static std::shared_ptr< TranslationRecognizer > FromConfig ( std::shared_ptr< SpeechTranslationConfig > speechconfig , std::shared_ptr< AutoDetectSourceLanguageConfig > autoDetectSourceLangConfig , std::shared_ptr< Audio::AudioConfig > audioInput );

Create a translation recognizer from a translation config, auto detection source language config and an audio config. Users should use this function to create a translation recognizer.

Parameters

  • speechconfig Speech translation config.

  • autoDetectSourceLangConfig Auto detection source language config.

  • audioInput Audio config.

Returns

The shared smart pointer of the created translation recognizer.

FromConfig

Syntax: public inline static std::shared_ptr< TranslationRecognizer > FromConfig ( std::shared_ptr< EmbeddedSpeechConfig > speechConfig , std::shared_ptr< AutoDetectSourceLanguageConfig > autoDetectSourceLangConfig , std::shared_ptr< Audio::AudioConfig > audioInput );

Create a translation recognizer from an embedded speech config, auto detection source language config and audio config.

Parameters

  • speechConfig Embedded speech config.

  • autoDetectSourceLangConfig Auto detection source language config.

  • audioInput Audio config.

Returns

The shared smart pointer of the created translation recognizer.

BaseType

Syntax: typedef BaseType;