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
When making an API call, you may pass UpdateChannelRequest data as a hash:
{
arn: "ChannelArn", # required
authorized: false,
latency_mode: "NORMAL", # accepts NORMAL, LOW
name: "ChannelName",
recording_configuration_arn: "ChannelRecordingConfigurationArn",
type: "BASIC", # accepts BASIC, STANDARD
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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.
2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 |
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 2015 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).
2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 |
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 2015 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.)
2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 |
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 2015 class UpdateChannelRequest < Struct.new( :arn, :authorized, :latency_mode, :name, :recording_configuration_arn, :type) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
Channel name.
2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 |
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 2015 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
2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 |
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 2015 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
: 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.
2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 |
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 2015 class UpdateChannelRequest < Struct.new( :arn, :authorized, :latency_mode, :name, :recording_configuration_arn, :type) SENSITIVE = [] include Aws::Structure end |