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

Description

 
Synopsis

Documentation

data AdBreak Source #

Ad break configuration parameters.

See: newAdBreak smart constructor.

Constructors

AdBreak' 

Fields

  • messageType :: Maybe MessageType

    The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.

  • offsetMillis :: Maybe Integer

    How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.

  • slate :: Maybe SlateSource

    Ad break slate configuration.

  • spliceInsertMessage :: Maybe SpliceInsertMessage

    This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.

  • timeSignalMessage :: Maybe TimeSignalMessage

    Defines the SCTE-35 time_signal message inserted around the ad.

    Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.

    See section 9.7.4 of the 2022 SCTE-35 specification for more information.

Instances

Instances details
FromJSON AdBreak Source # 
Instance details

Defined in Amazonka.MediaTailor.Types.AdBreak

ToJSON AdBreak Source # 
Instance details

Defined in Amazonka.MediaTailor.Types.AdBreak

Generic AdBreak Source # 
Instance details

Defined in Amazonka.MediaTailor.Types.AdBreak

Associated Types

type Rep AdBreak :: Type -> Type #

Methods

from :: AdBreak -> Rep AdBreak x #

to :: Rep AdBreak x -> AdBreak #

Read AdBreak Source # 
Instance details

Defined in Amazonka.MediaTailor.Types.AdBreak

Show AdBreak Source # 
Instance details

Defined in Amazonka.MediaTailor.Types.AdBreak

NFData AdBreak Source # 
Instance details

Defined in Amazonka.MediaTailor.Types.AdBreak

Methods

rnf :: AdBreak -> () #

Eq AdBreak Source # 
Instance details

Defined in Amazonka.MediaTailor.Types.AdBreak

Methods

(==) :: AdBreak -> AdBreak -> Bool #

(/=) :: AdBreak -> AdBreak -> Bool #

Hashable AdBreak Source # 
Instance details

Defined in Amazonka.MediaTailor.Types.AdBreak

Methods

hashWithSalt :: Int -> AdBreak -> Int #

hash :: AdBreak -> Int #

type Rep AdBreak Source # 
Instance details

Defined in Amazonka.MediaTailor.Types.AdBreak

type Rep AdBreak = D1 ('MetaData "AdBreak" "Amazonka.MediaTailor.Types.AdBreak" "amazonka-mediatailor-2.0-6mxt6n51Pv3JbuBr2GKiO4" 'False) (C1 ('MetaCons "AdBreak'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "messageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageType)) :*: S1 ('MetaSel ('Just "offsetMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "slate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SlateSource)) :*: (S1 ('MetaSel ('Just "spliceInsertMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SpliceInsertMessage)) :*: S1 ('MetaSel ('Just "timeSignalMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeSignalMessage))))))

newAdBreak :: AdBreak Source #

Create a value of AdBreak 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:messageType:AdBreak', adBreak_messageType - The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.

$sel:offsetMillis:AdBreak', adBreak_offsetMillis - How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.

$sel:slate:AdBreak', adBreak_slate - Ad break slate configuration.

$sel:spliceInsertMessage:AdBreak', adBreak_spliceInsertMessage - This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.

$sel:timeSignalMessage:AdBreak', adBreak_timeSignalMessage - Defines the SCTE-35 time_signal message inserted around the ad.

Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.

See section 9.7.4 of the 2022 SCTE-35 specification for more information.

adBreak_messageType :: Lens' AdBreak (Maybe MessageType) Source #

The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.

adBreak_offsetMillis :: Lens' AdBreak (Maybe Integer) Source #

How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.

adBreak_slate :: Lens' AdBreak (Maybe SlateSource) Source #

Ad break slate configuration.

adBreak_spliceInsertMessage :: Lens' AdBreak (Maybe SpliceInsertMessage) Source #

This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.

adBreak_timeSignalMessage :: Lens' AdBreak (Maybe TimeSignalMessage) Source #

Defines the SCTE-35 time_signal message inserted around the ad.

Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.

See section 9.7.4 of the 2022 SCTE-35 specification for more information.