Struct aws_sdk_mediaconvert::types::M3u8Settings

#[non_exhaustive]
pub struct M3u8Settings {

    pub audio_duration: Option<M3u8AudioDuration>,
    pub audio_frames_per_pes: Option<i32>,
    pub audio_pids: Option<Vec<i32>>,
    pub data_pts_control: Option<M3u8DataPtsControl>,
    pub max_pcr_interval: Option<i32>,
    pub nielsen_id3: Option<M3u8NielsenId3>,
    pub pat_interval: Option<i32>,
    pub pcr_control: Option<M3u8PcrControl>,
    pub pcr_pid: Option<i32>,
    pub pmt_interval: Option<i32>,
    pub pmt_pid: Option<i32>,
    pub private_metadata_pid: Option<i32>,
    pub program_number: Option<i32>,
    pub pts_offset: Option<i32>,
    pub pts_offset_mode: Option<TsPtsOffset>,
    pub scte35_pid: Option<i32>,
    pub scte35_source: Option<M3u8Scte35Source>,
    pub timed_metadata: Option<TimedMetadata>,
    pub timed_metadata_pid: Option<i32>,
    pub transport_stream_id: Option<i32>,
    pub video_pid: Option<i32>,
}

These settings relate to the MPEG-2 transport stream (MPEG2-TS) container for the MPEG2-TS segments in your HLS outputs.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

audio_duration: Option<M3u8AudioDuration>

Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between video and audio. For this situation, choose Match video duration. In all other cases, keep the default value, Default codec duration. When you choose Match video duration, MediaConvert pads the output audio streams with silence or trims them to ensure that the total duration of each audio stream is at least as long as the total duration of the video stream. After padding or trimming, the audio stream duration is no more than one frame longer than the video stream. MediaConvert applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies between audio and video duration will depend on your output audio codec.

audio_frames_per_pes: Option<i32>

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

audio_pids: Option<Vec<i32>>

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.

data_pts_control: Option<M3u8DataPtsControl>

If you select ALIGN_TO_VIDEO, MediaConvert writes captions and data packets with Presentation Timestamp (PTS) values greater than or equal to the first video packet PTS (MediaConvert drops captions and data packets with lesser PTS values). Keep the default value AUTO to allow all PTS values.

max_pcr_interval: Option<i32>

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

nielsen_id3: Option<M3u8NielsenId3>

If INSERT, 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: Option<i32>

The number of milliseconds between instances of this table in the output transport stream.

pcr_control: Option<M3u8PcrControl>

When set to PCR_EVERY_PES_PACKET 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_pid: Option<i32>

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.

pmt_interval: Option<i32>

The number of milliseconds between instances of this table in the output transport stream.

pmt_pid: Option<i32>

Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream.

private_metadata_pid: Option<i32>

Packet Identifier (PID) of the private metadata stream in the transport stream.

program_number: Option<i32>

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

pts_offset: Option<i32>

Manually specify the initial PTS offset, in seconds, when you set PTS offset to Seconds. Enter an integer from 0 to 3600. Leave blank to keep the default value 2.

pts_offset_mode: Option<TsPtsOffset>

Specify the initial presentation timestamp (PTS) offset for your transport stream output. To let MediaConvert automatically determine the initial PTS offset: Keep the default value, Auto. We recommend that you choose Auto for the widest player compatibility. The initial PTS will be at least two seconds and vary depending on your output’s bitrate, HRD buffer size and HRD buffer initial fill percentage. To manually specify an initial PTS offset: Choose Seconds. Then specify the number of seconds with PTS offset.

scte35_pid: Option<i32>

Packet Identifier (PID) of the SCTE-35 stream in the transport stream.

scte35_source: Option<M3u8Scte35Source>

For SCTE-35 markers from your input– Choose Passthrough if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None if you don’t want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document– Choose None if you don’t want manifest conditioning. Choose Passthrough and choose Ad markers if you do want manifest conditioning. In both cases, also provide the ESAM XML as a string in the setting Signal processing notification XML.

timed_metadata: Option<TimedMetadata>

Set ID3 metadata to Passthrough to include ID3 metadata in this output. This includes ID3 metadata from the following features: ID3 timestamp period, and Custom ID3 metadata inserter. To exclude this ID3 metadata in this output: set ID3 metadata to None or leave blank.

timed_metadata_pid: Option<i32>

Packet Identifier (PID) of the ID3 metadata stream in the transport stream.

transport_stream_id: Option<i32>

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

video_pid: Option<i32>

Packet Identifier (PID) of the elementary video stream in the transport stream.

Implementations

impl M3u8Settings

pub fn audio_duration(&self) -> Option<&M3u8AudioDuration>

Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between video and audio. For this situation, choose Match video duration. In all other cases, keep the default value, Default codec duration. When you choose Match video duration, MediaConvert pads the output audio streams with silence or trims them to ensure that the total duration of each audio stream is at least as long as the total duration of the video stream. After padding or trimming, the audio stream duration is no more than one frame longer than the video stream. MediaConvert applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies between audio and video duration will depend on your output audio codec.

pub fn audio_frames_per_pes(&self) -> Option<i32>

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

pub fn audio_pids(&self) -> &[i32]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .audio_pids.is_none().

pub fn data_pts_control(&self) -> Option<&M3u8DataPtsControl>

If you select ALIGN_TO_VIDEO, MediaConvert writes captions and data packets with Presentation Timestamp (PTS) values greater than or equal to the first video packet PTS (MediaConvert drops captions and data packets with lesser PTS values). Keep the default value AUTO to allow all PTS values.

pub fn max_pcr_interval(&self) -> Option<i32>

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

pub fn nielsen_id3(&self) -> Option<&M3u8NielsenId3>

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

pub fn pat_interval(&self) -> Option<i32>

The number of milliseconds between instances of this table in the output transport stream.

pub fn pcr_control(&self) -> Option<&M3u8PcrControl>

When set to PCR_EVERY_PES_PACKET 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.

pub fn pcr_pid(&self) -> Option<i32>

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.

pub fn pmt_interval(&self) -> Option<i32>

The number of milliseconds between instances of this table in the output transport stream.

pub fn pmt_pid(&self) -> Option<i32>

Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream.

pub fn private_metadata_pid(&self) -> Option<i32>

Packet Identifier (PID) of the private metadata stream in the transport stream.

pub fn program_number(&self) -> Option<i32>

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

pub fn pts_offset(&self) -> Option<i32>

Manually specify the initial PTS offset, in seconds, when you set PTS offset to Seconds. Enter an integer from 0 to 3600. Leave blank to keep the default value 2.

pub fn pts_offset_mode(&self) -> Option<&TsPtsOffset>

Specify the initial presentation timestamp (PTS) offset for your transport stream output. To let MediaConvert automatically determine the initial PTS offset: Keep the default value, Auto. We recommend that you choose Auto for the widest player compatibility. The initial PTS will be at least two seconds and vary depending on your output’s bitrate, HRD buffer size and HRD buffer initial fill percentage. To manually specify an initial PTS offset: Choose Seconds. Then specify the number of seconds with PTS offset.

pub fn scte35_pid(&self) -> Option<i32>

Packet Identifier (PID) of the SCTE-35 stream in the transport stream.

pub fn scte35_source(&self) -> Option<&M3u8Scte35Source>

For SCTE-35 markers from your input– Choose Passthrough if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None if you don’t want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document– Choose None if you don’t want manifest conditioning. Choose Passthrough and choose Ad markers if you do want manifest conditioning. In both cases, also provide the ESAM XML as a string in the setting Signal processing notification XML.

pub fn timed_metadata(&self) -> Option<&TimedMetadata>

Set ID3 metadata to Passthrough to include ID3 metadata in this output. This includes ID3 metadata from the following features: ID3 timestamp period, and Custom ID3 metadata inserter. To exclude this ID3 metadata in this output: set ID3 metadata to None or leave blank.

pub fn timed_metadata_pid(&self) -> Option<i32>

Packet Identifier (PID) of the ID3 metadata stream in the transport stream.

pub fn transport_stream_id(&self) -> Option<i32>

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

pub fn video_pid(&self) -> Option<i32>

Packet Identifier (PID) of the elementary video stream in the transport stream.

impl M3u8Settings

pub fn builder() -> M3u8SettingsBuilder

Creates a new builder-style object to manufacture M3u8Settings.

Trait Implementations

impl Clone for M3u8Settings

fn clone(&self) -> M3u8Settings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for M3u8Settings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for M3u8Settings

fn eq(&self, other: &M3u8Settings) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for M3u8Settings