TranscriberRecognizer class

Extends

Constructors

TranscriberRecognizer(SpeechTranslationConfig, AudioConfig)

TranscriberRecognizer constructor.

Properties

authorizationToken
canceled
conversation
internalData
properties
recognized
recognizing
sessionStarted

Defines event handler for session started events.

sessionStopped

Defines event handler for session stopped events.

speechEndDetected

Defines event handler for speech stopped events.

speechRecognitionLanguage
speechStartDetected

Defines event handler for speech started events.

telemetryEnabled

This method returns the current state of the telemetry setting.

Methods

close()
connectCallbacks(ConversationTranscriber)
disconnectCallbacks()
dispose(boolean)

Disposes any resources held by the object.

enableTelemetry(boolean)

This method globally enables or disables telemetry.

getConversationInfo()
pushConversationEvent(ConversationInfo, string)
startContinuousRecognitionAsync(() => void, (e: string) => void)
stopContinuousRecognitionAsync(() => void, (e: string) => void)

Constructor Details

TranscriberRecognizer(SpeechTranslationConfig, AudioConfig)

TranscriberRecognizer constructor.

new TranscriberRecognizer(speechTranslationConfig: SpeechTranslationConfig, audioConfig?: AudioConfig)

Parameters

speechTranslationConfig
SpeechTranslationConfig
audioConfig
AudioConfig

An optional audio configuration associated with the recognizer

Property Details

authorizationToken

string authorizationToken

Property Value

string

canceled

canceled: (sender: Recognizer, event: CancellationEventArgs) => void

Property Value

(sender: Recognizer, event: CancellationEventArgs) => void

conversation

any conversation

Property Value

any

internalData

object internalData

Property Value

object

properties

PropertyCollection properties

Property Value

recognized

recognized: (sender: Recognizer, event: SpeechRecognitionEventArgs) => void

Property Value

(sender: Recognizer, event: SpeechRecognitionEventArgs) => void

recognizing

recognizing: (sender: Recognizer, event: SpeechRecognitionEventArgs) => void

Property Value

(sender: Recognizer, event: SpeechRecognitionEventArgs) => void

sessionStarted

Defines event handler for session started events.

public sessionStarted: (sender: Recognizer, event: SessionEventArgs) => void

Property Value

(sender: Recognizer, event: SessionEventArgs) => void

sessionStopped

Defines event handler for session stopped events.

public sessionStopped: (sender: Recognizer, event: SessionEventArgs) => void

Property Value

(sender: Recognizer, event: SessionEventArgs) => void

speechEndDetected

Defines event handler for speech stopped events.

public speechEndDetected: (sender: Recognizer, event: RecognitionEventArgs) => void

Property Value

(sender: Recognizer, event: RecognitionEventArgs) => void

speechRecognitionLanguage

string speechRecognitionLanguage

Property Value

string

speechStartDetected

Defines event handler for speech started events.

public speechStartDetected: (sender: Recognizer, event: RecognitionEventArgs) => void

Property Value

(sender: Recognizer, event: RecognitionEventArgs) => void

telemetryEnabled

This method returns the current state of the telemetry setting.

static boolean telemetryEnabled

Property Value

boolean

true if the telemetry is enabled, false otherwise.

Method Details

close()

function close()

Returns

Promise<void>

connectCallbacks(ConversationTranscriber)

function connectCallbacks(transcriber: ConversationTranscriber)

Parameters

disconnectCallbacks()

function disconnectCallbacks()

dispose(boolean)

Disposes any resources held by the object.

function dispose(disposing: boolean)

Parameters

disposing

boolean

true if disposing the object.

Returns

Promise<void>

enableTelemetry(boolean)

This method globally enables or disables telemetry.

static function enableTelemetry(enabled: boolean)

Parameters

enabled

boolean

Global setting for telemetry collection. If set to true, telemetry information like microphone errors, recognition errors are collected and sent to Microsoft. If set to false, no telemetry is sent to Microsoft.

getConversationInfo()

function getConversationInfo()

Returns

pushConversationEvent(ConversationInfo, string)

function pushConversationEvent(conversationInfo: ConversationInfo, command: string)

Parameters

conversationInfo
ConversationInfo
command

string

Returns

Promise<void>

startContinuousRecognitionAsync(() => void, (e: string) => void)

function startContinuousRecognitionAsync(cb?: () => void, err?: (e: string) => void)

Parameters

cb

() => void

err

(e: string) => void

stopContinuousRecognitionAsync(() => void, (e: string) => void)

function stopContinuousRecognitionAsync(cb?: () => void, err?: (e: string) => void)

Parameters

cb

() => void

err

(e: string) => void