Class MultiplexM2tsSettings

    • Method Detail

      • 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:
        M2tsAbsentInputAudioBehavior
      • 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:
        M2tsAbsentInputAudioBehavior
      • 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:
        M2tsArib
      • 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:
        M2tsArib
      • 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:
        M2tsAudioBufferModel
      • 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:
        M2tsAudioBufferModel
      • 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.
      • 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:
        M2tsAudioStreamType
      • 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:
        M2tsAudioStreamType
      • 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:
        M2tsCcDescriptor
      • 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:
        M2tsEbifControl
      • 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:
        M2tsEbifControl
      • 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:
        M2tsEsRateInPes
      • 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:
        M2tsKlv
      • 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:
        M2tsKlv
      • 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:
        M2tsNielsenId3Behavior
      • 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:
        M2tsNielsenId3Behavior
      • 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:
        M2tsPcrControl
      • 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:
        M2tsPcrControl
      • 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.
      • 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:
        M2tsScte35Control
      • 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.
      • 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)