software.amazon.awssdk.services.mediaconvert.model

Interface HlsSettings.Builder

All Superinterfaces:

Buildable, CopyableBuilder<HlsSettings.Builder,HlsSettings>, SdkBuilder<HlsSettings.Builder,HlsSettings>, SdkPojo

Enclosing class:

HlsSettings

public static interface HlsSettings.Builder
extends SdkPojo, CopyableBuilder<HlsSettings.Builder,HlsSettings>

Method Summary

Modifier and Type	Method and Description
HlsSettings.Builder	audioGroupId(String audioGroupId) Specifies the group to which the audio rendition belongs.
HlsSettings.Builder	audioOnlyContainer(HlsAudioOnlyContainer audioOnlyContainer) Use this setting only in audio-only outputs.
HlsSettings.Builder	audioOnlyContainer(String audioOnlyContainer) Use this setting only in audio-only outputs.
HlsSettings.Builder	audioRenditionSets(String audioRenditionSets) List all the audio groups that are used with the video output stream.
HlsSettings.Builder	audioTrackType(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.
HlsSettings.Builder	audioTrackType(String 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.
HlsSettings.Builder	descriptiveVideoServiceFlag(HlsDescriptiveVideoServiceFlag descriptiveVideoServiceFlag) Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest.
HlsSettings.Builder	descriptiveVideoServiceFlag(String descriptiveVideoServiceFlag) Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest.
HlsSettings.Builder	iFrameOnlyManifest(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.
HlsSettings.Builder	iFrameOnlyManifest(String 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.
HlsSettings.Builder	segmentModifier(String segmentModifier) Use this setting to add an identifying string to the filename of each segment.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

audioGroupId

HlsSettings.Builder audioGroupId(String audioGroupId)

Specifies the group to which the audio rendition belongs.

Parameters:

audioGroupId - Specifies the group to which the audio rendition belongs.

Returns:

Returns a reference to this object so that method calls can be chained together.

audioOnlyContainer

HlsSettings.Builder audioOnlyContainer(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsAudioOnlyContainer, HlsAudioOnlyContainer

audioOnlyContainer

HlsSettings.Builder audioOnlyContainer(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsAudioOnlyContainer, HlsAudioOnlyContainer

audioRenditionSets

HlsSettings.Builder audioRenditionSets(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 ','.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

audioTrackType

HlsSettings.Builder audioTrackType(String 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsAudioTrackType, HlsAudioTrackType

audioTrackType

HlsSettings.Builder audioTrackType(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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsAudioTrackType, HlsAudioTrackType

descriptiveVideoServiceFlag

HlsSettings.Builder descriptiveVideoServiceFlag(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsDescriptiveVideoServiceFlag, HlsDescriptiveVideoServiceFlag

descriptiveVideoServiceFlag

HlsSettings.Builder descriptiveVideoServiceFlag(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsDescriptiveVideoServiceFlag, HlsDescriptiveVideoServiceFlag

iFrameOnlyManifest

HlsSettings.Builder iFrameOnlyManifest(String 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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsIFrameOnlyManifest, HlsIFrameOnlyManifest

iFrameOnlyManifest

HlsSettings.Builder iFrameOnlyManifest(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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsIFrameOnlyManifest, HlsIFrameOnlyManifest

segmentModifier

HlsSettings.Builder segmentModifier(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.