Class: AWSCDK::MediaLive::CfnChannel::BlackoutSlateProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
media_live/cfn_channel.rb

Overview

The settings for a blackout slate.

The parent of this entity is EncoderSettings.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(blackout_slate_image: nil, network_end_blackout: nil, network_end_blackout_image: nil, network_id: nil, state: nil) ⇒ BlackoutSlateProperty

Returns a new instance of BlackoutSlateProperty.

Parameters:

  • blackout_slate_image (AWSCDK::IResolvable, AWSCDK::MediaLive::CfnChannel::InputLocationProperty, nil) (defaults to: nil) —

    The blackout slate image to be used.

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

    Setting to enabled causes MediaLive to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered.

  • network_end_blackout_image (AWSCDK::IResolvable, AWSCDK::MediaLive::CfnChannel::InputLocationProperty, nil) (defaults to: nil) —

    The path to the local file to use as the Network End Blackout image.

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

    Provides a Network ID that matches EIDR ID format (for example, "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").

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

    When set to enabled, this causes video, audio, and captions to be blanked when indicated by program metadata.



2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
 
# File 'media_live/cfn_channel.rb', line 2953

def initialize(blackout_slate_image: nil, network_end_blackout: nil, network_end_blackout_image: nil, network_id: nil, state: nil)
  @blackout_slate_image = blackout_slate_image.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::InputLocationProperty.new(**blackout_slate_image.transform_keys(&:to_sym)) : blackout_slate_image
  Jsii::Type.check_type(@blackout_slate_image, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5JbnB1dExvY2F0aW9uUHJvcGVydHkifV19fQ==")), "blackoutSlateImage") unless @blackout_slate_image.nil?
  @network_end_blackout = network_end_blackout
  Jsii::Type.check_type(@network_end_blackout, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "networkEndBlackout") unless @network_end_blackout.nil?
  @network_end_blackout_image = network_end_blackout_image.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::InputLocationProperty.new(**network_end_blackout_image.transform_keys(&:to_sym)) : network_end_blackout_image
  Jsii::Type.check_type(@network_end_blackout_image, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5JbnB1dExvY2F0aW9uUHJvcGVydHkifV19fQ==")), "networkEndBlackoutImage") unless @network_end_blackout_image.nil?
  @network_id = network_id
  Jsii::Type.check_type(@network_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "networkId") unless @network_id.nil?
  @state = state
  Jsii::Type.check_type(@state, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "state") unless @state.nil?
end

Instance Attribute Details

#blackout_slate_image ⇒ AWSCDK::IResolvable, ... (readonly)

The blackout slate image to be used.

Keep empty for solid black. Only .bmp and .png images are supported.

Returns:

See Also:



2972
2973
2974
 
# File 'media_live/cfn_channel.rb', line 2972

def blackout_slate_image
  @blackout_slate_image
end

#network_end_blackout ⇒ String? (readonly)

Setting to enabled causes MediaLive to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered.

The blackout is lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in Network ID.

Returns:

  • (String, nil)

See Also:



2979
2980
2981
 
# File 'media_live/cfn_channel.rb', line 2979

def network_end_blackout
  @network_end_blackout
end

#network_end_blackout_image ⇒ AWSCDK::IResolvable, ... (readonly)

The path to the local file to use as the Network End Blackout image.

The image is scaled to fill the entire output raster.

Returns:

See Also:



2986
2987
2988
 
# File 'media_live/cfn_channel.rb', line 2986

def network_end_blackout_image
  @network_end_blackout_image
end

#network_id ⇒ String? (readonly)

Provides a Network ID that matches EIDR ID format (for example, "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").

Returns:

  • (String, nil)

See Also:



2991
2992
2993
 
# File 'media_live/cfn_channel.rb', line 2991

def network_id
  @network_id
end

#state ⇒ String? (readonly)

When set to enabled, this causes video, audio, and captions to be blanked when indicated by program metadata.

Returns:

  • (String, nil)

See Also:



2996
2997
2998
 
# File 'media_live/cfn_channel.rb', line 2996

def state
  @state
end

Class Method Details

.jsii_properties ⇒ Object 



2998
2999
3000
3001
3002
3003
3004
3005
3006
 
# File 'media_live/cfn_channel.rb', line 2998

def self.jsii_properties
  {
    :blackout_slate_image => "blackoutSlateImage",
    :network_end_blackout => "networkEndBlackout",
    :network_end_blackout_image => "networkEndBlackoutImage",
    :network_id => "networkId",
    :state => "state",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
 
# File 'media_live/cfn_channel.rb', line 3008

def to_jsii
  result = {}
  result.merge!({
    "blackoutSlateImage" => @blackout_slate_image,
    "networkEndBlackout" => @network_end_blackout,
    "networkEndBlackoutImage" => @network_end_blackout_image,
    "networkId" => @network_id,
    "state" => @state,
  })
  result.compact
end