Class: Aws::KinesisVideo::Types::SingleMasterChannelEndpointConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::KinesisVideo::Types::SingleMasterChannelEndpointConfiguration

Defined in:

(unknown)

Overview

Note:

When passing SingleMasterChannelEndpointConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  protocols: ["WSS"], # accepts WSS, HTTPS
  role: "MASTER", # accepts MASTER, VIEWER
}

An object that contains the endpoint configuration for the SINGLE_MASTER channel type.

Returned by:

• GetSignalingChannelEndpointInput#single_master_channel_endpoint_configuration

See Also:

• AWS API Documentation

Instance Attribute Summary

• #protocols ⇒ Array<String>

  This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel.

• #role ⇒ String

  This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel.

Instance Attribute Details

#protocols ⇒ Array<String>

This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel. If WSS is specified, this API returns a websocket endpoint. If HTTPS is specified, this API returns an HTTPS endpoint.

Returns:

• (Array<String>) —

  This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel.

#role ⇒ String

This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel. If MASTER is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. If VIEWER is specified, this API returns an endpoint that a client can use only to send offers to another MASTER client on this signaling channel.

Possible values:

• MASTER
• VIEWER

Returns:

• (String) —

  This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel.