You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::MediaLive::Types::BlackoutSlate

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing BlackoutSlate as input to an Aws::Client method, you can use a vanilla Hash:

{
  blackout_slate_image: {
    password_param: "__string",
    uri: "__string", # required
    username: "__string",
  },
  network_end_blackout: "DISABLED", # accepts DISABLED, ENABLED
  network_end_blackout_image: {
    password_param: "__string",
    uri: "__string", # required
    username: "__string",
  },
  network_id: "__stringMin34Max34",
  state: "DISABLED", # accepts DISABLED, ENABLED
}

Blackout Slate

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#blackout_slate_image ⇒ Types::InputLocation

Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.

Returns:

#network_end_blackout ⇒ String

Setting to enabled causes the encoder 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 will be 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\".

Possible values:

  • DISABLED
  • ENABLED

Returns:

  • (String) —

    Setting to enabled causes the encoder 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 ⇒ Types::InputLocation

Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.

Returns:

#network_id ⇒ String

Provides Network ID that matches EIDR ID format (e.g., \"10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C\").

Returns:

  • (String) —

    Provides Network ID that matches EIDR ID format (e.g., \"10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C\").

#state ⇒ String

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

Possible values:

  • DISABLED
  • ENABLED

Returns:

  • (String) —

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