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

Inherits:

Struct

• Object
• Struct
• Aws::IVS::Types::UpdateChannelRequest

Defined in:

gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  ARN of the channel to be updated.

• #authorized ⇒ Boolean

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

• #latency_mode ⇒ String

  Channel latency mode.

• #name ⇒ String

  Channel name.

• #recording_configuration_arn ⇒ String

  Recording-configuration ARN.

• #type ⇒ String

  Channel type, which determines the allowable resolution and bitrate.

Instance Attribute Details

#arn ⇒ String

ARN of the channel to be updated.

Returns:

• (String)

# 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

#authorized ⇒ Boolean

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

Returns:

• (Boolean)

# 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_mode ⇒ String

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)

# 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

#name ⇒ String

Channel name.

Returns:

• (String)

# 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_arn ⇒ String

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)

# 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

#type ⇒ String

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)

# 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