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

Inherits:

Struct

• Object
• Struct
• Aws::IVS::Types::Channel

Includes:

Structure

Defined in:

lib/aws-sdk-ivs/types.rb

Overview

Object specifying a channel.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  Channel ARN.

• #authorized ⇒ Boolean

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

• #ingest_endpoint ⇒ String

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

• #latency_mode ⇒ String

  Channel latency mode.

• #name ⇒ String

  Channel name.

• #playback_url ⇒ String

  Channel playback URL.

• #recording_configuration_arn ⇒ String

  Recording-configuration ARN.

• #tags ⇒ Hash<String,String>

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

• #type ⇒ String

  Channel type, which determines the allowable resolution and bitrate.

Instance Attribute Details

#arn ⇒ String

Channel ARN.

Returns:

• (String)

# File '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

#authorized ⇒ Boolean

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

Returns:

• (Boolean)

# File '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_endpoint ⇒ String

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

Returns:

• (String)

# File '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_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. Default: `LOW`. (Note: In the Amazon IVS console, `LOW` and `NORMAL` correspond to Ultra-low and Standard, respectively.)

Returns:

• (String)

# File '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

#name ⇒ String

Channel name.

Returns:

• (String)

# File '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_url ⇒ String

Channel playback URL.

Returns:

• (String)

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

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

Returns:

• (String)

# File '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

#tags ⇒ Hash<String,String>

Array of 1-50 maps, each of the form `string:string (key:value)`. See [Tagging Amazon Web Services Resources] for more information, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

[1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:

• (Hash<String,String>)

# File '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

#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.* Default: `STANDARD`. 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 '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