Amazonka.MediaTailor.Types.AvailSuppression

Documentation

data AvailSuppression

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

FromJSON AvailSuppression

Defined in Amazonka.MediaTailor.Types.AvailSuppression

Methods

parseJSON :: Value -> Parser AvailSuppression

parseJSONList :: Value -> Parser [AvailSuppression]

ToJSON AvailSuppression

Defined in Amazonka.MediaTailor.Types.AvailSuppression

Methods

toJSON :: AvailSuppression -> Value

toEncoding :: AvailSuppression -> Encoding

toJSONList :: [AvailSuppression] -> Value

toEncodingList :: [AvailSuppression] -> Encoding

Generic AvailSuppression

Defined in Amazonka.MediaTailor.Types.AvailSuppression

Associated Types

type Rep AvailSuppression :: Type -> Type

Methods

from :: AvailSuppression -> Rep AvailSuppression x

to :: Rep AvailSuppression x -> AvailSuppression

Read AvailSuppression

Defined in Amazonka.MediaTailor.Types.AvailSuppression

Methods

readsPrec :: Int -> ReadS AvailSuppression

readList :: ReadS [AvailSuppression]

readPrec :: ReadPrec AvailSuppression

readListPrec :: ReadPrec [AvailSuppression]

Show AvailSuppression

Defined in Amazonka.MediaTailor.Types.AvailSuppression

Methods

showsPrec :: Int -> AvailSuppression -> ShowS

show :: AvailSuppression -> String

showList :: [AvailSuppression] -> ShowS

NFData AvailSuppression

Defined in Amazonka.MediaTailor.Types.AvailSuppression

Methods

rnf :: AvailSuppression -> ()

Eq AvailSuppression

Defined in Amazonka.MediaTailor.Types.AvailSuppression

Methods

(==) :: AvailSuppression -> AvailSuppression -> Bool

(/=) :: AvailSuppression -> AvailSuppression -> Bool

Hashable AvailSuppression

Defined in Amazonka.MediaTailor.Types.AvailSuppression

Methods

hashWithSalt :: Int -> AvailSuppression -> Int

hash :: AvailSuppression -> Int

type Rep AvailSuppression

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

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)

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)

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.