com.amazonaws.services.mediaconvert.model

Class HlsSettings

java.lang.Object

com.amazonaws.services.mediaconvert.model.HlsSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HlsSettings
extends Object
implements Serializable, Cloneable, StructuredPojo

Settings for HLS output groups

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
HlsSettings()

Method Summary

Modifier and Type	Method and Description
HlsSettings	clone()
boolean	equals(Object obj)
String	getAudioGroupId() Specifies the group to which the audio Rendition belongs.
String	getAudioOnlyContainer() Use this setting only in audio-only outputs.
String	getAudioRenditionSets() List all the audio groups that are used with the video output stream.
String	getAudioTrackType() 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	getIFrameOnlyManifest() When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest
String	getSegmentModifier() Use this setting to add an identifying string to the filename of each segment.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAudioGroupId(String audioGroupId) Specifies the group to which the audio Rendition belongs.
void	setAudioOnlyContainer(String audioOnlyContainer) Use this setting only in audio-only outputs.
void	setAudioRenditionSets(String audioRenditionSets) List all the audio groups that are used with the video output stream.
void	setAudioTrackType(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.
void	setIFrameOnlyManifest(String iFrameOnlyManifest) When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest
void	setSegmentModifier(String segmentModifier) Use this setting to add an identifying string to the filename of each segment.
String	toString() Returns a string representation of this object.
HlsSettings	withAudioGroupId(String audioGroupId) Specifies the group to which the audio Rendition belongs.
HlsSettings	withAudioOnlyContainer(HlsAudioOnlyContainer audioOnlyContainer) Use this setting only in audio-only outputs.
HlsSettings	withAudioOnlyContainer(String audioOnlyContainer) Use this setting only in audio-only outputs.
HlsSettings	withAudioRenditionSets(String audioRenditionSets) List all the audio groups that are used with the video output stream.
HlsSettings	withAudioTrackType(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	withAudioTrackType(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	withIFrameOnlyManifest(HlsIFrameOnlyManifest iFrameOnlyManifest) When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest
HlsSettings	withIFrameOnlyManifest(String iFrameOnlyManifest) When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest
HlsSettings	withSegmentModifier(String segmentModifier) Use this setting to add an identifying string to the filename of each segment.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HlsSettings

public HlsSettings()

Method Detail

setAudioGroupId

public void setAudioGroupId(String audioGroupId)

Specifies the group to which the audio Rendition belongs.

Parameters:

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

getAudioGroupId

public String getAudioGroupId()

Specifies the group to which the audio Rendition belongs.

Returns:

Specifies the group to which the audio Rendition belongs.

withAudioGroupId

public HlsSettings withAudioGroupId(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.

setAudioOnlyContainer

public void setAudioOnlyContainer(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.

See Also:

HlsAudioOnlyContainer

getAudioOnlyContainer

public String getAudioOnlyContainer()

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:

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

withAudioOnlyContainer

public HlsSettings withAudioOnlyContainer(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

withAudioOnlyContainer

public HlsSettings withAudioOnlyContainer(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

setAudioRenditionSets

public void setAudioRenditionSets(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 ','.

getAudioRenditionSets

public String getAudioRenditionSets()

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 ','.

withAudioRenditionSets

public HlsSettings withAudioRenditionSets(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.

setAudioTrackType

public void setAudioTrackType(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

See Also:

HlsAudioTrackType

getAudioTrackType

public String getAudioTrackType()

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:

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

withAudioTrackType

public HlsSettings withAudioTrackType(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

withAudioTrackType

public HlsSettings withAudioTrackType(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

setIFrameOnlyManifest

public void setIFrameOnlyManifest(String iFrameOnlyManifest)

When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest

Parameters:

iFrameOnlyManifest - When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest

See Also:

HlsIFrameOnlyManifest

getIFrameOnlyManifest

public String getIFrameOnlyManifest()

When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest

Returns:

When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest

See Also:

HlsIFrameOnlyManifest

withIFrameOnlyManifest

public HlsSettings withIFrameOnlyManifest(String iFrameOnlyManifest)

When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest

Parameters:

iFrameOnlyManifest - When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest

Returns:

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

See Also:

HlsIFrameOnlyManifest

withIFrameOnlyManifest

public HlsSettings withIFrameOnlyManifest(HlsIFrameOnlyManifest iFrameOnlyManifest)

When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest

Parameters:

iFrameOnlyManifest - When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest

Returns:

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

See Also:

HlsIFrameOnlyManifest

setSegmentModifier

public void setSegmentModifier(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

getSegmentModifier

public String getSegmentModifier()

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

withSegmentModifier

public HlsSettings withSegmentModifier(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public HlsSettings clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.