Class: Aws::IVS::Types::ChannelSummary

Inherits:

Struct

• Object
• Struct
• Aws::IVS::Types::ChannelSummary

Includes:

Structure

Defined in:

lib/aws-sdk-ivs/types.rb

Overview

Summary information about 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).

• #insecure_ingest ⇒ Boolean

  Whether the channel allows insecure RTMP ingest.

• #latency_mode ⇒ String

  Channel latency mode.

• #name ⇒ String

  Channel name.

• #playback_restriction_policy_arn ⇒ String

  Playback-restriction-policy ARN.

• #preset ⇒ String

  Optional transcode preset for the channel.

• #recording_configuration_arn ⇒ String

  Recording-configuration ARN.

• #tags ⇒ Hash<String,String>

  Tags attached to the resource.

• #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 429

class ChannelSummary < Struct.new(
  :arn,
  :authorized,
  :insecure_ingest,
  :latency_mode,
  :name,
  :playback_restriction_policy_arn,
  :preset,
  :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 429

class ChannelSummary < Struct.new(
  :arn,
  :authorized,
  :insecure_ingest,
  :latency_mode,
  :name,
  :playback_restriction_policy_arn,
  :preset,
  :recording_configuration_arn,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#insecure_ingest ⇒ Boolean

Whether the channel allows insecure RTMP ingest. Default: ‘false`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ivs/types.rb', line 429

class ChannelSummary < Struct.new(
  :arn,
  :authorized,
  :insecure_ingest,
  :latency_mode,
  :name,
  :playback_restriction_policy_arn,
  :preset,
  :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`.

Returns:

• (String)

# File 'lib/aws-sdk-ivs/types.rb', line 429

class ChannelSummary < Struct.new(
  :arn,
  :authorized,
  :insecure_ingest,
  :latency_mode,
  :name,
  :playback_restriction_policy_arn,
  :preset,
  :recording_configuration_arn,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Channel name.

Returns:

• (String)

# File 'lib/aws-sdk-ivs/types.rb', line 429

class ChannelSummary < Struct.new(
  :arn,
  :authorized,
  :insecure_ingest,
  :latency_mode,
  :name,
  :playback_restriction_policy_arn,
  :preset,
  :recording_configuration_arn,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#playback_restriction_policy_arn ⇒ String

Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: “” (empty string, no playback restriction policy is applied).

Returns:

• (String)

# File 'lib/aws-sdk-ivs/types.rb', line 429

class ChannelSummary < Struct.new(
  :arn,
  :authorized,
  :insecure_ingest,
  :latency_mode,
  :name,
  :playback_restriction_policy_arn,
  :preset,
  :recording_configuration_arn,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#preset ⇒ String

Optional transcode preset for the channel. This is selectable only for ‘ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For other channel types (`BASIC` and `STANDARD`), `preset` is the empty string (`“”`).

Returns:

• (String)

# File 'lib/aws-sdk-ivs/types.rb', line 429

class ChannelSummary < Struct.new(
  :arn,
  :authorized,
  :insecure_ingest,
  :latency_mode,
  :name,
  :playback_restriction_policy_arn,
  :preset,
  :recording_configuration_arn,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#recording_configuration_arn ⇒ String

Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: “” (empty string, recording is disabled).

Returns:

• (String)

# File 'lib/aws-sdk-ivs/types.rb', line 429

class ChannelSummary < Struct.new(
  :arn,
  :authorized,
  :insecure_ingest,
  :latency_mode,
  :name,
  :playback_restriction_policy_arn,
  :preset,
  :recording_configuration_arn,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Tags attached to the resource. Array of 1-50 maps, each of the form ‘string:string (key:value)`. See [Best practices and strategies] in *Tagging Amazon Web Services Resources and Tag Editor* for details, 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/tag-editor/latest/userguide/best-practices-and-strats.html

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-ivs/types.rb', line 429

class ChannelSummary < Struct.new(
  :arn,
  :authorized,
  :insecure_ingest,
  :latency_mode,
  :name,
  :playback_restriction_policy_arn,
  :preset,
  :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 input resolution or bitrate, the stream probably will disconnect immediately.* Default: ‘STANDARD`. For details, see [Channel Types].

[1]: docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html

Returns:

• (String)

# File 'lib/aws-sdk-ivs/types.rb', line 429

class ChannelSummary < Struct.new(
  :arn,
  :authorized,
  :insecure_ingest,
  :latency_mode,
  :name,
  :playback_restriction_policy_arn,
  :preset,
  :recording_configuration_arn,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end