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 |
Synopsis
- data CmfcSettings = CmfcSettings' {
- descriptiveVideoServiceFlag :: Maybe CmfcDescriptiveVideoServiceFlag
- audioRenditionSets :: Maybe Text
- iFrameOnlyManifest :: Maybe CmfcIFrameOnlyManifest
- scte35Esam :: Maybe CmfcScte35Esam
- audioDuration :: Maybe CmfcAudioDuration
- audioGroupId :: Maybe Text
- scte35Source :: Maybe CmfcScte35Source
- audioTrackType :: Maybe CmfcAudioTrackType
- newCmfcSettings :: CmfcSettings
- cmfcSettings_descriptiveVideoServiceFlag :: Lens' CmfcSettings (Maybe CmfcDescriptiveVideoServiceFlag)
- cmfcSettings_audioRenditionSets :: Lens' CmfcSettings (Maybe Text)
- cmfcSettings_iFrameOnlyManifest :: Lens' CmfcSettings (Maybe CmfcIFrameOnlyManifest)
- cmfcSettings_scte35Esam :: Lens' CmfcSettings (Maybe CmfcScte35Esam)
- cmfcSettings_audioDuration :: Lens' CmfcSettings (Maybe CmfcAudioDuration)
- cmfcSettings_audioGroupId :: Lens' CmfcSettings (Maybe Text)
- cmfcSettings_scte35Source :: Lens' CmfcSettings (Maybe CmfcScte35Source)
- cmfcSettings_audioTrackType :: Lens' CmfcSettings (Maybe CmfcAudioTrackType)
Documentation
data CmfcSettings Source #
These settings relate to the fragmented MP4 container for the segments in your CMAF outputs.
See: newCmfcSettings
smart constructor.
CmfcSettings' | |
|
Instances
newCmfcSettings :: CmfcSettings Source #
Create a value of CmfcSettings
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:descriptiveVideoServiceFlag:CmfcSettings'
, cmfcSettings_descriptiveVideoServiceFlag
- Specify whether to flag this audio track as descriptive video service
(DVS) in your HLS parent manifest. When you choose Flag (FLAG),
MediaConvert includes the parameter
CHARACTERISTICS="public.accessibility.describes-video" in the
EXT-X-MEDIA entry for this track. When you keep the default choice,
Don't flag (DONT_FLAG), MediaConvert leaves this parameter out. The DVS
flag can help with accessibility on Apple devices. For more information,
see the Apple documentation.
$sel:audioRenditionSets:CmfcSettings'
, cmfcSettings_audioRenditionSets
- List the audio rendition groups that you want included with this video
rendition. Use a comma-separated list. For example, say you want to
include the audio rendition groups that have the audio group IDs
"audio_aac_1" and "audio_dolby". Then you would specify this value:
"audio_aac_1, audio_dolby". Related setting: The rendition groups that
you include in your comma-separated list should all match values that
you specify in the setting Audio group ID (AudioGroupId) for audio
renditions in the same output group as this video rendition. Default
behavior: If you don't specify anything here and for Audio group ID,
MediaConvert puts each audio variant in its own audio rendition group
and associates it with every video variant. Each value in your list
appears in your HLS parent manifest in the EXT-X-STREAM-INF tag as the
value for the AUDIO attribute. To continue the previous example, say
that the file name for the child manifest for your video rendition is
"amazing_video_1.m3u8". Then, in your parent manifest, each value will
appear on separate lines, like this:
#EXT-X-STREAM-INF:AUDIO="audio_aac_1"... amazing_video_1.m3u8
#EXT-X-STREAM-INF:AUDIO="audio_dolby"... amazing_video_1.m3u8
$sel:iFrameOnlyManifest:CmfcSettings'
, cmfcSettings_iFrameOnlyManifest
- Choose Include (INCLUDE) to have MediaConvert generate an HLS child
manifest that lists only the I-frames for this rendition, in addition to
your regular manifest for this rendition. You might use this manifest as
part of a workflow that creates preview functions for your video.
MediaConvert adds both the I-frame only child manifest and the regular
child manifest to the parent manifest. When you don't need the I-frame
only child manifest, keep the default value Exclude (EXCLUDE).
$sel:scte35Esam:CmfcSettings'
, cmfcSettings_scte35Esam
- Use this setting only when you specify SCTE-35 markers from ESAM. Choose
INSERT to put SCTE-35 markers in this output at the insertion points
that you specify in an ESAM XML document. Provide the document in the
setting SCC XML (sccXml).
$sel:audioDuration:CmfcSettings'
, cmfcSettings_audioDuration
- Specify this setting only when your output will be consumed by a
downstream repackaging workflow that is sensitive to very small duration
differences between video and audio. For this situation, choose Match
video duration (MATCH_VIDEO_DURATION). In all other cases, keep the
default value, Default codec duration (DEFAULT_CODEC_DURATION). When you
choose Match video duration, MediaConvert pads the output audio streams
with silence or trims them to ensure that the total duration of each
audio stream is at least as long as the total duration of the video
stream. After padding or trimming, the audio stream duration is no more
than one frame longer than the video stream. MediaConvert applies audio
padding or trimming only to the end of the last segment of the output.
For unsegmented outputs, MediaConvert adds padding only to the end of
the file. When you keep the default value, any minor discrepancies
between audio and video duration will depend on your output audio codec.
$sel:audioGroupId:CmfcSettings'
, cmfcSettings_audioGroupId
- Specify the audio rendition group for this audio rendition. Specify up
to one value for each audio output in your output group. This value
appears in your HLS parent manifest in the EXT-X-MEDIA tag of
TYPE=AUDIO, as the value for the GROUP-ID attribute. For example, if you
specify "audio_aac_1" for Audio group ID, it appears in your manifest
like this: #EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="audio_aac_1". Related
setting: To associate the rendition group that this audio track belongs
to with a video rendition, include the same value that you provide here
for that video output's setting Audio rendition sets
(audioRenditionSets).
$sel:scte35Source:CmfcSettings'
, cmfcSettings_scte35Source
- Ignore this setting unless you have SCTE-35 markers in your input video
file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that
appear in your input to also appear in this output. Choose None (NONE)
if you don't want those SCTE-35 markers in this output.
$sel:audioTrackType:CmfcSettings'
, cmfcSettings_audioTrackType
- Use this setting to control the values that MediaConvert puts in your
HLS parent playlist to control how the client player selects which audio
track to play. The other options for this setting determine the values
that MediaConvert writes for the DEFAULT and AUTOSELECT attributes of
the EXT-X-MEDIA entry for the audio variant. For more information about
these attributes, see the Apple documentation article
https://developer.apple.com/documentation/http_live_streaming/example_playlists_for_http_live_streaming/adding_alternate_media_to_a_playlist.
Choose Alternate audio, auto select, default
(ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT) to set DEFAULT=YES and
AUTOSELECT=YES. Choose this value for only one variant in your output
group. Choose Alternate audio, auto select, not default
(ALTERNATE_AUDIO_AUTO_SELECT) to set DEFAULT=NO and AUTOSELECT=YES.
Choose Alternate Audio, Not Auto Select to set DEFAULT=NO and
AUTOSELECT=NO. When you don't specify a value for this setting,
MediaConvert defaults to Alternate audio, auto select, default. When
there is more than one variant in your output group, you must explicitly
choose a value for this setting.
cmfcSettings_descriptiveVideoServiceFlag :: Lens' CmfcSettings (Maybe CmfcDescriptiveVideoServiceFlag) Source #
Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag (FLAG), MediaConvert includes the parameter CHARACTERISTICS="public.accessibility.describes-video" in the EXT-X-MEDIA entry for this track. When you keep the default choice, Don't flag (DONT_FLAG), MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation.
cmfcSettings_audioRenditionSets :: Lens' CmfcSettings (Maybe Text) Source #
List the audio rendition groups that you want included with this video rendition. Use a comma-separated list. For example, say you want to include the audio rendition groups that have the audio group IDs "audio_aac_1" and "audio_dolby". Then you would specify this value: "audio_aac_1, audio_dolby". Related setting: The rendition groups that you include in your comma-separated list should all match values that you specify in the setting Audio group ID (AudioGroupId) for audio renditions in the same output group as this video rendition. Default behavior: If you don't specify anything here and for Audio group ID, MediaConvert puts each audio variant in its own audio rendition group and associates it with every video variant. Each value in your list appears in your HLS parent manifest in the EXT-X-STREAM-INF tag as the value for the AUDIO attribute. To continue the previous example, say that the file name for the child manifest for your video rendition is "amazing_video_1.m3u8". Then, in your parent manifest, each value will appear on separate lines, like this: #EXT-X-STREAM-INF:AUDIO="audio_aac_1"... amazing_video_1.m3u8 #EXT-X-STREAM-INF:AUDIO="audio_dolby"... amazing_video_1.m3u8
cmfcSettings_iFrameOnlyManifest :: Lens' CmfcSettings (Maybe CmfcIFrameOnlyManifest) Source #
Choose Include (INCLUDE) to have MediaConvert generate an HLS child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition. You might use this manifest as part of a workflow that creates preview functions for your video. MediaConvert adds both the I-frame only child manifest and the regular child manifest to the parent manifest. When you don't need the I-frame only child manifest, keep the default value Exclude (EXCLUDE).
cmfcSettings_scte35Esam :: Lens' CmfcSettings (Maybe CmfcScte35Esam) Source #
Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).
cmfcSettings_audioDuration :: Lens' CmfcSettings (Maybe CmfcAudioDuration) Source #
Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between video and audio. For this situation, choose Match video duration (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (DEFAULT_CODEC_DURATION). When you choose Match video duration, MediaConvert pads the output audio streams with silence or trims them to ensure that the total duration of each audio stream is at least as long as the total duration of the video stream. After padding or trimming, the audio stream duration is no more than one frame longer than the video stream. MediaConvert applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies between audio and video duration will depend on your output audio codec.
cmfcSettings_audioGroupId :: Lens' CmfcSettings (Maybe Text) Source #
Specify the audio rendition group for this audio rendition. Specify up to one value for each audio output in your output group. This value appears in your HLS parent manifest in the EXT-X-MEDIA tag of TYPE=AUDIO, as the value for the GROUP-ID attribute. For example, if you specify "audio_aac_1" for Audio group ID, it appears in your manifest like this: #EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="audio_aac_1". Related setting: To associate the rendition group that this audio track belongs to with a video rendition, include the same value that you provide here for that video output's setting Audio rendition sets (audioRenditionSets).
cmfcSettings_scte35Source :: Lens' CmfcSettings (Maybe CmfcScte35Source) Source #
Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output.
cmfcSettings_audioTrackType :: Lens' CmfcSettings (Maybe CmfcAudioTrackType) Source #
Use this setting to control the values that MediaConvert puts in your HLS parent playlist to control how the client player selects which audio track to play. The other options for this setting determine the values that MediaConvert writes for the DEFAULT and AUTOSELECT attributes of the EXT-X-MEDIA entry for the audio variant. For more information about these attributes, see the Apple documentation article https://developer.apple.com/documentation/http_live_streaming/example_playlists_for_http_live_streaming/adding_alternate_media_to_a_playlist. Choose Alternate audio, auto select, default (ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT) to set DEFAULT=YES and AUTOSELECT=YES. Choose this value for only one variant in your output group. Choose Alternate audio, auto select, not default (ALTERNATE_AUDIO_AUTO_SELECT) to set DEFAULT=NO and AUTOSELECT=YES. Choose Alternate Audio, Not Auto Select to set DEFAULT=NO and AUTOSELECT=NO. When you don't specify a value for this setting, MediaConvert defaults to Alternate audio, auto select, default. When there is more than one variant in your output group, you must explicitly choose a value for this setting.