Class: Aws::IVS::Types::UpdateChannelRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

ARN of the channel to be updated.

Returns:

  • (String)


1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 1764

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

#authorizedBoolean

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

Returns:

  • (Boolean)


1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 1764

class UpdateChannelRequest < Struct.new(
  :arn,
  :authorized,
  :latency_mode,
  :name,
  :recording_configuration_arn,
  :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. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

Returns:

  • (String)


1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 1764

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

#nameString

Channel name.

Returns:

  • (String)


1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 1764

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

#recording_configuration_arnString

Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

Returns:

  • (String)


1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 1764

class UpdateChannelRequest < Struct.new(
  :arn,
  :authorized,
  :latency_mode,
  :name,
  :recording_configuration_arn,
  :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. Valid values:

  • STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.

  • BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

Returns:

  • (String)


1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 1764

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