@twick/studio - v0.15.0 / Exports / StudioConfig
Interface: StudioConfig
Hierarchy
-
VideoEditorConfig↳
StudioConfig
Table of contents
Properties
- canvasConfig
- captionGenerationService
- customPanels
- customTools
- exportVideo
- hiddenTools
- imageGenerationService
- loadProject
- saveProject
- scriptToTimelineService
- templates
- translationService
- uploadConfig
- videoGenerationService
- voiceoverGenerationService
Properties
canvasConfig
• Optional canvasConfig: CanvasConfig
Canvas behavior options (e.g. enableShiftAxisLock). Same as editorConfig.canvasConfig in TwickEditor.
Overrides
VideoEditorConfig.canvasConfig
Defined in
captionGenerationService
• Optional captionGenerationService: ICaptionGenerationService
Caption generation service for polling-based async caption generation Implement this in your application code to provide API endpoints
Defined in
customPanels
• Optional customPanels: Record<string, ComponentType<PanelProps>>
Custom panel renderers keyed by tool id.
Defined in
customTools
• Optional customTools: ToolCategory[]
Extra tool definitions injected into the left toolbar.
Defined in
exportVideo
• Optional exportVideo: (project: ProjectJSON, videoSettings: VideoSettings) => Promise<Result>
Type declaration
▸ (project, videoSettings): Promise<Result>
Parameters
| Name | Type |
|---|---|
project | ProjectJSON |
videoSettings | VideoSettings |
Returns
Promise<Result>
Defined in
hiddenTools
• Optional hiddenTools: string[]
Tool ids that should be hidden from the default toolbar.
Defined in
imageGenerationService
• Optional imageGenerationService: IImageGenerationService
Image generation service for polling-based async image generation
Defined in
loadProject
• Optional loadProject: () => Promise<ProjectJSON>
Type declaration
▸ (): Promise<ProjectJSON>
Returns
Promise<ProjectJSON>
Defined in
saveProject
• Optional saveProject: (project: ProjectJSON, fileName: string) => Promise<Result>
Type declaration
▸ (project, fileName): Promise<Result>
Parameters
| Name | Type |
|---|---|
project | ProjectJSON |
fileName | string |
Returns
Promise<Result>
Defined in
scriptToTimelineService
• Optional scriptToTimelineService: IScriptToTimelineService
Script-to-timeline service for AI outline expansion.
Defined in
templates
• Optional templates: ProjectTemplate[]
Optional project templates shown in Template Gallery.
Defined in
translationService
• Optional translationService: ITranslationService
Caption translation service for multi-language workflows.
Defined in
uploadConfig
• Optional uploadConfig: UploadConfig
When set, media panels show cloud upload (S3 or GCS). Backend must be configured with env (e.g. FILE_UPLOADER_S3_* or GOOGLE_CLOUD_*). See cloud-functions/cors/ and file-uploader README for CORS and credentials.
Defined in
videoGenerationService
• Optional videoGenerationService: IVideoGenerationService
Video generation service for polling-based async video generation
Defined in
voiceoverGenerationService
• Optional voiceoverGenerationService: IVoiceoverService
Voiceover generation service for narration generation.