@twick/workflow / Exports

@twick/workflow

Table of contents

Interfaces

• ApplyCaptionToEditorInput
• CaptionProjectApplyInput
• CaptionProjectBuildInput
• CaptionSegmentMs
• CaptionTrackBuildInput
• CaptionTrackStyle
• TemplateSpec
• TemplateTrackSpec

Type Aliases

• WorkflowProjectJSON
• WorkflowProjectPatch

Functions

• applyCaptionsToEditor
• applyCaptionsToProject
• applyProjectPatch
• applyTemplateToExistingProject
• buildCaptionProject
• buildCaptionTrack
• buildProjectFromTemplateSpec
• buildProjectVariantFromTemplate

Type Aliases

WorkflowProjectJSON

Ƭ WorkflowProjectJSON: ProjectJSON & { properties?: { height: number ; width: number } }

Defined in

types.ts:96

---

WorkflowProjectPatch

Ƭ WorkflowProjectPatch: { payload: CaptionProjectApplyInput ; type: "captions" }

Defined in

projects.ts:5

Functions

applyCaptionsToEditor

▸ applyCaptionsToEditor(editor, input): Promise<void>

Parameters

Name	Type
editor	TimelineEditor
input	ApplyCaptionToEditorInput

Returns

Promise<void>

Defined in

captions.ts:268

---

applyCaptionsToProject

▸ applyCaptionsToProject(project, input): ProjectJSON

Parameters

Name	Type
project	ProjectJSON
input	CaptionProjectApplyInput

Returns

ProjectJSON

Defined in

captions.ts:158

---

applyProjectPatch

▸ applyProjectPatch(project, patch): ProjectJSON

Parameters

Name	Type
project	ProjectJSON
patch	Object
patch.payload	CaptionProjectApplyInput
patch.type	"captions"

Returns

ProjectJSON

Defined in

projects.ts:11

---

applyTemplateToExistingProject

▸ applyTemplateToExistingProject(project, spec): WorkflowProjectJSON

Parameters

Name	Type
project	ProjectJSON
spec	TemplateSpec

Returns

WorkflowProjectJSON

Defined in

templates.ts:56

---

buildCaptionProject

▸ buildCaptionProject(input): WorkflowProjectJSON

Parameters

Name	Type
input	CaptionProjectBuildInput

Returns

WorkflowProjectJSON

Defined in

captions.ts:97

---

buildCaptionTrack

▸ buildCaptionTrack(input): TrackJSON

Parameters

Name	Type
input	CaptionTrackBuildInput

Returns

TrackJSON

Defined in

captions.ts:60

---

buildProjectFromTemplateSpec

▸ buildProjectFromTemplateSpec(spec): WorkflowProjectJSON

Parameters

Name	Type
spec	TemplateSpec

Returns

WorkflowProjectJSON

Defined in

templates.ts:23

---

buildProjectVariantFromTemplate

▸ buildProjectVariantFromTemplate(baseProject, spec): WorkflowProjectJSON

Parameters

Name	Type
baseProject	ProjectJSON
spec	TemplateSpec

Returns

WorkflowProjectJSON

Defined in

templates.ts:36