Class: AWSCDK::IVS::CfnRecordingConfiguration::ThumbnailConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ivs/cfn_recording_configuration.rb

Overview

The ThumbnailConfiguration property type describes a configuration of thumbnails for recorded video.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(recording_mode: nil, resolution: nil, storage: nil, target_interval_seconds: nil) ⇒ ThumbnailConfigurationProperty

Returns a new instance of ThumbnailConfigurationProperty.

Parameters:

  • recording_mode (String, nil) (defaults to: nil) —

    Thumbnail recording mode. Valid values:.

  • resolution (String, nil) (defaults to: nil) —

    The desired resolution of recorded thumbnails for a stream.

  • storage (Array<String>, nil) (defaults to: nil) —

    The format in which thumbnails are recorded for a stream.

  • target_interval_seconds (Numeric, nil) (defaults to: nil) —

    The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if RecordingMode is INTERVAL .



720
721
722
723
724
725
726
727
728
729
 
# File 'ivs/cfn_recording_configuration.rb', line 720

def initialize(recording_mode: nil, resolution: nil, storage: nil, target_interval_seconds: nil)
  @recording_mode = recording_mode
  Jsii::Type.check_type(@recording_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "recordingMode") unless @recording_mode.nil?
  @resolution = resolution
  Jsii::Type.check_type(@resolution, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resolution") unless @resolution.nil?
  @storage = storage
  Jsii::Type.check_type(@storage, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "storage") unless @storage.nil?
  @target_interval_seconds = target_interval_seconds
  Jsii::Type.check_type(@target_interval_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "targetIntervalSeconds") unless @target_interval_seconds.nil?
end

Instance Attribute Details

#recording_mode ⇒ String? (readonly)

Note:

Default: - "INTERVAL"

Thumbnail recording mode. Valid values:.

  • DISABLED : Use DISABLED to disable the generation of thumbnails for recorded video.
  • INTERVAL : Use INTERVAL to enable the generation of thumbnails for recorded video at a time interval controlled by the TargetIntervalSeconds property.

Default : INTERVAL

Returns:

  • (String, nil)

See Also:



741
742
743
 
# File 'ivs/cfn_recording_configuration.rb', line 741

def recording_mode
  @recording_mode
end

#resolution ⇒ String? (readonly)

The desired resolution of recorded thumbnails for a stream.

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 .

Returns:

  • (String, nil)

See Also:



748
749
750
 
# File 'ivs/cfn_recording_configuration.rb', line 748

def resolution
  @resolution
end

#storage ⇒ Array<String>? (readonly)

The format in which thumbnails are recorded for a stream.

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

Returns:

  • (Array<String>, nil)

See Also:



755
756
757
 
# File 'ivs/cfn_recording_configuration.rb', line 755

def storage
  @storage
end

#target_interval_seconds ⇒ Numeric? (readonly)

Note:

Default: - 60

The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if RecordingMode is INTERVAL .

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.

Default : 60

Returns:

  • (Numeric, nil)

See Also:



765
766
767
 
# File 'ivs/cfn_recording_configuration.rb', line 765

def target_interval_seconds
  @target_interval_seconds
end

Class Method Details

.jsii_properties ⇒ Object 



767
768
769
770
771
772
773
774
 
# File 'ivs/cfn_recording_configuration.rb', line 767

def self.jsii_properties
  {
    :recording_mode => "recordingMode",
    :resolution => "resolution",
    :storage => "storage",
    :target_interval_seconds => "targetIntervalSeconds",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



776
777
778
779
780
781
782
783
784
785
 
# File 'ivs/cfn_recording_configuration.rb', line 776

def to_jsii
  result = {}
  result.merge!({
    "recordingMode" => @recording_mode,
    "resolution" => @resolution,
    "storage" => @storage,
    "targetIntervalSeconds" => @target_interval_seconds,
  })
  result.compact
end