Class AudioOnlyHlsSettings

java.lang.Object
software.amazon.awssdk.services.medialive.model.AudioOnlyHlsSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AudioOnlyHlsSettings.Builder,AudioOnlyHlsSettings>

@Generated("software.amazon.awssdk:codegen") public final class AudioOnlyHlsSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AudioOnlyHlsSettings.Builder,AudioOnlyHlsSettings>
Audio Only Hls Settings
See Also:
  • Method Details

    • audioGroupId

      public final String audioGroupId()
      Specifies the group to which the audio Rendition belongs.
      Returns:
      Specifies the group to which the audio Rendition belongs.
    • audioOnlyImage

      public final InputLocation audioOnlyImage()
      Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth. The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard.
      Returns:
      Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth. The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard.
    • audioTrackType

      public final AudioOnlyHlsTrackType audioTrackType()
      Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO

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

      Returns:
      Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO
      See Also:
    • audioTrackTypeAsString

      public final String audioTrackTypeAsString()
      Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO

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

      Returns:
      Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO
      See Also:
    • segmentType

      public final AudioOnlyHlsSegmentType segmentType()
      Specifies the segment type.

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

      Returns:
      Specifies the segment type.
      See Also:
    • segmentTypeAsString

      public final String segmentTypeAsString()
      Specifies the segment type.

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

      Returns:
      Specifies the segment type.
      See Also:
    • toBuilder

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

      public static AudioOnlyHlsSettings.Builder builder()
    • serializableBuilderClass

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