ConnectionMessage Class

Definition

Represents implementation-specific messages sent to and received from the speech service. For debugging only. Added in 1.10.0

public class ConnectionMessage
type ConnectionMessage = class
Public Class ConnectionMessage
Inheritance
ConnectionMessage

Remarks

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.

Properties

Path

A string that specifies the message type.

Properties

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

Methods

GetBinaryMessage()

Gets the binary message payload.

GetTextMessage()

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

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().

ToString()

Returns a string that represents the connection message.

Applies to