amazonka-mediatailor-2.0: Amazon MediaTailor 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.MediaTailor.Types.AvailSuppression

Description

 
Synopsis

Documentation

data AvailSuppression Source #

The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.

See: newAvailSuppression smart constructor.

Constructors

AvailSuppression' 

Fields

  • mode :: Maybe Mode

    Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.

  • value :: Maybe Text

    A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.

Instances

Instances details
FromJSON AvailSuppression Source # 
Instance details

Defined in Amazonka.MediaTailor.Types.AvailSuppression

ToJSON AvailSuppression Source # 
Instance details

Defined in Amazonka.MediaTailor.Types.AvailSuppression

Generic AvailSuppression Source # 
Instance details

Defined in Amazonka.MediaTailor.Types.AvailSuppression

Associated Types

type Rep AvailSuppression :: Type -> Type #

Read AvailSuppression Source # 
Instance details

Defined in Amazonka.MediaTailor.Types.AvailSuppression

Show AvailSuppression Source # 
Instance details

Defined in Amazonka.MediaTailor.Types.AvailSuppression

NFData AvailSuppression Source # 
Instance details

Defined in Amazonka.MediaTailor.Types.AvailSuppression

Methods

rnf :: AvailSuppression -> () #

Eq AvailSuppression Source # 
Instance details

Defined in Amazonka.MediaTailor.Types.AvailSuppression

Hashable AvailSuppression Source # 
Instance details

Defined in Amazonka.MediaTailor.Types.AvailSuppression

type Rep AvailSuppression Source # 
Instance details

Defined in Amazonka.MediaTailor.Types.AvailSuppression

type Rep AvailSuppression = D1 ('MetaData "AvailSuppression" "Amazonka.MediaTailor.Types.AvailSuppression" "amazonka-mediatailor-2.0-6mxt6n51Pv3JbuBr2GKiO4" 'False) (C1 ('MetaCons "AvailSuppression'" 'PrefixI 'True) (S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Mode)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newAvailSuppression :: AvailSuppression Source #

Create a value of AvailSuppression 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:mode:AvailSuppression', availSuppression_mode - Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.

$sel:value:AvailSuppression', availSuppression_value - A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.

availSuppression_mode :: Lens' AvailSuppression (Maybe Mode) Source #

Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.

availSuppression_value :: Lens' AvailSuppression (Maybe Text) Source #

A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.