Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Amazonka.MediaConvert.Types.DashIsoGroupSettings
Description
Synopsis
- data DashIsoGroupSettings = DashIsoGroupSettings' {
- fragmentLength :: Maybe Natural
- segmentControl :: Maybe DashIsoSegmentControl
- destination :: Maybe Text
- hbbtvCompliance :: Maybe DashIsoHbbtvCompliance
- minBufferTime :: Maybe Natural
- mpdProfile :: Maybe DashIsoMpdProfile
- imageBasedTrickPlay :: Maybe DashIsoImageBasedTrickPlay
- additionalManifests :: Maybe [DashAdditionalManifest]
- segmentLengthControl :: Maybe DashIsoSegmentLengthControl
- imageBasedTrickPlaySettings :: Maybe DashIsoImageBasedTrickPlaySettings
- baseUrl :: Maybe Text
- destinationSettings :: Maybe DestinationSettings
- minFinalSegmentLength :: Maybe Double
- audioChannelConfigSchemeIdUri :: Maybe DashIsoGroupAudioChannelConfigSchemeIdUri
- encryption :: Maybe DashIsoEncryptionSettings
- segmentLength :: Maybe Natural
- ptsOffsetHandlingForBFrames :: Maybe DashIsoPtsOffsetHandlingForBFrames
- writeSegmentTimelineInRepresentation :: Maybe DashIsoWriteSegmentTimelineInRepresentation
- newDashIsoGroupSettings :: DashIsoGroupSettings
- dashIsoGroupSettings_fragmentLength :: Lens' DashIsoGroupSettings (Maybe Natural)
- dashIsoGroupSettings_segmentControl :: Lens' DashIsoGroupSettings (Maybe DashIsoSegmentControl)
- dashIsoGroupSettings_destination :: Lens' DashIsoGroupSettings (Maybe Text)
- dashIsoGroupSettings_hbbtvCompliance :: Lens' DashIsoGroupSettings (Maybe DashIsoHbbtvCompliance)
- dashIsoGroupSettings_minBufferTime :: Lens' DashIsoGroupSettings (Maybe Natural)
- dashIsoGroupSettings_mpdProfile :: Lens' DashIsoGroupSettings (Maybe DashIsoMpdProfile)
- dashIsoGroupSettings_imageBasedTrickPlay :: Lens' DashIsoGroupSettings (Maybe DashIsoImageBasedTrickPlay)
- dashIsoGroupSettings_additionalManifests :: Lens' DashIsoGroupSettings (Maybe [DashAdditionalManifest])
- dashIsoGroupSettings_segmentLengthControl :: Lens' DashIsoGroupSettings (Maybe DashIsoSegmentLengthControl)
- dashIsoGroupSettings_imageBasedTrickPlaySettings :: Lens' DashIsoGroupSettings (Maybe DashIsoImageBasedTrickPlaySettings)
- dashIsoGroupSettings_baseUrl :: Lens' DashIsoGroupSettings (Maybe Text)
- dashIsoGroupSettings_destinationSettings :: Lens' DashIsoGroupSettings (Maybe DestinationSettings)
- dashIsoGroupSettings_minFinalSegmentLength :: Lens' DashIsoGroupSettings (Maybe Double)
- dashIsoGroupSettings_audioChannelConfigSchemeIdUri :: Lens' DashIsoGroupSettings (Maybe DashIsoGroupAudioChannelConfigSchemeIdUri)
- dashIsoGroupSettings_encryption :: Lens' DashIsoGroupSettings (Maybe DashIsoEncryptionSettings)
- dashIsoGroupSettings_segmentLength :: Lens' DashIsoGroupSettings (Maybe Natural)
- dashIsoGroupSettings_ptsOffsetHandlingForBFrames :: Lens' DashIsoGroupSettings (Maybe DashIsoPtsOffsetHandlingForBFrames)
- dashIsoGroupSettings_writeSegmentTimelineInRepresentation :: Lens' DashIsoGroupSettings (Maybe DashIsoWriteSegmentTimelineInRepresentation)
Documentation
data DashIsoGroupSettings Source #
Settings related to your DASH 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 DASH_ISO_GROUP_SETTINGS.
See: newDashIsoGroupSettings
smart constructor.
Constructors
DashIsoGroupSettings' | |
Fields
|
Instances
newDashIsoGroupSettings :: DashIsoGroupSettings Source #
Create a value of DashIsoGroupSettings
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:fragmentLength:DashIsoGroupSettings'
, dashIsoGroupSettings_fragmentLength
- Length of fragments to generate (in seconds). Fragment length must be
compatible with GOP size and Framerate. Note that fragments will end on
the next keyframe after this number of seconds, so actual fragment
length may be longer. When Emit Single File is checked, the
fragmentation is internal to a single output file and it does not cause
the creation of many output files as in other output types.
$sel:segmentControl:DashIsoGroupSettings'
, dashIsoGroupSettings_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:destination:DashIsoGroupSettings'
, dashIsoGroupSettings_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:hbbtvCompliance:DashIsoGroupSettings'
, dashIsoGroupSettings_hbbtvCompliance
- Supports HbbTV specification as indicated
$sel:minBufferTime:DashIsoGroupSettings'
, dashIsoGroupSettings_minBufferTime
- Minimum time of initially buffered media that is needed to ensure smooth
playout.
$sel:mpdProfile:DashIsoGroupSettings'
, dashIsoGroupSettings_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:imageBasedTrickPlay:DashIsoGroupSettings'
, dashIsoGroupSettings_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. 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:additionalManifests:DashIsoGroupSettings'
, dashIsoGroupSettings_additionalManifests
- By default, the service creates one .mpd DASH manifest for each DASH ISO
output group in your job. This default manifest references every output
in the output group. To create additional DASH manifests that reference
a subset of the outputs in the output group, specify a list of them
here.
$sel:segmentLengthControl:DashIsoGroupSettings'
, dashIsoGroupSettings_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:imageBasedTrickPlaySettings:DashIsoGroupSettings'
, dashIsoGroupSettings_imageBasedTrickPlaySettings
- Tile and thumbnail settings applicable when imageBasedTrickPlay is
ADVANCED
$sel:baseUrl:DashIsoGroupSettings'
, dashIsoGroupSettings_baseUrl
- A partial URI prefix that will be put in the manifest (.mpd) file at the
top level BaseURL element. Can be used if streams are delivered from a
different URL than the manifest file.
$sel:destinationSettings:DashIsoGroupSettings'
, dashIsoGroupSettings_destinationSettings
- Settings associated with the destination. Will vary based on the type of
destination
$sel:minFinalSegmentLength:DashIsoGroupSettings'
, dashIsoGroupSettings_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:audioChannelConfigSchemeIdUri:DashIsoGroupSettings'
, dashIsoGroupSettings_audioChannelConfigSchemeIdUri
- Use this setting only when your audio codec is a Dolby one (AC3, EAC3,
or Atmos) and your downstream workflow requires that your DASH manifest
use the Dolby channel configuration tag, rather than the MPEG one. For
example, you might need to use this to make dynamic ad insertion work.
Specify which audio channel configuration scheme ID URI MediaConvert
writes in your DASH manifest. Keep the default value, MPEG channel
configuration (MPEG_CHANNEL_CONFIGURATION), to have MediaConvert write
this: urn:mpeg:mpegB:cicp:ChannelConfiguration. Choose Dolby channel
configuration (DOLBY_CHANNEL_CONFIGURATION) to have MediaConvert write
this instead: tag:dolby.com,2014:dash:audio_channel_configuration:2011.
$sel:encryption:DashIsoGroupSettings'
, dashIsoGroupSettings_encryption
- DRM settings.
$sel:segmentLength:DashIsoGroupSettings'
, dashIsoGroupSettings_segmentLength
- Specify the length, in whole seconds, of each segment. When you don't
specify a value, MediaConvert defaults to 30. Related settings: Use
Segment length control (SegmentLengthControl) to specify whether the
encoder enforces this value strictly. Use Segment control
(DashIsoSegmentControl) to specify whether MediaConvert creates separate
segment files or one content file that has metadata to mark the segment
boundaries.
$sel:ptsOffsetHandlingForBFrames:DashIsoGroupSettings'
, dashIsoGroupSettings_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:writeSegmentTimelineInRepresentation:DashIsoGroupSettings'
, dashIsoGroupSettings_writeSegmentTimelineInRepresentation
- If you get an HTTP error in the 400 range when you play back your DASH
output, enable this setting and run your transcoding job again. When you
enable this setting, the service writes precise segment durations in the
DASH manifest. The segment duration information appears inside the
SegmentTimeline element, inside SegmentTemplate at the Representation
level. When you don't enable this setting, the service writes
approximate segment durations in your DASH manifest.
dashIsoGroupSettings_fragmentLength :: Lens' DashIsoGroupSettings (Maybe Natural) Source #
Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.
dashIsoGroupSettings_segmentControl :: Lens' DashIsoGroupSettings (Maybe DashIsoSegmentControl) 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.
dashIsoGroupSettings_destination :: Lens' DashIsoGroupSettings (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.
dashIsoGroupSettings_hbbtvCompliance :: Lens' DashIsoGroupSettings (Maybe DashIsoHbbtvCompliance) Source #
Supports HbbTV specification as indicated
dashIsoGroupSettings_minBufferTime :: Lens' DashIsoGroupSettings (Maybe Natural) Source #
Minimum time of initially buffered media that is needed to ensure smooth playout.
dashIsoGroupSettings_mpdProfile :: Lens' DashIsoGroupSettings (Maybe DashIsoMpdProfile) 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).
dashIsoGroupSettings_imageBasedTrickPlay :: Lens' DashIsoGroupSettings (Maybe DashIsoImageBasedTrickPlay) 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. 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
dashIsoGroupSettings_additionalManifests :: Lens' DashIsoGroupSettings (Maybe [DashAdditionalManifest]) Source #
By default, the service creates one .mpd DASH manifest for each DASH ISO output group in your job. This default manifest references every output in the output group. To create additional DASH manifests that reference a subset of the outputs in the output group, specify a list of them here.
dashIsoGroupSettings_segmentLengthControl :: Lens' DashIsoGroupSettings (Maybe DashIsoSegmentLengthControl) 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.
dashIsoGroupSettings_imageBasedTrickPlaySettings :: Lens' DashIsoGroupSettings (Maybe DashIsoImageBasedTrickPlaySettings) Source #
Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
dashIsoGroupSettings_baseUrl :: Lens' DashIsoGroupSettings (Maybe Text) Source #
A partial URI prefix that will be put in the manifest (.mpd) file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.
dashIsoGroupSettings_destinationSettings :: Lens' DashIsoGroupSettings (Maybe DestinationSettings) Source #
Settings associated with the destination. Will vary based on the type of destination
dashIsoGroupSettings_minFinalSegmentLength :: Lens' DashIsoGroupSettings (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.
dashIsoGroupSettings_audioChannelConfigSchemeIdUri :: Lens' DashIsoGroupSettings (Maybe DashIsoGroupAudioChannelConfigSchemeIdUri) Source #
Use this setting only when your audio codec is a Dolby one (AC3, EAC3, or Atmos) and your downstream workflow requires that your DASH manifest use the Dolby channel configuration tag, rather than the MPEG one. For example, you might need to use this to make dynamic ad insertion work. Specify which audio channel configuration scheme ID URI MediaConvert writes in your DASH manifest. Keep the default value, MPEG channel configuration (MPEG_CHANNEL_CONFIGURATION), to have MediaConvert write this: urn:mpeg:mpegB:cicp:ChannelConfiguration. Choose Dolby channel configuration (DOLBY_CHANNEL_CONFIGURATION) to have MediaConvert write this instead: tag:dolby.com,2014:dash:audio_channel_configuration:2011.
dashIsoGroupSettings_encryption :: Lens' DashIsoGroupSettings (Maybe DashIsoEncryptionSettings) Source #
DRM settings.
dashIsoGroupSettings_segmentLength :: Lens' DashIsoGroupSettings (Maybe Natural) Source #
Specify the length, in whole seconds, of each segment. When you don't specify a value, MediaConvert defaults to 30. Related settings: Use Segment length control (SegmentLengthControl) to specify whether the encoder enforces this value strictly. Use Segment control (DashIsoSegmentControl) to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries.
dashIsoGroupSettings_ptsOffsetHandlingForBFrames :: Lens' DashIsoGroupSettings (Maybe DashIsoPtsOffsetHandlingForBFrames) 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.
dashIsoGroupSettings_writeSegmentTimelineInRepresentation :: Lens' DashIsoGroupSettings (Maybe DashIsoWriteSegmentTimelineInRepresentation) Source #
If you get an HTTP error in the 400 range when you play back your DASH output, enable this setting and run your transcoding job again. When you enable this setting, the service writes precise segment durations in the DASH manifest. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When you don't enable this setting, the service writes approximate segment durations in your DASH manifest.