HlsGroupSettings class
Hls Group Settings
Constructors
-
HlsGroupSettings({required OutputLocationRef destination, List<
HlsAdMarkers> ? adMarkers, String? baseUrlContent, String? baseUrlContent1, String? baseUrlManifest, String? baseUrlManifest1, List<CaptionLanguageMapping> ? captionLanguageMappings, HlsCaptionLanguageSetting? captionLanguageSetting, HlsClientCache? clientCache, HlsCodecSpecification? codecSpecification, String? constantIv, HlsDirectoryStructure? directoryStructure, HlsDiscontinuityTags? discontinuityTags, HlsEncryptionType? encryptionType, HlsCdnSettings? hlsCdnSettings, HlsId3SegmentTaggingState? hlsId3SegmentTagging, IFrameOnlyPlaylistType? iFrameOnlyPlaylists, HlsIncompleteSegmentBehavior? incompleteSegmentBehavior, int? indexNSegments, InputLossActionForHlsOut? inputLossAction, HlsIvInManifest? ivInManifest, HlsIvSource? ivSource, int? keepSegments, String? keyFormat, String? keyFormatVersions, KeyProviderSettings? keyProviderSettings, HlsManifestCompression? manifestCompression, HlsManifestDurationFormat? manifestDurationFormat, int? minSegmentLength, HlsMode? mode, HlsOutputSelection? outputSelection, HlsProgramDateTime? programDateTime, int? programDateTimePeriod, HlsRedundantManifest? redundantManifest, int? segmentLength, HlsSegmentationMode? segmentationMode, int? segmentsPerSubdirectory, HlsStreamInfResolution? streamInfResolution, HlsTimedMetadataId3Frame? timedMetadataId3Frame, int? timedMetadataId3Period, int? timestampDeltaMilliseconds, HlsTsFileMode? tsFileMode}) -
HlsGroupSettings.fromJson(Map<
String, dynamic> json) -
factory
Properties
-
adMarkers
→ List<
HlsAdMarkers> ? -
Choose one or more ad marker types to pass SCTE35 signals through to this
group of Apple HLS outputs.
final
- baseUrlContent → 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
- baseUrlContent1 → String?
-
Optional. One value per output group.
final
- baseUrlManifest → 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
- baseUrlManifest1 → String?
-
Optional. One value per output group.
final
-
captionLanguageMappings
→ List<
CaptionLanguageMapping> ? -
Mapping of up to 4 caption channels to caption languages. Is only
meaningful if captionLanguageSetting is set to "insert".
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?
-
When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest,
which prevents clients from saving media segments for later replay.
final
- codecSpecification → HlsCodecSpecification?
-
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist
generation.
final
- constantIv → String?
-
For use with encryptionType. This is a 128-bit, 16-byte hex value
represented by a 32-character text string. If ivSource is set to "explicit"
then this parameter is required and is used as the IV for encryption.
final
- destination → OutputLocationRef
-
A directory or HTTP destination for the HLS segments, manifest files, and
encryption keys (if enabled).
final
- directoryStructure → HlsDirectoryStructure?
-
Place segments in subdirectories.
final
- discontinuityTags → HlsDiscontinuityTags?
-
Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child
manifests for this output group.
Typically, choose Insert because these tags are required in the manifest
(according to the HLS specification) and serve an important purpose.
Choose Never Insert only if the downstream system is doing real-time
failover (without using the MediaLive automatic failover feature) and only
if that downstream system has advised you to exclude the tags.
final
- encryptionType → HlsEncryptionType?
-
Encrypts the segments with the given encryption scheme. Exclude this
parameter if no encryption is desired.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- hlsCdnSettings → HlsCdnSettings?
-
Parameters that control interactions with the CDN.
final
- hlsId3SegmentTagging → HlsId3SegmentTaggingState?
-
State of HLS ID3 Segment Tagging
final
- iFrameOnlyPlaylists → IFrameOnlyPlaylistType?
-
DISABLED: Do not create an I-frame-only manifest, but do create the master
and media manifests (according to the Output Selection field).
final
- incompleteSegmentBehavior → HlsIncompleteSegmentBehavior?
-
Specifies whether to include the final (incomplete) segment in the media
output when the pipeline stops producing output because of a channel stop, a
channel pause or a loss of input to the pipeline.
Auto means that MediaLive decides whether to include the final segment,
depending on the channel class and the types of output groups.
Suppress means to never include the incomplete segment. We recommend you
choose Auto and let MediaLive control the behavior.
final
- indexNSegments → int?
-
Applies only if Mode field is LIVE.
final
- inputLossAction → InputLossActionForHlsOut?
-
Parameter that control output group behavior on input loss.
final
- ivInManifest → HlsIvInManifest?
-
For use with encryptionType. The IV (Initialization Vector) is a 128-bit
number used in conjunction with the key for encrypting blocks. If set to
"include", IV is listed in the manifest, otherwise the IV is not in the
manifest.
final
- ivSource → HlsIvSource?
-
For use with encryptionType. The IV (Initialization Vector) is a 128-bit
number used in conjunction with the key for encrypting blocks. If this
setting is "followsSegmentNumber", it will cause the IV to change every
segment (to match the segment number). If this is set to "explicit", you
must enter a constantIv value.
final
- keepSegments → int?
-
Applies only if Mode field is LIVE.
final
- keyFormat → String?
-
The value specifies how the key is represented in the resource identified by
the URI. If parameter is absent, an implicit value of "identity" is used.
A reverse DNS string can also be given.
final
- keyFormatVersions → String?
-
Either a single positive integer version value or a slash delimited list of
version values (1/2/3).
final
- keyProviderSettings → KeyProviderSettings?
-
The key provider settings.
final
- manifestCompression → HlsManifestCompression?
-
When set to gzip, compresses HLS playlist.
final
- manifestDurationFormat → HlsManifestDurationFormat?
-
Indicates whether the output manifest should use floating point or integer
values for segment duration.
final
- minSegmentLength → int?
-
When set, minimumSegmentLength is enforced by looking ahead and back within
the specified range for a nearby avail and extending the segment size if
needed.
final
- mode → HlsMode?
-
If "vod", all segments are indexed and kept permanently in the destination
and manifest. If "live", only the number segments specified in keepSegments
and indexNSegments are kept; newer segments replace older segments, which
may prevent players from rewinding all the way to the beginning of the
event.
final
- outputSelection → HlsOutputSelection?
-
MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable,
and media manifests) for this 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
timestampOffset.
final
- programDateTimePeriod → int?
-
Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
final
- redundantManifest → HlsRedundantManifest?
-
ENABLED: The master manifest (.m3u8 file) for each pipeline includes
information about both pipelines: first its own media files, then the media
files of the other pipeline. This feature allows playout device that support
stale manifest detection to switch from one manifest to the other, when the
current manifest seems to be stale. There are still two destinations and two
master manifests, but both master manifests reference the media files from
both pipelines.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- segmentationMode → HlsSegmentationMode?
-
useInputSegmentation has been deprecated. The configured segment size is
always used.
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 subdirectoryPerStream 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
- tsFileMode → HlsTsFileMode?
-
SEGMENTED_FILES: Emit the program as segments - multiple .ts media files.
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