software.amazon.awssdk.services.medialive.model

Interface AudioOnlyHlsSettings.Builder

All Superinterfaces:

CopyableBuilder<AudioOnlyHlsSettings.Builder,AudioOnlyHlsSettings>, SdkBuilder<AudioOnlyHlsSettings.Builder,AudioOnlyHlsSettings>

Enclosing class:

AudioOnlyHlsSettings

public static interface AudioOnlyHlsSettings.Builder
extends CopyableBuilder<AudioOnlyHlsSettings.Builder,AudioOnlyHlsSettings>

Method Summary

Modifier and Type	Method and Description
AudioOnlyHlsSettings.Builder	audioGroupId(String audioGroupId) Specifies the group to which the audio Rendition belongs.
default AudioOnlyHlsSettings.Builder	audioOnlyImage(Consumer<InputLocation.Builder> audioOnlyImage) For use with an audio only Stream.
AudioOnlyHlsSettings.Builder	audioOnlyImage(InputLocation audioOnlyImage) For use with an audio only Stream.
AudioOnlyHlsSettings.Builder	audioTrackType(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.
AudioOnlyHlsSettings.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.

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

copy

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

apply, build

Method Detail

audioGroupId

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

audioOnlyImage

AudioOnlyHlsSettings.Builder audioOnlyImage(InputLocation audioOnlyImage)

For use with an audio only Stream. Must be a .jpg or .png file. If given, this image will be used as the cover-art for the audio only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so will increase bandwidth by {image file size} * {segment count} * {user count.}.

Parameters:

audioOnlyImage - For use with an audio only Stream. Must be a .jpg or .png file. If given, this image will be used as the cover-art for the audio only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so will increase bandwidth by {image file size} * {segment count} * {user count.}.

Returns:

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

audioOnlyImage

default AudioOnlyHlsSettings.Builder audioOnlyImage(Consumer<InputLocation.Builder> audioOnlyImage)

For use with an audio only Stream. Must be a .jpg or .png file. If given, this image will be used as the cover-art for the audio only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so will increase bandwidth by {image file size} * {segment count} * {user count.}. This is a convenience that creates an instance of the InputLocation.Builder avoiding the need to create one manually via InputLocation.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to audioOnlyImage(InputLocation).

Parameters:

audioOnlyImage - a consumer that will call methods on InputLocation.Builder

Returns:

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

See Also:

audioOnlyImage(InputLocation)

audioTrackType

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

AudioOnlyHlsTrackType, AudioOnlyHlsTrackType

audioTrackType

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

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:

AudioOnlyHlsTrackType, AudioOnlyHlsTrackType