Class M3u8Settings

java.lang.Object
software.amazon.awssdk.services.medialive.model.M3u8Settings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<M3u8Settings.Builder,M3u8Settings>
@Generated("software.amazon.awssdk:codegen") public final class M3u8Settings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<M3u8Settings.Builder,M3u8Settings>
Settings information for the .m3u8 container
See Also:

  • Method Details

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

    • ecmPid

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

    • nielsenId3Behavior

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

    • patInterval

      public final Integer patInterval()
      The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
      Returns:
      The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.

    • pcrControl

      public final M3u8PcrControl 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 M3u8PcrControl.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 M3u8PcrControl.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 References (PCRs) inserted into the transport stream.
      Returns:
      Maximum time in milliseconds between Program Clock References (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.
      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.

    • pmtInterval

      public final Integer pmtInterval()
      The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
      Returns:
      The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.

    • 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.
      Returns:
      Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.

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

    • scte35Behavior

      public final M3u8Scte35Behavior scte35Behavior()
      If set to passthrough, passes any 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, scte35Behavior will return M3u8Scte35Behavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scte35BehaviorAsString().

      Returns:
      If set to passthrough, passes any SCTE-35 signals from the input source to this output.
      See Also:

    • scte35BehaviorAsString

      public final String scte35BehaviorAsString()
      If set to passthrough, passes any 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, scte35Behavior will return M3u8Scte35Behavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scte35BehaviorAsString().

      Returns:
      If set to passthrough, passes any 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.
      Returns:
      Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.

    • timedMetadataBehavior

      public final M3u8TimedMetadataBehavior timedMetadataBehavior()
      Set to PASSTHROUGH to enable ID3 metadata insertion. To include metadata, you configure other parameters in the output group or individual outputs, or you add an ID3 action to the channel schedule.

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

      Returns:
      Set to PASSTHROUGH to enable ID3 metadata insertion. To include metadata, you configure other parameters in the output group or individual outputs, or you add an ID3 action to the channel schedule.
      See Also:

    • timedMetadataBehaviorAsString

      public final String timedMetadataBehaviorAsString()
      Set to PASSTHROUGH to enable ID3 metadata insertion. To include metadata, you configure other parameters in the output group or individual outputs, or you add an ID3 action to the channel schedule.

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

      Returns:
      Set to PASSTHROUGH to enable ID3 metadata insertion. To include metadata, you configure other parameters in the output group or individual outputs, or you add an ID3 action to the channel schedule.
      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.
      Returns:
      Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.

    • klvBehavior

      public final M3u8KlvBehavior klvBehavior()
      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, klvBehavior will return M3u8KlvBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from klvBehaviorAsString().

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

    • klvBehaviorAsString

      public final String klvBehaviorAsString()
      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, klvBehavior will return M3u8KlvBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from klvBehaviorAsString().

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

    • toBuilder

      public M3u8Settings.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<M3u8Settings.Builder,M3u8Settings>
      Returns:
      a builder for type T

    • builder

      public static M3u8Settings.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.