Class: Aws::IVS::Types::RecordingConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::IVS::Types::RecordingConfiguration

Defined in:

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

Overview

An object representing a configuration to record a channel stream.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  Recording-configuration ARN.

• #destination_configuration ⇒ Types::DestinationConfiguration

  A complex type that contains information about where recorded video will be stored.

• #name ⇒ String

  Recording-configuration name.

• #recording_reconnect_window_seconds ⇒ Integer

  If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.

• #rendition_configuration ⇒ Types::RenditionConfiguration

  Object that describes which renditions should be recorded for a stream.

• #state ⇒ String

  Indicates the current state of the recording configuration.

• #tags ⇒ Hash<String,String>

  Tags attached to the resource.

• #thumbnail_configuration ⇒ Types::ThumbnailConfiguration

  A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

Instance Attribute Details

#arn ⇒ String

Recording-configuration ARN.

Returns:

• (String)

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

class RecordingConfiguration < Struct.new(
  :arn,
  :destination_configuration,
  :name,
  :recording_reconnect_window_seconds,
  :rendition_configuration,
  :state,
  :tags,
  :thumbnail_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#destination_configuration ⇒ Types::DestinationConfiguration

A complex type that contains information about where recorded video will be stored.

Returns:

• (Types::DestinationConfiguration)

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

class RecordingConfiguration < Struct.new(
  :arn,
  :destination_configuration,
  :name,
  :recording_reconnect_window_seconds,
  :rendition_configuration,
  :state,
  :tags,
  :thumbnail_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Recording-configuration name. The value does not need to be unique.

Returns:

• (String)

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

class RecordingConfiguration < Struct.new(
  :arn,
  :destination_configuration,
  :name,
  :recording_reconnect_window_seconds,
  :rendition_configuration,
  :state,
  :tags,
  :thumbnail_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#recording_reconnect_window_seconds ⇒ Integer

If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

Returns:

• (Integer)

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

class RecordingConfiguration < Struct.new(
  :arn,
  :destination_configuration,
  :name,
  :recording_reconnect_window_seconds,
  :rendition_configuration,
  :state,
  :tags,
  :thumbnail_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#rendition_configuration ⇒ Types::RenditionConfiguration

Object that describes which renditions should be recorded for a stream.

Returns:

• (Types::RenditionConfiguration)

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

class RecordingConfiguration < Struct.new(
  :arn,
  :destination_configuration,
  :name,
  :recording_reconnect_window_seconds,
  :rendition_configuration,
  :state,
  :tags,
  :thumbnail_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

Returns:

• (String)

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

class RecordingConfiguration < Struct.new(
  :arn,
  :destination_configuration,
  :name,
  :recording_reconnect_window_seconds,
  :rendition_configuration,
  :state,
  :tags,
  :thumbnail_configuration)
  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.

Returns:

• (Hash<String,String>)

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

class RecordingConfiguration < Struct.new(
  :arn,
  :destination_configuration,
  :name,
  :recording_reconnect_window_seconds,
  :rendition_configuration,
  :state,
  :tags,
  :thumbnail_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#thumbnail_configuration ⇒ Types::ThumbnailConfiguration

A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

Returns:

• (Types::ThumbnailConfiguration)

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

class RecordingConfiguration < Struct.new(
  :arn,
  :destination_configuration,
  :name,
  :recording_reconnect_window_seconds,
  :rendition_configuration,
  :state,
  :tags,
  :thumbnail_configuration)
  SENSITIVE = []
  include Aws::Structure
end