Class: Aws::IVS::Types::Channel

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

Overview

Object specifying a channel.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

Channel ARN.

Returns:

  • (String)


208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 208

class Channel < Struct.new(
  :arn,
  :authorized,
  :ingest_endpoint,
  :latency_mode,
  :name,
  :playback_url,
  :recording_configuration_arn,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#authorizedBoolean

Whether the channel is private (enabled for playback authorization). Default: false.

Returns:

  • (Boolean)


208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 208

class Channel < Struct.new(
  :arn,
  :authorized,
  :ingest_endpoint,
  :latency_mode,
  :name,
  :playback_url,
  :recording_configuration_arn,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#ingest_endpointString

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

Returns:

  • (String)


208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 208

class Channel < Struct.new(
  :arn,
  :authorized,
  :ingest_endpoint,
  :latency_mode,
  :name,
  :playback_url,
  :recording_configuration_arn,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#latency_modeString

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

Returns:

  • (String)


208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 208

class Channel < Struct.new(
  :arn,
  :authorized,
  :ingest_endpoint,
  :latency_mode,
  :name,
  :playback_url,
  :recording_configuration_arn,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

Channel name.

Returns:

  • (String)


208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 208

class Channel < Struct.new(
  :arn,
  :authorized,
  :ingest_endpoint,
  :latency_mode,
  :name,
  :playback_url,
  :recording_configuration_arn,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#playback_urlString

Channel playback URL.

Returns:

  • (String)


208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 208

class Channel < Struct.new(
  :arn,
  :authorized,
  :ingest_endpoint,
  :latency_mode,
  :name,
  :playback_url,
  :recording_configuration_arn,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#recording_configuration_arnString

Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

Returns:

  • (String)


208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 208

class Channel < Struct.new(
  :arn,
  :authorized,
  :ingest_endpoint,
  :latency_mode,
  :name,
  :playback_url,
  :recording_configuration_arn,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

Array of 1-50 maps, each of the form string:string (key:value).

Returns:

  • (Hash<String,String>)


208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 208

class Channel < Struct.new(
  :arn,
  :authorized,
  :ingest_endpoint,
  :latency_mode,
  :name,
  :playback_url,
  :recording_configuration_arn,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:

  • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.

  • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

Returns:

  • (String)


208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 208

class Channel < Struct.new(
  :arn,
  :authorized,
  :ingest_endpoint,
  :latency_mode,
  :name,
  :playback_url,
  :recording_configuration_arn,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end