Share via

TranslationRecognitionCanceledEventArgs class

  • Reference
Package:
microsoft-cognitiveservices-speech-sdk

Define payload of speech recognition canceled result events.

Constructors

TranslationRecognitionCanceledEventArgs(string, CancellationReason, string, CancellationErrorCode, TranslationRecognitionResult)

Creates and initializes an instance of this class.

Properties

errorCode

The error code in case of an unsuccessful recognition. Added in version 1.1.0.
errorDetails

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

The reason the recognition was canceled.
result

Specifies the recognition result.
sessionId

Specifies the session identifier.

Constructor Details

TranslationRecognitionCanceledEventArgs(string, CancellationReason, string, CancellationErrorCode, TranslationRecognitionResult)

Creates and initializes an instance of this class.

new TranslationRecognitionCanceledEventArgs(sessionid: string, cancellationReason: CancellationReason, errorDetails: string, errorCode: CancellationErrorCode, result: TranslationRecognitionResult)

Parameters

sessionid

string

The session id.

cancellationReason
CancellationReason

The cancellation reason.

errorDetails

string

Error details, if provided.

errorCode
CancellationErrorCode
result
TranslationRecognitionResult

The result.

Property Details

errorCode

The error code in case of an unsuccessful recognition. Added in version 1.1.0.

CancellationErrorCode errorCode

Property Value

CancellationErrorCode

An error code that represents the error reason.

errorDetails

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

string errorDetails

Property Value

string

A String that represents the error details.

reason

The reason the recognition was canceled.

CancellationReason reason

Property Value

CancellationReason

Specifies the reason canceled.

result

Specifies the recognition result.

TranslationRecognitionResult result

Property Value

TranslationRecognitionResult

the recognition result.

sessionId

Specifies the session identifier.

string sessionId

Property Value

string

the session identifier.