Skip to content

Segment

Source code in docs_src/capo_mediapackagev2/types/segment.py
class Segment(TypedDict, closed=True):
    segment_duration_seconds: NotRequired["int"]
    """<p>The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.</p>"""
    segment_name: NotRequired["str"]
    """<p>The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.</p>"""
    ts_use_audio_rendition_group: NotRequired["bool"]
    """<p>When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.</p>"""
    include_iframe_only_streams: NotRequired["bool"]
    """<p>When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.</p>"""
    ts_include_dvb_subtitles: NotRequired["bool"]
    """<p>By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.</p>"""
    scte: NotRequired["capo_mediapackagev2.types.scte.Scte"]
    """<p>The SCTE configuration options in the segment settings.</p>"""
    encryption: NotRequired["capo_mediapackagev2.types.encryption.Encryption"]
    output_timestamp_mode: NotRequired[
        "capo_mediapackagev2.types.output_timestamp_mode.OutputTimestampMode"
    ]
    """<p>The output timestamp mode for the origin endpoint's segments. This setting is only configurable on channels with <code>OutputLockingMode</code> set to <code>NON_EPOCH_LOCKED</code>. This value is immutable after endpoint creation. If you don't specify a value, the default is <code>PASSTHROUGH</code>.</p> <p>The allowed values are:</p> <ul> <li> <p> <code>PASSTHROUGH</code> - Output PTS (Presentation Timestamp) values pass through unchanged from the input.</p> </li> <li> <p> <code>REBASED_TO_CHANNEL_START</code> - Output PTS is rebased relative to the channel start time.</p> </li> </ul>"""

encryption instance-attribute

encryption: NotRequired[Encryption]

include_iframe_only_streams instance-attribute

include_iframe_only_streams: NotRequired[bool]

When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.

output_timestamp_mode instance-attribute

output_timestamp_mode: NotRequired[OutputTimestampMode]

The output timestamp mode for the origin endpoint's segments. This setting is only configurable on channels with OutputLockingMode set to NON_EPOCH_LOCKED. This value is immutable after endpoint creation. If you don't specify a value, the default is PASSTHROUGH.

The allowed values are:

  • PASSTHROUGH - Output PTS (Presentation Timestamp) values pass through unchanged from the input.

  • REBASED_TO_CHANNEL_START - Output PTS is rebased relative to the channel start time.

scte instance-attribute

scte: NotRequired[Scte]

The SCTE configuration options in the segment settings.

segment_duration_seconds instance-attribute

segment_duration_seconds: NotRequired[int]

The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.

segment_name instance-attribute

segment_name: NotRequired[str]

The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.

ts_include_dvb_subtitles instance-attribute

ts_include_dvb_subtitles: NotRequired[bool]

By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.

ts_use_audio_rendition_group instance-attribute

ts_use_audio_rendition_group: NotRequired[bool]

When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.