CmafTtmlOutputSettings interface

Settings for a CMAF TTML Output.

TTML subtitles (ISO/IEC 14496-30, stpp) are carried as fragmented-MP4 segments for both HLS and DASH (unlike WebVTT, which uses raw .vtt for HLS). see NorskOutput.cmafTtml()

Signature:

export interface CmafTtmlOutputSettings extends SinkNodeSettings<CmafTtmlOutputNode>

Properties

Property Type Description

cueLatencyToleranceMs?

number

(Optional) How far behind live the subtitle "forcing timer" keeps its finalisation watermark when no cues are flowing, so that cues arriving late relative to their media timestamp (e.g. a transcriber holding a caption until an utterance ends) are not stranded in an already-finalised segment. Raise this if captioning for a stream is very stop-start / delayed. Default: one segment.

destinations

CmafDestinationSettings[]

A list of destinations CmafDestinationSettings for this stream to be published to

discontinuityMode?

PlaylistDiscontinuityMode

(Optional) How to handle discontinuities in the media playlist

maximumPlaylistPushIntervalMs?

number

(Optional) Maximum elapsed duration since last playlist push before initiating a new push (ms)

mqaConfig?

MqaConfig

(Optional) Optional MQA quality-metric aggregation weights. When omitted, server defaults are used.

name?

string

(Optional) The name to use for the playlist in a multivariant playlist

pdtEverySegment?

boolean

(Optional) Whether to insert a program date-time directive on every segment

pdtSource?

PdtSource

(Optional) What source to use for the program-date-time

playlistFormat?

CmafPlaylistFormat

(Optional) Playlist format(s) to generate

renditionGroupId?

string

(Optional) When generating LL-HLS playlists, include rendition reports for all streams sharing this renditionGroupId

segmentDurationSeconds

number

The target segment duration in seconds