AelionPreviewOptions

Defined in: packages/sdk/src/types.ts:221

Extends

• AelionPreviewQualityOptions

Properties

overlay()?

readonly optional overlay: (transaction) => void

Defined in: packages/sdk/src/types.ts:238

Renders an edit that has not been made.

The callback describes a transaction exactly as transaction.edit would, but nothing is committed: no revision, no history entry, no change event. The frame shows the Project as it would be, and the loaded Project is untouched whether the interaction is completed or abandoned.

This is what a drag needs. Committing on every pointer move to see the result rearranges the timeline under the cursor and fills the undo stack with states nobody chose; without it, a host can only preview a proposed edit by making it. Pair with transaction.commands.applyPlacements on release to write the layout the user was looking at.

Parameters

transaction

TransactionBuilder

Returns

void

---

quality?

readonly optional quality: "draft" | "full"

Defined in: packages/sdk/src/types.ts:216

Draft defaults to half-resolution; full defaults to Project resolution.

Inherited from

AelionPreviewQualityOptions.quality

---

renderScale?

readonly optional renderScale: number

Defined in: packages/sdk/src/types.ts:218

Explicit preview scale in (0, 1]. Overrides the quality default.

Inherited from

AelionPreviewQualityOptions.renderScale

---

signal?

readonly optional signal: AbortSignal

Defined in: packages/sdk/src/types.ts:223

---

timeUs

readonly timeUs: number

Defined in: packages/sdk/src/types.ts:222