amazonka-medialive-2.0: Amazon Elemental MediaLive SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MediaLive.Types.BlackoutSlate

Description

 
Synopsis

Documentation

data BlackoutSlate Source #

Blackout Slate

See: newBlackoutSlate smart constructor.

Constructors

BlackoutSlate' 

Fields

  • blackoutSlateImage :: Maybe InputLocation

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

  • networkEndBlackout :: Maybe BlackoutSlateNetworkEndBlackout

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

  • networkEndBlackoutImage :: Maybe InputLocation

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

  • networkId :: Maybe Text

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

  • state :: Maybe BlackoutSlateState

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

Instances

Instances details
FromJSON BlackoutSlate Source # 
Instance details

Defined in Amazonka.MediaLive.Types.BlackoutSlate

ToJSON BlackoutSlate Source # 
Instance details

Defined in Amazonka.MediaLive.Types.BlackoutSlate

Generic BlackoutSlate Source # 
Instance details

Defined in Amazonka.MediaLive.Types.BlackoutSlate

Associated Types

type Rep BlackoutSlate :: Type -> Type #

Read BlackoutSlate Source # 
Instance details

Defined in Amazonka.MediaLive.Types.BlackoutSlate

Show BlackoutSlate Source # 
Instance details

Defined in Amazonka.MediaLive.Types.BlackoutSlate

NFData BlackoutSlate Source # 
Instance details

Defined in Amazonka.MediaLive.Types.BlackoutSlate

Methods

rnf :: BlackoutSlate -> () #

Eq BlackoutSlate Source # 
Instance details

Defined in Amazonka.MediaLive.Types.BlackoutSlate

Hashable BlackoutSlate Source # 
Instance details

Defined in Amazonka.MediaLive.Types.BlackoutSlate

type Rep BlackoutSlate Source # 
Instance details

Defined in Amazonka.MediaLive.Types.BlackoutSlate

type Rep BlackoutSlate = D1 ('MetaData "BlackoutSlate" "Amazonka.MediaLive.Types.BlackoutSlate" "amazonka-medialive-2.0-FK9HUAz0OmeIH2i6eRdod0" 'False) (C1 ('MetaCons "BlackoutSlate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "blackoutSlateImage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputLocation)) :*: S1 ('MetaSel ('Just "networkEndBlackout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BlackoutSlateNetworkEndBlackout))) :*: (S1 ('MetaSel ('Just "networkEndBlackoutImage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputLocation)) :*: (S1 ('MetaSel ('Just "networkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BlackoutSlateState))))))

newBlackoutSlate :: BlackoutSlate Source #

Create a value of BlackoutSlate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:blackoutSlateImage:BlackoutSlate', blackoutSlate_blackoutSlateImage - Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.

$sel:networkEndBlackout:BlackoutSlate', blackoutSlate_networkEndBlackout - 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".

$sel:networkEndBlackoutImage:BlackoutSlate', blackoutSlate_networkEndBlackoutImage - Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.

$sel:networkId:BlackoutSlate', blackoutSlate_networkId - Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").

$sel:state:BlackoutSlate', blackoutSlate_state - When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.

blackoutSlate_blackoutSlateImage :: Lens' BlackoutSlate (Maybe InputLocation) Source #

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

blackoutSlate_networkEndBlackout :: Lens' BlackoutSlate (Maybe BlackoutSlateNetworkEndBlackout) Source #

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

blackoutSlate_networkEndBlackoutImage :: Lens' BlackoutSlate (Maybe InputLocation) Source #

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

blackoutSlate_networkId :: Lens' BlackoutSlate (Maybe Text) Source #

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

blackoutSlate_state :: Lens' BlackoutSlate (Maybe BlackoutSlateState) Source #

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