Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

CmafGroupSettings

import type { CmafGroupSettings } from "https://aws-api.deno.dev/v0.4/services/mediaconvert.ts?docs=full";

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.

interface CmafGroupSettings {
AdditionalManifests?: CmafAdditionalManifest[] | null;
BaseUrl?: string | null;
ClientCache?: CmafClientCache | null;
CodecSpecification?: CmafCodecSpecification | null;
DashManifestStyle?: DashManifestStyle | null;
Destination?: string | null;
DestinationSettings?: DestinationSettings | null;
Encryption?: CmafEncryptionSettings | null;
FragmentLength?: number | null;
ImageBasedTrickPlay?: CmafImageBasedTrickPlay | null;
ImageBasedTrickPlaySettings?: CmafImageBasedTrickPlaySettings | null;
ManifestCompression?: CmafManifestCompression | null;
ManifestDurationFormat?: CmafManifestDurationFormat | null;
MinBufferTime?: number | null;
MinFinalSegmentLength?: number | null;
MpdManifestBandwidthType?: CmafMpdManifestBandwidthType | null;
MpdProfile?: CmafMpdProfile | null;
PtsOffsetHandlingForBFrames?: CmafPtsOffsetHandlingForBFrames | null;
SegmentControl?: CmafSegmentControl | null;
SegmentLength?: number | null;
SegmentLengthControl?: CmafSegmentLengthControl | null;
StreamInfResolution?: CmafStreamInfResolution | null;
TargetDurationCompatibilityMode?: CmafTargetDurationCompatibilityMode | null;
VideoCompositionOffsets?: CmafVideoCompositionOffsets | null;
WriteDashManifest?: CmafWriteDASHManifest | null;
WriteHlsManifest?: CmafWriteHLSManifest | null;
WriteSegmentTimelineInRepresentation?: CmafWriteSegmentTimelineInRepresentation | null;
}

§Properties

§
AdditionalManifests?: CmafAdditionalManifest[] | null
[src]

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?: string | null
[src]

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?: CmafClientCache | null
[src]

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?: CmafCodecSpecification | null
[src]

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

§
DashManifestStyle?: DashManifestStyle | null
[src]

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?: string | null
[src]

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?: DestinationSettings | null
[src]

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

§
Encryption?: CmafEncryptionSettings | null
[src]

DRM settings.

§
FragmentLength?: number | null
[src]

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?: CmafImageBasedTrickPlay | null
[src]

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?: CmafImageBasedTrickPlaySettings | null
[src]

Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED

§
ManifestCompression?: CmafManifestCompression | null
[src]

When set to GZIP, compresses HLS playlist.

§
ManifestDurationFormat?: CmafManifestDurationFormat | null
[src]

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

§
MinBufferTime?: number | null
[src]

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

§
MinFinalSegmentLength?: number | null
[src]

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?: CmafMpdManifestBandwidthType | null
[src]

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?: CmafMpdProfile | null
[src]

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?: CmafPtsOffsetHandlingForBFrames | null
[src]

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?: CmafSegmentControl | null
[src]

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?: number | null
[src]

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?: CmafSegmentLengthControl | null
[src]

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?: CmafStreamInfResolution | null
[src]

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

§
TargetDurationCompatibilityMode?: CmafTargetDurationCompatibilityMode | null
[src]

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 (

§
VideoCompositionOffsets?: CmafVideoCompositionOffsets | null
[src]

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?: CmafWriteDASHManifest | null
[src]

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

§
WriteHlsManifest?: CmafWriteHLSManifest | null
[src]

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

§
WriteSegmentTimelineInRepresentation?: CmafWriteSegmentTimelineInRepresentation | null
[src]

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.