Share via

ConnectionMessage class

  • Reference
Package:
microsoft-cognitiveservices-speech-sdk

ConnectionMessage represents implementation specific messages sent to and received from the speech service. These messages are provided for debugging purposes and should not be used for production use cases with the Azure Cognitive Services Speech Service. Messages sent to and received from the Speech Service are subject to change without notice. This includes message contents, headers, payloads, ordering, etc. Added in version 1.11.0.

Properties

binaryMessage

Gets the binary message payload.
isBinaryMessage

Checks to see if the ConnectionMessage is a binary message. See also GetBinaryMessage().
isTextMessage

Checks to see if the ConnectionMessage is a text message. See also IsBinaryMessage().
path

The message path.
properties

A collection of properties and their values defined for this . Message headers can be accessed via this collection (e.g. "Content-Type").
TextMessage

Gets the text message payload. Typically the text message content-type is application/json. To determine other content-types use Properties.GetProperty("Content-Type").

Methods

toString()

Returns a string that represents the connection message.

Property Details

binaryMessage

Gets the binary message payload.

ArrayBuffer binaryMessage

Property Value

ArrayBuffer

isBinaryMessage

Checks to see if the ConnectionMessage is a binary message. See also GetBinaryMessage().

boolean isBinaryMessage

Property Value

boolean

isTextMessage

Checks to see if the ConnectionMessage is a text message. See also IsBinaryMessage().

boolean isTextMessage

Property Value

boolean

path

The message path.

string path

Property Value

string

properties

A collection of properties and their values defined for this . Message headers can be accessed via this collection (e.g. "Content-Type").

PropertyCollection properties

Property Value

PropertyCollection

TextMessage

Gets the text message payload. Typically the text message content-type is application/json. To determine other content-types use Properties.GetProperty("Content-Type").

string TextMessage

Property Value

string

Method Details

toString()

Returns a string that represents the connection message.

function toString(): string

Returns

string