Documentation

Settings information for the .m3u8 container

See: newM3u8Settings smart constructor.

Create a value of M3u8Settings 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:audioFramesPerPes:M3u8Settings', m3u8Settings_audioFramesPerPes - The number of audio frames to insert for each PES packet.

$sel:audioPids:M3u8Settings', m3u8Settings_audioPids - 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.

$sel:ecmPid:M3u8Settings', m3u8Settings_ecmPid - This parameter is unused and deprecated.

$sel:nielsenId3Behavior:M3u8Settings', m3u8Settings_nielsenId3Behavior - 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.

$sel:patInterval:M3u8Settings', m3u8Settings_patInterval - 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.

$sel:pcrControl:M3u8Settings', m3u8Settings_pcrControl - 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.

$sel:pcrPeriod:M3u8Settings', m3u8Settings_pcrPeriod - Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.

$sel:pcrPid:M3u8Settings', m3u8Settings_pcrPid - 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.

$sel:pmtInterval:M3u8Settings', m3u8Settings_pmtInterval - 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.

$sel:pmtPid:M3u8Settings', m3u8Settings_pmtPid - Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.

$sel:programNum:M3u8Settings', m3u8Settings_programNum - The value of the program number field in the Program Map Table.

$sel:scte35Behavior:M3u8Settings', m3u8Settings_scte35Behavior - If set to passthrough, passes any SCTE-35 signals from the input source to this output.

$sel:scte35Pid:M3u8Settings', m3u8Settings_scte35Pid - Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.

$sel:timedMetadataBehavior:M3u8Settings', m3u8Settings_timedMetadataBehavior - When set to passthrough, timed metadata is passed through from input to output.

$sel:timedMetadataPid:M3u8Settings', m3u8Settings_timedMetadataPid - 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).

$sel:transportStreamId:M3u8Settings', m3u8Settings_transportStreamId - The value of the transport stream ID field in the Program Map Table.

$sel:videoPid:M3u8Settings', m3u8Settings_videoPid - Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.

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

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.

This parameter is unused and deprecated.

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.

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.

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.

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

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.

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.

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

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

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

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

When set to passthrough, timed metadata is passed through from input to output.

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

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

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