Interface: VideoEditorConfig
Configuration options for the video editor. Defines the video properties and editor behavior settings.
Example
const editorConfig = {
videoProps: { width: 1920, height: 1080 },
canvasMode: true,
canvasConfig: { enableShiftAxisLock: true },
timelineTickConfigs: [
{ durationThreshold: 30, majorInterval: 5, minorTicks: 5 },
{ durationThreshold: 300, majorInterval: 30, minorTicks: 6 }
],
timelineZoomConfig: {
min: 0.5, max: 2.0, step: 0.25, default: 1.0
},
elementColors: {
video: "#8B5FBF",
audio: "#3D8B8B",
// ... other element colors
}
};
Table of contents
Properties
- videoProps
- playerProps
- canvasMode
- canvasConfig
- timelineTickConfigs
- timelineZoomConfig
- elementColors
- fps
Properties
videoProps
• videoProps: Object
Video dimensions and properties
Type declaration
| Name | Type | Description |
|---|---|---|
width | number | Width of the video in pixels |
height | number | Height of the video in pixels |
backgroundColor? | string | Background color of the video |
Defined in
packages/video-editor/src/components/video-editor.tsx:87
playerProps
• Optional playerProps: Object
Type declaration
| Name | Type |
|---|---|
quality? | number |
maxWidth? | number |
maxHeight? | number |
Defined in
packages/video-editor/src/components/video-editor.tsx:95
canvasMode
• Optional canvasMode: boolean
Whether to use canvas mode for rendering
Defined in
packages/video-editor/src/components/video-editor.tsx:101
canvasConfig
• Optional canvasConfig: CanvasConfig
Canvas behavior options (axis lock, zoom, snapping, etc.). Used by TwickEditor and TwickStudio.
Defined in
packages/video-editor/src/components/video-editor.tsx:103
timelineTickConfigs
• Optional timelineTickConfigs: TimelineTickConfig[]
Custom timeline tick configurations for different duration ranges
Defined in
packages/video-editor/src/components/video-editor.tsx:105
timelineZoomConfig
• Optional timelineZoomConfig: TimelineZoomConfig
Custom timeline zoom configuration (min, max, step, default)
Defined in
packages/video-editor/src/components/video-editor.tsx:107
elementColors
• Optional elementColors: ElementColors
Custom element colors for timeline elements
Defined in
packages/video-editor/src/components/video-editor.tsx:109
fps
• Optional fps: number
Frames per second for time display (MM:SS.FF format)