Class WebsocketEndpoint

Represents a WebSocket endpoint for streaming audio to and from a WebSocket server.

public class WebsocketEndpoint : Endpoint

Inherited Members: Endpoint.Type

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

public WebsocketEndpoint()

Optional configuration defining how the Authorization HTTP header is set in the WebSocket opening handshake.

[JsonProperty("authorization", Order = 3)]
public WebsocketAuthorization Authorization { get; set; }

The internet media type for the audio being streamed. Must be audio/l16;rate=16000 or audio/l16;rate=8000.

[JsonProperty("content-type", Order = 1)]
public string ContentType { get; set; }

An object containing custom metadata to include as headers in the WebSocket connection request.

[JsonProperty("headers", Order = 2)]
public object Headers { get; set; }

The URI of the WebSocket server to stream audio to, e.g. wss://example.com/socket.

[JsonProperty("uri", Order = 0)]
public string Uri { get; set; }