Struct aws_sdk_mediaconvert::types::CmafGroupSettings
source · #[non_exhaustive]pub struct CmafGroupSettings {Show 27 fields
pub additional_manifests: Option<Vec<CmafAdditionalManifest>>,
pub base_url: Option<String>,
pub client_cache: Option<CmafClientCache>,
pub codec_specification: Option<CmafCodecSpecification>,
pub dash_manifest_style: Option<DashManifestStyle>,
pub destination: Option<String>,
pub destination_settings: Option<DestinationSettings>,
pub encryption: Option<CmafEncryptionSettings>,
pub fragment_length: Option<i32>,
pub image_based_trick_play: Option<CmafImageBasedTrickPlay>,
pub image_based_trick_play_settings: Option<CmafImageBasedTrickPlaySettings>,
pub manifest_compression: Option<CmafManifestCompression>,
pub manifest_duration_format: Option<CmafManifestDurationFormat>,
pub min_buffer_time: Option<i32>,
pub min_final_segment_length: Option<f64>,
pub mpd_manifest_bandwidth_type: Option<CmafMpdManifestBandwidthType>,
pub mpd_profile: Option<CmafMpdProfile>,
pub pts_offset_handling_for_b_frames: Option<CmafPtsOffsetHandlingForBFrames>,
pub segment_control: Option<CmafSegmentControl>,
pub segment_length: Option<i32>,
pub segment_length_control: Option<CmafSegmentLengthControl>,
pub stream_inf_resolution: Option<CmafStreamInfResolution>,
pub target_duration_compatibility_mode: Option<CmafTargetDurationCompatibilityMode>,
pub video_composition_offsets: Option<CmafVideoCompositionOffsets>,
pub write_dash_manifest: Option<CmafWriteDashManifest>,
pub write_hls_manifest: Option<CmafWriteHlsManifest>,
pub write_segment_timeline_in_representation: Option<CmafWriteSegmentTimelineInRepresentation>,
}
Expand description
Settings related to your CMAF output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.additional_manifests: Option<Vec<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.
base_url: Option<String>
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.
client_cache: Option<CmafClientCache>
Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled and control caching in your video distribution set up. For example, use the Cache-Control http header.
codec_specification: Option<CmafCodecSpecification>
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
dash_manifest_style: Option<DashManifestStyle>
Specify how MediaConvert writes SegmentTimeline in your output DASH manifest. To write a SegmentTimeline in each video Representation: Keep the default value, Basic. To write a common SegmentTimeline in the video AdaptationSet: Choose Compact. Note that MediaConvert will still write a SegmentTimeline in any Representation that does not share a common timeline. To write a video AdaptationSet for each different output framerate, and a common SegmentTimeline in each AdaptationSet: Choose Distinct.
destination: Option<String>
Use 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.
destination_settings: Option<DestinationSettings>
Settings associated with the destination. Will vary based on the type of destination
encryption: Option<CmafEncryptionSettings>
DRM settings.
fragment_length: Option<i32>
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 to specify whether the encoder enforces this value strictly.
image_based_trick_play: Option<CmafImageBasedTrickPlay>
Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. When you enable Write HLS manifest, 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, 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
image_based_trick_play_settings: Option<CmafImageBasedTrickPlaySettings>
Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
manifest_compression: Option<CmafManifestCompression>
When set to GZIP, compresses HLS playlist.
manifest_duration_format: Option<CmafManifestDurationFormat>
Indicates whether the output manifest should use floating point values for segment duration.
min_buffer_time: Option<i32>
Minimum time of initially buffered media that is needed to ensure smooth playout.
min_final_segment_length: Option<f64>
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.
mpd_manifest_bandwidth_type: Option<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.
mpd_profile: Option<CmafMpdProfile>
Specify whether your DASH profile is on-demand or main. When you choose Main profile, the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand, 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 to Single file.
pts_offset_handling_for_b_frames: Option<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 when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose 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.
segment_control: Option<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.
segment_length: Option<i32>
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 to specify whether the encoder enforces this value strictly. Use Segment control to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries.
segment_length_control: Option<CmafSegmentLengthControl>
Specify how you want MediaConvert to determine the segment length. Choose Exact to have the encoder use the exact length that you specify with the setting Segment length. This might result in extra I-frames. Choose Multiple of GOP to have the encoder round up the segment lengths to match the next GOP boundary.
stream_inf_resolution: Option<CmafStreamInfResolution>
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
target_duration_compatibility_mode: Option<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.
video_composition_offsets: Option<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.
write_dash_manifest: Option<CmafWriteDashManifest>
When set to ENABLED, a DASH MPD manifest will be generated for this output.
write_hls_manifest: Option<CmafWriteHlsManifest>
When set to ENABLED, an Apple HLS manifest will be generated for this output.
write_segment_timeline_in_representation: Option<CmafWriteSegmentTimelineInRepresentation>
When you enable Precise segment duration in DASH manifests, 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.
Implementations§
source§impl CmafGroupSettings
impl CmafGroupSettings
sourcepub fn additional_manifests(&self) -> &[CmafAdditionalManifest]
pub fn additional_manifests(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .additional_manifests.is_none()
.
sourcepub fn base_url(&self) -> Option<&str>
pub fn base_url(&self) -> Option<&str>
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.
sourcepub fn client_cache(&self) -> Option<&CmafClientCache>
pub fn client_cache(&self) -> Option<&CmafClientCache>
Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled and control caching in your video distribution set up. For example, use the Cache-Control http header.
sourcepub fn codec_specification(&self) -> Option<&CmafCodecSpecification>
pub fn codec_specification(&self) -> Option<&CmafCodecSpecification>
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
sourcepub fn dash_manifest_style(&self) -> Option<&DashManifestStyle>
pub fn dash_manifest_style(&self) -> Option<&DashManifestStyle>
Specify how MediaConvert writes SegmentTimeline in your output DASH manifest. To write a SegmentTimeline in each video Representation: Keep the default value, Basic. To write a common SegmentTimeline in the video AdaptationSet: Choose Compact. Note that MediaConvert will still write a SegmentTimeline in any Representation that does not share a common timeline. To write a video AdaptationSet for each different output framerate, and a common SegmentTimeline in each AdaptationSet: Choose Distinct.
sourcepub fn destination(&self) -> Option<&str>
pub fn destination(&self) -> Option<&str>
Use 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.
sourcepub fn destination_settings(&self) -> Option<&DestinationSettings>
pub fn destination_settings(&self) -> Option<&DestinationSettings>
Settings associated with the destination. Will vary based on the type of destination
sourcepub fn encryption(&self) -> Option<&CmafEncryptionSettings>
pub fn encryption(&self) -> Option<&CmafEncryptionSettings>
DRM settings.
sourcepub fn fragment_length(&self) -> Option<i32>
pub fn fragment_length(&self) -> Option<i32>
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 to specify whether the encoder enforces this value strictly.
sourcepub fn image_based_trick_play(&self) -> Option<&CmafImageBasedTrickPlay>
pub fn image_based_trick_play(&self) -> Option<&CmafImageBasedTrickPlay>
Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. When you enable Write HLS manifest, 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, 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
sourcepub fn image_based_trick_play_settings(
&self
) -> Option<&CmafImageBasedTrickPlaySettings>
pub fn image_based_trick_play_settings( &self ) -> Option<&CmafImageBasedTrickPlaySettings>
Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
sourcepub fn manifest_compression(&self) -> Option<&CmafManifestCompression>
pub fn manifest_compression(&self) -> Option<&CmafManifestCompression>
When set to GZIP, compresses HLS playlist.
sourcepub fn manifest_duration_format(&self) -> Option<&CmafManifestDurationFormat>
pub fn manifest_duration_format(&self) -> Option<&CmafManifestDurationFormat>
Indicates whether the output manifest should use floating point values for segment duration.
sourcepub fn min_buffer_time(&self) -> Option<i32>
pub fn min_buffer_time(&self) -> Option<i32>
Minimum time of initially buffered media that is needed to ensure smooth playout.
sourcepub fn min_final_segment_length(&self) -> Option<f64>
pub fn min_final_segment_length(&self) -> Option<f64>
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.
sourcepub fn mpd_manifest_bandwidth_type(
&self
) -> Option<&CmafMpdManifestBandwidthType>
pub fn mpd_manifest_bandwidth_type( &self ) -> Option<&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.
sourcepub fn mpd_profile(&self) -> Option<&CmafMpdProfile>
pub fn mpd_profile(&self) -> Option<&CmafMpdProfile>
Specify whether your DASH profile is on-demand or main. When you choose Main profile, the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand, 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 to Single file.
sourcepub fn pts_offset_handling_for_b_frames(
&self
) -> Option<&CmafPtsOffsetHandlingForBFrames>
pub fn pts_offset_handling_for_b_frames( &self ) -> Option<&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 when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose 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.
sourcepub fn segment_control(&self) -> Option<&CmafSegmentControl>
pub fn segment_control(&self) -> Option<&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.
sourcepub fn segment_length(&self) -> Option<i32>
pub fn segment_length(&self) -> Option<i32>
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 to specify whether the encoder enforces this value strictly. Use Segment control to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries.
sourcepub fn segment_length_control(&self) -> Option<&CmafSegmentLengthControl>
pub fn segment_length_control(&self) -> Option<&CmafSegmentLengthControl>
Specify how you want MediaConvert to determine the segment length. Choose Exact to have the encoder use the exact length that you specify with the setting Segment length. This might result in extra I-frames. Choose Multiple of GOP to have the encoder round up the segment lengths to match the next GOP boundary.
sourcepub fn stream_inf_resolution(&self) -> Option<&CmafStreamInfResolution>
pub fn stream_inf_resolution(&self) -> Option<&CmafStreamInfResolution>
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
sourcepub fn target_duration_compatibility_mode(
&self
) -> Option<&CmafTargetDurationCompatibilityMode>
pub fn target_duration_compatibility_mode( &self ) -> Option<&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.
sourcepub fn video_composition_offsets(&self) -> Option<&CmafVideoCompositionOffsets>
pub fn video_composition_offsets(&self) -> Option<&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.
sourcepub fn write_dash_manifest(&self) -> Option<&CmafWriteDashManifest>
pub fn write_dash_manifest(&self) -> Option<&CmafWriteDashManifest>
When set to ENABLED, a DASH MPD manifest will be generated for this output.
sourcepub fn write_hls_manifest(&self) -> Option<&CmafWriteHlsManifest>
pub fn write_hls_manifest(&self) -> Option<&CmafWriteHlsManifest>
When set to ENABLED, an Apple HLS manifest will be generated for this output.
sourcepub fn write_segment_timeline_in_representation(
&self
) -> Option<&CmafWriteSegmentTimelineInRepresentation>
pub fn write_segment_timeline_in_representation( &self ) -> Option<&CmafWriteSegmentTimelineInRepresentation>
When you enable Precise segment duration in DASH manifests, 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.
source§impl CmafGroupSettings
impl CmafGroupSettings
sourcepub fn builder() -> CmafGroupSettingsBuilder
pub fn builder() -> CmafGroupSettingsBuilder
Creates a new builder-style object to manufacture CmafGroupSettings
.
Trait Implementations§
source§impl Clone for CmafGroupSettings
impl Clone for CmafGroupSettings
source§fn clone(&self) -> CmafGroupSettings
fn clone(&self) -> CmafGroupSettings
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CmafGroupSettings
impl Debug for CmafGroupSettings
source§impl PartialEq for CmafGroupSettings
impl PartialEq for CmafGroupSettings
source§fn eq(&self, other: &CmafGroupSettings) -> bool
fn eq(&self, other: &CmafGroupSettings) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for CmafGroupSettings
Auto Trait Implementations§
impl Freeze for CmafGroupSettings
impl RefUnwindSafe for CmafGroupSettings
impl Send for CmafGroupSettings
impl Sync for CmafGroupSettings
impl Unpin for CmafGroupSettings
impl UnwindSafe for CmafGroupSettings
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more