Skip to content

DependencyOverlayOptions

DependencyOverlayOptions = Pick<OverlayCommon, "relativeTo" | "x" | "y" | "width" | "height" | "aspectRatio" | "fill" | "duration" | "clip" | "pinToScreen" | "overMouse"> & object

Defined in: asset.ts:390

Placement options accepted by selected. These are the subset of OverlayCommon that apply to a render dependency: the embedded output is a finished still or clip, so source-only fields (over/margin/animate/ css/capturePadding) do not apply.

optional end?: TimelineOffset

Early end into the embedded VIDEO (video dependencies only).

optional inheritSubtitles?: boolean

Also carry the embedded target’s narration subtitles up into the surrounding video. The embed always plays the target’s audio; with this on, the target’s subtitles are additionally shown as subtitles of the surrounding video (in its VTT track) for the window the embed plays, wherever the surrounding video has no competing narration of its own. Defaults to false.

optional language?: string

Pin the embed to a specific language of the target (a language code such as 'fi'), independent of the surrounding render’s language. Use this to embed a fixed-language version of the target no matter which language the surrounding video is rendered in. When the target has no finished render in this language, the dependent render FAILS explicitly (the error lists the languages the target does have) rather than falling back to another one. Omit to inherit the surrounding render’s language (embedding the target’s output for the matching language, or its single language when unambiguous).

optional start?: TimelineOffset

Late start into the embedded VIDEO (ms number/timecode/'50%' position). Video dependencies only; rejected when the target resolves to a screenshot.