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

#include <HlsGroupSettings.h>

Public Member Functions

 HlsGroupSettings ()
 
 HlsGroupSettings (Aws::Utils::Json::JsonView jsonValue)
 
HlsGroupSettingsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Vector< HlsAdMarkers > & GetAdMarkers () const
 
bool AdMarkersHasBeenSet () const
 
void SetAdMarkers (const Aws::Vector< HlsAdMarkers > &value)
 
void SetAdMarkers (Aws::Vector< HlsAdMarkers > &&value)
 
HlsGroupSettingsWithAdMarkers (const Aws::Vector< HlsAdMarkers > &value)
 
HlsGroupSettingsWithAdMarkers (Aws::Vector< HlsAdMarkers > &&value)
 
HlsGroupSettingsAddAdMarkers (const HlsAdMarkers &value)
 
HlsGroupSettingsAddAdMarkers (HlsAdMarkers &&value)
 
const Aws::Vector< HlsAdditionalManifest > & GetAdditionalManifests () const
 
bool AdditionalManifestsHasBeenSet () const
 
void SetAdditionalManifests (const Aws::Vector< HlsAdditionalManifest > &value)
 
void SetAdditionalManifests (Aws::Vector< HlsAdditionalManifest > &&value)
 
HlsGroupSettingsWithAdditionalManifests (const Aws::Vector< HlsAdditionalManifest > &value)
 
HlsGroupSettingsWithAdditionalManifests (Aws::Vector< HlsAdditionalManifest > &&value)
 
HlsGroupSettingsAddAdditionalManifests (const HlsAdditionalManifest &value)
 
HlsGroupSettingsAddAdditionalManifests (HlsAdditionalManifest &&value)
 
const HlsAudioOnlyHeaderGetAudioOnlyHeader () const
 
bool AudioOnlyHeaderHasBeenSet () const
 
void SetAudioOnlyHeader (const HlsAudioOnlyHeader &value)
 
void SetAudioOnlyHeader (HlsAudioOnlyHeader &&value)
 
HlsGroupSettingsWithAudioOnlyHeader (const HlsAudioOnlyHeader &value)
 
HlsGroupSettingsWithAudioOnlyHeader (HlsAudioOnlyHeader &&value)
 
const Aws::StringGetBaseUrl () const
 
bool BaseUrlHasBeenSet () const
 
void SetBaseUrl (const Aws::String &value)
 
void SetBaseUrl (Aws::String &&value)
 
void SetBaseUrl (const char *value)
 
HlsGroupSettingsWithBaseUrl (const Aws::String &value)
 
HlsGroupSettingsWithBaseUrl (Aws::String &&value)
 
HlsGroupSettingsWithBaseUrl (const char *value)
 
const Aws::Vector< HlsCaptionLanguageMapping > & GetCaptionLanguageMappings () const
 
bool CaptionLanguageMappingsHasBeenSet () const
 
void SetCaptionLanguageMappings (const Aws::Vector< HlsCaptionLanguageMapping > &value)
 
void SetCaptionLanguageMappings (Aws::Vector< HlsCaptionLanguageMapping > &&value)
 
HlsGroupSettingsWithCaptionLanguageMappings (const Aws::Vector< HlsCaptionLanguageMapping > &value)
 
HlsGroupSettingsWithCaptionLanguageMappings (Aws::Vector< HlsCaptionLanguageMapping > &&value)
 
HlsGroupSettingsAddCaptionLanguageMappings (const HlsCaptionLanguageMapping &value)
 
HlsGroupSettingsAddCaptionLanguageMappings (HlsCaptionLanguageMapping &&value)
 
const HlsCaptionLanguageSettingGetCaptionLanguageSetting () const
 
bool CaptionLanguageSettingHasBeenSet () const
 
void SetCaptionLanguageSetting (const HlsCaptionLanguageSetting &value)
 
void SetCaptionLanguageSetting (HlsCaptionLanguageSetting &&value)
 
HlsGroupSettingsWithCaptionLanguageSetting (const HlsCaptionLanguageSetting &value)
 
HlsGroupSettingsWithCaptionLanguageSetting (HlsCaptionLanguageSetting &&value)
 
const HlsClientCacheGetClientCache () const
 
bool ClientCacheHasBeenSet () const
 
void SetClientCache (const HlsClientCache &value)
 
void SetClientCache (HlsClientCache &&value)
 
HlsGroupSettingsWithClientCache (const HlsClientCache &value)
 
HlsGroupSettingsWithClientCache (HlsClientCache &&value)
 
const HlsCodecSpecificationGetCodecSpecification () const
 
bool CodecSpecificationHasBeenSet () const
 
void SetCodecSpecification (const HlsCodecSpecification &value)
 
void SetCodecSpecification (HlsCodecSpecification &&value)
 
HlsGroupSettingsWithCodecSpecification (const HlsCodecSpecification &value)
 
HlsGroupSettingsWithCodecSpecification (HlsCodecSpecification &&value)
 
const Aws::StringGetDestination () const
 
bool DestinationHasBeenSet () const
 
void SetDestination (const Aws::String &value)
 
void SetDestination (Aws::String &&value)
 
void SetDestination (const char *value)
 
HlsGroupSettingsWithDestination (const Aws::String &value)
 
HlsGroupSettingsWithDestination (Aws::String &&value)
 
HlsGroupSettingsWithDestination (const char *value)
 
const DestinationSettingsGetDestinationSettings () const
 
bool DestinationSettingsHasBeenSet () const
 
void SetDestinationSettings (const DestinationSettings &value)
 
void SetDestinationSettings (DestinationSettings &&value)
 
HlsGroupSettingsWithDestinationSettings (const DestinationSettings &value)
 
HlsGroupSettingsWithDestinationSettings (DestinationSettings &&value)
 
const HlsDirectoryStructureGetDirectoryStructure () const
 
bool DirectoryStructureHasBeenSet () const
 
void SetDirectoryStructure (const HlsDirectoryStructure &value)
 
void SetDirectoryStructure (HlsDirectoryStructure &&value)
 
HlsGroupSettingsWithDirectoryStructure (const HlsDirectoryStructure &value)
 
HlsGroupSettingsWithDirectoryStructure (HlsDirectoryStructure &&value)
 
const HlsEncryptionSettingsGetEncryption () const
 
bool EncryptionHasBeenSet () const
 
void SetEncryption (const HlsEncryptionSettings &value)
 
void SetEncryption (HlsEncryptionSettings &&value)
 
HlsGroupSettingsWithEncryption (const HlsEncryptionSettings &value)
 
HlsGroupSettingsWithEncryption (HlsEncryptionSettings &&value)
 
const HlsImageBasedTrickPlayGetImageBasedTrickPlay () const
 
bool ImageBasedTrickPlayHasBeenSet () const
 
void SetImageBasedTrickPlay (const HlsImageBasedTrickPlay &value)
 
void SetImageBasedTrickPlay (HlsImageBasedTrickPlay &&value)
 
HlsGroupSettingsWithImageBasedTrickPlay (const HlsImageBasedTrickPlay &value)
 
HlsGroupSettingsWithImageBasedTrickPlay (HlsImageBasedTrickPlay &&value)
 
const HlsImageBasedTrickPlaySettingsGetImageBasedTrickPlaySettings () const
 
bool ImageBasedTrickPlaySettingsHasBeenSet () const
 
void SetImageBasedTrickPlaySettings (const HlsImageBasedTrickPlaySettings &value)
 
void SetImageBasedTrickPlaySettings (HlsImageBasedTrickPlaySettings &&value)
 
HlsGroupSettingsWithImageBasedTrickPlaySettings (const HlsImageBasedTrickPlaySettings &value)
 
HlsGroupSettingsWithImageBasedTrickPlaySettings (HlsImageBasedTrickPlaySettings &&value)
 
const HlsManifestCompressionGetManifestCompression () const
 
bool ManifestCompressionHasBeenSet () const
 
void SetManifestCompression (const HlsManifestCompression &value)
 
void SetManifestCompression (HlsManifestCompression &&value)
 
HlsGroupSettingsWithManifestCompression (const HlsManifestCompression &value)
 
HlsGroupSettingsWithManifestCompression (HlsManifestCompression &&value)
 
const HlsManifestDurationFormatGetManifestDurationFormat () const
 
bool ManifestDurationFormatHasBeenSet () const
 
void SetManifestDurationFormat (const HlsManifestDurationFormat &value)
 
void SetManifestDurationFormat (HlsManifestDurationFormat &&value)
 
HlsGroupSettingsWithManifestDurationFormat (const HlsManifestDurationFormat &value)
 
HlsGroupSettingsWithManifestDurationFormat (HlsManifestDurationFormat &&value)
 
double GetMinFinalSegmentLength () const
 
bool MinFinalSegmentLengthHasBeenSet () const
 
void SetMinFinalSegmentLength (double value)
 
HlsGroupSettingsWithMinFinalSegmentLength (double value)
 
int GetMinSegmentLength () const
 
bool MinSegmentLengthHasBeenSet () const
 
void SetMinSegmentLength (int value)
 
HlsGroupSettingsWithMinSegmentLength (int value)
 
const HlsOutputSelectionGetOutputSelection () const
 
bool OutputSelectionHasBeenSet () const
 
void SetOutputSelection (const HlsOutputSelection &value)
 
void SetOutputSelection (HlsOutputSelection &&value)
 
HlsGroupSettingsWithOutputSelection (const HlsOutputSelection &value)
 
HlsGroupSettingsWithOutputSelection (HlsOutputSelection &&value)
 
const HlsProgramDateTimeGetProgramDateTime () const
 
bool ProgramDateTimeHasBeenSet () const
 
void SetProgramDateTime (const HlsProgramDateTime &value)
 
void SetProgramDateTime (HlsProgramDateTime &&value)
 
HlsGroupSettingsWithProgramDateTime (const HlsProgramDateTime &value)
 
HlsGroupSettingsWithProgramDateTime (HlsProgramDateTime &&value)
 
int GetProgramDateTimePeriod () const
 
bool ProgramDateTimePeriodHasBeenSet () const
 
void SetProgramDateTimePeriod (int value)
 
HlsGroupSettingsWithProgramDateTimePeriod (int value)
 
const HlsSegmentControlGetSegmentControl () const
 
bool SegmentControlHasBeenSet () const
 
void SetSegmentControl (const HlsSegmentControl &value)
 
void SetSegmentControl (HlsSegmentControl &&value)
 
HlsGroupSettingsWithSegmentControl (const HlsSegmentControl &value)
 
HlsGroupSettingsWithSegmentControl (HlsSegmentControl &&value)
 
int GetSegmentLength () const
 
bool SegmentLengthHasBeenSet () const
 
void SetSegmentLength (int value)
 
HlsGroupSettingsWithSegmentLength (int value)
 
const HlsSegmentLengthControlGetSegmentLengthControl () const
 
bool SegmentLengthControlHasBeenSet () const
 
void SetSegmentLengthControl (const HlsSegmentLengthControl &value)
 
void SetSegmentLengthControl (HlsSegmentLengthControl &&value)
 
HlsGroupSettingsWithSegmentLengthControl (const HlsSegmentLengthControl &value)
 
HlsGroupSettingsWithSegmentLengthControl (HlsSegmentLengthControl &&value)
 
int GetSegmentsPerSubdirectory () const
 
bool SegmentsPerSubdirectoryHasBeenSet () const
 
void SetSegmentsPerSubdirectory (int value)
 
HlsGroupSettingsWithSegmentsPerSubdirectory (int value)
 
const HlsStreamInfResolutionGetStreamInfResolution () const
 
bool StreamInfResolutionHasBeenSet () const
 
void SetStreamInfResolution (const HlsStreamInfResolution &value)
 
void SetStreamInfResolution (HlsStreamInfResolution &&value)
 
HlsGroupSettingsWithStreamInfResolution (const HlsStreamInfResolution &value)
 
HlsGroupSettingsWithStreamInfResolution (HlsStreamInfResolution &&value)
 
const HlsTargetDurationCompatibilityModeGetTargetDurationCompatibilityMode () const
 
bool TargetDurationCompatibilityModeHasBeenSet () const
 
void SetTargetDurationCompatibilityMode (const HlsTargetDurationCompatibilityMode &value)
 
void SetTargetDurationCompatibilityMode (HlsTargetDurationCompatibilityMode &&value)
 
HlsGroupSettingsWithTargetDurationCompatibilityMode (const HlsTargetDurationCompatibilityMode &value)
 
HlsGroupSettingsWithTargetDurationCompatibilityMode (HlsTargetDurationCompatibilityMode &&value)
 
const HlsTimedMetadataId3FrameGetTimedMetadataId3Frame () const
 
bool TimedMetadataId3FrameHasBeenSet () const
 
void SetTimedMetadataId3Frame (const HlsTimedMetadataId3Frame &value)
 
void SetTimedMetadataId3Frame (HlsTimedMetadataId3Frame &&value)
 
HlsGroupSettingsWithTimedMetadataId3Frame (const HlsTimedMetadataId3Frame &value)
 
HlsGroupSettingsWithTimedMetadataId3Frame (HlsTimedMetadataId3Frame &&value)
 
int GetTimedMetadataId3Period () const
 
bool TimedMetadataId3PeriodHasBeenSet () const
 
void SetTimedMetadataId3Period (int value)
 
HlsGroupSettingsWithTimedMetadataId3Period (int value)
 
int GetTimestampDeltaMilliseconds () const
 
bool TimestampDeltaMillisecondsHasBeenSet () const
 
void SetTimestampDeltaMilliseconds (int value)
 
HlsGroupSettingsWithTimestampDeltaMilliseconds (int value)
 

Detailed Description

Settings related to your HLS output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work directly in your JSON job specification, include this object and any required children when you set Type, under OutputGroupSettings, to HLS_GROUP_SETTINGS.

See Also:

AWS API Reference

Definition at line 57 of file HlsGroupSettings.h.

Constructor & Destructor Documentation

◆ HlsGroupSettings() [1/2]

Aws::MediaConvert::Model::HlsGroupSettings::HlsGroupSettings ( )

◆ HlsGroupSettings() [2/2]

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

Member Function Documentation

◆ AddAdditionalManifests() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::AddAdditionalManifests ( const HlsAdditionalManifest value)
inline

By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job. This default manifest references every output in the output group. To create additional top-level manifests that reference a subset of the outputs in the output group, specify a list of them here.

Definition at line 177 of file HlsGroupSettings.h.

◆ AddAdditionalManifests() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::AddAdditionalManifests ( HlsAdditionalManifest &&  value)
inline

By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job. This default manifest references every output in the output group. To create additional top-level manifests that reference a subset of the outputs in the output group, specify a list of them here.

Definition at line 185 of file HlsGroupSettings.h.

◆ AddAdMarkers() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::AddAdMarkers ( const HlsAdMarkers value)
inline

Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves.

Definition at line 113 of file HlsGroupSettings.h.

◆ AddAdMarkers() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::AddAdMarkers ( HlsAdMarkers &&  value)
inline

Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves.

Definition at line 120 of file HlsGroupSettings.h.

◆ AddCaptionLanguageMappings() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::AddCaptionLanguageMappings ( const HlsCaptionLanguageMapping value)
inline

Language to be used on Caption outputs

Definition at line 327 of file HlsGroupSettings.h.

◆ AddCaptionLanguageMappings() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::AddCaptionLanguageMappings ( HlsCaptionLanguageMapping &&  value)
inline

Language to be used on Caption outputs

Definition at line 332 of file HlsGroupSettings.h.

◆ AdditionalManifestsHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::AdditionalManifestsHasBeenSet ( ) const
inline

By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job. This default manifest references every output in the output group. To create additional top-level manifests that reference a subset of the outputs in the output group, specify a list of them here.

Definition at line 137 of file HlsGroupSettings.h.

◆ AdMarkersHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::AdMarkersHasBeenSet ( ) const
inline

Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves.

Definition at line 78 of file HlsGroupSettings.h.

◆ AudioOnlyHeaderHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::AudioOnlyHeaderHasBeenSet ( ) const
inline

Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include (INCLUDE), to output audio-only headers. Choose Exclude (EXCLUDE) to remove the audio-only headers from your audio segments.

Definition at line 202 of file HlsGroupSettings.h.

◆ BaseUrlHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::BaseUrlHasBeenSet ( ) const
inline

A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.

Definition at line 249 of file HlsGroupSettings.h.

◆ CaptionLanguageMappingsHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::CaptionLanguageMappingsHasBeenSet ( ) const
inline

Language to be used on Caption outputs

Definition at line 302 of file HlsGroupSettings.h.

◆ CaptionLanguageSettingHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::CaptionLanguageSettingHasBeenSet ( ) const
inline

Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.

Definition at line 359 of file HlsGroupSettings.h.

◆ ClientCacheHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::ClientCacheHasBeenSet ( ) const
inline

Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled (ENABLED) and control caching in your video distribution set up. For example, use the Cache-Control http header.

Definition at line 426 of file HlsGroupSettings.h.

◆ CodecSpecificationHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::CodecSpecificationHasBeenSet ( ) const
inline

Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

Definition at line 467 of file HlsGroupSettings.h.

◆ DestinationHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::DestinationHasBeenSet ( ) const
inline

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

Definition at line 510 of file HlsGroupSettings.h.

◆ DestinationSettingsHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::DestinationSettingsHasBeenSet ( ) const
inline

Settings associated with the destination. Will vary based on the type of destination

Definition at line 577 of file HlsGroupSettings.h.

◆ DirectoryStructureHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::DirectoryStructureHasBeenSet ( ) const
inline

Indicates whether segments should be placed in subdirectories.

Definition at line 612 of file HlsGroupSettings.h.

◆ EncryptionHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::EncryptionHasBeenSet ( ) const
inline

DRM settings.

Definition at line 643 of file HlsGroupSettings.h.

◆ GetAdditionalManifests()

const Aws::Vector<HlsAdditionalManifest>& Aws::MediaConvert::Model::HlsGroupSettings::GetAdditionalManifests ( ) const
inline

By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job. This default manifest references every output in the output group. To create additional top-level manifests that reference a subset of the outputs in the output group, specify a list of them here.

Definition at line 129 of file HlsGroupSettings.h.

◆ GetAdMarkers()

const Aws::Vector<HlsAdMarkers>& Aws::MediaConvert::Model::HlsGroupSettings::GetAdMarkers ( ) const
inline

Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves.

Definition at line 71 of file HlsGroupSettings.h.

◆ GetAudioOnlyHeader()

const HlsAudioOnlyHeader& Aws::MediaConvert::Model::HlsGroupSettings::GetAudioOnlyHeader ( ) const
inline

Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include (INCLUDE), to output audio-only headers. Choose Exclude (EXCLUDE) to remove the audio-only headers from your audio segments.

Definition at line 194 of file HlsGroupSettings.h.

◆ GetBaseUrl()

const Aws::String& Aws::MediaConvert::Model::HlsGroupSettings::GetBaseUrl ( ) const
inline

A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.

Definition at line 242 of file HlsGroupSettings.h.

◆ GetCaptionLanguageMappings()

const Aws::Vector<HlsCaptionLanguageMapping>& Aws::MediaConvert::Model::HlsGroupSettings::GetCaptionLanguageMappings ( ) const
inline

Language to be used on Caption outputs

Definition at line 297 of file HlsGroupSettings.h.

◆ GetCaptionLanguageSetting()

const HlsCaptionLanguageSetting& Aws::MediaConvert::Model::HlsGroupSettings::GetCaptionLanguageSetting ( ) const
inline

Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.

Definition at line 346 of file HlsGroupSettings.h.

◆ GetClientCache()

const HlsClientCache& Aws::MediaConvert::Model::HlsGroupSettings::GetClientCache ( ) const
inline

Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled (ENABLED) and control caching in your video distribution set up. For example, use the Cache-Control http header.

Definition at line 419 of file HlsGroupSettings.h.

◆ GetCodecSpecification()

const HlsCodecSpecification& Aws::MediaConvert::Model::HlsGroupSettings::GetCodecSpecification ( ) const
inline

Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

Definition at line 461 of file HlsGroupSettings.h.

◆ GetDestination()

const Aws::String& Aws::MediaConvert::Model::HlsGroupSettings::GetDestination ( ) const
inline

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

Definition at line 501 of file HlsGroupSettings.h.

◆ GetDestinationSettings()

const DestinationSettings& Aws::MediaConvert::Model::HlsGroupSettings::GetDestinationSettings ( ) const
inline

Settings associated with the destination. Will vary based on the type of destination

Definition at line 571 of file HlsGroupSettings.h.

◆ GetDirectoryStructure()

const HlsDirectoryStructure& Aws::MediaConvert::Model::HlsGroupSettings::GetDirectoryStructure ( ) const
inline

Indicates whether segments should be placed in subdirectories.

Definition at line 607 of file HlsGroupSettings.h.

◆ GetEncryption()

const HlsEncryptionSettings& Aws::MediaConvert::Model::HlsGroupSettings::GetEncryption ( ) const
inline

DRM settings.

Definition at line 638 of file HlsGroupSettings.h.

◆ GetImageBasedTrickPlay()

const HlsImageBasedTrickPlay& Aws::MediaConvert::Model::HlsGroupSettings::GetImageBasedTrickPlay ( ) const
inline

Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails and full-resolution images of single frames. MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md

Definition at line 678 of file HlsGroupSettings.h.

◆ GetImageBasedTrickPlaySettings()

const HlsImageBasedTrickPlaySettings& Aws::MediaConvert::Model::HlsGroupSettings::GetImageBasedTrickPlaySettings ( ) const
inline

Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED

Definition at line 754 of file HlsGroupSettings.h.

◆ GetManifestCompression()

const HlsManifestCompression& Aws::MediaConvert::Model::HlsGroupSettings::GetManifestCompression ( ) const
inline

When set to GZIP, compresses HLS playlist.

Definition at line 785 of file HlsGroupSettings.h.

◆ GetManifestDurationFormat()

const HlsManifestDurationFormat& Aws::MediaConvert::Model::HlsGroupSettings::GetManifestDurationFormat ( ) const
inline

Indicates whether the output manifest should use floating point values for segment duration.

Definition at line 817 of file HlsGroupSettings.h.

◆ GetMinFinalSegmentLength()

double Aws::MediaConvert::Model::HlsGroupSettings::GetMinFinalSegmentLength ( ) const
inline

Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds.

Definition at line 863 of file HlsGroupSettings.h.

◆ GetMinSegmentLength()

int Aws::MediaConvert::Model::HlsGroupSettings::GetMinSegmentLength ( ) const
inline

When set, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.

Definition at line 915 of file HlsGroupSettings.h.

◆ GetOutputSelection()

const HlsOutputSelection& Aws::MediaConvert::Model::HlsGroupSettings::GetOutputSelection ( ) const
inline

Indicates whether the .m3u8 manifest file should be generated for this HLS output group.

Definition at line 940 of file HlsGroupSettings.h.

◆ GetProgramDateTime()

const HlsProgramDateTime& Aws::MediaConvert::Model::HlsGroupSettings::GetProgramDateTime ( ) const
inline

Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset.

Definition at line 979 of file HlsGroupSettings.h.

◆ GetProgramDateTimePeriod()

int Aws::MediaConvert::Model::HlsGroupSettings::GetProgramDateTimePeriod ( ) const
inline

Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.

Definition at line 1025 of file HlsGroupSettings.h.

◆ GetSegmentControl()

const HlsSegmentControl& Aws::MediaConvert::Model::HlsGroupSettings::GetSegmentControl ( ) const
inline

When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.

Definition at line 1047 of file HlsGroupSettings.h.

◆ GetSegmentLength()

int Aws::MediaConvert::Model::HlsGroupSettings::GetSegmentLength ( ) const
inline

Specify the length, in whole seconds, of each segment. When you don't specify a value, MediaConvert defaults to 10. Related settings: Use Segment length control (SegmentLengthControl) to specify whether the encoder enforces this value strictly. Use Segment control (HlsSegmentControl) to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries.

Definition at line 1088 of file HlsGroupSettings.h.

◆ GetSegmentLengthControl()

const HlsSegmentLengthControl& Aws::MediaConvert::Model::HlsGroupSettings::GetSegmentLengthControl ( ) const
inline

Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary.

Definition at line 1128 of file HlsGroupSettings.h.

◆ GetSegmentsPerSubdirectory()

int Aws::MediaConvert::Model::HlsGroupSettings::GetSegmentsPerSubdirectory ( ) const
inline

Number of segments to write to a subdirectory before starting a new one. directoryStructure must be SINGLE_DIRECTORY for this setting to have an effect.

Definition at line 1180 of file HlsGroupSettings.h.

◆ GetStreamInfResolution()

const HlsStreamInfResolution& Aws::MediaConvert::Model::HlsGroupSettings::GetStreamInfResolution ( ) const
inline

Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.

Definition at line 1205 of file HlsGroupSettings.h.

◆ GetTargetDurationCompatibilityMode()

const HlsTargetDurationCompatibilityMode& Aws::MediaConvert::Model::HlsGroupSettings::GetTargetDurationCompatibilityMode ( ) const
inline

When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its current value in seconds. When set to SPEC\_COMPLIANT, the segment target duration is rounded up to the nearest integer value if fraction seconds are greater than or equal to 0.5 (>= 0.5) and rounded down if less than 0.5 (< 0.5). You may need to use LEGACY if your client needs to ensure that the target duration is always longer than the actual duration of the segment. Some older players may experience interrupted playback when the actual duration of a track in a segment is longer than the target duration.

Definition at line 1249 of file HlsGroupSettings.h.

◆ GetTimedMetadataId3Frame()

const HlsTimedMetadataId3Frame& Aws::MediaConvert::Model::HlsGroupSettings::GetTimedMetadataId3Frame ( ) const
inline

Indicates ID3 frame that has the timecode.

Definition at line 1320 of file HlsGroupSettings.h.

◆ GetTimedMetadataId3Period()

int Aws::MediaConvert::Model::HlsGroupSettings::GetTimedMetadataId3Period ( ) const
inline

Timed Metadata interval in seconds.

Definition at line 1351 of file HlsGroupSettings.h.

◆ GetTimestampDeltaMilliseconds()

int Aws::MediaConvert::Model::HlsGroupSettings::GetTimestampDeltaMilliseconds ( ) const
inline

Provides an extra millisecond delta offset to fine tune the timestamps.

Definition at line 1372 of file HlsGroupSettings.h.

◆ ImageBasedTrickPlayHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::ImageBasedTrickPlayHasBeenSet ( ) const
inline

Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails and full-resolution images of single frames. MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md

Definition at line 692 of file HlsGroupSettings.h.

◆ ImageBasedTrickPlaySettingsHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::ImageBasedTrickPlaySettingsHasBeenSet ( ) const
inline

Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED

Definition at line 759 of file HlsGroupSettings.h.

◆ Jsonize()

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

◆ ManifestCompressionHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::ManifestCompressionHasBeenSet ( ) const
inline

When set to GZIP, compresses HLS playlist.

Definition at line 790 of file HlsGroupSettings.h.

◆ ManifestDurationFormatHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::ManifestDurationFormatHasBeenSet ( ) const
inline

Indicates whether the output manifest should use floating point values for segment duration.

Definition at line 823 of file HlsGroupSettings.h.

◆ MinFinalSegmentLengthHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::MinFinalSegmentLengthHasBeenSet ( ) const
inline

Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds.

Definition at line 878 of file HlsGroupSettings.h.

◆ MinSegmentLengthHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::MinSegmentLengthHasBeenSet ( ) const
inline

When set, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.

Definition at line 921 of file HlsGroupSettings.h.

◆ operator=()

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

◆ OutputSelectionHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::OutputSelectionHasBeenSet ( ) const
inline

Indicates whether the .m3u8 manifest file should be generated for this HLS output group.

Definition at line 946 of file HlsGroupSettings.h.

◆ ProgramDateTimeHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::ProgramDateTimeHasBeenSet ( ) const
inline

Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset.

Definition at line 987 of file HlsGroupSettings.h.

◆ ProgramDateTimePeriodHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::ProgramDateTimePeriodHasBeenSet ( ) const
inline

Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.

Definition at line 1030 of file HlsGroupSettings.h.

◆ SegmentControlHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::SegmentControlHasBeenSet ( ) const
inline

When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.

Definition at line 1053 of file HlsGroupSettings.h.

◆ SegmentLengthControlHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::SegmentLengthControlHasBeenSet ( ) const
inline

Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary.

Definition at line 1137 of file HlsGroupSettings.h.

◆ SegmentLengthHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::SegmentLengthHasBeenSet ( ) const
inline

Specify the length, in whole seconds, of each segment. When you don't specify a value, MediaConvert defaults to 10. Related settings: Use Segment length control (SegmentLengthControl) to specify whether the encoder enforces this value strictly. Use Segment control (HlsSegmentControl) to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries.

Definition at line 1098 of file HlsGroupSettings.h.

◆ SegmentsPerSubdirectoryHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::SegmentsPerSubdirectoryHasBeenSet ( ) const
inline

Number of segments to write to a subdirectory before starting a new one. directoryStructure must be SINGLE_DIRECTORY for this setting to have an effect.

Definition at line 1186 of file HlsGroupSettings.h.

◆ SetAdditionalManifests() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetAdditionalManifests ( Aws::Vector< HlsAdditionalManifest > &&  value)
inline

By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job. This default manifest references every output in the output group. To create additional top-level manifests that reference a subset of the outputs in the output group, specify a list of them here.

Definition at line 153 of file HlsGroupSettings.h.

◆ SetAdditionalManifests() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetAdditionalManifests ( const Aws::Vector< HlsAdditionalManifest > &  value)
inline

By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job. This default manifest references every output in the output group. To create additional top-level manifests that reference a subset of the outputs in the output group, specify a list of them here.

Definition at line 145 of file HlsGroupSettings.h.

◆ SetAdMarkers() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetAdMarkers ( Aws::Vector< HlsAdMarkers > &&  value)
inline

Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves.

Definition at line 92 of file HlsGroupSettings.h.

◆ SetAdMarkers() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetAdMarkers ( const Aws::Vector< HlsAdMarkers > &  value)
inline

Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves.

Definition at line 85 of file HlsGroupSettings.h.

◆ SetAudioOnlyHeader() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetAudioOnlyHeader ( const HlsAudioOnlyHeader value)
inline

Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include (INCLUDE), to output audio-only headers. Choose Exclude (EXCLUDE) to remove the audio-only headers from your audio segments.

Definition at line 210 of file HlsGroupSettings.h.

◆ SetAudioOnlyHeader() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetAudioOnlyHeader ( HlsAudioOnlyHeader &&  value)
inline

Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include (INCLUDE), to output audio-only headers. Choose Exclude (EXCLUDE) to remove the audio-only headers from your audio segments.

Definition at line 218 of file HlsGroupSettings.h.

◆ SetBaseUrl() [1/3]

void Aws::MediaConvert::Model::HlsGroupSettings::SetBaseUrl ( Aws::String &&  value)
inline

A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.

Definition at line 263 of file HlsGroupSettings.h.

◆ SetBaseUrl() [2/3]

void Aws::MediaConvert::Model::HlsGroupSettings::SetBaseUrl ( const Aws::String value)
inline

A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.

Definition at line 256 of file HlsGroupSettings.h.

◆ SetBaseUrl() [3/3]

void Aws::MediaConvert::Model::HlsGroupSettings::SetBaseUrl ( const char *  value)
inline

A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.

Definition at line 270 of file HlsGroupSettings.h.

◆ SetCaptionLanguageMappings() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetCaptionLanguageMappings ( Aws::Vector< HlsCaptionLanguageMapping > &&  value)
inline

Language to be used on Caption outputs

Definition at line 312 of file HlsGroupSettings.h.

◆ SetCaptionLanguageMappings() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetCaptionLanguageMappings ( const Aws::Vector< HlsCaptionLanguageMapping > &  value)
inline

Language to be used on Caption outputs

Definition at line 307 of file HlsGroupSettings.h.

◆ SetCaptionLanguageSetting() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetCaptionLanguageSetting ( const HlsCaptionLanguageSetting value)
inline

Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.

Definition at line 372 of file HlsGroupSettings.h.

◆ SetCaptionLanguageSetting() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetCaptionLanguageSetting ( HlsCaptionLanguageSetting &&  value)
inline

Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.

Definition at line 385 of file HlsGroupSettings.h.

◆ SetClientCache() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetClientCache ( const HlsClientCache value)
inline

Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled (ENABLED) and control caching in your video distribution set up. For example, use the Cache-Control http header.

Definition at line 433 of file HlsGroupSettings.h.

◆ SetClientCache() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetClientCache ( HlsClientCache &&  value)
inline

Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled (ENABLED) and control caching in your video distribution set up. For example, use the Cache-Control http header.

Definition at line 440 of file HlsGroupSettings.h.

◆ SetCodecSpecification() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetCodecSpecification ( const HlsCodecSpecification value)
inline

Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

Definition at line 473 of file HlsGroupSettings.h.

◆ SetCodecSpecification() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetCodecSpecification ( HlsCodecSpecification &&  value)
inline

Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

Definition at line 479 of file HlsGroupSettings.h.

◆ SetDestination() [1/3]

void Aws::MediaConvert::Model::HlsGroupSettings::SetDestination ( Aws::String &&  value)
inline

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

Definition at line 528 of file HlsGroupSettings.h.

◆ SetDestination() [2/3]

void Aws::MediaConvert::Model::HlsGroupSettings::SetDestination ( const Aws::String value)
inline

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

Definition at line 519 of file HlsGroupSettings.h.

◆ SetDestination() [3/3]

void Aws::MediaConvert::Model::HlsGroupSettings::SetDestination ( const char *  value)
inline

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

Definition at line 537 of file HlsGroupSettings.h.

◆ SetDestinationSettings() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetDestinationSettings ( const DestinationSettings value)
inline

Settings associated with the destination. Will vary based on the type of destination

Definition at line 583 of file HlsGroupSettings.h.

◆ SetDestinationSettings() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetDestinationSettings ( DestinationSettings &&  value)
inline

Settings associated with the destination. Will vary based on the type of destination

Definition at line 589 of file HlsGroupSettings.h.

◆ SetDirectoryStructure() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetDirectoryStructure ( const HlsDirectoryStructure value)
inline

Indicates whether segments should be placed in subdirectories.

Definition at line 617 of file HlsGroupSettings.h.

◆ SetDirectoryStructure() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetDirectoryStructure ( HlsDirectoryStructure &&  value)
inline

Indicates whether segments should be placed in subdirectories.

Definition at line 622 of file HlsGroupSettings.h.

◆ SetEncryption() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetEncryption ( const HlsEncryptionSettings value)
inline

DRM settings.

Definition at line 648 of file HlsGroupSettings.h.

◆ SetEncryption() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetEncryption ( HlsEncryptionSettings &&  value)
inline

DRM settings.

Definition at line 653 of file HlsGroupSettings.h.

◆ SetImageBasedTrickPlay() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetImageBasedTrickPlay ( const HlsImageBasedTrickPlay value)
inline

Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails and full-resolution images of single frames. MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md

Definition at line 706 of file HlsGroupSettings.h.

◆ SetImageBasedTrickPlay() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetImageBasedTrickPlay ( HlsImageBasedTrickPlay &&  value)
inline

Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails and full-resolution images of single frames. MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md

Definition at line 720 of file HlsGroupSettings.h.

◆ SetImageBasedTrickPlaySettings() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetImageBasedTrickPlaySettings ( const HlsImageBasedTrickPlaySettings value)
inline

Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED

Definition at line 764 of file HlsGroupSettings.h.

◆ SetImageBasedTrickPlaySettings() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetImageBasedTrickPlaySettings ( HlsImageBasedTrickPlaySettings &&  value)
inline

Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED

Definition at line 769 of file HlsGroupSettings.h.

◆ SetManifestCompression() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetManifestCompression ( const HlsManifestCompression value)
inline

When set to GZIP, compresses HLS playlist.

Definition at line 795 of file HlsGroupSettings.h.

◆ SetManifestCompression() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetManifestCompression ( HlsManifestCompression &&  value)
inline

When set to GZIP, compresses HLS playlist.

Definition at line 800 of file HlsGroupSettings.h.

◆ SetManifestDurationFormat() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetManifestDurationFormat ( const HlsManifestDurationFormat value)
inline

Indicates whether the output manifest should use floating point values for segment duration.

Definition at line 829 of file HlsGroupSettings.h.

◆ SetManifestDurationFormat() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetManifestDurationFormat ( HlsManifestDurationFormat &&  value)
inline

Indicates whether the output manifest should use floating point values for segment duration.

Definition at line 835 of file HlsGroupSettings.h.

◆ SetMinFinalSegmentLength()

void Aws::MediaConvert::Model::HlsGroupSettings::SetMinFinalSegmentLength ( double  value)
inline

Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds.

Definition at line 893 of file HlsGroupSettings.h.

◆ SetMinSegmentLength()

void Aws::MediaConvert::Model::HlsGroupSettings::SetMinSegmentLength ( int  value)
inline

When set, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.

Definition at line 927 of file HlsGroupSettings.h.

◆ SetOutputSelection() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetOutputSelection ( const HlsOutputSelection value)
inline

Indicates whether the .m3u8 manifest file should be generated for this HLS output group.

Definition at line 952 of file HlsGroupSettings.h.

◆ SetOutputSelection() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetOutputSelection ( HlsOutputSelection &&  value)
inline

Indicates whether the .m3u8 manifest file should be generated for this HLS output group.

Definition at line 958 of file HlsGroupSettings.h.

◆ SetProgramDateTime() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetProgramDateTime ( const HlsProgramDateTime value)
inline

Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset.

Definition at line 995 of file HlsGroupSettings.h.

◆ SetProgramDateTime() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetProgramDateTime ( HlsProgramDateTime &&  value)
inline

Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset.

Definition at line 1003 of file HlsGroupSettings.h.

◆ SetProgramDateTimePeriod()

void Aws::MediaConvert::Model::HlsGroupSettings::SetProgramDateTimePeriod ( int  value)
inline

Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.

Definition at line 1035 of file HlsGroupSettings.h.

◆ SetSegmentControl() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetSegmentControl ( const HlsSegmentControl value)
inline

When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.

Definition at line 1059 of file HlsGroupSettings.h.

◆ SetSegmentControl() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetSegmentControl ( HlsSegmentControl &&  value)
inline

When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.

Definition at line 1065 of file HlsGroupSettings.h.

◆ SetSegmentLength()

void Aws::MediaConvert::Model::HlsGroupSettings::SetSegmentLength ( int  value)
inline

Specify the length, in whole seconds, of each segment. When you don't specify a value, MediaConvert defaults to 10. Related settings: Use Segment length control (SegmentLengthControl) to specify whether the encoder enforces this value strictly. Use Segment control (HlsSegmentControl) to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries.

Definition at line 1108 of file HlsGroupSettings.h.

◆ SetSegmentLengthControl() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetSegmentLengthControl ( const HlsSegmentLengthControl value)
inline

Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary.

Definition at line 1146 of file HlsGroupSettings.h.

◆ SetSegmentLengthControl() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetSegmentLengthControl ( HlsSegmentLengthControl &&  value)
inline

Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary.

Definition at line 1155 of file HlsGroupSettings.h.

◆ SetSegmentsPerSubdirectory()

void Aws::MediaConvert::Model::HlsGroupSettings::SetSegmentsPerSubdirectory ( int  value)
inline

Number of segments to write to a subdirectory before starting a new one. directoryStructure must be SINGLE_DIRECTORY for this setting to have an effect.

Definition at line 1192 of file HlsGroupSettings.h.

◆ SetStreamInfResolution() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetStreamInfResolution ( const HlsStreamInfResolution value)
inline

Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.

Definition at line 1217 of file HlsGroupSettings.h.

◆ SetStreamInfResolution() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetStreamInfResolution ( HlsStreamInfResolution &&  value)
inline

Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.

Definition at line 1223 of file HlsGroupSettings.h.

◆ SetTargetDurationCompatibilityMode() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetTargetDurationCompatibilityMode ( const HlsTargetDurationCompatibilityMode value)
inline

When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its current value in seconds. When set to SPEC\_COMPLIANT, the segment target duration is rounded up to the nearest integer value if fraction seconds are greater than or equal to 0.5 (>= 0.5) and rounded down if less than 0.5 (< 0.5). You may need to use LEGACY if your client needs to ensure that the target duration is always longer than the actual duration of the segment. Some older players may experience interrupted playback when the actual duration of a track in a segment is longer than the target duration.

Definition at line 1275 of file HlsGroupSettings.h.

◆ SetTargetDurationCompatibilityMode() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetTargetDurationCompatibilityMode ( HlsTargetDurationCompatibilityMode &&  value)
inline

When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its current value in seconds. When set to SPEC\_COMPLIANT, the segment target duration is rounded up to the nearest integer value if fraction seconds are greater than or equal to 0.5 (>= 0.5) and rounded down if less than 0.5 (< 0.5). You may need to use LEGACY if your client needs to ensure that the target duration is always longer than the actual duration of the segment. Some older players may experience interrupted playback when the actual duration of a track in a segment is longer than the target duration.

Definition at line 1288 of file HlsGroupSettings.h.

◆ SetTimedMetadataId3Frame() [1/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetTimedMetadataId3Frame ( const HlsTimedMetadataId3Frame value)
inline

Indicates ID3 frame that has the timecode.

Definition at line 1330 of file HlsGroupSettings.h.

◆ SetTimedMetadataId3Frame() [2/2]

void Aws::MediaConvert::Model::HlsGroupSettings::SetTimedMetadataId3Frame ( HlsTimedMetadataId3Frame &&  value)
inline

Indicates ID3 frame that has the timecode.

Definition at line 1335 of file HlsGroupSettings.h.

◆ SetTimedMetadataId3Period()

void Aws::MediaConvert::Model::HlsGroupSettings::SetTimedMetadataId3Period ( int  value)
inline

Timed Metadata interval in seconds.

Definition at line 1361 of file HlsGroupSettings.h.

◆ SetTimestampDeltaMilliseconds()

void Aws::MediaConvert::Model::HlsGroupSettings::SetTimestampDeltaMilliseconds ( int  value)
inline

Provides an extra millisecond delta offset to fine tune the timestamps.

Definition at line 1382 of file HlsGroupSettings.h.

◆ StreamInfResolutionHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::StreamInfResolutionHasBeenSet ( ) const
inline

Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.

Definition at line 1211 of file HlsGroupSettings.h.

◆ TargetDurationCompatibilityModeHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::TargetDurationCompatibilityModeHasBeenSet ( ) const
inline

When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its current value in seconds. When set to SPEC\_COMPLIANT, the segment target duration is rounded up to the nearest integer value if fraction seconds are greater than or equal to 0.5 (>= 0.5) and rounded down if less than 0.5 (< 0.5). You may need to use LEGACY if your client needs to ensure that the target duration is always longer than the actual duration of the segment. Some older players may experience interrupted playback when the actual duration of a track in a segment is longer than the target duration.

Definition at line 1262 of file HlsGroupSettings.h.

◆ TimedMetadataId3FrameHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::TimedMetadataId3FrameHasBeenSet ( ) const
inline

Indicates ID3 frame that has the timecode.

Definition at line 1325 of file HlsGroupSettings.h.

◆ TimedMetadataId3PeriodHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::TimedMetadataId3PeriodHasBeenSet ( ) const
inline

Timed Metadata interval in seconds.

Definition at line 1356 of file HlsGroupSettings.h.

◆ TimestampDeltaMillisecondsHasBeenSet()

bool Aws::MediaConvert::Model::HlsGroupSettings::TimestampDeltaMillisecondsHasBeenSet ( ) const
inline

Provides an extra millisecond delta offset to fine tune the timestamps.

Definition at line 1377 of file HlsGroupSettings.h.

◆ WithAdditionalManifests() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithAdditionalManifests ( Aws::Vector< HlsAdditionalManifest > &&  value)
inline

By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job. This default manifest references every output in the output group. To create additional top-level manifests that reference a subset of the outputs in the output group, specify a list of them here.

Definition at line 169 of file HlsGroupSettings.h.

◆ WithAdditionalManifests() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithAdditionalManifests ( const Aws::Vector< HlsAdditionalManifest > &  value)
inline

By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job. This default manifest references every output in the output group. To create additional top-level manifests that reference a subset of the outputs in the output group, specify a list of them here.

Definition at line 161 of file HlsGroupSettings.h.

◆ WithAdMarkers() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithAdMarkers ( Aws::Vector< HlsAdMarkers > &&  value)
inline

Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves.

Definition at line 106 of file HlsGroupSettings.h.

◆ WithAdMarkers() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithAdMarkers ( const Aws::Vector< HlsAdMarkers > &  value)
inline

Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves.

Definition at line 99 of file HlsGroupSettings.h.

◆ WithAudioOnlyHeader() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithAudioOnlyHeader ( const HlsAudioOnlyHeader value)
inline

Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include (INCLUDE), to output audio-only headers. Choose Exclude (EXCLUDE) to remove the audio-only headers from your audio segments.

Definition at line 226 of file HlsGroupSettings.h.

◆ WithAudioOnlyHeader() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithAudioOnlyHeader ( HlsAudioOnlyHeader &&  value)
inline

Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include (INCLUDE), to output audio-only headers. Choose Exclude (EXCLUDE) to remove the audio-only headers from your audio segments.

Definition at line 234 of file HlsGroupSettings.h.

◆ WithBaseUrl() [1/3]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithBaseUrl ( Aws::String &&  value)
inline

A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.

Definition at line 284 of file HlsGroupSettings.h.

◆ WithBaseUrl() [2/3]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithBaseUrl ( const Aws::String value)
inline

A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.

Definition at line 277 of file HlsGroupSettings.h.

◆ WithBaseUrl() [3/3]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithBaseUrl ( const char *  value)
inline

A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.

Definition at line 291 of file HlsGroupSettings.h.

◆ WithCaptionLanguageMappings() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithCaptionLanguageMappings ( Aws::Vector< HlsCaptionLanguageMapping > &&  value)
inline

Language to be used on Caption outputs

Definition at line 322 of file HlsGroupSettings.h.

◆ WithCaptionLanguageMappings() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithCaptionLanguageMappings ( const Aws::Vector< HlsCaptionLanguageMapping > &  value)
inline

Language to be used on Caption outputs

Definition at line 317 of file HlsGroupSettings.h.

◆ WithCaptionLanguageSetting() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithCaptionLanguageSetting ( const HlsCaptionLanguageSetting value)
inline

Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.

Definition at line 398 of file HlsGroupSettings.h.

◆ WithCaptionLanguageSetting() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithCaptionLanguageSetting ( HlsCaptionLanguageSetting &&  value)
inline

Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.

Definition at line 411 of file HlsGroupSettings.h.

◆ WithClientCache() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithClientCache ( const HlsClientCache value)
inline

Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled (ENABLED) and control caching in your video distribution set up. For example, use the Cache-Control http header.

Definition at line 447 of file HlsGroupSettings.h.

◆ WithClientCache() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithClientCache ( HlsClientCache &&  value)
inline

Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled (ENABLED) and control caching in your video distribution set up. For example, use the Cache-Control http header.

Definition at line 454 of file HlsGroupSettings.h.

◆ WithCodecSpecification() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithCodecSpecification ( const HlsCodecSpecification value)
inline

Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

Definition at line 485 of file HlsGroupSettings.h.

◆ WithCodecSpecification() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithCodecSpecification ( HlsCodecSpecification &&  value)
inline

Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

Definition at line 491 of file HlsGroupSettings.h.

◆ WithDestination() [1/3]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithDestination ( Aws::String &&  value)
inline

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

Definition at line 555 of file HlsGroupSettings.h.

◆ WithDestination() [2/3]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithDestination ( const Aws::String value)
inline

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

Definition at line 546 of file HlsGroupSettings.h.

◆ WithDestination() [3/3]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithDestination ( const char *  value)
inline

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

Definition at line 564 of file HlsGroupSettings.h.

◆ WithDestinationSettings() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithDestinationSettings ( const DestinationSettings value)
inline

Settings associated with the destination. Will vary based on the type of destination

Definition at line 595 of file HlsGroupSettings.h.

◆ WithDestinationSettings() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithDestinationSettings ( DestinationSettings &&  value)
inline

Settings associated with the destination. Will vary based on the type of destination

Definition at line 601 of file HlsGroupSettings.h.

◆ WithDirectoryStructure() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithDirectoryStructure ( const HlsDirectoryStructure value)
inline

Indicates whether segments should be placed in subdirectories.

Definition at line 627 of file HlsGroupSettings.h.

◆ WithDirectoryStructure() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithDirectoryStructure ( HlsDirectoryStructure &&  value)
inline

Indicates whether segments should be placed in subdirectories.

Definition at line 632 of file HlsGroupSettings.h.

◆ WithEncryption() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithEncryption ( const HlsEncryptionSettings value)
inline

DRM settings.

Definition at line 658 of file HlsGroupSettings.h.

◆ WithEncryption() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithEncryption ( HlsEncryptionSettings &&  value)
inline

DRM settings.

Definition at line 663 of file HlsGroupSettings.h.

◆ WithImageBasedTrickPlay() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithImageBasedTrickPlay ( const HlsImageBasedTrickPlay value)
inline

Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails and full-resolution images of single frames. MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md

Definition at line 734 of file HlsGroupSettings.h.

◆ WithImageBasedTrickPlay() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithImageBasedTrickPlay ( HlsImageBasedTrickPlay &&  value)
inline

Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails and full-resolution images of single frames. MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md

Definition at line 748 of file HlsGroupSettings.h.

◆ WithImageBasedTrickPlaySettings() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithImageBasedTrickPlaySettings ( const HlsImageBasedTrickPlaySettings value)
inline

Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED

Definition at line 774 of file HlsGroupSettings.h.

◆ WithImageBasedTrickPlaySettings() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithImageBasedTrickPlaySettings ( HlsImageBasedTrickPlaySettings &&  value)
inline

Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED

Definition at line 779 of file HlsGroupSettings.h.

◆ WithManifestCompression() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithManifestCompression ( const HlsManifestCompression value)
inline

When set to GZIP, compresses HLS playlist.

Definition at line 805 of file HlsGroupSettings.h.

◆ WithManifestCompression() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithManifestCompression ( HlsManifestCompression &&  value)
inline

When set to GZIP, compresses HLS playlist.

Definition at line 810 of file HlsGroupSettings.h.

◆ WithManifestDurationFormat() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithManifestDurationFormat ( const HlsManifestDurationFormat value)
inline

Indicates whether the output manifest should use floating point values for segment duration.

Definition at line 841 of file HlsGroupSettings.h.

◆ WithManifestDurationFormat() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithManifestDurationFormat ( HlsManifestDurationFormat &&  value)
inline

Indicates whether the output manifest should use floating point values for segment duration.

Definition at line 847 of file HlsGroupSettings.h.

◆ WithMinFinalSegmentLength()

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithMinFinalSegmentLength ( double  value)
inline

Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds.

Definition at line 908 of file HlsGroupSettings.h.

◆ WithMinSegmentLength()

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithMinSegmentLength ( int  value)
inline

When set, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.

Definition at line 933 of file HlsGroupSettings.h.

◆ WithOutputSelection() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithOutputSelection ( const HlsOutputSelection value)
inline

Indicates whether the .m3u8 manifest file should be generated for this HLS output group.

Definition at line 964 of file HlsGroupSettings.h.

◆ WithOutputSelection() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithOutputSelection ( HlsOutputSelection &&  value)
inline

Indicates whether the .m3u8 manifest file should be generated for this HLS output group.

Definition at line 970 of file HlsGroupSettings.h.

◆ WithProgramDateTime() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithProgramDateTime ( const HlsProgramDateTime value)
inline

Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset.

Definition at line 1011 of file HlsGroupSettings.h.

◆ WithProgramDateTime() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithProgramDateTime ( HlsProgramDateTime &&  value)
inline

Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset.

Definition at line 1019 of file HlsGroupSettings.h.

◆ WithProgramDateTimePeriod()

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithProgramDateTimePeriod ( int  value)
inline

Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.

Definition at line 1040 of file HlsGroupSettings.h.

◆ WithSegmentControl() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithSegmentControl ( const HlsSegmentControl value)
inline

When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.

Definition at line 1071 of file HlsGroupSettings.h.

◆ WithSegmentControl() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithSegmentControl ( HlsSegmentControl &&  value)
inline

When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.

Definition at line 1077 of file HlsGroupSettings.h.

◆ WithSegmentLength()

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithSegmentLength ( int  value)
inline

Specify the length, in whole seconds, of each segment. When you don't specify a value, MediaConvert defaults to 10. Related settings: Use Segment length control (SegmentLengthControl) to specify whether the encoder enforces this value strictly. Use Segment control (HlsSegmentControl) to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries.

Definition at line 1118 of file HlsGroupSettings.h.

◆ WithSegmentLengthControl() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithSegmentLengthControl ( const HlsSegmentLengthControl value)
inline

Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary.

Definition at line 1164 of file HlsGroupSettings.h.

◆ WithSegmentLengthControl() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithSegmentLengthControl ( HlsSegmentLengthControl &&  value)
inline

Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary.

Definition at line 1173 of file HlsGroupSettings.h.

◆ WithSegmentsPerSubdirectory()

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithSegmentsPerSubdirectory ( int  value)
inline

Number of segments to write to a subdirectory before starting a new one. directoryStructure must be SINGLE_DIRECTORY for this setting to have an effect.

Definition at line 1198 of file HlsGroupSettings.h.

◆ WithStreamInfResolution() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithStreamInfResolution ( const HlsStreamInfResolution value)
inline

Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.

Definition at line 1229 of file HlsGroupSettings.h.

◆ WithStreamInfResolution() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithStreamInfResolution ( HlsStreamInfResolution &&  value)
inline

Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.

Definition at line 1235 of file HlsGroupSettings.h.

◆ WithTargetDurationCompatibilityMode() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithTargetDurationCompatibilityMode ( const HlsTargetDurationCompatibilityMode value)
inline

When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its current value in seconds. When set to SPEC\_COMPLIANT, the segment target duration is rounded up to the nearest integer value if fraction seconds are greater than or equal to 0.5 (>= 0.5) and rounded down if less than 0.5 (< 0.5). You may need to use LEGACY if your client needs to ensure that the target duration is always longer than the actual duration of the segment. Some older players may experience interrupted playback when the actual duration of a track in a segment is longer than the target duration.

Definition at line 1301 of file HlsGroupSettings.h.

◆ WithTargetDurationCompatibilityMode() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithTargetDurationCompatibilityMode ( HlsTargetDurationCompatibilityMode &&  value)
inline

When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its current value in seconds. When set to SPEC\_COMPLIANT, the segment target duration is rounded up to the nearest integer value if fraction seconds are greater than or equal to 0.5 (>= 0.5) and rounded down if less than 0.5 (< 0.5). You may need to use LEGACY if your client needs to ensure that the target duration is always longer than the actual duration of the segment. Some older players may experience interrupted playback when the actual duration of a track in a segment is longer than the target duration.

Definition at line 1314 of file HlsGroupSettings.h.

◆ WithTimedMetadataId3Frame() [1/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithTimedMetadataId3Frame ( const HlsTimedMetadataId3Frame value)
inline

Indicates ID3 frame that has the timecode.

Definition at line 1340 of file HlsGroupSettings.h.

◆ WithTimedMetadataId3Frame() [2/2]

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithTimedMetadataId3Frame ( HlsTimedMetadataId3Frame &&  value)
inline

Indicates ID3 frame that has the timecode.

Definition at line 1345 of file HlsGroupSettings.h.

◆ WithTimedMetadataId3Period()

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithTimedMetadataId3Period ( int  value)
inline

Timed Metadata interval in seconds.

Definition at line 1366 of file HlsGroupSettings.h.

◆ WithTimestampDeltaMilliseconds()

HlsGroupSettings& Aws::MediaConvert::Model::HlsGroupSettings::WithTimestampDeltaMilliseconds ( int  value)
inline

Provides an extra millisecond delta offset to fine tune the timestamps.

Definition at line 1387 of file HlsGroupSettings.h.


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