AvatarWebRTCConnectionResult class

Package:

microsoft-cognitiveservices-speech-sdk

Defines the avatar WebRTC connection result.

Extends

SynthesisResult

Constructors

AvatarWebRTCConnectionResult(RTCSessionDescriptionInit, string, ResultReason, string, PropertyCollection)

Creates and initializes an instance of this class.

Properties

errorDetails	In case of an unsuccessful synthesis, provides details of the occurred error.
properties	The set of properties exposed in the result.
reason	Specifies status of the result.
resultId	Specifies the result identifier.
SDPAnswer	Specifies SDP (Session Description Protocol) answer of WebRTC connection.

Constructor Details

AvatarWebRTCConnectionResult(RTCSessionDescriptionInit, string, ResultReason, string, PropertyCollection)

Creates and initializes an instance of this class.

new AvatarWebRTCConnectionResult(SDPAnswer?: RTCSessionDescriptionInit, resultId?: string, reason?: ResultReason, errorDetails?: string, properties?: PropertyCollection)

Parameters

SDPAnswer

RTCSessionDescriptionInit

The SDP answer of WebRTC connection.

resultId

string

The result id.

reason

ResultReason

The reason.

errorDetails

string

Error details, if provided.

properties

PropertyCollection

Additional properties, if provided.

Property Details

errorDetails

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

string errorDetails

Property Value

string

a brief description of an error.

properties

The set of properties exposed in the result.

PropertyCollection properties

Property Value

PropertyCollection

The set of properties exposed in the result.

reason

Specifies status of the result.

ResultReason reason

Property Value

ResultReason

Specifies status of the result.

resultId

Specifies the result identifier.

string resultId

Property Value

string

Specifies the result identifier.

SDPAnswer

Specifies SDP (Session Description Protocol) answer of WebRTC connection.

RTCSessionDescriptionInit SDPAnswer

Property Value

RTCSessionDescriptionInit

Specifies the SDP answer of WebRTC connection.