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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb

Overview

An object representing a configuration of thumbnails for recorded video.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#recording_modeString

Thumbnail recording mode. Default: INTERVAL.

Returns:

  • (String)


2191
2192
2193
2194
2195
2196
2197
2198
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 2191

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

#resolutionString

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).

Returns:

  • (String)


2191
2192
2193
2194
2195
2196
2197
2198
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 2191

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

#storageArray<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>)


2191
2192
2193
2194
2195
2196
2197
2198
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 2191

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

#target_interval_secondsInteger

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, 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.

Returns:

  • (Integer)


2191
2192
2193
2194
2195
2196
2197
2198
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 2191

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