amazonka-mediaconvert-2.0: Amazon Elemental MediaConvert SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MediaConvert.Types.CmafGroupSettings

Description

 
Synopsis

Documentation

data CmafGroupSettings Source #

Settings related to your CMAF 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 CMAF_GROUP_SETTINGS.

See: newCmafGroupSettings smart constructor.

Constructors

CmafGroupSettings' 

Fields

  • additionalManifests :: Maybe [CmafAdditionalManifest]

    By default, the service creates one top-level .m3u8 HLS manifest and one top -level .mpd DASH manifest for each CMAF output group in your job. These default manifests reference 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. For each additional manifest that you specify, the service creates one HLS manifest and one DASH manifest.

  • baseUrl :: Maybe Text

    A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.

  • clientCache :: Maybe CmafClientCache

    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.

  • codecSpecification :: Maybe CmafCodecSpecification

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

  • destination :: Maybe Text

    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.

  • destinationSettings :: Maybe DestinationSettings

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

  • encryption :: Maybe CmafEncryptionSettings

    DRM settings.

  • fragmentLength :: Maybe Natural

    Specify the length, in whole seconds, of the mp4 fragments. When you don't specify a value, MediaConvert defaults to 2. Related setting: Use Fragment length control (FragmentLengthControl) to specify whether the encoder enforces this value strictly.

  • imageBasedTrickPlay :: Maybe CmafImageBasedTrickPlay

    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. When you enable Write HLS manifest (WriteHlsManifest), MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. When you enable Write DASH manifest (WriteDashManifest), MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. 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

  • imageBasedTrickPlaySettings :: Maybe CmafImageBasedTrickPlaySettings

    Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED

  • manifestCompression :: Maybe CmafManifestCompression

    When set to GZIP, compresses HLS playlist.

  • manifestDurationFormat :: Maybe CmafManifestDurationFormat

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

  • minBufferTime :: Maybe Natural

    Minimum time of initially buffered media that is needed to ensure smooth playout.

  • minFinalSegmentLength :: Maybe Double

    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.

  • mpdManifestBandwidthType :: Maybe CmafMpdManifestBandwidthType

    Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest. We recommend that you choose a MPD manifest bandwidth type that is compatible with your downstream player configuration. Max: Use the same value that you specify for Max bitrate in the video output, in bits per second. Average: Use the calculated average bitrate of the encoded video output, in bits per second.

  • mpdProfile :: Maybe CmafMpdProfile

    Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE).

  • ptsOffsetHandlingForBFrames :: Maybe CmafPtsOffsetHandlingForBFrames

    Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode time stamp (DTS). Specify how MediaConvert handles PTS when writing time stamps in output DASH manifests. Choose Match initial PTS (MATCH_INITIAL_PTS) when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose Zero-based (ZERO_BASED) to have MediaConvert ignore the initial PTS in the video stream and instead write the initial time stamp as zero in the manifest. For outputs that don't have B-frames, the time stamps in your DASH manifests start at zero regardless of your choice here.

  • segmentControl :: Maybe CmafSegmentControl

    When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.

  • segmentLength :: Maybe Natural

    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 (CmafSegmentControl) to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries.

  • segmentLengthControl :: Maybe CmafSegmentLengthControl

    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.

  • streamInfResolution :: Maybe CmafStreamInfResolution

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

  • targetDurationCompatibilityMode :: Maybe CmafTargetDurationCompatibilityMode

    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.

  • videoCompositionOffsets :: Maybe CmafVideoCompositionOffsets

    Specify the video sample composition time offset mode in the output fMP4 TRUN box. For wider player compatibility, set Video composition offsets to Unsigned or leave blank. The earliest presentation time may be greater than zero, and sample composition time offsets will increment using unsigned integers. For strict fMP4 video and audio timing, set Video composition offsets to Signed. The earliest presentation time will be equal to zero, and sample composition time offsets will increment using signed integers.

  • writeDashManifest :: Maybe CmafWriteDASHManifest

    When set to ENABLED, a DASH MPD manifest will be generated for this output.

  • writeHlsManifest :: Maybe CmafWriteHLSManifest

    When set to ENABLED, an Apple HLS manifest will be generated for this output.

  • writeSegmentTimelineInRepresentation :: Maybe CmafWriteSegmentTimelineInRepresentation

    When you enable Precise segment duration in DASH manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate element.

Instances

Instances details
FromJSON CmafGroupSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.CmafGroupSettings

ToJSON CmafGroupSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.CmafGroupSettings

Generic CmafGroupSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.CmafGroupSettings

Associated Types

type Rep CmafGroupSettings :: Type -> Type #

Read CmafGroupSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.CmafGroupSettings

Show CmafGroupSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.CmafGroupSettings

NFData CmafGroupSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.CmafGroupSettings

Methods

rnf :: CmafGroupSettings -> () #

Eq CmafGroupSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.CmafGroupSettings

Hashable CmafGroupSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.CmafGroupSettings

type Rep CmafGroupSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.CmafGroupSettings

type Rep CmafGroupSettings = D1 ('MetaData "CmafGroupSettings" "Amazonka.MediaConvert.Types.CmafGroupSettings" "amazonka-mediaconvert-2.0-ClG8xHhlx4y6bdaCrZchqH" 'False) (C1 ('MetaCons "CmafGroupSettings'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "additionalManifests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CmafAdditionalManifest])) :*: (S1 ('MetaSel ('Just "baseUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clientCache") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CmafClientCache)))) :*: (S1 ('MetaSel ('Just "codecSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CmafCodecSpecification)) :*: (S1 ('MetaSel ('Just "destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "destinationSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DestinationSettings))))) :*: ((S1 ('MetaSel ('Just "encryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CmafEncryptionSettings)) :*: (S1 ('MetaSel ('Just "fragmentLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "imageBasedTrickPlay") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CmafImageBasedTrickPlay)))) :*: ((S1 ('MetaSel ('Just "imageBasedTrickPlaySettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CmafImageBasedTrickPlaySettings)) :*: S1 ('MetaSel ('Just "manifestCompression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CmafManifestCompression))) :*: (S1 ('MetaSel ('Just "manifestDurationFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CmafManifestDurationFormat)) :*: S1 ('MetaSel ('Just "minBufferTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))) :*: (((S1 ('MetaSel ('Just "minFinalSegmentLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "mpdManifestBandwidthType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CmafMpdManifestBandwidthType)) :*: S1 ('MetaSel ('Just "mpdProfile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CmafMpdProfile)))) :*: (S1 ('MetaSel ('Just "ptsOffsetHandlingForBFrames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CmafPtsOffsetHandlingForBFrames)) :*: (S1 ('MetaSel ('Just "segmentControl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CmafSegmentControl)) :*: S1 ('MetaSel ('Just "segmentLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :*: ((S1 ('MetaSel ('Just "segmentLengthControl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CmafSegmentLengthControl)) :*: (S1 ('MetaSel ('Just "streamInfResolution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CmafStreamInfResolution)) :*: S1 ('MetaSel ('Just "targetDurationCompatibilityMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CmafTargetDurationCompatibilityMode)))) :*: ((S1 ('MetaSel ('Just "videoCompositionOffsets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CmafVideoCompositionOffsets)) :*: S1 ('MetaSel ('Just "writeDashManifest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CmafWriteDASHManifest))) :*: (S1 ('MetaSel ('Just "writeHlsManifest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CmafWriteHLSManifest)) :*: S1 ('MetaSel ('Just "writeSegmentTimelineInRepresentation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CmafWriteSegmentTimelineInRepresentation))))))))

newCmafGroupSettings :: CmafGroupSettings Source #

Create a value of CmafGroupSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:additionalManifests:CmafGroupSettings', cmafGroupSettings_additionalManifests - By default, the service creates one top-level .m3u8 HLS manifest and one top -level .mpd DASH manifest for each CMAF output group in your job. These default manifests reference 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. For each additional manifest that you specify, the service creates one HLS manifest and one DASH manifest.

$sel:baseUrl:CmafGroupSettings', cmafGroupSettings_baseUrl - A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.

$sel:clientCache:CmafGroupSettings', cmafGroupSettings_clientCache - 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.

$sel:codecSpecification:CmafGroupSettings', cmafGroupSettings_codecSpecification - Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

$sel:destination:CmafGroupSettings', cmafGroupSettings_destination - 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.

$sel:destinationSettings:CmafGroupSettings', cmafGroupSettings_destinationSettings - Settings associated with the destination. Will vary based on the type of destination

$sel:encryption:CmafGroupSettings', cmafGroupSettings_encryption - DRM settings.

$sel:fragmentLength:CmafGroupSettings', cmafGroupSettings_fragmentLength - Specify the length, in whole seconds, of the mp4 fragments. When you don't specify a value, MediaConvert defaults to 2. Related setting: Use Fragment length control (FragmentLengthControl) to specify whether the encoder enforces this value strictly.

$sel:imageBasedTrickPlay:CmafGroupSettings', cmafGroupSettings_imageBasedTrickPlay - 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. When you enable Write HLS manifest (WriteHlsManifest), MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. When you enable Write DASH manifest (WriteDashManifest), MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. 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

$sel:imageBasedTrickPlaySettings:CmafGroupSettings', cmafGroupSettings_imageBasedTrickPlaySettings - Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED

$sel:manifestCompression:CmafGroupSettings', cmafGroupSettings_manifestCompression - When set to GZIP, compresses HLS playlist.

$sel:manifestDurationFormat:CmafGroupSettings', cmafGroupSettings_manifestDurationFormat - Indicates whether the output manifest should use floating point values for segment duration.

$sel:minBufferTime:CmafGroupSettings', cmafGroupSettings_minBufferTime - Minimum time of initially buffered media that is needed to ensure smooth playout.

$sel:minFinalSegmentLength:CmafGroupSettings', cmafGroupSettings_minFinalSegmentLength - 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.

$sel:mpdManifestBandwidthType:CmafGroupSettings', cmafGroupSettings_mpdManifestBandwidthType - Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest. We recommend that you choose a MPD manifest bandwidth type that is compatible with your downstream player configuration. Max: Use the same value that you specify for Max bitrate in the video output, in bits per second. Average: Use the calculated average bitrate of the encoded video output, in bits per second.

$sel:mpdProfile:CmafGroupSettings', cmafGroupSettings_mpdProfile - Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE).

$sel:ptsOffsetHandlingForBFrames:CmafGroupSettings', cmafGroupSettings_ptsOffsetHandlingForBFrames - Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode time stamp (DTS). Specify how MediaConvert handles PTS when writing time stamps in output DASH manifests. Choose Match initial PTS (MATCH_INITIAL_PTS) when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose Zero-based (ZERO_BASED) to have MediaConvert ignore the initial PTS in the video stream and instead write the initial time stamp as zero in the manifest. For outputs that don't have B-frames, the time stamps in your DASH manifests start at zero regardless of your choice here.

$sel:segmentControl:CmafGroupSettings', cmafGroupSettings_segmentControl - When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.

$sel:segmentLength:CmafGroupSettings', cmafGroupSettings_segmentLength - 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 (CmafSegmentControl) to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries.

$sel:segmentLengthControl:CmafGroupSettings', cmafGroupSettings_segmentLengthControl - 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.

$sel:streamInfResolution:CmafGroupSettings', cmafGroupSettings_streamInfResolution - Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.

$sel:targetDurationCompatibilityMode:CmafGroupSettings', cmafGroupSettings_targetDurationCompatibilityMode - 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.

$sel:videoCompositionOffsets:CmafGroupSettings', cmafGroupSettings_videoCompositionOffsets - Specify the video sample composition time offset mode in the output fMP4 TRUN box. For wider player compatibility, set Video composition offsets to Unsigned or leave blank. The earliest presentation time may be greater than zero, and sample composition time offsets will increment using unsigned integers. For strict fMP4 video and audio timing, set Video composition offsets to Signed. The earliest presentation time will be equal to zero, and sample composition time offsets will increment using signed integers.

$sel:writeDashManifest:CmafGroupSettings', cmafGroupSettings_writeDashManifest - When set to ENABLED, a DASH MPD manifest will be generated for this output.

$sel:writeHlsManifest:CmafGroupSettings', cmafGroupSettings_writeHlsManifest - When set to ENABLED, an Apple HLS manifest will be generated for this output.

$sel:writeSegmentTimelineInRepresentation:CmafGroupSettings', cmafGroupSettings_writeSegmentTimelineInRepresentation - When you enable Precise segment duration in DASH manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate element.

cmafGroupSettings_additionalManifests :: Lens' CmafGroupSettings (Maybe [CmafAdditionalManifest]) Source #

By default, the service creates one top-level .m3u8 HLS manifest and one top -level .mpd DASH manifest for each CMAF output group in your job. These default manifests reference 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. For each additional manifest that you specify, the service creates one HLS manifest and one DASH manifest.

cmafGroupSettings_baseUrl :: Lens' CmafGroupSettings (Maybe Text) Source #

A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.

cmafGroupSettings_clientCache :: Lens' CmafGroupSettings (Maybe CmafClientCache) Source #

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.

cmafGroupSettings_codecSpecification :: Lens' CmafGroupSettings (Maybe CmafCodecSpecification) Source #

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

cmafGroupSettings_destination :: Lens' CmafGroupSettings (Maybe Text) Source #

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.

cmafGroupSettings_destinationSettings :: Lens' CmafGroupSettings (Maybe DestinationSettings) Source #

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

cmafGroupSettings_fragmentLength :: Lens' CmafGroupSettings (Maybe Natural) Source #

Specify the length, in whole seconds, of the mp4 fragments. When you don't specify a value, MediaConvert defaults to 2. Related setting: Use Fragment length control (FragmentLengthControl) to specify whether the encoder enforces this value strictly.

cmafGroupSettings_imageBasedTrickPlay :: Lens' CmafGroupSettings (Maybe CmafImageBasedTrickPlay) Source #

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. When you enable Write HLS manifest (WriteHlsManifest), MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. When you enable Write DASH manifest (WriteDashManifest), MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. 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

cmafGroupSettings_imageBasedTrickPlaySettings :: Lens' CmafGroupSettings (Maybe CmafImageBasedTrickPlaySettings) Source #

Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED

cmafGroupSettings_manifestDurationFormat :: Lens' CmafGroupSettings (Maybe CmafManifestDurationFormat) Source #

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

cmafGroupSettings_minBufferTime :: Lens' CmafGroupSettings (Maybe Natural) Source #

Minimum time of initially buffered media that is needed to ensure smooth playout.

cmafGroupSettings_minFinalSegmentLength :: Lens' CmafGroupSettings (Maybe Double) Source #

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.

cmafGroupSettings_mpdManifestBandwidthType :: Lens' CmafGroupSettings (Maybe CmafMpdManifestBandwidthType) Source #

Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest. We recommend that you choose a MPD manifest bandwidth type that is compatible with your downstream player configuration. Max: Use the same value that you specify for Max bitrate in the video output, in bits per second. Average: Use the calculated average bitrate of the encoded video output, in bits per second.

cmafGroupSettings_mpdProfile :: Lens' CmafGroupSettings (Maybe CmafMpdProfile) Source #

Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE).

cmafGroupSettings_ptsOffsetHandlingForBFrames :: Lens' CmafGroupSettings (Maybe CmafPtsOffsetHandlingForBFrames) Source #

Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode time stamp (DTS). Specify how MediaConvert handles PTS when writing time stamps in output DASH manifests. Choose Match initial PTS (MATCH_INITIAL_PTS) when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose Zero-based (ZERO_BASED) to have MediaConvert ignore the initial PTS in the video stream and instead write the initial time stamp as zero in the manifest. For outputs that don't have B-frames, the time stamps in your DASH manifests start at zero regardless of your choice here.

cmafGroupSettings_segmentControl :: Lens' CmafGroupSettings (Maybe CmafSegmentControl) Source #

When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.

cmafGroupSettings_segmentLength :: Lens' CmafGroupSettings (Maybe Natural) Source #

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 (CmafSegmentControl) to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries.

cmafGroupSettings_segmentLengthControl :: Lens' CmafGroupSettings (Maybe CmafSegmentLengthControl) Source #

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.

cmafGroupSettings_streamInfResolution :: Lens' CmafGroupSettings (Maybe CmafStreamInfResolution) Source #

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

cmafGroupSettings_targetDurationCompatibilityMode :: Lens' CmafGroupSettings (Maybe CmafTargetDurationCompatibilityMode) Source #

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.

cmafGroupSettings_videoCompositionOffsets :: Lens' CmafGroupSettings (Maybe CmafVideoCompositionOffsets) Source #

Specify the video sample composition time offset mode in the output fMP4 TRUN box. For wider player compatibility, set Video composition offsets to Unsigned or leave blank. The earliest presentation time may be greater than zero, and sample composition time offsets will increment using unsigned integers. For strict fMP4 video and audio timing, set Video composition offsets to Signed. The earliest presentation time will be equal to zero, and sample composition time offsets will increment using signed integers.

cmafGroupSettings_writeDashManifest :: Lens' CmafGroupSettings (Maybe CmafWriteDASHManifest) Source #

When set to ENABLED, a DASH MPD manifest will be generated for this output.

cmafGroupSettings_writeHlsManifest :: Lens' CmafGroupSettings (Maybe CmafWriteHLSManifest) Source #

When set to ENABLED, an Apple HLS manifest will be generated for this output.

cmafGroupSettings_writeSegmentTimelineInRepresentation :: Lens' CmafGroupSettings (Maybe CmafWriteSegmentTimelineInRepresentation) Source #

When you enable Precise segment duration in DASH manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate element.