AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::MediaConvert::Model::CmfcSettings Class Reference

#include <CmfcSettings.h>

Public Member Functions

 CmfcSettings ()
 
 CmfcSettings (Aws::Utils::Json::JsonView jsonValue)
 
CmfcSettingsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const CmfcAudioDurationGetAudioDuration () const
 
bool AudioDurationHasBeenSet () const
 
void SetAudioDuration (const CmfcAudioDuration &value)
 
void SetAudioDuration (CmfcAudioDuration &&value)
 
CmfcSettingsWithAudioDuration (const CmfcAudioDuration &value)
 
CmfcSettingsWithAudioDuration (CmfcAudioDuration &&value)
 
const Aws::StringGetAudioGroupId () const
 
bool AudioGroupIdHasBeenSet () const
 
void SetAudioGroupId (const Aws::String &value)
 
void SetAudioGroupId (Aws::String &&value)
 
void SetAudioGroupId (const char *value)
 
CmfcSettingsWithAudioGroupId (const Aws::String &value)
 
CmfcSettingsWithAudioGroupId (Aws::String &&value)
 
CmfcSettingsWithAudioGroupId (const char *value)
 
const Aws::StringGetAudioRenditionSets () const
 
bool AudioRenditionSetsHasBeenSet () const
 
void SetAudioRenditionSets (const Aws::String &value)
 
void SetAudioRenditionSets (Aws::String &&value)
 
void SetAudioRenditionSets (const char *value)
 
CmfcSettingsWithAudioRenditionSets (const Aws::String &value)
 
CmfcSettingsWithAudioRenditionSets (Aws::String &&value)
 
CmfcSettingsWithAudioRenditionSets (const char *value)
 
const CmfcAudioTrackTypeGetAudioTrackType () const
 
bool AudioTrackTypeHasBeenSet () const
 
void SetAudioTrackType (const CmfcAudioTrackType &value)
 
void SetAudioTrackType (CmfcAudioTrackType &&value)
 
CmfcSettingsWithAudioTrackType (const CmfcAudioTrackType &value)
 
CmfcSettingsWithAudioTrackType (CmfcAudioTrackType &&value)
 
const CmfcDescriptiveVideoServiceFlagGetDescriptiveVideoServiceFlag () const
 
bool DescriptiveVideoServiceFlagHasBeenSet () const
 
void SetDescriptiveVideoServiceFlag (const CmfcDescriptiveVideoServiceFlag &value)
 
void SetDescriptiveVideoServiceFlag (CmfcDescriptiveVideoServiceFlag &&value)
 
CmfcSettingsWithDescriptiveVideoServiceFlag (const CmfcDescriptiveVideoServiceFlag &value)
 
CmfcSettingsWithDescriptiveVideoServiceFlag (CmfcDescriptiveVideoServiceFlag &&value)
 
const CmfcIFrameOnlyManifestGetIFrameOnlyManifest () const
 
bool IFrameOnlyManifestHasBeenSet () const
 
void SetIFrameOnlyManifest (const CmfcIFrameOnlyManifest &value)
 
void SetIFrameOnlyManifest (CmfcIFrameOnlyManifest &&value)
 
CmfcSettingsWithIFrameOnlyManifest (const CmfcIFrameOnlyManifest &value)
 
CmfcSettingsWithIFrameOnlyManifest (CmfcIFrameOnlyManifest &&value)
 
const CmfcScte35EsamGetScte35Esam () const
 
bool Scte35EsamHasBeenSet () const
 
void SetScte35Esam (const CmfcScte35Esam &value)
 
void SetScte35Esam (CmfcScte35Esam &&value)
 
CmfcSettingsWithScte35Esam (const CmfcScte35Esam &value)
 
CmfcSettingsWithScte35Esam (CmfcScte35Esam &&value)
 
const CmfcScte35SourceGetScte35Source () const
 
bool Scte35SourceHasBeenSet () const
 
void SetScte35Source (const CmfcScte35Source &value)
 
void SetScte35Source (CmfcScte35Source &&value)
 
CmfcSettingsWithScte35Source (const CmfcScte35Source &value)
 
CmfcSettingsWithScte35Source (CmfcScte35Source &&value)
 

Detailed Description

These settings relate to the fragmented MP4 container for the segments in your CMAF outputs.

See Also:

AWS API Reference

Definition at line 38 of file CmfcSettings.h.

Constructor & Destructor Documentation

◆ CmfcSettings() [1/2]

Aws::MediaConvert::Model::CmfcSettings::CmfcSettings ( )

◆ CmfcSettings() [2/2]

Aws::MediaConvert::Model::CmfcSettings::CmfcSettings ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AudioDurationHasBeenSet()

bool Aws::MediaConvert::Model::CmfcSettings::AudioDurationHasBeenSet ( ) const
inline

Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between video and audio. For this situation, choose Match video duration (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (DEFAULT_CODEC_DURATION). When you choose Match video duration, MediaConvert pads the output audio streams with silence or trims them to ensure that the total duration of each audio stream is at least as long as the total duration of the video stream. After padding or trimming, the audio stream duration is no more than one frame longer than the video stream. MediaConvert applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies between audio and video duration will depend on your output audio codec.

Definition at line 79 of file CmfcSettings.h.

◆ AudioGroupIdHasBeenSet()

bool Aws::MediaConvert::Model::CmfcSettings::AudioGroupIdHasBeenSet ( ) const
inline

Specify the audio rendition group for this audio rendition. Specify up to one value for each audio output in your output group. This value appears in your HLS parent manifest in the EXT-X-MEDIA tag of TYPE=AUDIO, as the value for the GROUP-ID attribute. For example, if you specify "audio_aac_1" for Audio group ID, it appears in your manifest like this: #EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="audio_aac_1". Related setting: To associate the rendition group that this audio track belongs to with a video rendition, include the same value that you provide here for that video output's setting Audio rendition sets (audioRenditionSets).

Definition at line 174 of file CmfcSettings.h.

◆ AudioRenditionSetsHasBeenSet()

bool Aws::MediaConvert::Model::CmfcSettings::AudioRenditionSetsHasBeenSet ( ) const
inline

List the audio rendition groups that you want included with this video rendition. Use a comma-separated list. For example, say you want to include the audio rendition groups that have the audio group IDs "audio_aac_1" and "audio_dolby". Then you would specify this value: "audio_aac_1, audio_dolby". Related setting: The rendition groups that you include in your comma-separated list should all match values that you specify in the setting Audio group ID (AudioGroupId) for audio renditions in the same output group as this video rendition. Default behavior: If you don't specify anything here and for Audio group ID, MediaConvert puts each audio variant in its own audio rendition group and associates it with every video variant. Each value in your list appears in your HLS parent manifest in the EXT-X-STREAM-INF tag as the value for the AUDIO attribute. To continue the previous example, say that the file name for the child manifest for your video rendition is "amazing_video_1.m3u8". Then, in your parent manifest, each value will appear on separate lines, like this: #EXT-X-STREAM-INF:AUDIO="audio_aac_1"... amazing_video_1.m3u8 #EXT-X-STREAM-INF:AUDIO="audio_dolby"... amazing_video_1.m3u8

Definition at line 293 of file CmfcSettings.h.

◆ AudioTrackTypeHasBeenSet()

bool Aws::MediaConvert::Model::CmfcSettings::AudioTrackTypeHasBeenSet ( ) const
inline

Use this setting to control the values that MediaConvert puts in your HLS parent playlist to control how the client player selects which audio track to play. The other options for this setting determine the values that MediaConvert writes for the DEFAULT and AUTOSELECT attributes of the EXT-X-MEDIA entry for the audio variant. For more information about these attributes, see the Apple documentation article https://developer.apple.com/documentation/http_live_streaming/example_playlists_for_http_live_streaming/adding_alternate_media_to_a_playlist. Choose Alternate audio, auto select, default (ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT) to set DEFAULT=YES and AUTOSELECT=YES. Choose this value for only one variant in your output group. Choose Alternate audio, auto select, not default (ALTERNATE_AUDIO_AUTO_SELECT) to set DEFAULT=NO and AUTOSELECT=YES. Choose Alternate Audio, Not Auto Select to set DEFAULT=NO and AUTOSELECT=NO. When you don't specify a value for this setting, MediaConvert defaults to Alternate audio, auto select, default. When there is more than one variant in your output group, you must explicitly choose a value for this setting.

Definition at line 454 of file CmfcSettings.h.

◆ DescriptiveVideoServiceFlagHasBeenSet()

bool Aws::MediaConvert::Model::CmfcSettings::DescriptiveVideoServiceFlagHasBeenSet ( ) const
inline

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.

Definition at line 557 of file CmfcSettings.h.

◆ GetAudioDuration()

const CmfcAudioDuration& Aws::MediaConvert::Model::CmfcSettings::GetAudioDuration ( ) const
inline

Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between video and audio. For this situation, choose Match video duration (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (DEFAULT_CODEC_DURATION). When you choose Match video duration, MediaConvert pads the output audio streams with silence or trims them to ensure that the total duration of each audio stream is at least as long as the total duration of the video stream. After padding or trimming, the audio stream duration is no more than one frame longer than the video stream. MediaConvert applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies between audio and video duration will depend on your output audio codec.

Definition at line 62 of file CmfcSettings.h.

◆ GetAudioGroupId()

const Aws::String& Aws::MediaConvert::Model::CmfcSettings::GetAudioGroupId ( ) const
inline

Specify the audio rendition group for this audio rendition. Specify up to one value for each audio output in your output group. This value appears in your HLS parent manifest in the EXT-X-MEDIA tag of TYPE=AUDIO, as the value for the GROUP-ID attribute. For example, if you specify "audio_aac_1" for Audio group ID, it appears in your manifest like this: #EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="audio_aac_1". Related setting: To associate the rendition group that this audio track belongs to with a video rendition, include the same value that you provide here for that video output's setting Audio rendition sets (audioRenditionSets).

Definition at line 161 of file CmfcSettings.h.

◆ GetAudioRenditionSets()

const Aws::String& Aws::MediaConvert::Model::CmfcSettings::GetAudioRenditionSets ( ) const
inline

List the audio rendition groups that you want included with this video rendition. Use a comma-separated list. For example, say you want to include the audio rendition groups that have the audio group IDs "audio_aac_1" and "audio_dolby". Then you would specify this value: "audio_aac_1, audio_dolby". Related setting: The rendition groups that you include in your comma-separated list should all match values that you specify in the setting Audio group ID (AudioGroupId) for audio renditions in the same output group as this video rendition. Default behavior: If you don't specify anything here and for Audio group ID, MediaConvert puts each audio variant in its own audio rendition group and associates it with every video variant. Each value in your list appears in your HLS parent manifest in the EXT-X-STREAM-INF tag as the value for the AUDIO attribute. To continue the previous example, say that the file name for the child manifest for your video rendition is "amazing_video_1.m3u8". Then, in your parent manifest, each value will appear on separate lines, like this: #EXT-X-STREAM-INF:AUDIO="audio_aac_1"... amazing_video_1.m3u8 #EXT-X-STREAM-INF:AUDIO="audio_dolby"... amazing_video_1.m3u8

Definition at line 273 of file CmfcSettings.h.

◆ GetAudioTrackType()

const CmfcAudioTrackType& Aws::MediaConvert::Model::CmfcSettings::GetAudioTrackType ( ) const
inline

Use this setting to control the values that MediaConvert puts in your HLS parent playlist to control how the client player selects which audio track to play. The other options for this setting determine the values that MediaConvert writes for the DEFAULT and AUTOSELECT attributes of the EXT-X-MEDIA entry for the audio variant. For more information about these attributes, see the Apple documentation article https://developer.apple.com/documentation/http_live_streaming/example_playlists_for_http_live_streaming/adding_alternate_media_to_a_playlist. Choose Alternate audio, auto select, default (ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT) to set DEFAULT=YES and AUTOSELECT=YES. Choose this value for only one variant in your output group. Choose Alternate audio, auto select, not default (ALTERNATE_AUDIO_AUTO_SELECT) to set DEFAULT=NO and AUTOSELECT=YES. Choose Alternate Audio, Not Auto Select to set DEFAULT=NO and AUTOSELECT=NO. When you don't specify a value for this setting, MediaConvert defaults to Alternate audio, auto select, default. When there is more than one variant in your output group, you must explicitly choose a value for this setting.

Definition at line 434 of file CmfcSettings.h.

◆ GetDescriptiveVideoServiceFlag()

const CmfcDescriptiveVideoServiceFlag& Aws::MediaConvert::Model::CmfcSettings::GetDescriptiveVideoServiceFlag ( ) const
inline

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.

Definition at line 546 of file CmfcSettings.h.

◆ GetIFrameOnlyManifest()

const CmfcIFrameOnlyManifest& Aws::MediaConvert::Model::CmfcSettings::GetIFrameOnlyManifest ( ) const
inline

Choose Include (INCLUDE) to have MediaConvert generate an HLS 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).

Definition at line 613 of file CmfcSettings.h.

◆ GetScte35Esam()

const CmfcScte35Esam& Aws::MediaConvert::Model::CmfcSettings::GetScte35Esam ( ) const
inline

Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).

Definition at line 676 of file CmfcSettings.h.

◆ GetScte35Source()

const CmfcScte35Source& Aws::MediaConvert::Model::CmfcSettings::GetScte35Source ( ) const
inline

Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output.

Definition at line 720 of file CmfcSettings.h.

◆ IFrameOnlyManifestHasBeenSet()

bool Aws::MediaConvert::Model::CmfcSettings::IFrameOnlyManifestHasBeenSet ( ) const
inline

Choose Include (INCLUDE) to have MediaConvert generate an HLS 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).

Definition at line 624 of file CmfcSettings.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::MediaConvert::Model::CmfcSettings::Jsonize ( ) const

◆ operator=()

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

◆ Scte35EsamHasBeenSet()

bool Aws::MediaConvert::Model::CmfcSettings::Scte35EsamHasBeenSet ( ) const
inline

Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).

Definition at line 683 of file CmfcSettings.h.

◆ Scte35SourceHasBeenSet()

bool Aws::MediaConvert::Model::CmfcSettings::Scte35SourceHasBeenSet ( ) const
inline

Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output.

Definition at line 728 of file CmfcSettings.h.

◆ SetAudioDuration() [1/2]

void Aws::MediaConvert::Model::CmfcSettings::SetAudioDuration ( CmfcAudioDuration &&  value)
inline

Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between video and audio. For this situation, choose Match video duration (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (DEFAULT_CODEC_DURATION). When you choose Match video duration, MediaConvert pads the output audio streams with silence or trims them to ensure that the total duration of each audio stream is at least as long as the total duration of the video stream. After padding or trimming, the audio stream duration is no more than one frame longer than the video stream. MediaConvert applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies between audio and video duration will depend on your output audio codec.

Definition at line 113 of file CmfcSettings.h.

◆ SetAudioDuration() [2/2]

void Aws::MediaConvert::Model::CmfcSettings::SetAudioDuration ( const CmfcAudioDuration value)
inline

Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between video and audio. For this situation, choose Match video duration (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (DEFAULT_CODEC_DURATION). When you choose Match video duration, MediaConvert pads the output audio streams with silence or trims them to ensure that the total duration of each audio stream is at least as long as the total duration of the video stream. After padding or trimming, the audio stream duration is no more than one frame longer than the video stream. MediaConvert applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies between audio and video duration will depend on your output audio codec.

Definition at line 96 of file CmfcSettings.h.

◆ SetAudioGroupId() [1/3]

void Aws::MediaConvert::Model::CmfcSettings::SetAudioGroupId ( Aws::String &&  value)
inline

Specify the audio rendition group for this audio rendition. Specify up to one value for each audio output in your output group. This value appears in your HLS parent manifest in the EXT-X-MEDIA tag of TYPE=AUDIO, as the value for the GROUP-ID attribute. For example, if you specify "audio_aac_1" for Audio group ID, it appears in your manifest like this: #EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="audio_aac_1". Related setting: To associate the rendition group that this audio track belongs to with a video rendition, include the same value that you provide here for that video output's setting Audio rendition sets (audioRenditionSets).

Definition at line 200 of file CmfcSettings.h.

◆ SetAudioGroupId() [2/3]

void Aws::MediaConvert::Model::CmfcSettings::SetAudioGroupId ( const Aws::String value)
inline

Specify the audio rendition group for this audio rendition. Specify up to one value for each audio output in your output group. This value appears in your HLS parent manifest in the EXT-X-MEDIA tag of TYPE=AUDIO, as the value for the GROUP-ID attribute. For example, if you specify "audio_aac_1" for Audio group ID, it appears in your manifest like this: #EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="audio_aac_1". Related setting: To associate the rendition group that this audio track belongs to with a video rendition, include the same value that you provide here for that video output's setting Audio rendition sets (audioRenditionSets).

Definition at line 187 of file CmfcSettings.h.

◆ SetAudioGroupId() [3/3]

void Aws::MediaConvert::Model::CmfcSettings::SetAudioGroupId ( const char *  value)
inline

Specify the audio rendition group for this audio rendition. Specify up to one value for each audio output in your output group. This value appears in your HLS parent manifest in the EXT-X-MEDIA tag of TYPE=AUDIO, as the value for the GROUP-ID attribute. For example, if you specify "audio_aac_1" for Audio group ID, it appears in your manifest like this: #EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="audio_aac_1". Related setting: To associate the rendition group that this audio track belongs to with a video rendition, include the same value that you provide here for that video output's setting Audio rendition sets (audioRenditionSets).

Definition at line 213 of file CmfcSettings.h.

◆ SetAudioRenditionSets() [1/3]

void Aws::MediaConvert::Model::CmfcSettings::SetAudioRenditionSets ( Aws::String &&  value)
inline

List the audio rendition groups that you want included with this video rendition. Use a comma-separated list. For example, say you want to include the audio rendition groups that have the audio group IDs "audio_aac_1" and "audio_dolby". Then you would specify this value: "audio_aac_1, audio_dolby". Related setting: The rendition groups that you include in your comma-separated list should all match values that you specify in the setting Audio group ID (AudioGroupId) for audio renditions in the same output group as this video rendition. Default behavior: If you don't specify anything here and for Audio group ID, MediaConvert puts each audio variant in its own audio rendition group and associates it with every video variant. Each value in your list appears in your HLS parent manifest in the EXT-X-STREAM-INF tag as the value for the AUDIO attribute. To continue the previous example, say that the file name for the child manifest for your video rendition is "amazing_video_1.m3u8". Then, in your parent manifest, each value will appear on separate lines, like this: #EXT-X-STREAM-INF:AUDIO="audio_aac_1"... amazing_video_1.m3u8 #EXT-X-STREAM-INF:AUDIO="audio_dolby"... amazing_video_1.m3u8

Definition at line 333 of file CmfcSettings.h.

◆ SetAudioRenditionSets() [2/3]

void Aws::MediaConvert::Model::CmfcSettings::SetAudioRenditionSets ( const Aws::String value)
inline

List the audio rendition groups that you want included with this video rendition. Use a comma-separated list. For example, say you want to include the audio rendition groups that have the audio group IDs "audio_aac_1" and "audio_dolby". Then you would specify this value: "audio_aac_1, audio_dolby". Related setting: The rendition groups that you include in your comma-separated list should all match values that you specify in the setting Audio group ID (AudioGroupId) for audio renditions in the same output group as this video rendition. Default behavior: If you don't specify anything here and for Audio group ID, MediaConvert puts each audio variant in its own audio rendition group and associates it with every video variant. Each value in your list appears in your HLS parent manifest in the EXT-X-STREAM-INF tag as the value for the AUDIO attribute. To continue the previous example, say that the file name for the child manifest for your video rendition is "amazing_video_1.m3u8". Then, in your parent manifest, each value will appear on separate lines, like this: #EXT-X-STREAM-INF:AUDIO="audio_aac_1"... amazing_video_1.m3u8 #EXT-X-STREAM-INF:AUDIO="audio_dolby"... amazing_video_1.m3u8

Definition at line 313 of file CmfcSettings.h.

◆ SetAudioRenditionSets() [3/3]

void Aws::MediaConvert::Model::CmfcSettings::SetAudioRenditionSets ( const char *  value)
inline

List the audio rendition groups that you want included with this video rendition. Use a comma-separated list. For example, say you want to include the audio rendition groups that have the audio group IDs "audio_aac_1" and "audio_dolby". Then you would specify this value: "audio_aac_1, audio_dolby". Related setting: The rendition groups that you include in your comma-separated list should all match values that you specify in the setting Audio group ID (AudioGroupId) for audio renditions in the same output group as this video rendition. Default behavior: If you don't specify anything here and for Audio group ID, MediaConvert puts each audio variant in its own audio rendition group and associates it with every video variant. Each value in your list appears in your HLS parent manifest in the EXT-X-STREAM-INF tag as the value for the AUDIO attribute. To continue the previous example, say that the file name for the child manifest for your video rendition is "amazing_video_1.m3u8". Then, in your parent manifest, each value will appear on separate lines, like this: #EXT-X-STREAM-INF:AUDIO="audio_aac_1"... amazing_video_1.m3u8 #EXT-X-STREAM-INF:AUDIO="audio_dolby"... amazing_video_1.m3u8

Definition at line 353 of file CmfcSettings.h.

◆ SetAudioTrackType() [1/2]

void Aws::MediaConvert::Model::CmfcSettings::SetAudioTrackType ( CmfcAudioTrackType &&  value)
inline

Use this setting to control the values that MediaConvert puts in your HLS parent playlist to control how the client player selects which audio track to play. The other options for this setting determine the values that MediaConvert writes for the DEFAULT and AUTOSELECT attributes of the EXT-X-MEDIA entry for the audio variant. For more information about these attributes, see the Apple documentation article https://developer.apple.com/documentation/http_live_streaming/example_playlists_for_http_live_streaming/adding_alternate_media_to_a_playlist. Choose Alternate audio, auto select, default (ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT) to set DEFAULT=YES and AUTOSELECT=YES. Choose this value for only one variant in your output group. Choose Alternate audio, auto select, not default (ALTERNATE_AUDIO_AUTO_SELECT) to set DEFAULT=NO and AUTOSELECT=YES. Choose Alternate Audio, Not Auto Select to set DEFAULT=NO and AUTOSELECT=NO. When you don't specify a value for this setting, MediaConvert defaults to Alternate audio, auto select, default. When there is more than one variant in your output group, you must explicitly choose a value for this setting.

Definition at line 494 of file CmfcSettings.h.

◆ SetAudioTrackType() [2/2]

void Aws::MediaConvert::Model::CmfcSettings::SetAudioTrackType ( const CmfcAudioTrackType value)
inline

Use this setting to control the values that MediaConvert puts in your HLS parent playlist to control how the client player selects which audio track to play. The other options for this setting determine the values that MediaConvert writes for the DEFAULT and AUTOSELECT attributes of the EXT-X-MEDIA entry for the audio variant. For more information about these attributes, see the Apple documentation article https://developer.apple.com/documentation/http_live_streaming/example_playlists_for_http_live_streaming/adding_alternate_media_to_a_playlist. Choose Alternate audio, auto select, default (ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT) to set DEFAULT=YES and AUTOSELECT=YES. Choose this value for only one variant in your output group. Choose Alternate audio, auto select, not default (ALTERNATE_AUDIO_AUTO_SELECT) to set DEFAULT=NO and AUTOSELECT=YES. Choose Alternate Audio, Not Auto Select to set DEFAULT=NO and AUTOSELECT=NO. When you don't specify a value for this setting, MediaConvert defaults to Alternate audio, auto select, default. When there is more than one variant in your output group, you must explicitly choose a value for this setting.

Definition at line 474 of file CmfcSettings.h.

◆ SetDescriptiveVideoServiceFlag() [1/2]

void Aws::MediaConvert::Model::CmfcSettings::SetDescriptiveVideoServiceFlag ( CmfcDescriptiveVideoServiceFlag &&  value)
inline

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.

Definition at line 579 of file CmfcSettings.h.

◆ SetDescriptiveVideoServiceFlag() [2/2]

void Aws::MediaConvert::Model::CmfcSettings::SetDescriptiveVideoServiceFlag ( const CmfcDescriptiveVideoServiceFlag value)
inline

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.

Definition at line 568 of file CmfcSettings.h.

◆ SetIFrameOnlyManifest() [1/2]

void Aws::MediaConvert::Model::CmfcSettings::SetIFrameOnlyManifest ( CmfcIFrameOnlyManifest &&  value)
inline

Choose Include (INCLUDE) to have MediaConvert generate an HLS 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).

Definition at line 646 of file CmfcSettings.h.

◆ SetIFrameOnlyManifest() [2/2]

void Aws::MediaConvert::Model::CmfcSettings::SetIFrameOnlyManifest ( const CmfcIFrameOnlyManifest value)
inline

Choose Include (INCLUDE) to have MediaConvert generate an HLS 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).

Definition at line 635 of file CmfcSettings.h.

◆ SetScte35Esam() [1/2]

void Aws::MediaConvert::Model::CmfcSettings::SetScte35Esam ( CmfcScte35Esam &&  value)
inline

Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).

Definition at line 697 of file CmfcSettings.h.

◆ SetScte35Esam() [2/2]

void Aws::MediaConvert::Model::CmfcSettings::SetScte35Esam ( const CmfcScte35Esam value)
inline

Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).

Definition at line 690 of file CmfcSettings.h.

◆ SetScte35Source() [1/2]

void Aws::MediaConvert::Model::CmfcSettings::SetScte35Source ( CmfcScte35Source &&  value)
inline

Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output.

Definition at line 744 of file CmfcSettings.h.

◆ SetScte35Source() [2/2]

void Aws::MediaConvert::Model::CmfcSettings::SetScte35Source ( const CmfcScte35Source value)
inline

Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output.

Definition at line 736 of file CmfcSettings.h.

◆ WithAudioDuration() [1/2]

CmfcSettings& Aws::MediaConvert::Model::CmfcSettings::WithAudioDuration ( CmfcAudioDuration &&  value)
inline

Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between video and audio. For this situation, choose Match video duration (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (DEFAULT_CODEC_DURATION). When you choose Match video duration, MediaConvert pads the output audio streams with silence or trims them to ensure that the total duration of each audio stream is at least as long as the total duration of the video stream. After padding or trimming, the audio stream duration is no more than one frame longer than the video stream. MediaConvert applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies between audio and video duration will depend on your output audio codec.

Definition at line 147 of file CmfcSettings.h.

◆ WithAudioDuration() [2/2]

CmfcSettings& Aws::MediaConvert::Model::CmfcSettings::WithAudioDuration ( const CmfcAudioDuration value)
inline

Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between video and audio. For this situation, choose Match video duration (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (DEFAULT_CODEC_DURATION). When you choose Match video duration, MediaConvert pads the output audio streams with silence or trims them to ensure that the total duration of each audio stream is at least as long as the total duration of the video stream. After padding or trimming, the audio stream duration is no more than one frame longer than the video stream. MediaConvert applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies between audio and video duration will depend on your output audio codec.

Definition at line 130 of file CmfcSettings.h.

◆ WithAudioGroupId() [1/3]

CmfcSettings& Aws::MediaConvert::Model::CmfcSettings::WithAudioGroupId ( Aws::String &&  value)
inline

Specify the audio rendition group for this audio rendition. Specify up to one value for each audio output in your output group. This value appears in your HLS parent manifest in the EXT-X-MEDIA tag of TYPE=AUDIO, as the value for the GROUP-ID attribute. For example, if you specify "audio_aac_1" for Audio group ID, it appears in your manifest like this: #EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="audio_aac_1". Related setting: To associate the rendition group that this audio track belongs to with a video rendition, include the same value that you provide here for that video output's setting Audio rendition sets (audioRenditionSets).

Definition at line 239 of file CmfcSettings.h.

◆ WithAudioGroupId() [2/3]

CmfcSettings& Aws::MediaConvert::Model::CmfcSettings::WithAudioGroupId ( const Aws::String value)
inline

Specify the audio rendition group for this audio rendition. Specify up to one value for each audio output in your output group. This value appears in your HLS parent manifest in the EXT-X-MEDIA tag of TYPE=AUDIO, as the value for the GROUP-ID attribute. For example, if you specify "audio_aac_1" for Audio group ID, it appears in your manifest like this: #EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="audio_aac_1". Related setting: To associate the rendition group that this audio track belongs to with a video rendition, include the same value that you provide here for that video output's setting Audio rendition sets (audioRenditionSets).

Definition at line 226 of file CmfcSettings.h.

◆ WithAudioGroupId() [3/3]

CmfcSettings& Aws::MediaConvert::Model::CmfcSettings::WithAudioGroupId ( const char *  value)
inline

Specify the audio rendition group for this audio rendition. Specify up to one value for each audio output in your output group. This value appears in your HLS parent manifest in the EXT-X-MEDIA tag of TYPE=AUDIO, as the value for the GROUP-ID attribute. For example, if you specify "audio_aac_1" for Audio group ID, it appears in your manifest like this: #EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="audio_aac_1". Related setting: To associate the rendition group that this audio track belongs to with a video rendition, include the same value that you provide here for that video output's setting Audio rendition sets (audioRenditionSets).

Definition at line 252 of file CmfcSettings.h.

◆ WithAudioRenditionSets() [1/3]

CmfcSettings& Aws::MediaConvert::Model::CmfcSettings::WithAudioRenditionSets ( Aws::String &&  value)
inline

List the audio rendition groups that you want included with this video rendition. Use a comma-separated list. For example, say you want to include the audio rendition groups that have the audio group IDs "audio_aac_1" and "audio_dolby". Then you would specify this value: "audio_aac_1, audio_dolby". Related setting: The rendition groups that you include in your comma-separated list should all match values that you specify in the setting Audio group ID (AudioGroupId) for audio renditions in the same output group as this video rendition. Default behavior: If you don't specify anything here and for Audio group ID, MediaConvert puts each audio variant in its own audio rendition group and associates it with every video variant. Each value in your list appears in your HLS parent manifest in the EXT-X-STREAM-INF tag as the value for the AUDIO attribute. To continue the previous example, say that the file name for the child manifest for your video rendition is "amazing_video_1.m3u8". Then, in your parent manifest, each value will appear on separate lines, like this: #EXT-X-STREAM-INF:AUDIO="audio_aac_1"... amazing_video_1.m3u8 #EXT-X-STREAM-INF:AUDIO="audio_dolby"... amazing_video_1.m3u8

Definition at line 393 of file CmfcSettings.h.

◆ WithAudioRenditionSets() [2/3]

CmfcSettings& Aws::MediaConvert::Model::CmfcSettings::WithAudioRenditionSets ( const Aws::String value)
inline

List the audio rendition groups that you want included with this video rendition. Use a comma-separated list. For example, say you want to include the audio rendition groups that have the audio group IDs "audio_aac_1" and "audio_dolby". Then you would specify this value: "audio_aac_1, audio_dolby". Related setting: The rendition groups that you include in your comma-separated list should all match values that you specify in the setting Audio group ID (AudioGroupId) for audio renditions in the same output group as this video rendition. Default behavior: If you don't specify anything here and for Audio group ID, MediaConvert puts each audio variant in its own audio rendition group and associates it with every video variant. Each value in your list appears in your HLS parent manifest in the EXT-X-STREAM-INF tag as the value for the AUDIO attribute. To continue the previous example, say that the file name for the child manifest for your video rendition is "amazing_video_1.m3u8". Then, in your parent manifest, each value will appear on separate lines, like this: #EXT-X-STREAM-INF:AUDIO="audio_aac_1"... amazing_video_1.m3u8 #EXT-X-STREAM-INF:AUDIO="audio_dolby"... amazing_video_1.m3u8

Definition at line 373 of file CmfcSettings.h.

◆ WithAudioRenditionSets() [3/3]

CmfcSettings& Aws::MediaConvert::Model::CmfcSettings::WithAudioRenditionSets ( const char *  value)
inline

List the audio rendition groups that you want included with this video rendition. Use a comma-separated list. For example, say you want to include the audio rendition groups that have the audio group IDs "audio_aac_1" and "audio_dolby". Then you would specify this value: "audio_aac_1, audio_dolby". Related setting: The rendition groups that you include in your comma-separated list should all match values that you specify in the setting Audio group ID (AudioGroupId) for audio renditions in the same output group as this video rendition. Default behavior: If you don't specify anything here and for Audio group ID, MediaConvert puts each audio variant in its own audio rendition group and associates it with every video variant. Each value in your list appears in your HLS parent manifest in the EXT-X-STREAM-INF tag as the value for the AUDIO attribute. To continue the previous example, say that the file name for the child manifest for your video rendition is "amazing_video_1.m3u8". Then, in your parent manifest, each value will appear on separate lines, like this: #EXT-X-STREAM-INF:AUDIO="audio_aac_1"... amazing_video_1.m3u8 #EXT-X-STREAM-INF:AUDIO="audio_dolby"... amazing_video_1.m3u8

Definition at line 413 of file CmfcSettings.h.

◆ WithAudioTrackType() [1/2]

CmfcSettings& Aws::MediaConvert::Model::CmfcSettings::WithAudioTrackType ( CmfcAudioTrackType &&  value)
inline

Use this setting to control the values that MediaConvert puts in your HLS parent playlist to control how the client player selects which audio track to play. The other options for this setting determine the values that MediaConvert writes for the DEFAULT and AUTOSELECT attributes of the EXT-X-MEDIA entry for the audio variant. For more information about these attributes, see the Apple documentation article https://developer.apple.com/documentation/http_live_streaming/example_playlists_for_http_live_streaming/adding_alternate_media_to_a_playlist. Choose Alternate audio, auto select, default (ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT) to set DEFAULT=YES and AUTOSELECT=YES. Choose this value for only one variant in your output group. Choose Alternate audio, auto select, not default (ALTERNATE_AUDIO_AUTO_SELECT) to set DEFAULT=NO and AUTOSELECT=YES. Choose Alternate Audio, Not Auto Select to set DEFAULT=NO and AUTOSELECT=NO. When you don't specify a value for this setting, MediaConvert defaults to Alternate audio, auto select, default. When there is more than one variant in your output group, you must explicitly choose a value for this setting.

Definition at line 534 of file CmfcSettings.h.

◆ WithAudioTrackType() [2/2]

CmfcSettings& Aws::MediaConvert::Model::CmfcSettings::WithAudioTrackType ( const CmfcAudioTrackType value)
inline

Use this setting to control the values that MediaConvert puts in your HLS parent playlist to control how the client player selects which audio track to play. The other options for this setting determine the values that MediaConvert writes for the DEFAULT and AUTOSELECT attributes of the EXT-X-MEDIA entry for the audio variant. For more information about these attributes, see the Apple documentation article https://developer.apple.com/documentation/http_live_streaming/example_playlists_for_http_live_streaming/adding_alternate_media_to_a_playlist. Choose Alternate audio, auto select, default (ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT) to set DEFAULT=YES and AUTOSELECT=YES. Choose this value for only one variant in your output group. Choose Alternate audio, auto select, not default (ALTERNATE_AUDIO_AUTO_SELECT) to set DEFAULT=NO and AUTOSELECT=YES. Choose Alternate Audio, Not Auto Select to set DEFAULT=NO and AUTOSELECT=NO. When you don't specify a value for this setting, MediaConvert defaults to Alternate audio, auto select, default. When there is more than one variant in your output group, you must explicitly choose a value for this setting.

Definition at line 514 of file CmfcSettings.h.

◆ WithDescriptiveVideoServiceFlag() [1/2]

CmfcSettings& Aws::MediaConvert::Model::CmfcSettings::WithDescriptiveVideoServiceFlag ( CmfcDescriptiveVideoServiceFlag &&  value)
inline

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.

Definition at line 601 of file CmfcSettings.h.

◆ WithDescriptiveVideoServiceFlag() [2/2]

CmfcSettings& Aws::MediaConvert::Model::CmfcSettings::WithDescriptiveVideoServiceFlag ( const CmfcDescriptiveVideoServiceFlag value)
inline

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.

Definition at line 590 of file CmfcSettings.h.

◆ WithIFrameOnlyManifest() [1/2]

CmfcSettings& Aws::MediaConvert::Model::CmfcSettings::WithIFrameOnlyManifest ( CmfcIFrameOnlyManifest &&  value)
inline

Choose Include (INCLUDE) to have MediaConvert generate an HLS 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).

Definition at line 668 of file CmfcSettings.h.

◆ WithIFrameOnlyManifest() [2/2]

CmfcSettings& Aws::MediaConvert::Model::CmfcSettings::WithIFrameOnlyManifest ( const CmfcIFrameOnlyManifest value)
inline

Choose Include (INCLUDE) to have MediaConvert generate an HLS 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).

Definition at line 657 of file CmfcSettings.h.

◆ WithScte35Esam() [1/2]

CmfcSettings& Aws::MediaConvert::Model::CmfcSettings::WithScte35Esam ( CmfcScte35Esam &&  value)
inline

Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).

Definition at line 711 of file CmfcSettings.h.

◆ WithScte35Esam() [2/2]

CmfcSettings& Aws::MediaConvert::Model::CmfcSettings::WithScte35Esam ( const CmfcScte35Esam value)
inline

Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).

Definition at line 704 of file CmfcSettings.h.

◆ WithScte35Source() [1/2]

CmfcSettings& Aws::MediaConvert::Model::CmfcSettings::WithScte35Source ( CmfcScte35Source &&  value)
inline

Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output.

Definition at line 760 of file CmfcSettings.h.

◆ WithScte35Source() [2/2]

CmfcSettings& Aws::MediaConvert::Model::CmfcSettings::WithScte35Source ( const CmfcScte35Source value)
inline

Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output.

Definition at line 752 of file CmfcSettings.h.


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