Share via

class Transcription::ConversationTranscriber

  • Article
class Transcription::ConversationTranscriber
  : public Recognizer

Class for ConversationTranscribers.

Members

SessionStarted

Syntax: public EventSignal< const SessionEventArgs & > SessionStarted;

Signal for events indicating the start of a recognition session (operation).

SessionStopped

Syntax: public EventSignal< const SessionEventArgs & > SessionStopped;

Signal for events indicating the end of a recognition session (operation).

SpeechStartDetected

Syntax: public EventSignal< const RecognitionEventArgs & > SpeechStartDetected;

Signal for events indicating the start of speech.

SpeechEndDetected

Syntax: public EventSignal< const RecognitionEventArgs & > SpeechEndDetected;

Signal for events indicating the end of speech.

Transcribing

Syntax: public EventSignal< const ConversationTranscriptionEventArgs & > Transcribing;

Signal for events containing intermediate recognition results.

Transcribed

Syntax: public EventSignal< const ConversationTranscriptionEventArgs & > Transcribed;

Signal for events containing final recognition results. (indicating a successful recognition attempt).

Canceled

Syntax: public EventSignal< const ConversationTranscriptionCanceledEventArgs & > Canceled;

Signal for events containing canceled recognition results (indicating a recognition attempt that was canceled as a result or a direct cancellation request or, alternatively, a transport or protocol failure).

Properties

Syntax: public PropertyCollection & Properties;

A collection of properties and their values defined for this ConversationTranscriber.

StartTranscribingAsync

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

Asynchronously starts a conversation transcribing.

Returns

An empty future.

StopTranscribingAsync

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

Asynchronously stops a conversation transcribing.

Returns

An empty future.

ConversationTranscriber

Syntax: public inline explicit ConversationTranscriber ( SPXRECOHANDLE hreco );

Internal constructor. Creates a new instance using the provided handle.

Parameters

  • hreco Recognizer handle.

~ConversationTranscriber

Syntax: public inline ~ConversationTranscriber ( );

Destructor.

SetAuthorizationToken

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

Sets the authorization token that will be used for connecting the server.

Parameters

  • token The authorization token.

GetAuthorizationToken

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

Gets the authorization token.

Returns

Authorization token

FromConfig

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

Create a conversation transcriber from a speech config.

Parameters

  • speechconfig Speech configuration.

Returns

A smart pointer wrapped conversation transcriber pointer.

FromConfig

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

Create a conversation transcriber from a speech config and audio config.

Parameters

  • speechconfig Speech configuration.

  • audioInput Audio configuration.

Returns

A smart pointer wrapped conversation transcriber pointer.

FromConfig

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

Create a conversation transcriber from a speech config, auto detection source language config and audio config.

Parameters

  • speechconfig Speech configuration.

  • autoDetectSourceLangConfig Auto detection source language config.

  • audioInput Audio configuration.

Returns

A smart pointer wrapped conversation trasncriber pointer.

FromConfig

Syntax: public inline static std::shared_ptr< ConversationTranscriber > FromConfig ( std::shared_ptr< SpeechConfig > speechconfig , std::shared_ptr< SourceLanguageConfig > sourceLanguageConfig , std::shared_ptr< Audio::AudioConfig > audioInput );

Create a conversation transcriber from a speech config, source language config and audio config.

Parameters

  • speechconfig Speech configuration.

  • sourceLanguageConfig Source language config.

  • audioInput Audio configuration.

Returns

A smart pointer wrapped conversation transcriber pointer.

FromConfig

Syntax: public inline static std::shared_ptr< ConversationTranscriber > FromConfig ( std::shared_ptr< SpeechConfig > speechconfig , const std::string & sourceLanguage , std::shared_ptr< Audio::AudioConfig > audioInput );

Create a conversation transcriber from a speech config, source language and audio config.

Parameters

  • speechconfig Speech configuration.

  • sourceLanguage Source language.

  • audioInput Audio configuration.

Returns

A smart pointer wrapped conversation transcriber pointer.