software.amazon.awssdk.services.mediaconvert.model

Class M3u8Settings

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.M3u8Settings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<M3u8Settings.Builder,M3u8Settings>

@Generated(value="software.amazon.awssdk:codegen")
public final class M3u8Settings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<M3u8Settings.Builder,M3u8Settings>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	M3u8Settings.Builder

Method Summary

Modifier and Type	Method and Description
M3u8AudioDuration	audioDuration() 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.
String	audioDurationAsString() 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.
Integer	audioFramesPerPes() The number of audio frames to insert for each PES packet.
List<Integer>	audioPids() Packet Identifier (PID) of the elementary audio stream(s) in the transport stream.
static M3u8Settings.Builder	builder()
M3u8DataPtsControl	dataPTSControl() 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).
String	dataPTSControlAsString() 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).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAudioPids() For responses, this returns true if the service returned a value for the AudioPids property.
int	hashCode()
Integer	maxPcrInterval() Specify the maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport stream.
M3u8NielsenId3	nielsenId3() 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.
String	nielsenId3AsString() 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.
Integer	patInterval() The number of milliseconds between instances of this table in the output transport stream.
M3u8PcrControl	pcrControl() When set to PCR_EVERY_PES_PACKET a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header.
String	pcrControlAsString() When set to PCR_EVERY_PES_PACKET a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header.
Integer	pcrPid() Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream.
Integer	pmtInterval() The number of milliseconds between instances of this table in the output transport stream.
Integer	pmtPid() Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream.
Integer	privateMetadataPid() Packet Identifier (PID) of the private metadata stream in the transport stream.
Integer	programNumber() The value of the program number field in the Program Map Table.
Integer	scte35Pid() Packet Identifier (PID) of the SCTE-35 stream in the transport stream.
M3u8Scte35Source	scte35Source() For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output.
String	scte35SourceAsString() For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output.
List<SdkField<?>>	sdkFields()
static Class<? extends M3u8Settings.Builder>	serializableBuilderClass()
TimedMetadata	timedMetadata() Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH) to include ID3 metadata in this output.
String	timedMetadataAsString() Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH) to include ID3 metadata in this output.
Integer	timedMetadataPid() Packet Identifier (PID) of the ID3 metadata stream in the transport stream.
M3u8Settings.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	transportStreamId() The value of the transport stream ID field in the Program Map Table.
Integer	videoPid() Packet Identifier (PID) of the elementary video stream in the transport stream.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

audioDuration

public final M3u8AudioDuration audioDuration()

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 (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (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.

If the service returns an enum value that is not available in the current SDK version, audioDuration will return M3u8AudioDuration.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from audioDurationAsString().

Returns:

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 (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (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.

See Also:

M3u8AudioDuration

audioDurationAsString

public final String audioDurationAsString()

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 (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (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.

If the service returns an enum value that is not available in the current SDK version, audioDuration will return M3u8AudioDuration.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from audioDurationAsString().

Returns:

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 (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (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.

See Also:

M3u8AudioDuration

audioFramesPerPes

public final Integer audioFramesPerPes()

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

Returns:

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

hasAudioPids

public final boolean hasAudioPids()

For responses, this returns true if the service returned a value for the AudioPids property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

audioPids

public final List<Integer> 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAudioPids() method.

Returns:

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.

dataPTSControl

public final M3u8DataPtsControl dataPTSControl()

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.

If the service returns an enum value that is not available in the current SDK version, dataPTSControl will return M3u8DataPtsControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataPTSControlAsString().

Returns:

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.

See Also:

M3u8DataPtsControl

dataPTSControlAsString

public final String dataPTSControlAsString()

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.

If the service returns an enum value that is not available in the current SDK version, dataPTSControl will return M3u8DataPtsControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataPTSControlAsString().

Returns:

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.

See Also:

M3u8DataPtsControl

maxPcrInterval

public final Integer maxPcrInterval()

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

Returns:

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

nielsenId3

public final M3u8NielsenId3 nielsenId3()

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.

If the service returns an enum value that is not available in the current SDK version, nielsenId3 will return M3u8NielsenId3.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nielsenId3AsString().

Returns:

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.

See Also:

M3u8NielsenId3

nielsenId3AsString

public final String nielsenId3AsString()

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.

If the service returns an enum value that is not available in the current SDK version, nielsenId3 will return M3u8NielsenId3.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nielsenId3AsString().

Returns:

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.

See Also:

M3u8NielsenId3

patInterval

public final Integer patInterval()

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

Returns:

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

pcrControl

public final M3u8PcrControl pcrControl()

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.

If the service returns an enum value that is not available in the current SDK version, pcrControl will return M3u8PcrControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pcrControlAsString().

Returns:

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.

See Also:

M3u8PcrControl

pcrControlAsString

public final String pcrControlAsString()

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.

If the service returns an enum value that is not available in the current SDK version, pcrControl will return M3u8PcrControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pcrControlAsString().

Returns:

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.

See Also:

M3u8PcrControl

pcrPid

public final Integer 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.

Returns:

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.

pmtInterval

public final Integer pmtInterval()

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

Returns:

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

pmtPid

public final Integer pmtPid()

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

Returns:

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

privateMetadataPid

public final Integer privateMetadataPid()

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

Returns:

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

programNumber

public final Integer programNumber()

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

Returns:

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

scte35Pid

public final Integer scte35Pid()

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

Returns:

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

scte35Source

public final M3u8Scte35Source scte35Source()

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

If the service returns an enum value that is not available in the current SDK version, scte35Source will return M3u8Scte35Source.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scte35SourceAsString().

Returns:

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

See Also:

M3u8Scte35Source

scte35SourceAsString

public final String scte35SourceAsString()

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

If the service returns an enum value that is not available in the current SDK version, scte35Source will return M3u8Scte35Source.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scte35SourceAsString().

Returns:

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

See Also:

M3u8Scte35Source

timedMetadata

public final TimedMetadata timedMetadata()

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

If the service returns an enum value that is not available in the current SDK version, timedMetadata will return TimedMetadata.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timedMetadataAsString().

Returns:

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

See Also:

TimedMetadata

timedMetadataAsString

public final String timedMetadataAsString()

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

If the service returns an enum value that is not available in the current SDK version, timedMetadata will return TimedMetadata.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timedMetadataAsString().

Returns:

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

See Also:

TimedMetadata

timedMetadataPid

public final Integer timedMetadataPid()

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

Returns:

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

transportStreamId

public final Integer transportStreamId()

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

Returns:

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

videoPid

public final Integer videoPid()

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

Returns:

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

toBuilder

public M3u8Settings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<M3u8Settings.Builder,M3u8Settings>

builder

public static M3u8Settings.Builder builder()

serializableBuilderClass

public static Class<? extends M3u8Settings.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo