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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb

Overview

Note:

When making an API call, you may pass SingleMasterChannelEndpointConfiguration data as a hash:

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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#protocolsArray<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>)


911
912
913
914
915
916
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 911

class SingleMasterChannelEndpointConfiguration < Struct.new(
  :protocols,
  :role)
  SENSITIVE = []
  include Aws::Structure
end

#roleString

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.

Returns:

  • (String)


911
912
913
914
915
916
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 911

class SingleMasterChannelEndpointConfiguration < Struct.new(
  :protocols,
  :role)
  SENSITIVE = []
  include Aws::Structure
end