HlsGroupSettings class

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to HLS_GROUP_SETTINGS.

Constructors

HlsGroupSettings({List<HlsAdMarkers>? adMarkers, List<HlsAdditionalManifest>? additionalManifests, HlsAudioOnlyHeader? audioOnlyHeader, String? baseUrl, List<HlsCaptionLanguageMapping>? captionLanguageMappings, HlsCaptionLanguageSetting? captionLanguageSetting, HlsClientCache? clientCache, HlsCodecSpecification? codecSpecification, String? destination, DestinationSettings? destinationSettings, HlsDirectoryStructure? directoryStructure, HlsEncryptionSettings? encryption, HlsManifestCompression? manifestCompression, HlsManifestDurationFormat? manifestDurationFormat, double? minFinalSegmentLength, int? minSegmentLength, HlsOutputSelection? outputSelection, HlsProgramDateTime? programDateTime, int? programDateTimePeriod, HlsSegmentControl? segmentControl, int? segmentLength, int? segmentsPerSubdirectory, HlsStreamInfResolution? streamInfResolution, HlsTimedMetadataId3Frame? timedMetadataId3Frame, int? timedMetadataId3Period, int? timestampDeltaMilliseconds})

HlsGroupSettings.fromJson(Map<String, dynamic> json)

factory

Properties

additionalManifests → List<HlsAdditionalManifest>?

By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job. This default manifest references 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.

final

adMarkers → List<HlsAdMarkers>?

Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves.

final

audioOnlyHeader → HlsAudioOnlyHeader?

Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include (INCLUDE), to output audio-only headers. Choose Exclude (EXCLUDE) to remove the audio-only headers from your audio segments.

final

baseUrl → String?

A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.

final

captionLanguageMappings → List<HlsCaptionLanguageMapping>?

Language to be used on Caption outputs

final

captionLanguageSetting → HlsCaptionLanguageSetting?

Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.

final

clientCache → HlsClientCache?

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.

final

codecSpecification → HlsCodecSpecification?

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

final

destination → String?

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.

final

destinationSettings → DestinationSettings?

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

final

directoryStructure → HlsDirectoryStructure?

Indicates whether segments should be placed in subdirectories.

final

encryption → HlsEncryptionSettings?

DRM settings.

final

hashCode → int

The hash code for this object.

no setter, inherited

manifestCompression → HlsManifestCompression?

When set to GZIP, compresses HLS playlist.

final

manifestDurationFormat → HlsManifestDurationFormat?

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

final

minFinalSegmentLength → double?

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.

final

minSegmentLength → int?

When set, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.

final

outputSelection → HlsOutputSelection?

Indicates whether the .m3u8 manifest file should be generated for this HLS output group.

final

programDateTime → HlsProgramDateTime?

Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset.

final

programDateTimePeriod → int?

Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

segmentControl → HlsSegmentControl?

When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.

final

segmentLength → int?

Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.

final

segmentsPerSubdirectory → int?

Number of segments to write to a subdirectory before starting a new one. directoryStructure must be SINGLE_DIRECTORY for this setting to have an effect.

final

streamInfResolution → HlsStreamInfResolution?

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

final

timedMetadataId3Frame → HlsTimedMetadataId3Frame?

Indicates ID3 frame that has the timecode.

final

timedMetadataId3Period → int?

Timed Metadata interval in seconds.

final

timestampDeltaMilliseconds → int?

Provides an extra millisecond delta offset to fine tune the timestamps.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited