Skip to content

M3u8Settings

Source code in docs_src/capo_medialive/types/m3u8_settings.py
class M3u8Settings(TypedDict, closed=True):
    audio_frames_per_pes: NotRequired[
        "capo_medialive.types.__integer_min0.__integerMin0"
    ]
    """The number of audio frames to insert for each PES packet."""
    audio_pids: NotRequired["capo_medialive.types.__string.__string"]
    """Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values."""
    ecm_pid: NotRequired["capo_medialive.types.__string.__string"]
    """This parameter is unused and deprecated."""
    nielsen_id3_behavior: NotRequired[
        "capo_medialive.types.m3u8_nielsen_id3_behavior.M3u8NielsenId3Behavior"
    ]
    """If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output."""
    pat_interval: NotRequired[
        "capo_medialive.types.__integer_min0_max1000.__integerMin0Max1000"
    ]
    r"""The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file."""
    pcr_control: NotRequired["capo_medialive.types.m3u8_pcr_control.M3u8PcrControl"]
    """When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream."""
    pcr_period: NotRequired[
        "capo_medialive.types.__integer_min0_max500.__integerMin0Max500"
    ]
    """Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream."""
    pcr_pid: NotRequired["capo_medialive.types.__string.__string"]
    """Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value."""
    pmt_interval: NotRequired[
        "capo_medialive.types.__integer_min0_max1000.__integerMin0Max1000"
    ]
    r"""The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file."""
    pmt_pid: NotRequired["capo_medialive.types.__string.__string"]
    """Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value."""
    program_num: NotRequired[
        "capo_medialive.types.__integer_min0_max65535.__integerMin0Max65535"
    ]
    """The value of the program number field in the Program Map Table."""
    scte35_behavior: NotRequired[
        "capo_medialive.types.m3u8_scte35_behavior.M3u8Scte35Behavior"
    ]
    """If set to passthrough, passes any SCTE-35 signals from the input source to this output."""
    scte35_pid: NotRequired["capo_medialive.types.__string.__string"]
    """Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value."""
    timed_metadata_behavior: NotRequired[
        "capo_medialive.types.m3u8_timed_metadata_behavior.M3u8TimedMetadataBehavior"
    ]
    """Set to PASSTHROUGH to enable ID3 metadata insertion. To include metadata, you configure other parameters in the output group or individual outputs, or you add an ID3 action to the channel schedule."""
    timed_metadata_pid: NotRequired["capo_medialive.types.__string.__string"]
    """Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."""
    transport_stream_id: NotRequired[
        "capo_medialive.types.__integer_min0_max65535.__integerMin0Max65535"
    ]
    """The value of the transport stream ID field in the Program Map Table."""
    video_pid: NotRequired["capo_medialive.types.__string.__string"]
    """Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value."""
    klv_behavior: NotRequired["capo_medialive.types.m3u8_klv_behavior.M3u8KlvBehavior"]
    """If set to passthrough, passes any KLV data from the input source to this output."""
    klv_data_pids: NotRequired["capo_medialive.types.__string.__string"]
    """Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6)."""

audio_frames_per_pes instance-attribute

audio_frames_per_pes: NotRequired[__integerMin0]

The number of audio frames to insert for each PES packet.

audio_pids instance-attribute

audio_pids: NotRequired[__string]

Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.

ecm_pid instance-attribute

ecm_pid: NotRequired[__string]

This parameter is unused and deprecated.

klv_behavior instance-attribute

klv_behavior: NotRequired[M3u8KlvBehavior]

If set to passthrough, passes any KLV data from the input source to this output.

klv_data_pids instance-attribute

klv_data_pids: NotRequired[__string]

Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).

nielsen_id3_behavior instance-attribute

nielsen_id3_behavior: NotRequired[M3u8NielsenId3Behavior]

If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.

pat_interval instance-attribute

pat_interval: NotRequired[__integerMin0Max1000]

The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.

pcr_control instance-attribute

pcr_control: NotRequired[M3u8PcrControl]

When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.

pcr_period instance-attribute

pcr_period: NotRequired[__integerMin0Max500]

Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.

pcr_pid instance-attribute

pcr_pid: NotRequired[__string]

Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.

pmt_interval instance-attribute

pmt_interval: NotRequired[__integerMin0Max1000]

The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.

pmt_pid instance-attribute

pmt_pid: NotRequired[__string]

Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.

program_num instance-attribute

program_num: NotRequired[__integerMin0Max65535]

The value of the program number field in the Program Map Table.

scte35_behavior instance-attribute

scte35_behavior: NotRequired[M3u8Scte35Behavior]

If set to passthrough, passes any SCTE-35 signals from the input source to this output.

scte35_pid instance-attribute

scte35_pid: NotRequired[__string]

Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.

timed_metadata_behavior instance-attribute

timed_metadata_behavior: NotRequired[M3u8TimedMetadataBehavior]

Set to PASSTHROUGH to enable ID3 metadata insertion. To include metadata, you configure other parameters in the output group or individual outputs, or you add an ID3 action to the channel schedule.

timed_metadata_pid instance-attribute

timed_metadata_pid: NotRequired[__string]

Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

transport_stream_id instance-attribute

transport_stream_id: NotRequired[__integerMin0Max65535]

The value of the transport stream ID field in the Program Map Table.

video_pid instance-attribute

video_pid: NotRequired[__string]

Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.