Package software.amazon.awssdk.services.medialive.model

Class M2tsSettings

java.lang.Object
software.amazon.awssdk.services.medialive.model.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>
M2ts Settings
See Also:

  • Method Details

    • absentInputAudioBehavior

      public final M2tsAbsentInputAudioBehavior absentInputAudioBehavior()
      When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.

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

      Returns:
      When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
      See Also:

    • absentInputAudioBehaviorAsString

      public final String absentInputAudioBehaviorAsString()
      When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.

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

      Returns:
      When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
      See Also:

    • arib

      public final M2tsArib arib()
      When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.

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

      Returns:
      When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
      See Also:

    • aribAsString

      public final String aribAsString()
      When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.

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

      Returns:
      When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
      See Also:

    • aribCaptionsPid

      public final String aribCaptionsPid()
      Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
      Returns:
      Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

    • aribCaptionsPidControl

      public final M2tsAribCaptionsPidControl aribCaptionsPidControl()
      If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.

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

      Returns:
      If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
      See Also:

    • aribCaptionsPidControlAsString

      public final String aribCaptionsPidControlAsString()
      If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.

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

      Returns:
      If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
      See Also:

    • audioBufferModel

      public final M2tsAudioBufferModel audioBufferModel()
      When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.

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

      Returns:
      When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
      See Also:

    • audioBufferModelAsString

      public final String audioBufferModelAsString()
      When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.

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

      Returns:
      When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
      See Also:

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

    • audioPids

      public final String 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. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
      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. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).

    • audioStreamType

      public final M2tsAudioStreamType audioStreamType()
      When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.

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

      Returns:
      When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
      See Also:

    • audioStreamTypeAsString

      public final String audioStreamTypeAsString()
      When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.

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

      Returns:
      When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
      See Also:

    • bitrate

      public final Integer bitrate()
      The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
      Returns:
      The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.

    • bufferModel

      public final M2tsBufferModel bufferModel()
      Controls the timing accuracy for output network traffic. Leave as MULTIPLEX to ensure accurate network packet timing. Or set to NONE, which might result in lower latency but will result in more variability in output network packet timing. This variability might cause interruptions, jitter, or bursty behavior in your playback or receiving devices.

      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 the timing accuracy for output network traffic. Leave as MULTIPLEX to ensure accurate network packet timing. Or set to NONE, which might result in lower latency but will result in more variability in output network packet timing. This variability might cause interruptions, jitter, or bursty behavior in your playback or receiving devices.
      See Also:

    • bufferModelAsString

      public final String bufferModelAsString()
      Controls the timing accuracy for output network traffic. Leave as MULTIPLEX to ensure accurate network packet timing. Or set to NONE, which might result in lower latency but will result in more variability in output network packet timing. This variability might cause interruptions, jitter, or bursty behavior in your playback or receiving devices.

      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 the timing accuracy for output network traffic. Leave as MULTIPLEX to ensure accurate network packet timing. Or set to NONE, which might result in lower latency but will result in more variability in output network packet timing. This variability might cause interruptions, jitter, or bursty behavior in your playback or receiving devices.
      See Also:

    • ccDescriptor

      public final M2tsCcDescriptor ccDescriptor()
      When set to enabled, generates captionServiceDescriptor in PMT.

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

      Returns:
      When set to enabled, generates captionServiceDescriptor in PMT.
      See Also:

    • ccDescriptorAsString

      public final String ccDescriptorAsString()
      When set to enabled, generates captionServiceDescriptor in PMT.

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

      Returns:
      When set to enabled, generates captionServiceDescriptor in PMT.
      See Also:

    • dvbNitSettings

      public final DvbNitSettings dvbNitSettings()
      Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
      Returns:
      Inserts DVB Network Information Table (NIT) at the specified table repetition interval.

    • dvbSdtSettings

      public final DvbSdtSettings dvbSdtSettings()
      Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
      Returns:
      Inserts DVB Service Description Table (SDT) at the specified table repetition interval.

    • dvbSubPids

      public final String dvbSubPids()
      Packet Identifier (PID) for input source DVB Subtitle 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).
      Returns:
      Packet Identifier (PID) for input source DVB Subtitle 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).

    • dvbTdtSettings

      public final DvbTdtSettings dvbTdtSettings()
      Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
      Returns:
      Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.

    • dvbTeletextPid

      public final String dvbTeletextPid()
      Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
      Returns:
      Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

    • ebif

      public final M2tsEbifControl ebif()
      If set to passthrough, passes any EBIF data from the input source to this output.

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

      Returns:
      If set to passthrough, passes any EBIF data from the input source to this output.
      See Also:

    • ebifAsString

      public final String ebifAsString()
      If set to passthrough, passes any EBIF data from the input source to this output.

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

      Returns:
      If set to passthrough, passes any EBIF data from the input source to this output.
      See Also:

    • ebpAudioInterval

      public final M2tsAudioInterval ebpAudioInterval()
      When videoAndFixedIntervals is selected, 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. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.

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

      Returns:
      When videoAndFixedIntervals is selected, 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. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
      See Also:

    • ebpAudioIntervalAsString

      public final String ebpAudioIntervalAsString()
      When videoAndFixedIntervals is selected, 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. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.

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

      Returns:
      When videoAndFixedIntervals is selected, 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. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
      See Also:

    • ebpLookaheadMs

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

    • ebpPlacement

      public final M2tsEbpPlacement ebpPlacement()
      Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.

      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:
      Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
      See Also:

    • ebpPlacementAsString

      public final String ebpPlacementAsString()
      Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.

      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:
      Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
      See Also:

    • ecmPid

      public final String ecmPid()
      This field is unused and deprecated.
      Returns:
      This field is unused and deprecated.

    • esRateInPes

      public final M2tsEsRateInPes esRateInPes()
      Include or exclude 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:
      Include or exclude the ES Rate field in the PES header.
      See Also:

    • esRateInPesAsString

      public final String esRateInPesAsString()
      Include or exclude 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:
      Include or exclude the ES Rate field in the PES header.
      See Also:

    • etvPlatformPid

      public final String etvPlatformPid()
      Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
      Returns:
      Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

    • etvSignalPid

      public final String etvSignalPid()
      Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
      Returns:
      Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

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

    • klv

      public final M2tsKlv klv()
      If set to passthrough, passes any KLV data from the input source to this output.

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

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

    • klvAsString

      public final String klvAsString()
      If set to passthrough, passes any KLV data from the input source to this output.

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

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

    • klvDataPids

      public final String klvDataPids()
      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).
      Returns:
      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).

    • nielsenId3Behavior

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

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

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

    • nielsenId3BehaviorAsString

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

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

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

    • 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. Valid values are 0, 10..1000.
      Returns:
      The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.

    • pcrControl

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

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

    • pcrControlAsString

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

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

    • pcrPeriod

      public final Integer pcrPeriod()
      Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
      Returns:
      Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.

    • pcrPid

      public final String 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. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
      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. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

    • pmtInterval

      public final Integer pmtInterval()
      The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
      Returns:
      The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.

    • pmtPid

      public final String pmtPid()
      Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
      Returns:
      Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

    • programNum

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

    • rateMode

      public final M2tsRateMode rateMode()
      When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.

      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 vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
      See Also:

    • rateModeAsString

      public final String rateModeAsString()
      When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.

      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 vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
      See Also:

    • scte27Pids

      public final String scte27Pids()
      Packet Identifier (PID) for input source SCTE-27 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).
      Returns:
      Packet Identifier (PID) for input source SCTE-27 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).

    • scte35Control

      public final M2tsScte35Control scte35Control()
      Optionally pass SCTE-35 signals from the input source to this output.

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

      Returns:
      Optionally pass SCTE-35 signals from the input source to this output.
      See Also:

    • scte35ControlAsString

      public final String scte35ControlAsString()
      Optionally pass SCTE-35 signals from the input source to this output.

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

      Returns:
      Optionally pass SCTE-35 signals from the input source to this output.
      See Also:

    • scte35Pid

      public final String scte35Pid()
      Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
      Returns:
      Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

    • segmentationMarkers

      public final M2tsSegmentationMarkers segmentationMarkers()
      Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart 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. ebpLegacy 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 segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart 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. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
      See Also:

    • segmentationMarkersAsString

      public final String segmentationMarkersAsString()
      Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart 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. ebpLegacy 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 segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart 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. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
      See Also:

    • 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 "resetCadence" 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 $segmentationTime seconds. When a segmentation style of "maintainCadence" 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 $segmentationTime 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 "resetCadence" 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 $segmentationTime seconds. When a segmentation style of "maintainCadence" 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 $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
      See Also:

    • 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 "resetCadence" 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 $segmentationTime seconds. When a segmentation style of "maintainCadence" 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 $segmentationTime 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 "resetCadence" 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 $segmentationTime seconds. When a segmentation style of "maintainCadence" 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 $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
      See Also:

    • segmentationTime

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

    • timedMetadataBehavior

      public final M2tsTimedMetadataBehavior timedMetadataBehavior()
      When set to passthrough, timed metadata will be passed through from input to output.

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

      Returns:
      When set to passthrough, timed metadata will be passed through from input to output.
      See Also:

    • timedMetadataBehaviorAsString

      public final String timedMetadataBehaviorAsString()
      When set to passthrough, timed metadata will be passed through from input to output.

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

      Returns:
      When set to passthrough, timed metadata will be passed through from input to output.
      See Also:

    • timedMetadataPid

      public final String 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).
      Returns:
      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).

    • 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 String videoPid()
      Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
      Returns:
      Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

    • scte35PrerollPullupMilliseconds

      public final Double scte35PrerollPullupMilliseconds()
      Defines the amount SCTE-35 preroll will be increased (in milliseconds) on the output. Preroll is the amount of time between the presence of a SCTE-35 indication in a transport stream and the PTS of the video frame it references. Zero means don't add pullup (it doesn't mean set the preroll to zero). Negative pullup is not supported, which means that you can't make the preroll shorter. Be aware that latency in the output will increase by the pullup amount.
      Returns:
      Defines the amount SCTE-35 preroll will be increased (in milliseconds) on the output. Preroll is the amount of time between the presence of a SCTE-35 indication in a transport stream and the PTS of the video frame it references. Zero means don't add pullup (it doesn't mean set the preroll to zero). Negative pullup is not supported, which means that you can't make the preroll shorter. Be aware that latency in the output will increase by the pullup amount.

    • toBuilder

      public M2tsSettings.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<M2tsSettings.Builder,M2tsSettings>
      Returns:
      a builder for type T

    • builder

      public static M2tsSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends M2tsSettings.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.