Package software.amazon.awssdk.services.mediaconvert.model

Class M2tsSettings

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<M2tsSettings.Builder,​M2tsSettings>
    @Generated("software.amazon.awssdk:codegen")
public final class M2tsSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<M2tsSettings.Builder,​M2tsSettings>
    MPEG-2 TS container settings. These apply to outputs in a File output group when the output's container is MPEG-2 Transport Stream (M2TS). In these assets, data is organized by the program map table (PMT). Each transport stream program contains subsets of data, including audio, video, and metadata. Each of these subsets of data has a numerical label called a packet identifier (PID). Each transport stream program corresponds to one MediaConvert output. The PMT lists the types of data in a program along with their PID. Downstream systems and players use the program map table to look up the PID for each type of data it accesses and then uses the PIDs to locate specific data within the asset.
    See Also:
    Serialized Form

    • Method Detail

      • audioDuration

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

        If the service returns an enum value that is not available in the current SDK version, audioDuration will return M2tsAudioDuration.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. 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.
        See Also:
        M2tsAudioDuration

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

        If the service returns an enum value that is not available in the current SDK version, audioDuration will return M2tsAudioDuration.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. 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.
        See Also:
        M2tsAudioDuration

      • 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()
        Specify the packet identifiers (PIDs) for any elementary audio streams you include in this output. Specify multiple PIDs as a JSON array. Default is the range 482-492.

        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:
        Specify the packet identifiers (PIDs) for any elementary audio streams you include in this output. Specify multiple PIDs as a JSON array. Default is the range 482-492.

      • bitrate

        public final Integer bitrate()
        Specify the output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. Other common values are 3750000, 7500000, and 15000000.
        Returns:
        Specify the output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. Other common values are 3750000, 7500000, and 15000000.

      • bufferModel

        public final M2tsBufferModel bufferModel()
        Controls what buffer model to use for accurate interleaving. If set to MULTIPLEX, use multiplex buffer model. If set to NONE, this can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.

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

        Returns:
        Controls what buffer model to use for accurate interleaving. If set to MULTIPLEX, use multiplex buffer model. If set to NONE, this can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
        See Also:
        M2tsBufferModel

      • bufferModelAsString

        public final String bufferModelAsString()
        Controls what buffer model to use for accurate interleaving. If set to MULTIPLEX, use multiplex buffer model. If set to NONE, this can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.

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

        Returns:
        Controls what buffer model to use for accurate interleaving. If set to MULTIPLEX, use multiplex buffer model. If set to NONE, this can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
        See Also:
        M2tsBufferModel

      • dataPTSControl

        public final M2tsDataPtsControl 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 to allow all PTS values.

        If the service returns an enum value that is not available in the current SDK version, dataPTSControl will return M2tsDataPtsControl.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 to allow all PTS values.
        See Also:
        M2tsDataPtsControl

      • 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 to allow all PTS values.

        If the service returns an enum value that is not available in the current SDK version, dataPTSControl will return M2tsDataPtsControl.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 to allow all PTS values.
        See Also:
        M2tsDataPtsControl

      • dvbNitSettings

        public final DvbNitSettings dvbNitSettings()
        Use these settings to insert a DVB Network Information Table (NIT) in the transport stream of this output.
        Returns:
        Use these settings to insert a DVB Network Information Table (NIT) in the transport stream of this output.

      • dvbSdtSettings

        public final DvbSdtSettings dvbSdtSettings()
        Use these settings to insert a DVB Service Description Table (SDT) in the transport stream of this output.
        Returns:
        Use these settings to insert a DVB Service Description Table (SDT) in the transport stream of this output.

      • hasDvbSubPids

        public final boolean hasDvbSubPids()
        For responses, this returns true if the service returned a value for the DvbSubPids 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.

      • dvbSubPids

        public final List<Integer> dvbSubPids()
        Specify the packet identifiers (PIDs) for DVB subtitle data included in this output. Specify multiple PIDs as a JSON array. Default is the range 460-479.

        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 hasDvbSubPids() method.

        Returns:
        Specify the packet identifiers (PIDs) for DVB subtitle data included in this output. Specify multiple PIDs as a JSON array. Default is the range 460-479.

      • dvbTdtSettings

        public final DvbTdtSettings dvbTdtSettings()
        Use these settings to insert a DVB Time and Date Table (TDT) in the transport stream of this output.
        Returns:
        Use these settings to insert a DVB Time and Date Table (TDT) in the transport stream of this output.

      • dvbTeletextPid

        public final Integer dvbTeletextPid()
        Specify the packet identifier (PID) for DVB teletext data you include in this output. Default is 499.
        Returns:
        Specify the packet identifier (PID) for DVB teletext data you include in this output. Default is 499.

      • ebpAudioInterval

        public final M2tsEbpAudioInterval ebpAudioInterval()
        When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. When set to VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).

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

        Returns:
        When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. When set to VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).
        See Also:
        M2tsEbpAudioInterval

      • ebpAudioIntervalAsString

        public final String ebpAudioIntervalAsString()
        When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. When set to VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).

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

        Returns:
        When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. When set to VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).
        See Also:
        M2tsEbpAudioInterval

      • ebpPlacement

        public final M2tsEbpPlacement ebpPlacement()
        Selects which PIDs to place EBP markers on. They can either be placed only on the video PID, or on both the video PID and all audio PIDs. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).

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

        Returns:
        Selects which PIDs to place EBP markers on. They can either be placed only on the video PID, or on both the video PID and all audio PIDs. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).
        See Also:
        M2tsEbpPlacement

      • ebpPlacementAsString

        public final String ebpPlacementAsString()
        Selects which PIDs to place EBP markers on. They can either be placed only on the video PID, or on both the video PID and all audio PIDs. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).

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

        Returns:
        Selects which PIDs to place EBP markers on. They can either be placed only on the video PID, or on both the video PID and all audio PIDs. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).
        See Also:
        M2tsEbpPlacement

      • esRateInPesAsString

        public final String esRateInPesAsString()
        Controls whether to include the ES Rate field in the PES header.

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

        Returns:
        Controls whether to include the ES Rate field in the PES header.
        See Also:
        M2tsEsRateInPes

      • forceTsVideoEbpOrder

        public final M2tsForceTsVideoEbpOrder forceTsVideoEbpOrder()
        Keep the default value unless you know that your audio EBP markers are incorrectly appearing before your video EBP markers. To correct this problem, set this value to Force.

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

        Returns:
        Keep the default value unless you know that your audio EBP markers are incorrectly appearing before your video EBP markers. To correct this problem, set this value to Force.
        See Also:
        M2tsForceTsVideoEbpOrder

      • forceTsVideoEbpOrderAsString

        public final String forceTsVideoEbpOrderAsString()
        Keep the default value unless you know that your audio EBP markers are incorrectly appearing before your video EBP markers. To correct this problem, set this value to Force.

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

        Returns:
        Keep the default value unless you know that your audio EBP markers are incorrectly appearing before your video EBP markers. To correct this problem, set this value to Force.
        See Also:
        M2tsForceTsVideoEbpOrder

      • fragmentTime

        public final Double fragmentTime()
        The length, in seconds, of each fragment. Only used with EBP markers.
        Returns:
        The length, in seconds, of each fragment. Only used with EBP markers.

      • klvMetadata

        public final M2tsKlvMetadata klvMetadata()
        To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads KLV metadata present in your input and passes it through to the output transport stream. To exclude this KLV metadata: Set KLV metadata insertion to None or leave blank.

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

        Returns:
        To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads KLV metadata present in your input and passes it through to the output transport stream. To exclude this KLV metadata: Set KLV metadata insertion to None or leave blank.
        See Also:
        M2tsKlvMetadata

      • klvMetadataAsString

        public final String klvMetadataAsString()
        To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads KLV metadata present in your input and passes it through to the output transport stream. To exclude this KLV metadata: Set KLV metadata insertion to None or leave blank.

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

        Returns:
        To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads KLV metadata present in your input and passes it through to the output transport stream. To exclude this KLV metadata: Set KLV metadata insertion to None or leave blank.
        See Also:
        M2tsKlvMetadata

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

      • minEbpInterval

        public final Integer minEbpInterval()
        When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
        Returns:
        When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.

      • nielsenId3

        public final M2tsNielsenId3 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 M2tsNielsenId3.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:
        M2tsNielsenId3

      • 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 M2tsNielsenId3.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:
        M2tsNielsenId3

      • nullPacketBitrate

        public final Double nullPacketBitrate()
        Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
        Returns:
        Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.

      • 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 M2tsPcrControl pcrControl()
        When set to PCR_EVERY_PES_PACKET, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This 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 M2tsPcrControl.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 is effective only when the PCR PID is the same as the video or audio elementary stream.
        See Also:
        M2tsPcrControl

      • 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 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 M2tsPcrControl.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 is effective only when the PCR PID is the same as the video or audio elementary stream.
        See Also:
        M2tsPcrControl

      • pcrPid

        public final Integer pcrPid()
        Specify the packet identifier (PID) for the program clock reference (PCR) in this output. If you do not specify a value, the service will use the value for Video PID.
        Returns:
        Specify the packet identifier (PID) for the program clock reference (PCR) in this output. If you do not specify a value, the service will use the value for Video PID.

      • pmtInterval

        public final Integer pmtInterval()
        Specify the number of milliseconds between instances of the program map table (PMT) in the output transport stream.
        Returns:
        Specify the number of milliseconds between instances of the program map table (PMT) in the output transport stream.

      • pmtPid

        public final Integer pmtPid()
        Specify the packet identifier (PID) for the program map table (PMT) itself. Default is 480.
        Returns:
        Specify the packet identifier (PID) for the program map table (PMT) itself. Default is 480.

      • privateMetadataPid

        public final Integer privateMetadataPid()
        Specify the packet identifier (PID) of the private metadata stream. Default is 503.
        Returns:
        Specify the packet identifier (PID) of the private metadata stream. Default is 503.

      • programNumber

        public final Integer programNumber()
        Use Program number to specify the program number used in the program map table (PMT) for this output. Default is 1. Program numbers and program map tables are parts of MPEG-2 transport stream containers, used for organizing data.
        Returns:
        Use Program number to specify the program number used in the program map table (PMT) for this output. Default is 1. Program numbers and program map tables are parts of MPEG-2 transport stream containers, used for organizing data.

      • ptsOffset

        public final Integer ptsOffset()
        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.
        Returns:
        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.

      • ptsOffsetMode

        public final TsPtsOffset ptsOffsetMode()
        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.

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

        Returns:
        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.
        See Also:
        TsPtsOffset

      • ptsOffsetModeAsString

        public final String ptsOffsetModeAsString()
        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.

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

        Returns:
        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.
        See Also:
        TsPtsOffset

      • rateMode

        public final M2tsRateMode rateMode()
        When set to CBR, inserts null packets into transport stream to fill specified bitrate. When set to VBR, the bitrate setting acts as the maximum bitrate, but the output will not be padded up to that bitrate.

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

        Returns:
        When set to CBR, inserts null packets into transport stream to fill specified bitrate. When set to VBR, the bitrate setting acts as the maximum bitrate, but the output will not be padded up to that bitrate.
        See Also:
        M2tsRateMode

      • rateModeAsString

        public final String rateModeAsString()
        When set to CBR, inserts null packets into transport stream to fill specified bitrate. When set to VBR, the bitrate setting acts as the maximum bitrate, but the output will not be padded up to that bitrate.

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

        Returns:
        When set to CBR, inserts null packets into transport stream to fill specified bitrate. When set to VBR, the bitrate setting acts as the maximum bitrate, but the output will not be padded up to that bitrate.
        See Also:
        M2tsRateMode

      • scte35Esam

        public final M2tsScte35Esam scte35Esam()
        Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML.
        Returns:
        Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML.

      • scte35Pid

        public final Integer scte35Pid()
        Specify the packet identifier (PID) of the SCTE-35 stream in the transport stream.
        Returns:
        Specify the packet identifier (PID) of the SCTE-35 stream in the transport stream.

      • scte35Source

        public final M2tsScte35Source scte35Source()
        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. Also provide the ESAM XML as a string in the setting Signal processing notification XML. Also enable ESAM SCTE-35 (include the property scte35Esam).

        If the service returns an enum value that is not available in the current SDK version, scte35Source will return M2tsScte35Source.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 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. Also provide the ESAM XML as a string in the setting Signal processing notification XML. Also enable ESAM SCTE-35 (include the property scte35Esam).
        See Also:
        M2tsScte35Source

      • scte35SourceAsString

        public final String scte35SourceAsString()
        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. Also provide the ESAM XML as a string in the setting Signal processing notification XML. Also enable ESAM SCTE-35 (include the property scte35Esam).

        If the service returns an enum value that is not available in the current SDK version, scte35Source will return M2tsScte35Source.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 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. Also provide the ESAM XML as a string in the setting Signal processing notification XML. Also enable ESAM SCTE-35 (include the property scte35Esam).
        See Also:
        M2tsScte35Source

      • segmentationMarkers

        public final M2tsSegmentationMarkers segmentationMarkers()
        Inserts segmentation markers at each segmentation_time period. rai_segstart sets the Random Access Indicator bit in the adaptation field. rai_adapt sets the RAI bit and adds the current timecode in the private data bytes. psi_segstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebp_legacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.

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

        Returns:
        Inserts segmentation markers at each segmentation_time period. rai_segstart sets the Random Access Indicator bit in the adaptation field. rai_adapt sets the RAI bit and adds the current timecode in the private data bytes. psi_segstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebp_legacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
        See Also:
        M2tsSegmentationMarkers

      • segmentationMarkersAsString

        public final String segmentationMarkersAsString()
        Inserts segmentation markers at each segmentation_time period. rai_segstart sets the Random Access Indicator bit in the adaptation field. rai_adapt sets the RAI bit and adds the current timecode in the private data bytes. psi_segstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebp_legacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.

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

        Returns:
        Inserts segmentation markers at each segmentation_time period. rai_segstart sets the Random Access Indicator bit in the adaptation field. rai_adapt sets the RAI bit and adds the current timecode in the private data bytes. psi_segstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebp_legacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
        See Also:
        M2tsSegmentationMarkers

      • segmentationStyle

        public final M2tsSegmentationStyle segmentationStyle()
        The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "reset_cadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of of $segmentation_time seconds. When a segmentation style of "maintain_cadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentation_time seconds. Note that EBP lookahead is a slight exception to this rule.

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

        Returns:
        The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "reset_cadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of of $segmentation_time seconds. When a segmentation style of "maintain_cadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentation_time seconds. Note that EBP lookahead is a slight exception to this rule.
        See Also:
        M2tsSegmentationStyle

      • segmentationStyleAsString

        public final String segmentationStyleAsString()
        The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "reset_cadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of of $segmentation_time seconds. When a segmentation style of "maintain_cadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentation_time seconds. Note that EBP lookahead is a slight exception to this rule.

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

        Returns:
        The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "reset_cadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of of $segmentation_time seconds. When a segmentation style of "maintain_cadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentation_time seconds. Note that EBP lookahead is a slight exception to this rule.
        See Also:
        M2tsSegmentationStyle

      • segmentationTime

        public final Double segmentationTime()
        Specify the length, in seconds, of each segment. Required unless markers is set to _none_.
        Returns:
        Specify the length, in seconds, of each segment. Required unless markers is set to _none_.

      • 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()
        Specify the ID for the transport stream itself in the program map table for this output. Transport stream IDs and program map tables are parts of MPEG-2 transport stream containers, used for organizing data.
        Returns:
        Specify the ID for the transport stream itself in the program map table for this output. Transport stream IDs and program map tables are parts of MPEG-2 transport stream containers, used for organizing data.

      • videoPid

        public final Integer videoPid()
        Specify the packet identifier (PID) of the elementary video stream in the transport stream.
        Returns:
        Specify the packet identifier (PID) of the elementary video stream in the transport stream.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

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