Share via

SpeechRecognitionCanceledEventArgs class

  • Reference
Package:
microsoft-cognitiveservices-speech-sdk
Extends

CancellationEventArgsBase

Constructors

SpeechRecognitionCanceledEventArgs(CancellationReason, string, CancellationErrorCode, number, string)

Creates and initializes an instance of this class.

Properties

errorCode

The error code in case of an unsuccessful operation.
errorDetails

In case of an unsuccessful operation, provides details of the occurred error.
offset

Represents the message offset
reason

The reason the recognition was canceled.
sessionId

Represents the session identifier.

Constructor Details

SpeechRecognitionCanceledEventArgs(CancellationReason, string, CancellationErrorCode, number, string)

Creates and initializes an instance of this class.

new SpeechRecognitionCanceledEventArgs(reason: CancellationReason, errorDetails: string, errorCode: CancellationErrorCode, offset?: number, sessionId?: string)

Parameters

reason
CancellationReason

The cancellation reason.

errorDetails

string

Error details, if provided.

errorCode
CancellationErrorCode
offset

number

The offset.

sessionId

string

The session id.

Property Details

errorCode

The error code in case of an unsuccessful operation.

CancellationErrorCode errorCode

Property Value

CancellationErrorCode

An error code that represents the error reason.

errorDetails

In case of an unsuccessful operation, provides details of the occurred error.

string errorDetails

Property Value

string

A String that represents the error details.

offset

Represents the message offset

number offset

Property Value

number

reason

The reason the recognition was canceled.

CancellationReason reason

Property Value

CancellationReason

Specifies the reason canceled.

sessionId

Represents the session identifier.

string sessionId

Property Value

string

Represents the session identifier.