Skip to content

AdBreak

Source code in docs_src/capo_mediatailor/types/ad_break.py
class AdBreak(TypedDict, closed=True):
    message_type: NotRequired["capo_mediatailor.types.message_type.MessageType"]
    """<p>The SCTE-35 ad insertion type. Accepted value: <code>SPLICE_INSERT</code>, <code>TIME_SIGNAL</code>.</p>"""
    offset_millis: "capo_mediatailor.types.__long.__long"
    """<p>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.</p>"""
    slate: NotRequired["capo_mediatailor.types.slate_source.SlateSource"]
    """<p>Ad break slate configuration.</p>"""
    splice_insert_message: NotRequired[
        "capo_mediatailor.types.splice_insert_message.SpliceInsertMessage"
    ]
    """<p>This defines the SCTE-35 <code>splice_insert()</code> message inserted around the ad. For information about using <code>splice_insert()</code>, see the SCTE-35 specficiaiton, section 9.7.3.1.</p>"""
    time_signal_message: NotRequired[
        "capo_mediatailor.types.time_signal_message.TimeSignalMessage"
    ]
    """<p>Defines the SCTE-35 <code>time_signal</code> message inserted around the ad.</p> <p>Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a <code>splice_insert</code> SCTE-35 message to the ad break. This message provides basic metadata about the ad break.</p> <p>See section 9.7.4 of the 2022 SCTE-35 specification for more information.</p>"""
    ad_break_metadata: NotRequired[
        "capo_mediatailor.types.ad_break_metadata_list.AdBreakMetadataList"
    ]
    """<p>Defines a list of key/value pairs that MediaTailor generates within the <code>EXT-X-ASSET</code>tag for <code>SCTE35_ENHANCED</code> output.</p>"""

ad_break_metadata instance-attribute

ad_break_metadata: NotRequired[AdBreakMetadataList]

Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.

message_type instance-attribute

message_type: NotRequired[MessageType]

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

offset_millis instance-attribute

offset_millis: __long

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 instance-attribute

slate: NotRequired[SlateSource]

Ad break slate configuration.

splice_insert_message instance-attribute

splice_insert_message: NotRequired[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.

time_signal_message instance-attribute

time_signal_message: NotRequired[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.