@twick/video-editor / Exports

@twick/video-editor

Table of contents

Classes

• BaseMediaManager
• BrowserMediaManager

Type Aliases

• Animation
• MediaItem
• PaginationOptions
• SearchOptions

Variables

• ANIMATIONS
• AVAILABLE_TEXT_FONTS
• DEFAULT_ELEMENT_COLORS
• DEFAULT_TIMELINE_ZOOM
• DRAG_TYPE
• INITIAL_TIMELINE_DATA
• MIN_DURATION
• TEXT_EFFECTS
• animationGifs

Functions

• PlayerControls
• TimelineManager
• default
• getAnimationGif
• usePlayerControl
• useTimelineControl

Type Aliases

Animation

Ƭ Animation: Object

Type declaration

Name	Type
animate?	"enter" | "exit" | "both"
direction?	"up" | "down" | "left" | "right" | "center"
getSample	(animation?: Animation) => string
interval?	number
mode?	"in" | "out"
name	string
options?	{ animate?: string[] ; direction?: string[] ; mode?: string[] }
options.animate?	string[]
options.direction?	string[]
options.mode?	string[]

Defined in

packages/video-editor/src/helpers/types.ts:27

---

MediaItem

Ƭ MediaItem: Object

Type declaration

Name	Type
arrayBuffer?	ArrayBuffer
id	string
metadata?	Record<string, any>
thumbnail?	string
type	"image" | "video" | "audio"
url	string

Defined in

packages/video-editor/src/helpers/types.ts:1

---

PaginationOptions

Ƭ PaginationOptions: Object

Type declaration

Name	Type
limit	number
page	number

Defined in

packages/video-editor/src/helpers/types.ts:10

---

SearchOptions

Ƭ SearchOptions: Object

Type declaration

Name	Type
metadata?	Record<string, any>
query	string
type?	"image" | "video" | "audio"

Defined in

packages/video-editor/src/helpers/types.ts:15

Variables

ANIMATIONS

• Const ANIMATIONS: Animation[]

Defined in

packages/video-editor/src/helpers/animation-manager.tsx:4

---

AVAILABLE_TEXT_FONTS

• Const AVAILABLE_TEXT_FONTS: Object

Type declaration

Name	Type
BANGERS	string
BIRTHSTONE	string
BRITTANY_SIGNATURE	string
CORINTHIA	string
DASHER	string
HANDYRUSH	string
IMPACT	string
IMPERIAL_SCRIPT	string
KAPAKANA	string
KUMAR_ONE_OUTLINE	string
LONDRI_OUTLINE	string
LUCKIEST_GUY	string
LUMANOSIMO	string
MARCK_SCRIPT	string
MONTSERRAT	string
MULISH	string
PATTAYA	string
PERALTA	string
PLAYFAIR_DISPLAY	string
POPPINS	string
ROBOTO	string
RUBIK	string

Defined in

packages/video-editor/src/helpers/constants.ts:53

---

DEFAULT_ELEMENT_COLORS

• Const DEFAULT_ELEMENT_COLORS: ElementColors

Defined in

packages/video-editor/src/helpers/constants.ts:38

---

DEFAULT_TIMELINE_ZOOM

• Const DEFAULT_TIMELINE_ZOOM: 1.5

Defined in

packages/video-editor/src/helpers/constants.ts:36

---

DRAG_TYPE

• Const DRAG_TYPE: Object

Type declaration

Name	Type
END	string
MOVE	string
START	string

Defined in

packages/video-editor/src/helpers/constants.ts:30

---

INITIAL_TIMELINE_DATA

• Const INITIAL_TIMELINE_DATA: Object

Type declaration

Name	Type
tracks	{ elements: { e: number = 5; id: string = "e-sample"; name: string = "sample"; props: { fill: string = "#FFFFFF"; text: string = "Twick Video Editor" } ; s: number = 0; trackId: string = "t-sample"; type: string = "text" }[] ; id: string = "t-sample"; name: string = "sample"; type: string = "element" }[]
version	number

Defined in

packages/video-editor/src/helpers/constants.ts:3

---

MIN_DURATION

• Const MIN_DURATION: 0.1

Defined in

packages/video-editor/src/helpers/constants.ts:28

---

TEXT_EFFECTS

• Const TEXT_EFFECTS: TextEffect[]

Defined in

packages/video-editor/src/helpers/text-effects-manager.tsx:3

---

animationGifs

• Const animationGifs: Object

Type declaration

Name	Type
blur	string
breathe-in	string
breathe-out	string
fade	string
rise-down	string
rise-up	string
succession	string

Defined in

packages/video-editor/src/assets/index.ts:11

Functions

PlayerControls

▸ PlayerControls(props, deprecatedLegacyContext?): ReactNode

Parameters

Name	Type	Description
props	PlayerControlsProps	-
deprecatedLegacyContext?	any	Deprecated See React Docs

Returns

ReactNode

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:23

---

TimelineManager

▸ TimelineManager(«destructured»): Element

Parameters

Name	Type
«destructured»	Object
› timelineControls?	ReactNode
› trackZoom	number

Returns

Element

Defined in

packages/video-editor/src/components/timeline/timeline-manager.tsx:5

---

default

▸ default(props, deprecatedLegacyContext?): ReactNode

Parameters

Name	Type	Description
props	VideoEditorProps	-
deprecatedLegacyContext?	any	Deprecated See React Docs

Returns

ReactNode

Defined in

packages/video-editor/src/components/video-editor.tsx:23

---

getAnimationGif

▸ getAnimationGif(name): string

Parameters

Name	Type
name	string

Returns

string

Defined in

packages/video-editor/src/assets/index.ts:33

---

usePlayerControl

▸ usePlayerControl(): Object

Returns

Object

Name	Type
togglePlayback	() => void

Defined in

packages/video-editor/src/hooks/use-player-control.tsx:8

---

useTimelineControl

▸ useTimelineControl(): Object

Returns

Object

Name	Type
deleteItem	(item: TrackElement | Track) => void
handleRedo	() => void
handleUndo	() => void
splitElement	(element: TrackElement, currentTime: number) => void

Defined in

packages/video-editor/src/hooks/use-timeline-control.tsx:7