CaptionItemEntity

Defined in: packages/project-schema/src/items.ts:219

One timed caption cue rendered inside a fixed pixel box.

Extends

• ItemEntity

Indexable

[key: string]: JsonValue

Properties

box

box: BoxValue

Defined in: packages/project-schema/src/items.ts:222

---

cueSettings?

optional cueSettings: JsonObject

Defined in: packages/project-schema/src/items.ts:226

---

enabled

enabled: boolean

Defined in: packages/project-schema/src/types.ts:157

Inherited from

ItemEntity.enabled

---

id

id: string

Defined in: packages/project-schema/src/types.ts:43

Inherited from

ItemEntity.id

---

linkGroupId?

optional linkGroupId: string

Defined in: packages/project-schema/src/types.ts:161

Inherited from

ItemEntity.linkGroupId

---

markerIds?

optional markerIds: string[]

Defined in: packages/project-schema/src/types.ts:160

Inherited from

ItemEntity.markerIds

---

materialInstanceIds

materialInstanceIds: string[]

Defined in: packages/project-schema/src/types.ts:159

Inherited from

ItemEntity.materialInstanceIds

---

overflow?

optional overflow: "clip" | "auto-fit"

Defined in: packages/project-schema/src/items.ts:225

A caption is one cue in a fixed box, so it may only clip or shrink.

---

range

range: TimeRange & JsonObject

Defined in: packages/project-schema/src/types.ts:158

Inherited from

VideoItemEntity.range

---

style

style: JsonObject

Defined in: packages/project-schema/src/items.ts:223

---

text

text: string

Defined in: packages/project-schema/src/items.ts:221

---

trackId

trackId: string

Defined in: packages/project-schema/src/types.ts:155

Inherited from

ItemEntity.trackId

---

type

type: "caption"

Defined in: packages/project-schema/src/items.ts:220

Overrides

ItemEntity.type

---

visual

visual: ItemVisualProperties

Defined in: packages/project-schema/src/items.ts:227