software.amazon.awssdk.services.mediaconvert.model

Class HlsSettings

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.HlsSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HlsSettings.Builder,HlsSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class HlsSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HlsSettings.Builder,HlsSettings>

Settings for HLS output groups

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HlsSettings.Builder

Method Summary

Modifier and Type	Method and Description
String	audioGroupId() Specifies the group to which the audio rendition belongs.
HlsAudioOnlyContainer	audioOnlyContainer() Use this setting only in audio-only outputs.
String	audioOnlyContainerAsString() Use this setting only in audio-only outputs.
String	audioRenditionSets() List all the audio groups that are used with the video output stream.
HlsAudioTrackType	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.
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.
static HlsSettings.Builder	builder()
HlsDescriptiveVideoServiceFlag	descriptiveVideoServiceFlag() Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest.
String	descriptiveVideoServiceFlagAsString() Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
HlsIFrameOnlyManifest	iFrameOnlyManifest() Choose Include (INCLUDE) to have MediaConvert generate a child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition.
String	iFrameOnlyManifestAsString() Choose Include (INCLUDE) to have MediaConvert generate a child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition.
List<SdkField<?>>	sdkFields()
String	segmentModifier() Use this setting to add an identifying string to the filename of each segment.
static Class<? extends HlsSettings.Builder>	serializableBuilderClass()
HlsSettings.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

audioGroupId

public final String audioGroupId()

Specifies the group to which the audio rendition belongs.

Returns:

Specifies the group to which the audio rendition belongs.

audioOnlyContainer

public final HlsAudioOnlyContainer audioOnlyContainer()

Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream (M2TS) to create a file in an MPEG2-TS container. Keep the default value Automatic (AUTOMATIC) to create an audio-only file in a raw container. Regardless of the value that you specify here, if this output has video, the service will place the output into an MPEG2-TS container.

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

Returns:

Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream (M2TS) to create a file in an MPEG2-TS container. Keep the default value Automatic (AUTOMATIC) to create an audio-only file in a raw container. Regardless of the value that you specify here, if this output has video, the service will place the output into an MPEG2-TS container.

See Also:

HlsAudioOnlyContainer

audioOnlyContainerAsString

public final String audioOnlyContainerAsString()

Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream (M2TS) to create a file in an MPEG2-TS container. Keep the default value Automatic (AUTOMATIC) to create an audio-only file in a raw container. Regardless of the value that you specify here, if this output has video, the service will place the output into an MPEG2-TS container.

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

Returns:

Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream (M2TS) to create a file in an MPEG2-TS container. Keep the default value Automatic (AUTOMATIC) to create an audio-only file in a raw container. Regardless of the value that you specify here, if this output has video, the service will place the output into an MPEG2-TS container.

See Also:

HlsAudioOnlyContainer

audioRenditionSets

public final String audioRenditionSets()

List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.

Returns:

List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.

audioTrackType

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

HlsAudioTrackType

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 HlsAudioTrackType.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:

HlsAudioTrackType

descriptiveVideoServiceFlag

public final HlsDescriptiveVideoServiceFlag descriptiveVideoServiceFlag()

Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag (FLAG), MediaConvert includes the parameter CHARACTERISTICS="public.accessibility.describes-video" in the EXT-X-MEDIA entry for this track. When you keep the default choice, Don't flag (DONT_FLAG), MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation.

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

Returns:

Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag (FLAG), MediaConvert includes the parameter CHARACTERISTICS="public.accessibility.describes-video" in the EXT-X-MEDIA entry for this track. When you keep the default choice, Don't flag (DONT_FLAG), MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation.

See Also:

HlsDescriptiveVideoServiceFlag

descriptiveVideoServiceFlagAsString

public final String descriptiveVideoServiceFlagAsString()

Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag (FLAG), MediaConvert includes the parameter CHARACTERISTICS="public.accessibility.describes-video" in the EXT-X-MEDIA entry for this track. When you keep the default choice, Don't flag (DONT_FLAG), MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation.

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

Returns:

Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag (FLAG), MediaConvert includes the parameter CHARACTERISTICS="public.accessibility.describes-video" in the EXT-X-MEDIA entry for this track. When you keep the default choice, Don't flag (DONT_FLAG), MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation.

See Also:

HlsDescriptiveVideoServiceFlag

iFrameOnlyManifest

public final HlsIFrameOnlyManifest iFrameOnlyManifest()

Choose Include (INCLUDE) to have MediaConvert generate a child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition. You might use this manifest as part of a workflow that creates preview functions for your video. MediaConvert adds both the I-frame only child manifest and the regular child manifest to the parent manifest. When you don't need the I-frame only child manifest, keep the default value Exclude (EXCLUDE).

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

Returns:

Choose Include (INCLUDE) to have MediaConvert generate a child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition. You might use this manifest as part of a workflow that creates preview functions for your video. MediaConvert adds both the I-frame only child manifest and the regular child manifest to the parent manifest. When you don't need the I-frame only child manifest, keep the default value Exclude (EXCLUDE).

See Also:

HlsIFrameOnlyManifest

iFrameOnlyManifestAsString

public final String iFrameOnlyManifestAsString()

Choose Include (INCLUDE) to have MediaConvert generate a child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition. You might use this manifest as part of a workflow that creates preview functions for your video. MediaConvert adds both the I-frame only child manifest and the regular child manifest to the parent manifest. When you don't need the I-frame only child manifest, keep the default value Exclude (EXCLUDE).

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

Returns:

Choose Include (INCLUDE) to have MediaConvert generate a child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition. You might use this manifest as part of a workflow that creates preview functions for your video. MediaConvert adds both the I-frame only child manifest and the regular child manifest to the parent manifest. When you don't need the I-frame only child manifest, keep the default value Exclude (EXCLUDE).

See Also:

HlsIFrameOnlyManifest

segmentModifier

public final String segmentModifier()

Use this setting to add an identifying string to the filename of each segment. The service adds this string between the name modifier and segment index number. You can use format identifiers in the string. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html

Returns:

Use this setting to add an identifying string to the filename of each segment. The service adds this string between the name modifier and segment index number. You can use format identifiers in the string. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html

toBuilder

public HlsSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HlsSettings.Builder,HlsSettings>

builder

public static HlsSettings.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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