Module Values.GetSignalingChannelEndpointOutputSource

Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols and Role properties. Protocols is used to determine the communication mechanism. For example, if you specify WSS as the protocol, this API produces a secure websocket endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS endpoint. If you specify WEBRTC as the protocol, but the signaling channel isn't configured for ingestion, you will receive the error InvalidArgumentException. Role determines the messaging permissions. A MASTER role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER role results in this API generating an endpoint that a client can use to communicate only with a MASTER.

Sourcetype nonrec t = {
  1. resourceEndpointList : ResourceEndpointList.t option;
    (*

    A list of endpoints for the specified signaling channel.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `ClientLimitExceededException of ClientLimitExceededException.t
  3. | `InvalidArgumentException of InvalidArgumentException.t
  4. | `ResourceInUseException of ResourceInUseException.t
  5. | `ResourceNotFoundException of ResourceNotFoundException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?resourceEndpointList:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `ClientLimitExceededException of ClientLimitExceededException.t | `InvalidArgumentException of InvalidArgumentException.t | `ResourceInUseException of ResourceInUseException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of AccessDeniedException.t | `ClientLimitExceededException of ClientLimitExceededException.t | `InvalidArgumentException of InvalidArgumentException.t | `ResourceInUseException of ResourceInUseException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `List of [> `Structure of (string * [> `Enum of string | `String of ResourceEndpoint.t ]) list ] list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t