Class: Aws::IVS::Types::ThumbnailConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::IVS::Types::ThumbnailConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-ivs/types.rb

Overview

An object representing a configuration of thumbnails for recorded video.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #recording_mode ⇒ String

  Thumbnail recording mode.

• #resolution ⇒ String

  Indicates the desired resolution of recorded thumbnails.

• #storage ⇒ Array<String>

  Indicates the format in which thumbnails are recorded.

• #target_interval_seconds ⇒ Integer

  The targeted thumbnail-generation interval in seconds.

Instance Attribute Details

#recording_mode ⇒ String

Thumbnail recording mode. Default: INTERVAL.

Returns:

• (String)

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

class ThumbnailConfiguration < Struct.new(
  :recording_mode,
  :resolution,
  :storage,
  :target_interval_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#resolution ⇒ String

Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see [Auto-Record to Amazon S3]. Default: Null (source resolution is returned).

[1]: docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html

Returns:

• (String)

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

class ThumbnailConfiguration < Struct.new(
  :recording_mode,
  :resolution,
  :storage,
  :target_interval_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#storage ⇒ Array<String>

Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

Returns:

• (Array<String>)

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

class ThumbnailConfiguration < Struct.new(
  :recording_mode,
  :resolution,
  :storage,
  :target_interval_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#target_interval_seconds ⇒ Integer

The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

Important: For the BASIC channel type, or the STANDARD channel type with multitrack input, setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See [ Amazon IVS Streaming Configuration] for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

[1]: docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html

Returns:

• (Integer)

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

class ThumbnailConfiguration < Struct.new(
  :recording_mode,
  :resolution,
  :storage,
  :target_interval_seconds)
  SENSITIVE = []
  include Aws::Structure
end