AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Settings related to your CMAF output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html.

Inheritance Hierarchy

System.Object
  Amazon.MediaConvert.Model.CmafGroupSettings

Namespace: Amazon.MediaConvert.Model
Assembly: AWSSDK.MediaConvert.dll
Version: 3.x.y.z

Syntax

C#
public class CmafGroupSettings

The CmafGroupSettings type exposes the following members

Constructors

NameDescription
Public Method CmafGroupSettings()

Properties

NameTypeDescription
Public Property AdditionalManifests System.Collections.Generic.List<Amazon.MediaConvert.Model.CmafAdditionalManifest>

Gets and sets the property 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.

Public Property BaseUrl System.String

Gets and sets the property 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.

Public Property ClientCache Amazon.MediaConvert.CmafClientCache

Gets and sets the property ClientCache. 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.

Public Property CodecSpecification Amazon.MediaConvert.CmafCodecSpecification

Gets and sets the property CodecSpecification. Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

Public Property DashManifestStyle Amazon.MediaConvert.DashManifestStyle

Gets and sets the property 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.

Public Property Destination System.String

Gets and sets the property Destination. 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.

Public Property DestinationSettings Amazon.MediaConvert.Model.DestinationSettings

Gets and sets the property DestinationSettings. Settings associated with the destination. Will vary based on the type of destination

Public Property Encryption Amazon.MediaConvert.Model.CmafEncryptionSettings

Gets and sets the property Encryption. DRM settings.

Public Property FragmentLength System.Int32

Gets and sets the property 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 to specify whether the encoder enforces this value strictly.

Public Property ImageBasedTrickPlay Amazon.MediaConvert.CmafImageBasedTrickPlay

Gets and sets the property ImageBasedTrickPlay. 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

Public Property ImageBasedTrickPlaySettings Amazon.MediaConvert.Model.CmafImageBasedTrickPlaySettings

Gets and sets the property ImageBasedTrickPlaySettings. Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED

Public Property ManifestCompression Amazon.MediaConvert.CmafManifestCompression

Gets and sets the property ManifestCompression. When set to GZIP, compresses HLS playlist.

Public Property ManifestDurationFormat Amazon.MediaConvert.CmafManifestDurationFormat

Gets and sets the property ManifestDurationFormat. Indicates whether the output manifest should use floating point values for segment duration.

Public Property MinBufferTime System.Int32

Gets and sets the property MinBufferTime. Minimum time of initially buffered media that is needed to ensure smooth playout.

Public Property MinFinalSegmentLength System.Double

Gets and sets the property 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.

Public Property MpdManifestBandwidthType Amazon.MediaConvert.CmafMpdManifestBandwidthType

Gets and sets the property 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.

Public Property MpdProfile Amazon.MediaConvert.CmafMpdProfile

Gets and sets the property MpdProfile. 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.

Public Property PtsOffsetHandlingForBFrames Amazon.MediaConvert.CmafPtsOffsetHandlingForBFrames

Gets and sets the property 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 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.

Public Property SegmentControl Amazon.MediaConvert.CmafSegmentControl

Gets and sets the property 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.

Public Property SegmentLength System.Int32

Gets and sets the property 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 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.

Public Property SegmentLengthControl Amazon.MediaConvert.CmafSegmentLengthControl

Gets and sets the property SegmentLengthControl. 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.

Public Property StreamInfResolution Amazon.MediaConvert.CmafStreamInfResolution

Gets and sets the property StreamInfResolution. Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.

Public Property TargetDurationCompatibilityMode Amazon.MediaConvert.CmafTargetDurationCompatibilityMode
Public Property VideoCompositionOffsets Amazon.MediaConvert.CmafVideoCompositionOffsets

Gets and sets the property 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.

Public Property WriteDashManifest Amazon.MediaConvert.CmafWriteDASHManifest

Gets and sets the property WriteDashManifest. When set to ENABLED, a DASH MPD manifest will be generated for this output.

Public Property WriteHlsManifest Amazon.MediaConvert.CmafWriteHLSManifest

Gets and sets the property WriteHlsManifest. When set to ENABLED, an Apple HLS manifest will be generated for this output.

Public Property WriteSegmentTimelineInRepresentation Amazon.MediaConvert.CmafWriteSegmentTimelineInRepresentation

Gets and sets the property WriteSegmentTimelineInRepresentation. 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5