Overview
EditorCore is the central singleton that coordinates all editor functionality through specialized manager instances. It follows the singleton pattern to ensure only one editor instance exists at a time.
Architecture
The EditorCore provides access to specialized managers:
playback - Controls video playback and seekingtimeline - Manages tracks and timeline elementsscenes - Handles scenes and bookmarksproject - Manages project lifecycle and settingsmedia - Handles media asset storagerenderer - Controls video rendering and exportcommand - Provides undo/redo functionalitysave - Manages auto-save behavioraudio - Controls audio playbackselection - Tracks selected elements
Usage
In React components
Always use the useEditor() hook in React components. The hook automatically subscribes to state changes and triggers re-renders:
import { useEditor } from '@/hooks/use-editor';
function MyComponent() {
const editor = useEditor();
const tracks = editor.timeline.getTracks();
return <div>{tracks.length} tracks</div>;
}
Outside React components
Use EditorCore.getInstance() directly in utilities, event handlers, or non-React code:
import { EditorCore } from "@/core";
const editor = EditorCore.getInstance();
editor.playback.play();
Do not use EditorCore.getInstance() inside React components. Always use the useEditor() hook to ensure proper reactivity.
Methods
getInstance()
Returns the singleton EditorCore instance, creating it if it doesn’t exist.
static getInstance(): EditorCore
EditorCore - The singleton editor instance
Example
const editor = EditorCore.getInstance();
reset()
Resets the singleton instance. Used primarily for testing.
This method destroys the current editor instance. Only use this in test environments.
Properties
All manager properties are readonly and initialized when the EditorCore instance is created:
command
Manages undo/redo command history.
readonly command: CommandManager
playback
Controls video playback state and seeking.
readonly playback: PlaybackManager
timeline
Manages timeline tracks and elements.
readonly timeline: TimelineManager
scenes
Handles scenes and bookmarks.
readonly scenes: ScenesManager
project
Manages project lifecycle, settings, and metadata.
readonly project: ProjectManager
media
Handles media asset storage and retrieval.
readonly media: MediaManager
renderer
Controls rendering and video export.
readonly renderer: RendererManager
save
Manages auto-save behavior and dirty state tracking.
readonly save: SaveManager
audio
Controls audio playback and mixing.
readonly audio: AudioManager
selection
Tracks currently selected timeline elements.
readonly selection: SelectionManager