Aws::MediaConvert::Model::HlsSettings Class Reference

#include <HlsSettings.h>

Public Member Functions

AWS_MEDIACONVERT_API HlsSettings ()=default

 

AWS_MEDIACONVERT_API HlsSettings (Aws::Utils::Json::JsonView jsonValue)

 

AWS_MEDIACONVERT_API HlsSettings & operator= (Aws::Utils::Json::JsonView jsonValue)

 

AWS_MEDIACONVERT_API Aws::Utils::Json::JsonValue Jsonize () const

 

const Aws::String & GetAudioGroupId () const

 

bool AudioGroupIdHasBeenSet () const

 

template<typename AudioGroupIdT = Aws::String>

void SetAudioGroupId (AudioGroupIdT &&value)

 

template<typename AudioGroupIdT = Aws::String>

HlsSettings & WithAudioGroupId (AudioGroupIdT &&value)

 

HlsAudioOnlyContainer GetAudioOnlyContainer () const

 

bool AudioOnlyContainerHasBeenSet () const

 

void SetAudioOnlyContainer (HlsAudioOnlyContainer value)

 

HlsSettings & WithAudioOnlyContainer (HlsAudioOnlyContainer value)

 

const Aws::String & GetAudioRenditionSets () const

 

bool AudioRenditionSetsHasBeenSet () const

 

template<typename AudioRenditionSetsT = Aws::String>

void SetAudioRenditionSets (AudioRenditionSetsT &&value)

 

template<typename AudioRenditionSetsT = Aws::String>

HlsSettings & WithAudioRenditionSets (AudioRenditionSetsT &&value)

 

HlsAudioTrackType GetAudioTrackType () const

 

bool AudioTrackTypeHasBeenSet () const

 

void SetAudioTrackType (HlsAudioTrackType value)

 

HlsSettings & WithAudioTrackType (HlsAudioTrackType value)

 

HlsDescriptiveVideoServiceFlag GetDescriptiveVideoServiceFlag () const

 

bool DescriptiveVideoServiceFlagHasBeenSet () const

 

void SetDescriptiveVideoServiceFlag (HlsDescriptiveVideoServiceFlag value)

 

HlsSettings & WithDescriptiveVideoServiceFlag (HlsDescriptiveVideoServiceFlag value)

 

HlsIFrameOnlyManifest GetIFrameOnlyManifest () const

 

bool IFrameOnlyManifestHasBeenSet () const

 

void SetIFrameOnlyManifest (HlsIFrameOnlyManifest value)

 

HlsSettings & WithIFrameOnlyManifest (HlsIFrameOnlyManifest value)

 

const Aws::String & GetSegmentModifier () const

 

bool SegmentModifierHasBeenSet () const

 

template<typename SegmentModifierT = Aws::String>

void SetSegmentModifier (SegmentModifierT &&value)

 

template<typename SegmentModifierT = Aws::String>

HlsSettings & WithSegmentModifier (SegmentModifierT &&value)

 

Detailed Description

Settings for HLS output groups

See Also:

AWS API Reference

Definition at line 35 of file HlsSettings.h.

Constructor & Destructor Documentation

HlsSettings() [1/2]

AWS_MEDIACONVERT_API Aws::MediaConvert::Model::HlsSettings::HlsSettings ( )

default

HlsSettings() [2/2]

AWS_MEDIACONVERT_API Aws::MediaConvert::Model::HlsSettings::HlsSettings ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

AudioGroupIdHasBeenSet()

bool Aws::MediaConvert::Model::HlsSettings::AudioGroupIdHasBeenSet ( ) const

inline

Specifies the group to which the audio rendition belongs.

Definition at line 49 of file HlsSettings.h.

AudioOnlyContainerHasBeenSet()

bool Aws::MediaConvert::Model::HlsSettings::AudioOnlyContainerHasBeenSet ( ) const

inline

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

Definition at line 65 of file HlsSettings.h.

AudioRenditionSetsHasBeenSet()

bool Aws::MediaConvert::Model::HlsSettings::AudioRenditionSetsHasBeenSet ( ) const

inline

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

Definition at line 76 of file HlsSettings.h.

AudioTrackTypeHasBeenSet()

bool Aws::MediaConvert::Model::HlsSettings::AudioTrackTypeHasBeenSet ( ) const

inline

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

Definition at line 98 of file HlsSettings.h.

DescriptiveVideoServiceFlagHasBeenSet()

bool Aws::MediaConvert::Model::HlsSettings::DescriptiveVideoServiceFlagHasBeenSet ( ) const

inline

Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose 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, MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation.

Definition at line 113 of file HlsSettings.h.

GetAudioGroupId()

const Aws::String & Aws::MediaConvert::Model::HlsSettings::GetAudioGroupId ( ) const

inline

Specifies the group to which the audio rendition belongs.

Definition at line 48 of file HlsSettings.h.

GetAudioOnlyContainer()

HlsAudioOnlyContainer Aws::MediaConvert::Model::HlsSettings::GetAudioOnlyContainer ( ) const

inline

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

Definition at line 64 of file HlsSettings.h.

GetAudioRenditionSets()

const Aws::String & Aws::MediaConvert::Model::HlsSettings::GetAudioRenditionSets ( ) const

inline

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

Definition at line 75 of file HlsSettings.h.

GetAudioTrackType()

HlsAudioTrackType Aws::MediaConvert::Model::HlsSettings::GetAudioTrackType ( ) const

inline

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

Definition at line 97 of file HlsSettings.h.

GetDescriptiveVideoServiceFlag()

HlsDescriptiveVideoServiceFlag Aws::MediaConvert::Model::HlsSettings::GetDescriptiveVideoServiceFlag ( ) const

inline

Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose 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, MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation.

Definition at line 112 of file HlsSettings.h.

GetIFrameOnlyManifest()

HlsIFrameOnlyManifest Aws::MediaConvert::Model::HlsSettings::GetIFrameOnlyManifest ( ) const

inline

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

Definition at line 127 of file HlsSettings.h.

GetSegmentModifier()

const Aws::String & Aws::MediaConvert::Model::HlsSettings::GetSegmentModifier ( ) const

inline

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

Definition at line 140 of file HlsSettings.h.

IFrameOnlyManifestHasBeenSet()

bool Aws::MediaConvert::Model::HlsSettings::IFrameOnlyManifestHasBeenSet ( ) const

inline

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

Definition at line 128 of file HlsSettings.h.

Jsonize()

AWS_MEDIACONVERT_API Aws::Utils::Json::JsonValue Aws::MediaConvert::Model::HlsSettings::Jsonize ( ) const

operator=()

AWS_MEDIACONVERT_API HlsSettings & Aws::MediaConvert::Model::HlsSettings::operator= ( Aws::Utils::Json::JsonView  jsonValue)

SegmentModifierHasBeenSet()

bool Aws::MediaConvert::Model::HlsSettings::SegmentModifierHasBeenSet ( ) const

inline

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

Definition at line 141 of file HlsSettings.h.

SetAudioGroupId()

template<typename AudioGroupIdT = Aws::String>

void Aws::MediaConvert::Model::HlsSettings::SetAudioGroupId ( AudioGroupIdT &&  value)

inline

Specifies the group to which the audio rendition belongs.

Definition at line 51 of file HlsSettings.h.

SetAudioOnlyContainer()

void Aws::MediaConvert::Model::HlsSettings::SetAudioOnlyContainer ( HlsAudioOnlyContainer  value)

inline

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

Definition at line 66 of file HlsSettings.h.

SetAudioRenditionSets()

template<typename AudioRenditionSetsT = Aws::String>

void Aws::MediaConvert::Model::HlsSettings::SetAudioRenditionSets ( AudioRenditionSetsT &&  value)

inline

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

Definition at line 78 of file HlsSettings.h.

SetAudioTrackType()

void Aws::MediaConvert::Model::HlsSettings::SetAudioTrackType ( HlsAudioTrackType  value)

inline

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

Definition at line 99 of file HlsSettings.h.

SetDescriptiveVideoServiceFlag()

void Aws::MediaConvert::Model::HlsSettings::SetDescriptiveVideoServiceFlag ( HlsDescriptiveVideoServiceFlag  value)

inline

Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose 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, MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation.

Definition at line 114 of file HlsSettings.h.

SetIFrameOnlyManifest()

void Aws::MediaConvert::Model::HlsSettings::SetIFrameOnlyManifest ( HlsIFrameOnlyManifest  value)

inline

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

Definition at line 129 of file HlsSettings.h.

SetSegmentModifier()

template<typename SegmentModifierT = Aws::String>

void Aws::MediaConvert::Model::HlsSettings::SetSegmentModifier ( SegmentModifierT &&  value)

inline

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

Definition at line 143 of file HlsSettings.h.

WithAudioGroupId()

template<typename AudioGroupIdT = Aws::String>

HlsSettings & Aws::MediaConvert::Model::HlsSettings::WithAudioGroupId ( AudioGroupIdT &&  value)

inline

Specifies the group to which the audio rendition belongs.

Definition at line 53 of file HlsSettings.h.

WithAudioOnlyContainer()

HlsSettings & Aws::MediaConvert::Model::HlsSettings::WithAudioOnlyContainer ( HlsAudioOnlyContainer  value)

inline

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

Definition at line 67 of file HlsSettings.h.

WithAudioRenditionSets()

template<typename AudioRenditionSetsT = Aws::String>

HlsSettings & Aws::MediaConvert::Model::HlsSettings::WithAudioRenditionSets ( AudioRenditionSetsT &&  value)

inline

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

Definition at line 80 of file HlsSettings.h.

WithAudioTrackType()

HlsSettings & Aws::MediaConvert::Model::HlsSettings::WithAudioTrackType ( HlsAudioTrackType  value)

inline

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

Definition at line 100 of file HlsSettings.h.

WithDescriptiveVideoServiceFlag()

HlsSettings & Aws::MediaConvert::Model::HlsSettings::WithDescriptiveVideoServiceFlag ( HlsDescriptiveVideoServiceFlag  value)

inline

Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose 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, MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation.

Definition at line 115 of file HlsSettings.h.

WithIFrameOnlyManifest()

HlsSettings & Aws::MediaConvert::Model::HlsSettings::WithIFrameOnlyManifest ( HlsIFrameOnlyManifest  value)

inline

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

Definition at line 130 of file HlsSettings.h.

WithSegmentModifier()

template<typename SegmentModifierT = Aws::String>

HlsSettings & Aws::MediaConvert::Model::HlsSettings::WithSegmentModifier ( SegmentModifierT &&  value)

inline

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

Definition at line 145 of file HlsSettings.h.

---

The documentation for this class was generated from the following file:

• generated/src/aws-cpp-sdk-mediaconvert/include/aws/mediaconvert/model/HlsSettings.h