ConversationTranscriber Class

Package:

com.microsoft.cognitiveservices.speech.transcription

Maven Artifact:

com.microsoft.cognitiveservices.speech:client-sdk:1.34.0

• java.lang.Object
• • com.microsoft.cognitiveservices.speech.Recognizer
  • • com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber

public final class ConversationTranscriber
extends Recognizer

Performs conversation transcribing for audio input streams, and gets transcribed text and speaker id as a result. Note: close() must be called in order to release underlying resources held by the object.

Field Summary

Modifier and Type	Field and Description
final EventHandlerImpl<ConversationTranscriptionCanceledEventArgs>	canceled The event canceled signals that the recognition was canceled.
final EventHandlerImpl<ConversationTranscriptionEventArgs>	transcribed The event transcribed signals that a final recognition result is received.
final EventHandlerImpl<ConversationTranscriptionEventArgs>	transcribing The event transcribing signals that an intermediate recognition result is received.

Constructor Summary

Constructor	Description
ConversationTranscriber(SpeechConfig speechConfig)	Initializes a new instance of Conversation Transcriber.
ConversationTranscriber(SpeechConfig speechConfig, AutoDetectSourceLanguageConfig autoDetectSourceLangConfig)	Initializes a new instance of Conversation Transcriber.
ConversationTranscriber(SpeechConfig speechConfig, AutoDetectSourceLanguageConfig autoDetectSourceLangConfig, AudioConfig audioConfig)	Initializes a new instance of Conversation Transcriber.
ConversationTranscriber(SpeechConfig speechConfig, SourceLanguageConfig sourceLanguageConfig)	Initializes a new instance of Conversation Transcriber.
ConversationTranscriber(SpeechConfig speechConfig, SourceLanguageConfig sourceLanguageConfig, AudioConfig audioConfig)	Initializes a new instance of Conversation Transcriber.
ConversationTranscriber(SpeechConfig speechConfig, AudioConfig audioConfig)	Initializes a new instance of Conversation Transcriber.
ConversationTranscriber(SpeechConfig speechConfig, String sourceLanguage)	Initializes a new instance of Conversation Transcriber.
ConversationTranscriber(SpeechConfig speechConfig, String sourceLanguage, AudioConfig audioConfig)	Initializes a new instance of Conversation Transcriber.

Method Summary

Modifier and Type	Method and Description
protected void	dispose(boolean disposing) This method performs cleanup of resources.
java.lang.String	getAuthorizationToken() Gets the authorization token used to communicate with the service.
OutputFormat	getOutputFormat() Gets the output format of recognition.
PropertyCollection	getProperties() The collection of properties and their values defined for this ConversationTranscriber.
java.lang.String	getSpeechRecognitionLanguage() Gets the spoken language of recognition.
void	setAuthorizationToken(String token) Sets the authorization token used to communicate with the service.
java.util.concurrent.Future<java.lang.Void>	startTranscribingAsync() Starts conversation transcribing on a continuous audio stream, until stopTranscribingAsync() is called.
java.util.concurrent.Future<java.lang.Void>	stopTranscribingAsync() Stops conversation transcribing.

Methods inherited from Recognizer

canceledSetCallback close dispose doAsyncRecognitionAction getImpl getPropertyBagFromRecognizerHandle recognize recognizedSetCallback recognizingSetCallback sessionStartedEventCallback sessionStartedSetCallback sessionStoppedEventCallback sessionStoppedSetCallback speechEndDetectedEventCallback speechEndDetectedSetCallback speechStartDetectedEventCallback speechStartDetectedSetCallback startContinuousRecognition startKeywordRecognition stopContinuousRecognition stopKeywordRecognition

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Field Details

canceled

public final EventHandlerImpl canceled

The event canceled signals that the recognition was canceled.

transcribed

public final EventHandlerImpl transcribed

The event transcribed signals that a final recognition result is received.

transcribing

public final EventHandlerImpl transcribing

The event transcribing signals that an intermediate recognition result is received.

Constructor Details

ConversationTranscriber

public ConversationTranscriber(SpeechConfig speechConfig)

Initializes a new instance of Conversation Transcriber.

Parameters:

speechConfig - speech configuration.

ConversationTranscriber

public ConversationTranscriber(SpeechConfig speechConfig, AutoDetectSourceLanguageConfig autoDetectSourceLangConfig)

Initializes a new instance of Conversation Transcriber.

Parameters:

speechConfig - speech configuration.

autoDetectSourceLangConfig - the configuration for auto detecting source language

ConversationTranscriber

public ConversationTranscriber(SpeechConfig speechConfig, AutoDetectSourceLanguageConfig autoDetectSourceLangConfig, AudioConfig audioConfig)

Initializes a new instance of Conversation Transcriber.

Parameters:

speechConfig - speech configuration.

autoDetectSourceLangConfig - the configuration for auto detecting source language

audioConfig - audio configuration.

ConversationTranscriber

public ConversationTranscriber(SpeechConfig speechConfig, SourceLanguageConfig sourceLanguageConfig)

Initializes a new instance of Conversation Transcriber.

Parameters:

speechConfig - speech configuration.

sourceLanguageConfig - the configuration for source language

ConversationTranscriber

public ConversationTranscriber(SpeechConfig speechConfig, SourceLanguageConfig sourceLanguageConfig, AudioConfig audioConfig)

Initializes a new instance of Conversation Transcriber.

Parameters:

speechConfig - speech configuration.

sourceLanguageConfig - the configuration for source language

audioConfig - audio configuration.

ConversationTranscriber

public ConversationTranscriber(SpeechConfig speechConfig, AudioConfig audioConfig)

Initializes a new instance of Conversation Transcriber.

Parameters:

speechConfig - speech configuration.

audioConfig - audio configuration.

ConversationTranscriber

public ConversationTranscriber(SpeechConfig speechConfig, String sourceLanguage)

Initializes a new instance of Conversation Transcriber.

Parameters:

speechConfig - speech configuration.

sourceLanguage - the recognition source language

ConversationTranscriber

public ConversationTranscriber(SpeechConfig speechConfig, String sourceLanguage, AudioConfig audioConfig)

Initializes a new instance of Conversation Transcriber.

Parameters:

speechConfig - speech configuration.

sourceLanguage - the recognition source language

audioConfig - audio configuration.

Method Details

dispose

protected void dispose(boolean disposing)

This method performs cleanup of resources. The Boolean parameter disposing indicates whether the method is called from Dispose (if disposing is true) or from the finalizer (if disposing is false). Derived classes should override this method to dispose resource if needed.

Overrides:

ConversationTranscriber.dispose(boolean disposing)

Parameters:

disposing

getAuthorizationToken

public String getAuthorizationToken()

Gets the authorization token used to communicate with the service.

Returns:

Authorization token.

getOutputFormat

public OutputFormat getOutputFormat()

Gets the output format of recognition.

Returns:

The output format of recognition.

getProperties

public PropertyCollection getProperties()

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

Returns:

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

getSpeechRecognitionLanguage

public String getSpeechRecognitionLanguage()

Gets the spoken language of recognition.

Returns:

The spoken language of recognition.

setAuthorizationToken

public void setAuthorizationToken(String token)

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

startTranscribingAsync

public Future startTranscribingAsync()

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

Returns:

A task representing the asynchronous operation that starts the transcription.

stopTranscribingAsync

public Future stopTranscribingAsync()

Stops conversation transcribing.

Returns:

A task representing the asynchronous operation that stops the transcription.