Class: AWSCDK::IVS::CfnStage::ParticipantThumbnailConfigurationProperty

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

Overview

Object specifying a configuration of thumbnails for recorded video from an individual participant.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(recording_mode: nil, storage: nil, target_interval_seconds: nil) ⇒ ParticipantThumbnailConfigurationProperty

Returns a new instance of ParticipantThumbnailConfigurationProperty.

Parameters:

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

    Thumbnail recording mode.

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

    Indicates the format in which thumbnails are recorded.

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

    The targeted thumbnail-generation interval in seconds.



709
710
711
712
713
714
715
716
 
# File 'ivs/cfn_stage.rb', line 709

def initialize(recording_mode: 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?
  @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: - "DISABLED"

Thumbnail recording mode.

Default: DISABLED .

Returns:

  • (String, nil)

See Also:



725
726
727
 
# File 'ivs/cfn_stage.rb', line 725

def recording_mode
  @recording_mode
end

#storage ⇒ Array<String>? (readonly)

Indicates the format in which thumbnails are recorded.

SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails/high directory. LATEST saves the latest thumbnail in media/latest_thumbnail/high/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:



732
733
734
 
# File 'ivs/cfn_stage.rb', line 732

def storage
  @storage
end

#target_interval_seconds ⇒ Numeric? (readonly)

Note:

Default: - 60

The targeted thumbnail-generation interval in seconds.

This is configurable only if recording_mode is INTERVAL . Default: 60.

Returns:

  • (Numeric, nil)

See Also:



740
741
742
 
# File 'ivs/cfn_stage.rb', line 740

def target_interval_seconds
  @target_interval_seconds
end

Class Method Details

.jsii_properties ⇒ Object 



742
743
744
745
746
747
748
 
# File 'ivs/cfn_stage.rb', line 742

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

Instance Method Details

#to_jsii ⇒ Object 



750
751
752
753
754
755
756
757
758
 
# File 'ivs/cfn_stage.rb', line 750

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