Class HlsManifest

java.lang.Object
software.amazon.awssdk.services.mediapackagevod.model.HlsManifest
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HlsManifest.Builder,HlsManifest>
@Generated("software.amazon.awssdk:codegen") public final class HlsManifest extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HlsManifest.Builder,HlsManifest>
An HTTP Live Streaming (HLS) manifest configuration.
See Also:

  • Method Details

    • adMarkers

      public final AdMarkers adMarkers()
      This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.

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

      Returns:
      This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.
      See Also:

    • adMarkersAsString

      public final String adMarkersAsString()
      This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.

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

      Returns:
      This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.
      See Also:

    • includeIframeOnlyStream

      public final Boolean includeIframeOnlyStream()
      When enabled, an I-Frame only stream will be included in the output.
      Returns:
      When enabled, an I-Frame only stream will be included in the output.

    • manifestName

      public final String manifestName()
      An optional string to include in the name of the manifest.
      Returns:
      An optional string to include in the name of the manifest.

    • programDateTimeIntervalSeconds

      public final Integer programDateTimeIntervalSeconds()
      The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
      Returns:
      The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.

    • repeatExtXKey

      public final Boolean repeatExtXKey()
      When enabled, the EXT-X-KEY tag will be repeated in output manifests.
      Returns:
      When enabled, the EXT-X-KEY tag will be repeated in output manifests.

    • streamSelection

      public final StreamSelection streamSelection()
      Returns the value of the StreamSelection property for this object.
      Returns:
      The value of the StreamSelection property for this object.

    • toBuilder

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

    • builder

      public static HlsManifest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends HlsManifest.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.