@imgly/codesign-mcp 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +16 -0
- package/README.md +158 -0
- package/assets/docs/api/SKILL.md +49 -0
- package/assets/docs/api/index.d.ts +10518 -0
- package/assets/docs/guide/SKILL.md +142 -0
- package/assets/docs/guide/actions.md +1038 -0
- package/assets/docs/guide/animation/create/base.md +467 -0
- package/assets/docs/guide/animation/create/text.md +453 -0
- package/assets/docs/guide/animation/create.md +558 -0
- package/assets/docs/guide/animation/edit.md +501 -0
- package/assets/docs/guide/animation/overview.md +22 -0
- package/assets/docs/guide/animation/types.md +430 -0
- package/assets/docs/guide/animation.md +23 -0
- package/assets/docs/guide/api/AssetAPI.md +602 -0
- package/assets/docs/guide/api/BlockAPI.md +6152 -0
- package/assets/docs/guide/api/CreativeEngine.md +180 -0
- package/assets/docs/guide/api/EditorAPI.md +1261 -0
- package/assets/docs/guide/api/EventAPI.md +25 -0
- package/assets/docs/guide/api/SceneAPI.md +729 -0
- package/assets/docs/guide/api/VariableAPI.md +59 -0
- package/assets/docs/guide/api/types.md +71 -0
- package/assets/docs/guide/api-reference/overview.md +20 -0
- package/assets/docs/guide/automation/auto-resize.md +412 -0
- package/assets/docs/guide/automation/batch-processing.md +474 -0
- package/assets/docs/guide/automation/data-merge.md +406 -0
- package/assets/docs/guide/automation/design-generation.md +107 -0
- package/assets/docs/guide/automation/overview.md +16 -0
- package/assets/docs/guide/automation.md +24 -0
- package/assets/docs/guide/browser-support.md +38 -0
- package/assets/docs/guide/capabilities.md +18 -0
- package/assets/docs/guide/colors/adjust.md +551 -0
- package/assets/docs/guide/colors/apply.md +349 -0
- package/assets/docs/guide/colors/basics.md +440 -0
- package/assets/docs/guide/colors/conversion.md +504 -0
- package/assets/docs/guide/colors/create-color-palette.md +426 -0
- package/assets/docs/guide/colors/for-print/cmyk.md +577 -0
- package/assets/docs/guide/colors/for-print/spot.md +751 -0
- package/assets/docs/guide/colors/for-print.md +21 -0
- package/assets/docs/guide/colors/for-screen/p3.md +60 -0
- package/assets/docs/guide/colors/for-screen/srgb.md +463 -0
- package/assets/docs/guide/colors/for-screen.md +21 -0
- package/assets/docs/guide/colors/overview.md +20 -0
- package/assets/docs/guide/colors/replace.md +535 -0
- package/assets/docs/guide/colors.md +28 -0
- package/assets/docs/guide/compatibility.md +27 -0
- package/assets/docs/guide/concepts/architecture.md +99 -0
- package/assets/docs/guide/concepts/assets.md +360 -0
- package/assets/docs/guide/concepts/blocks.md +750 -0
- package/assets/docs/guide/concepts/buffers.md +546 -0
- package/assets/docs/guide/concepts/design-units.md +333 -0
- package/assets/docs/guide/concepts/edit-modes.md +431 -0
- package/assets/docs/guide/concepts/editing-workflow.md +303 -0
- package/assets/docs/guide/concepts/events.md +466 -0
- package/assets/docs/guide/concepts/headless-mode/browser.md +291 -0
- package/assets/docs/guide/concepts/pages.md +396 -0
- package/assets/docs/guide/concepts/resources.md +496 -0
- package/assets/docs/guide/concepts/scenes.md +443 -0
- package/assets/docs/guide/concepts/templating.md +194 -0
- package/assets/docs/guide/concepts/terminology.md +296 -0
- package/assets/docs/guide/concepts/undo-and-history.md +461 -0
- package/assets/docs/guide/concepts.md +38 -0
- package/assets/docs/guide/configuration.md +469 -0
- package/assets/docs/guide/conversion/overview.md +22 -0
- package/assets/docs/guide/conversion/to-base64.md +234 -0
- package/assets/docs/guide/conversion/to-pdf.md +616 -0
- package/assets/docs/guide/conversion/to-png.md +290 -0
- package/assets/docs/guide/conversion.md +23 -0
- package/assets/docs/guide/create-audio/audio/add-music.md +430 -0
- package/assets/docs/guide/create-audio/audio/add-sound-effects.md +664 -0
- package/assets/docs/guide/create-audio/audio/loop.md +370 -0
- package/assets/docs/guide/create-audio/audio.md +336 -0
- package/assets/docs/guide/create-composition/add-background.md +395 -0
- package/assets/docs/guide/create-composition/blend-modes.md +372 -0
- package/assets/docs/guide/create-composition/collage.md +432 -0
- package/assets/docs/guide/create-composition/group-and-ungroup.md +388 -0
- package/assets/docs/guide/create-composition/layer-management.md +503 -0
- package/assets/docs/guide/create-composition/layout.md +396 -0
- package/assets/docs/guide/create-composition/lock-design.md +362 -0
- package/assets/docs/guide/create-composition/multi-page.md +204 -0
- package/assets/docs/guide/create-composition/overview.md +18 -0
- package/assets/docs/guide/create-composition/programmatic.md +593 -0
- package/assets/docs/guide/create-composition.md +30 -0
- package/assets/docs/guide/create-templates/add-dynamic-content/placeholders.md +688 -0
- package/assets/docs/guide/create-templates/add-dynamic-content/set-editing-constraints.md +600 -0
- package/assets/docs/guide/create-templates/add-dynamic-content/text-variables.md +647 -0
- package/assets/docs/guide/create-templates/add-dynamic-content.md +307 -0
- package/assets/docs/guide/create-templates/add-to-template-library.md +297 -0
- package/assets/docs/guide/create-templates/edit-or-remove.md +441 -0
- package/assets/docs/guide/create-templates/from-scratch.md +558 -0
- package/assets/docs/guide/create-templates/import/from-scene-file.md +440 -0
- package/assets/docs/guide/create-templates/import.md +244 -0
- package/assets/docs/guide/create-templates/lock.md +325 -0
- package/assets/docs/guide/create-templates/overview.md +16 -0
- package/assets/docs/guide/create-templates.md +32 -0
- package/assets/docs/guide/create-video/audio/adjust-speed.md +302 -0
- package/assets/docs/guide/create-video/audio/adjust-volume.md +346 -0
- package/assets/docs/guide/create-video/control.md +285 -0
- package/assets/docs/guide/create-video/limitations.md +396 -0
- package/assets/docs/guide/create-video/overview.md +224 -0
- package/assets/docs/guide/create-video/timeline-editor.md +622 -0
- package/assets/docs/guide/create-video/update-caption-presets.md +676 -0
- package/assets/docs/guide/create-video.md +32 -0
- package/assets/docs/guide/edit-image/add-watermark.md +497 -0
- package/assets/docs/guide/edit-image/overview.md +22 -0
- package/assets/docs/guide/edit-image/remove-bg.md +420 -0
- package/assets/docs/guide/edit-image/replace-colors.md +680 -0
- package/assets/docs/guide/edit-image/transform/crop.md +523 -0
- package/assets/docs/guide/edit-image/transform/move.md +279 -0
- package/assets/docs/guide/edit-image/transform/resize.md +301 -0
- package/assets/docs/guide/edit-image/transform/rotate.md +408 -0
- package/assets/docs/guide/edit-image/transform/scale.md +278 -0
- package/assets/docs/guide/edit-image/transform.md +24 -0
- package/assets/docs/guide/edit-image/vectorize.md +204 -0
- package/assets/docs/guide/edit-image.md +25 -0
- package/assets/docs/guide/edit-video/add-captions.md +589 -0
- package/assets/docs/guide/edit-video/add-watermark.md +429 -0
- package/assets/docs/guide/edit-video/join-and-arrange.md +540 -0
- package/assets/docs/guide/edit-video/redaction.md +544 -0
- package/assets/docs/guide/edit-video/split.md +634 -0
- package/assets/docs/guide/edit-video/transform/crop.md +380 -0
- package/assets/docs/guide/edit-video/transform/flip.md +182 -0
- package/assets/docs/guide/edit-video/transform/move.md +413 -0
- package/assets/docs/guide/edit-video/transform/resize.md +534 -0
- package/assets/docs/guide/edit-video/transform/rotate.md +312 -0
- package/assets/docs/guide/edit-video/transform/scale.md +603 -0
- package/assets/docs/guide/edit-video/transform.md +25 -0
- package/assets/docs/guide/edit-video/trim.md +773 -0
- package/assets/docs/guide/engine-interface.md +108 -0
- package/assets/docs/guide/export-save-publish/create-thumbnail.md +292 -0
- package/assets/docs/guide/export-save-publish/export/compress.md +639 -0
- package/assets/docs/guide/export-save-publish/export/overview.md +576 -0
- package/assets/docs/guide/export-save-publish/export/partial-export.md +694 -0
- package/assets/docs/guide/export-save-publish/export/size-limits.md +401 -0
- package/assets/docs/guide/export-save-publish/export/to-html5.md +474 -0
- package/assets/docs/guide/export-save-publish/export/to-jpeg.md +312 -0
- package/assets/docs/guide/export-save-publish/export/to-mp4.md +364 -0
- package/assets/docs/guide/export-save-publish/export/to-pdf.md +389 -0
- package/assets/docs/guide/export-save-publish/export/to-png.md +255 -0
- package/assets/docs/guide/export-save-publish/export/to-raw-data.md +303 -0
- package/assets/docs/guide/export-save-publish/export/to-webp.md +261 -0
- package/assets/docs/guide/export-save-publish/export/with-color-mask.md +278 -0
- package/assets/docs/guide/export-save-publish/export.md +36 -0
- package/assets/docs/guide/export-save-publish/for-printing.md +423 -0
- package/assets/docs/guide/export-save-publish/for-social-media.md +318 -0
- package/assets/docs/guide/export-save-publish/pre-export-validation.md +698 -0
- package/assets/docs/guide/export-save-publish/save.md +340 -0
- package/assets/docs/guide/export-save-publish/store-custom-metadata.md +367 -0
- package/assets/docs/guide/file-format-support.md +34 -0
- package/assets/docs/guide/fills/color.md +678 -0
- package/assets/docs/guide/fills/image.md +539 -0
- package/assets/docs/guide/fills/overview.md +144 -0
- package/assets/docs/guide/fills/video.md +641 -0
- package/assets/docs/guide/fills.md +24 -0
- package/assets/docs/guide/filters-and-effects/apply.md +1019 -0
- package/assets/docs/guide/filters-and-effects/blur.md +382 -0
- package/assets/docs/guide/filters-and-effects/chroma-key-green-screen.md +445 -0
- package/assets/docs/guide/filters-and-effects/create-custom-filters.md +614 -0
- package/assets/docs/guide/filters-and-effects/create-custom-lut-filter.md +426 -0
- package/assets/docs/guide/filters-and-effects/distortion.md +527 -0
- package/assets/docs/guide/filters-and-effects/duotone.md +602 -0
- package/assets/docs/guide/filters-and-effects/gradients.md +1311 -0
- package/assets/docs/guide/filters-and-effects/overview.md +22 -0
- package/assets/docs/guide/filters-and-effects/support.md +623 -0
- package/assets/docs/guide/filters-and-effects.md +28 -0
- package/assets/docs/guide/get-started/agent-skills.md +119 -0
- package/assets/docs/guide/get-started/build-with-ai.md +45 -0
- package/assets/docs/guide/get-started/mcp-server.md +119 -0
- package/assets/docs/guide/get-started/overview.md +28 -0
- package/assets/docs/guide/get-started/vanilla-js/quickstart.md +175 -0
- package/assets/docs/guide/grid-and-rulers.md +222 -0
- package/assets/docs/guide/guides/export-save-publish/export/audio.md +224 -0
- package/assets/docs/guide/guides/text/rendering-internals.md +796 -0
- package/assets/docs/guide/guides.md +49 -0
- package/assets/docs/guide/import-media/asset-library.md +23 -0
- package/assets/docs/guide/import-media/asset-panel/basics.md +324 -0
- package/assets/docs/guide/import-media/asset-panel/customize.md +478 -0
- package/assets/docs/guide/import-media/asset-panel/refresh-assets.md +415 -0
- package/assets/docs/guide/import-media/asset-panel/thumbnails.md +633 -0
- package/assets/docs/guide/import-media/capture-from-camera/record-video.md +137 -0
- package/assets/docs/guide/import-media/capture-from-camera.md +20 -0
- package/assets/docs/guide/import-media/concepts.md +173 -0
- package/assets/docs/guide/import-media/content-json-schema.md +615 -0
- package/assets/docs/guide/import-media/default-assets.md +381 -0
- package/assets/docs/guide/import-media/edit-or-remove-assets.md +489 -0
- package/assets/docs/guide/import-media/file-format-support.md +178 -0
- package/assets/docs/guide/import-media/from-local-source/user-upload.md +438 -0
- package/assets/docs/guide/import-media/from-local-source.md +20 -0
- package/assets/docs/guide/import-media/from-remote-source/asset-versioning.md +390 -0
- package/assets/docs/guide/import-media/from-remote-source/getty-images.md +627 -0
- package/assets/docs/guide/import-media/from-remote-source/imgly-premium-assets.md +625 -0
- package/assets/docs/guide/import-media/from-remote-source/pexels.md +692 -0
- package/assets/docs/guide/import-media/from-remote-source/remote-asset.md +473 -0
- package/assets/docs/guide/import-media/from-remote-source/soundstripe.md +497 -0
- package/assets/docs/guide/import-media/from-remote-source/third-party.md +51 -0
- package/assets/docs/guide/import-media/from-remote-source/unsplash.md +914 -0
- package/assets/docs/guide/import-media/from-remote-source/your-server.md +764 -0
- package/assets/docs/guide/import-media/from-remote-source.md +28 -0
- package/assets/docs/guide/import-media/overview.md +32 -0
- package/assets/docs/guide/import-media/retrieve-mimetype.md +274 -0
- package/assets/docs/guide/import-media/size-limits.md +20 -0
- package/assets/docs/guide/import-media/source-sets.md +476 -0
- package/assets/docs/guide/import-media.md +32 -0
- package/assets/docs/guide/insert-media/audio.md +291 -0
- package/assets/docs/guide/insert-media/images.md +380 -0
- package/assets/docs/guide/insert-media/position-and-align.md +734 -0
- package/assets/docs/guide/insert-media/shapes-or-stickers.md +799 -0
- package/assets/docs/guide/insert-media/videos.md +308 -0
- package/assets/docs/guide/insert-media.md +24 -0
- package/assets/docs/guide/key-capabilities.md +24 -0
- package/assets/docs/guide/key-concepts.md +83 -0
- package/assets/docs/guide/licensing.md +45 -0
- package/assets/docs/guide/llms-txt.md +53 -0
- package/assets/docs/guide/open-the-editor/blank-canvas.md +124 -0
- package/assets/docs/guide/open-the-editor/from-htmlcanvas.md +228 -0
- package/assets/docs/guide/open-the-editor/from-image.md +205 -0
- package/assets/docs/guide/open-the-editor/from-template.md +189 -0
- package/assets/docs/guide/open-the-editor/from-video.md +274 -0
- package/assets/docs/guide/open-the-editor/import-design/from-archive.md +504 -0
- package/assets/docs/guide/open-the-editor/import-design/from-indesign.md +680 -0
- package/assets/docs/guide/open-the-editor/import-design/from-photoshop.md +865 -0
- package/assets/docs/guide/open-the-editor/import-design.md +481 -0
- package/assets/docs/guide/open-the-editor/load-scene.md +178 -0
- package/assets/docs/guide/open-the-editor/overview.md +20 -0
- package/assets/docs/guide/open-the-editor/set-zoom-level.md +303 -0
- package/assets/docs/guide/open-the-editor/uri-resolver.md +347 -0
- package/assets/docs/guide/open-the-editor.md +29 -0
- package/assets/docs/guide/outlines/overview.md +14 -0
- package/assets/docs/guide/outlines/shadows-and-glows.md +515 -0
- package/assets/docs/guide/outlines/strokes.md +292 -0
- package/assets/docs/guide/outlines.md +22 -0
- package/assets/docs/guide/overview.md +22 -0
- package/assets/docs/guide/performance.md +217 -0
- package/assets/docs/guide/plugins/asset-sources.md +553 -0
- package/assets/docs/guide/plugins/print-ready-pdf.md +549 -0
- package/assets/docs/guide/plugins.md +36 -0
- package/assets/docs/guide/rules/asset-handling.md +180 -0
- package/assets/docs/guide/rules/common-pitfalls.md +272 -0
- package/assets/docs/guide/rules/content-fill-mode.md +29 -0
- package/assets/docs/guide/rules/enforce-brand-guidelines.md +672 -0
- package/assets/docs/guide/rules/lock-content.md +478 -0
- package/assets/docs/guide/rules/moderate-content.md +761 -0
- package/assets/docs/guide/rules/overview.md +514 -0
- package/assets/docs/guide/rules/silent-init-errors.md +137 -0
- package/assets/docs/guide/rules/verify-properties-before-use.md +78 -0
- package/assets/docs/guide/rules.md +23 -0
- package/assets/docs/guide/security.md +199 -0
- package/assets/docs/guide/serve-assets.md +332 -0
- package/assets/docs/guide/settings.md +199 -0
- package/assets/docs/guide/shapes.md +23 -0
- package/assets/docs/guide/starterkits/3d-mockup-editor.md +748 -0
- package/assets/docs/guide/starterkits/advanced-editor.md +698 -0
- package/assets/docs/guide/starterkits/advanced-video-editor.md +696 -0
- package/assets/docs/guide/starterkits/ai-editor.md +749 -0
- package/assets/docs/guide/starterkits/airtable-image-editor.md +672 -0
- package/assets/docs/guide/starterkits/apparel-ui.md +188 -0
- package/assets/docs/guide/starterkits/assets.md +27 -0
- package/assets/docs/guide/starterkits/auto-resize.md +586 -0
- package/assets/docs/guide/starterkits/automated-video-generation.md +692 -0
- package/assets/docs/guide/starterkits/background-removal-editor.md +480 -0
- package/assets/docs/guide/starterkits/content-moderation.md +863 -0
- package/assets/docs/guide/starterkits/creative-automation.md +28 -0
- package/assets/docs/guide/starterkits/custom-built-uis.md +26 -0
- package/assets/docs/guide/starterkits/customization.md +29 -0
- package/assets/docs/guide/starterkits/cutout-lines-editor.md +470 -0
- package/assets/docs/guide/starterkits/data-merge.md +850 -0
- package/assets/docs/guide/starterkits/design-editor.md +698 -0
- package/assets/docs/guide/starterkits/design-generation.md +719 -0
- package/assets/docs/guide/starterkits/design-validation.md +808 -0
- package/assets/docs/guide/starterkits/editor-ui-configurations.md +14 -0
- package/assets/docs/guide/starterkits/export-options.md +724 -0
- package/assets/docs/guide/starterkits/export-using-renderer.md +708 -0
- package/assets/docs/guide/starterkits/extensibility.md +28 -0
- package/assets/docs/guide/starterkits/force-crop-editor.md +675 -0
- package/assets/docs/guide/starterkits/form-based-template-adoption.md +522 -0
- package/assets/docs/guide/starterkits/getty-images-editor.md +700 -0
- package/assets/docs/guide/starterkits/html5-ads-exporter.md +719 -0
- package/assets/docs/guide/starterkits/indesign-template-import.md +580 -0
- package/assets/docs/guide/starterkits/layouts-editor.md +724 -0
- package/assets/docs/guide/starterkits/mobile-ui.md +185 -0
- package/assets/docs/guide/starterkits/mockup-editor.md +745 -0
- package/assets/docs/guide/starterkits/multi-image-generation.md +542 -0
- package/assets/docs/guide/starterkits/page-sizes-editor.md +657 -0
- package/assets/docs/guide/starterkits/pexels-image-editor.md +665 -0
- package/assets/docs/guide/starterkits/photo-editor.md +755 -0
- package/assets/docs/guide/starterkits/photo-ui.md +186 -0
- package/assets/docs/guide/starterkits/photobook-ui.md +188 -0
- package/assets/docs/guide/starterkits/placeholders.md +678 -0
- package/assets/docs/guide/starterkits/player.md +405 -0
- package/assets/docs/guide/starterkits/plugins.md +25 -0
- package/assets/docs/guide/starterkits/postcard-editor.md +202 -0
- package/assets/docs/guide/starterkits/pptx-template-import.md +581 -0
- package/assets/docs/guide/starterkits/print-ready-pdf-editor.md +746 -0
- package/assets/docs/guide/starterkits/product-editor.md +773 -0
- package/assets/docs/guide/starterkits/psd-template-import.md +580 -0
- package/assets/docs/guide/starterkits/qr-code-editor.md +470 -0
- package/assets/docs/guide/starterkits/single-page-editor.md +661 -0
- package/assets/docs/guide/starterkits/start-with-image.md +684 -0
- package/assets/docs/guide/starterkits/start-with-video.md +651 -0
- package/assets/docs/guide/starterkits/t-shirt-designer.md +742 -0
- package/assets/docs/guide/starterkits/templating.md +23 -0
- package/assets/docs/guide/starterkits/theming.md +662 -0
- package/assets/docs/guide/starterkits/translation-internationalization.md +662 -0
- package/assets/docs/guide/starterkits/unsplash-editor.md +839 -0
- package/assets/docs/guide/starterkits/vectorizer-editor.md +466 -0
- package/assets/docs/guide/starterkits/version-history.md +745 -0
- package/assets/docs/guide/starterkits/video-animations.md +853 -0
- package/assets/docs/guide/starterkits/video-captions.md +884 -0
- package/assets/docs/guide/starterkits/video-editing.md +25 -0
- package/assets/docs/guide/starterkits/video-editor.md +696 -0
- package/assets/docs/guide/starterkits/video-export-options.md +676 -0
- package/assets/docs/guide/starterkits/viewer.md +400 -0
- package/assets/docs/guide/starterkits.md +41 -0
- package/assets/docs/guide/stickers-and-shapes/combine.md +743 -0
- package/assets/docs/guide/stickers-and-shapes/create-cutout.md +425 -0
- package/assets/docs/guide/stickers-and-shapes/create-edit/create-shapes.md +794 -0
- package/assets/docs/guide/stickers-and-shapes/create-edit/create-stickers.md +290 -0
- package/assets/docs/guide/stickers-and-shapes/create-edit/edit-shapes.md +211 -0
- package/assets/docs/guide/stickers-and-shapes/create-edit/vector-edit.md +362 -0
- package/assets/docs/guide/stickers-and-shapes/insert-qr-code.md +208 -0
- package/assets/docs/guide/stickers.md +21 -0
- package/assets/docs/guide/text/add.md +641 -0
- package/assets/docs/guide/text/adjust-spacing.md +288 -0
- package/assets/docs/guide/text/auto-size.md +404 -0
- package/assets/docs/guide/text/custom-fonts.md +401 -0
- package/assets/docs/guide/text/decorations.md +330 -0
- package/assets/docs/guide/text/edit.md +458 -0
- package/assets/docs/guide/text/effects.md +244 -0
- package/assets/docs/guide/text/emojis.md +310 -0
- package/assets/docs/guide/text/enumerations.md +258 -0
- package/assets/docs/guide/text/language-support.md +604 -0
- package/assets/docs/guide/text/overview.md +14 -0
- package/assets/docs/guide/text/styling.md +390 -0
- package/assets/docs/guide/text/text-designs.md +834 -0
- package/assets/docs/guide/text.md +33 -0
- package/assets/docs/guide/to-v1-10.md +131 -0
- package/assets/docs/guide/to-v1-13.md +165 -0
- package/assets/docs/guide/to-v1-19.md +315 -0
- package/assets/docs/guide/to-v1-32.md +110 -0
- package/assets/docs/guide/to-v1-69.md +468 -0
- package/assets/docs/guide/to-v1-72.md +193 -0
- package/assets/docs/guide/upgrade.md +25 -0
- package/assets/docs/guide/use-templates/apply-template.md +279 -0
- package/assets/docs/guide/use-templates/generate.md +405 -0
- package/assets/docs/guide/use-templates/library.md +450 -0
- package/assets/docs/guide/use-templates/overview.md +20 -0
- package/assets/docs/guide/use-templates/programmatic.md +482 -0
- package/assets/docs/guide/use-templates/replace-content.md +399 -0
- package/assets/docs/guide/user-interface/ai-integration/audio-generation.md +428 -0
- package/assets/docs/guide/user-interface/ai-integration/auto-captions.md +337 -0
- package/assets/docs/guide/user-interface/ai-integration/custom-provider.md +853 -0
- package/assets/docs/guide/user-interface/ai-integration/gateway-provider.md +1045 -0
- package/assets/docs/guide/user-interface/ai-integration/image-generation.md +641 -0
- package/assets/docs/guide/user-interface/ai-integration/integrate.md +966 -0
- package/assets/docs/guide/user-interface/ai-integration/proxy-server.md +99 -0
- package/assets/docs/guide/user-interface/ai-integration/text-generation.md +498 -0
- package/assets/docs/guide/user-interface/ai-integration/video-generation.md +493 -0
- package/assets/docs/guide/user-interface/ai-integration.md +30 -0
- package/assets/docs/guide/user-interface/appearance/change-ui-font.md +316 -0
- package/assets/docs/guide/user-interface/appearance/custom-labels.md +509 -0
- package/assets/docs/guide/user-interface/appearance/icons.md +373 -0
- package/assets/docs/guide/user-interface/appearance/theming.md +665 -0
- package/assets/docs/guide/user-interface/appearance.md +23 -0
- package/assets/docs/guide/user-interface/build-your-own-ui.md +620 -0
- package/assets/docs/guide/user-interface/customization/canvas-menu.md +412 -0
- package/assets/docs/guide/user-interface/customization/canvas.md +281 -0
- package/assets/docs/guide/user-interface/customization/color-palette.md +413 -0
- package/assets/docs/guide/user-interface/customization/crop-presets.md +384 -0
- package/assets/docs/guide/user-interface/customization/disable-or-enable.md +676 -0
- package/assets/docs/guide/user-interface/customization/dock.md +399 -0
- package/assets/docs/guide/user-interface/customization/force-crop.md +289 -0
- package/assets/docs/guide/user-interface/customization/inspector-bar.md +371 -0
- package/assets/docs/guide/user-interface/customization/navigation-bar.md +516 -0
- package/assets/docs/guide/user-interface/customization/page-format.md +436 -0
- package/assets/docs/guide/user-interface/customization/panel.md +605 -0
- package/assets/docs/guide/user-interface/customization/quick-start/add-action-buttons.md +531 -0
- package/assets/docs/guide/user-interface/customization/quick-start/add-dock-buttons.md +358 -0
- package/assets/docs/guide/user-interface/customization/quick-start/create-custom-components.md +374 -0
- package/assets/docs/guide/user-interface/customization/quick-start/reorder-components.md +323 -0
- package/assets/docs/guide/user-interface/customization/quick-start/show-hide-components.md +294 -0
- package/assets/docs/guide/user-interface/customization/quick-start.md +12 -0
- package/assets/docs/guide/user-interface/customization/reference/component-order-api.md +519 -0
- package/assets/docs/guide/user-interface/customization/reference/component-reference.md +333 -0
- package/assets/docs/guide/user-interface/customization/reference.md +12 -0
- package/assets/docs/guide/user-interface/customization.md +39 -0
- package/assets/docs/guide/user-interface/localization.md +633 -0
- package/assets/docs/guide/user-interface/overview.md +167 -0
- package/assets/docs/guide/user-interface/ui-extensions/add-custom-feature.md +411 -0
- package/assets/docs/guide/user-interface/ui-extensions/asset-library.md +721 -0
- package/assets/docs/guide/user-interface/ui-extensions/create-custom-panel.md +331 -0
- package/assets/docs/guide/user-interface/ui-extensions/customize-behaviour.md +553 -0
- package/assets/docs/guide/user-interface/ui-extensions/notifications-and-dialogs.md +672 -0
- package/assets/docs/guide/user-interface/ui-extensions/quick-actions.md +415 -0
- package/assets/docs/guide/user-interface/ui-extensions/register-new-component.md +521 -0
- package/assets/docs/guide/user-interface/ui-extensions.md +26 -0
- package/assets/docs/guide/user-interface.md +25 -0
- package/assets/docs/guide/what-is-cesdk.md +319 -0
- package/assets/docs/handbook/SKILL.md +521 -0
- package/assets/prompts/evals-assetGenerate.md +12 -0
- package/assets/prompts/evals-brutalistCore.md +34 -0
- package/assets/prompts/evals-danskCatalogue.md +31 -0
- package/assets/prompts/evals-exportRoundTrip.md +12 -0
- package/assets/prompts/evals-inspectPriorCode.md +16 -0
- package/assets/prompts/evals-listProjectFiles.md +6 -0
- package/assets/prompts/evals-readAndExplainScript.md +6 -0
- package/assets/prompts/evals-resumeAcrossRestart.md +15 -0
- package/assets/prompts/evals-rewindRecovery.md +10 -0
- package/assets/prompts/evals-searchAcrossFiles.md +6 -0
- package/assets/prompts/evals-weddingCard.md +20 -0
- package/assets/prompts/explain.md +6 -0
- package/assets/prompts/review.md +6 -0
- package/dist/assets/inline.generated.d.ts +2 -0
- package/dist/assets/inline.generated.d.ts.map +1 -0
- package/dist/assets/inline.generated.js +413 -0
- package/dist/assets/inline.generated.js.map +1 -0
- package/dist/assets/load-browser.d.ts +8 -0
- package/dist/assets/load-browser.d.ts.map +1 -0
- package/dist/assets/load-browser.js +11 -0
- package/dist/assets/load-browser.js.map +1 -0
- package/dist/assets/load-node.d.ts +8 -0
- package/dist/assets/load-node.d.ts.map +1 -0
- package/dist/assets/load-node.js +11 -0
- package/dist/assets/load-node.js.map +1 -0
- package/dist/cli/http.d.ts +2 -0
- package/dist/cli/http.d.ts.map +1 -0
- package/dist/cli/http.js +231 -0
- package/dist/cli/http.js.map +1 -0
- package/dist/cli/redirect-console.d.ts +10 -0
- package/dist/cli/redirect-console.d.ts.map +1 -0
- package/dist/cli/redirect-console.js +18 -0
- package/dist/cli/redirect-console.js.map +1 -0
- package/dist/cli/resolve-license.d.ts +2 -0
- package/dist/cli/resolve-license.d.ts.map +1 -0
- package/dist/cli/resolve-license.js +13 -0
- package/dist/cli/resolve-license.js.map +1 -0
- package/dist/cli/stdio.d.ts +2 -0
- package/dist/cli/stdio.d.ts.map +1 -0
- package/dist/cli/stdio.js +124 -0
- package/dist/cli/stdio.js.map +1 -0
- package/dist/cli/trial-license.generated.d.ts +2 -0
- package/dist/cli/trial-license.generated.d.ts.map +1 -0
- package/dist/cli/trial-license.generated.js +4 -0
- package/dist/cli/trial-license.generated.js.map +1 -0
- package/dist/cli.d.ts +3 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +64 -0
- package/dist/cli.js.map +1 -0
- package/dist/config.d.ts +61 -0
- package/dist/config.d.ts.map +1 -0
- package/dist/config.js +102 -0
- package/dist/config.js.map +1 -0
- package/dist/cross-ref.d.ts +2 -0
- package/dist/cross-ref.d.ts.map +1 -0
- package/dist/cross-ref.js +31 -0
- package/dist/cross-ref.js.map +1 -0
- package/dist/dashboard/router.d.ts +3 -0
- package/dist/dashboard/router.d.ts.map +1 -0
- package/dist/dashboard/router.js +19 -0
- package/dist/dashboard/router.js.map +1 -0
- package/dist/dashboard/spa-assets.generated.d.ts +2 -0
- package/dist/dashboard/spa-assets.generated.d.ts.map +1 -0
- package/dist/dashboard/spa-assets.generated.js +220 -0
- package/dist/dashboard/spa-assets.generated.js.map +1 -0
- package/dist/engine/asset-sources.d.ts +17 -0
- package/dist/engine/asset-sources.d.ts.map +1 -0
- package/dist/engine/asset-sources.js +75 -0
- package/dist/engine/asset-sources.js.map +1 -0
- package/dist/engine/cesdk-adapter.d.ts +10 -0
- package/dist/engine/cesdk-adapter.d.ts.map +1 -0
- package/dist/engine/cesdk-adapter.js +19 -0
- package/dist/engine/cesdk-adapter.js.map +1 -0
- package/dist/engine/index.d.ts +3 -0
- package/dist/engine/index.d.ts.map +1 -0
- package/dist/engine/index.js +3 -0
- package/dist/engine/index.js.map +1 -0
- package/dist/engine/mutex.d.ts +5 -0
- package/dist/engine/mutex.d.ts.map +1 -0
- package/dist/engine/mutex.js +42 -0
- package/dist/engine/mutex.js.map +1 -0
- package/dist/engine/session.d.ts +50 -0
- package/dist/engine/session.d.ts.map +1 -0
- package/dist/engine/session.js +95 -0
- package/dist/engine/session.js.map +1 -0
- package/dist/engine/uri-resolver.d.ts +14 -0
- package/dist/engine/uri-resolver.d.ts.map +1 -0
- package/dist/engine/uri-resolver.js +12 -0
- package/dist/engine/uri-resolver.js.map +1 -0
- package/dist/frontmatter.d.ts +15 -0
- package/dist/frontmatter.d.ts.map +1 -0
- package/dist/frontmatter.js +46 -0
- package/dist/frontmatter.js.map +1 -0
- package/dist/gateway/hosted-stub.d.ts +6 -0
- package/dist/gateway/hosted-stub.d.ts.map +1 -0
- package/dist/gateway/hosted-stub.js +11 -0
- package/dist/gateway/hosted-stub.js.map +1 -0
- package/dist/gateway/index.d.ts +4 -0
- package/dist/gateway/index.d.ts.map +1 -0
- package/dist/gateway/index.js +4 -0
- package/dist/gateway/index.js.map +1 -0
- package/dist/gateway/local.d.ts +14 -0
- package/dist/gateway/local.d.ts.map +1 -0
- package/dist/gateway/local.js +41 -0
- package/dist/gateway/local.js.map +1 -0
- package/dist/gateway/types.d.ts +24 -0
- package/dist/gateway/types.d.ts.map +1 -0
- package/dist/gateway/types.js +7 -0
- package/dist/gateway/types.js.map +1 -0
- package/dist/http/server.d.ts +80 -0
- package/dist/http/server.d.ts.map +1 -0
- package/dist/http/server.js +183 -0
- package/dist/http/server.js.map +1 -0
- package/dist/http/session-manager.d.ts +42 -0
- package/dist/http/session-manager.d.ts.map +1 -0
- package/dist/http/session-manager.js +82 -0
- package/dist/http/session-manager.js.map +1 -0
- package/dist/http/workspace-auth.d.ts +9 -0
- package/dist/http/workspace-auth.d.ts.map +1 -0
- package/dist/http/workspace-auth.js +29 -0
- package/dist/http/workspace-auth.js.map +1 -0
- package/dist/index.d.ts +10 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +10 -0
- package/dist/index.js.map +1 -0
- package/dist/metrics/mount.d.ts +11 -0
- package/dist/metrics/mount.d.ts.map +1 -0
- package/dist/metrics/mount.js +13 -0
- package/dist/metrics/mount.js.map +1 -0
- package/dist/metrics/recorder.d.ts +55 -0
- package/dist/metrics/recorder.d.ts.map +1 -0
- package/dist/metrics/recorder.js +97 -0
- package/dist/metrics/recorder.js.map +1 -0
- package/dist/revisions/hash.d.ts +7 -0
- package/dist/revisions/hash.d.ts.map +1 -0
- package/dist/revisions/hash.js +24 -0
- package/dist/revisions/hash.js.map +1 -0
- package/dist/revisions/index.d.ts +4 -0
- package/dist/revisions/index.d.ts.map +1 -0
- package/dist/revisions/index.js +4 -0
- package/dist/revisions/index.js.map +1 -0
- package/dist/revisions/store.d.ts +69 -0
- package/dist/revisions/store.d.ts.map +1 -0
- package/dist/revisions/store.js +196 -0
- package/dist/revisions/store.js.map +1 -0
- package/dist/revisions/types.d.ts +39 -0
- package/dist/revisions/types.d.ts.map +1 -0
- package/dist/revisions/types.js +2 -0
- package/dist/revisions/types.js.map +1 -0
- package/dist/server.d.ts +51 -0
- package/dist/server.d.ts.map +1 -0
- package/dist/server.js +175 -0
- package/dist/server.js.map +1 -0
- package/dist/skill-tools.d.ts +3 -0
- package/dist/skill-tools.d.ts.map +1 -0
- package/dist/skill-tools.js +105 -0
- package/dist/skill-tools.js.map +1 -0
- package/dist/test/test/cli/dispatcher.test.d.ts +2 -0
- package/dist/test/test/cli/dispatcher.test.d.ts.map +1 -0
- package/dist/test/test/cli/dispatcher.test.js +47 -0
- package/dist/test/test/cli/dispatcher.test.js.map +1 -0
- package/dist/test/test/cross-ref.test.d.ts +2 -0
- package/dist/test/test/cross-ref.test.d.ts.map +1 -0
- package/dist/test/test/cross-ref.test.js +39 -0
- package/dist/test/test/cross-ref.test.js.map +1 -0
- package/dist/test/test/engine/session.test.d.ts +2 -0
- package/dist/test/test/engine/session.test.d.ts.map +1 -0
- package/dist/test/test/engine/session.test.js +144 -0
- package/dist/test/test/engine/session.test.js.map +1 -0
- package/dist/test/test/engine/uri-resolver.test.d.ts +2 -0
- package/dist/test/test/engine/uri-resolver.test.d.ts.map +1 -0
- package/dist/test/test/engine/uri-resolver.test.js +38 -0
- package/dist/test/test/engine/uri-resolver.test.js.map +1 -0
- package/dist/test/test/frontmatter.test.d.ts +2 -0
- package/dist/test/test/frontmatter.test.d.ts.map +1 -0
- package/dist/test/test/frontmatter.test.js +55 -0
- package/dist/test/test/frontmatter.test.js.map +1 -0
- package/dist/test/test/gateway/hosted-stub.test.d.ts +2 -0
- package/dist/test/test/gateway/hosted-stub.test.d.ts.map +1 -0
- package/dist/test/test/gateway/hosted-stub.test.js +11 -0
- package/dist/test/test/gateway/hosted-stub.test.js.map +1 -0
- package/dist/test/test/gateway/local.test.d.ts +2 -0
- package/dist/test/test/gateway/local.test.d.ts.map +1 -0
- package/dist/test/test/gateway/local.test.js +29 -0
- package/dist/test/test/gateway/local.test.js.map +1 -0
- package/dist/test/test/handbook-contract.test.d.ts +2 -0
- package/dist/test/test/handbook-contract.test.d.ts.map +1 -0
- package/dist/test/test/handbook-contract.test.js +71 -0
- package/dist/test/test/handbook-contract.test.js.map +1 -0
- package/dist/test/test/http/server.test.d.ts +2 -0
- package/dist/test/test/http/server.test.d.ts.map +1 -0
- package/dist/test/test/http/server.test.js +245 -0
- package/dist/test/test/http/server.test.js.map +1 -0
- package/dist/test/test/http/session-manager.test.d.ts +2 -0
- package/dist/test/test/http/session-manager.test.d.ts.map +1 -0
- package/dist/test/test/http/session-manager.test.js +83 -0
- package/dist/test/test/http/session-manager.test.js.map +1 -0
- package/dist/test/test/revisions/hash.test.d.ts +2 -0
- package/dist/test/test/revisions/hash.test.d.ts.map +1 -0
- package/dist/test/test/revisions/hash.test.js +33 -0
- package/dist/test/test/revisions/hash.test.js.map +1 -0
- package/dist/test/test/revisions/store.test.d.ts +2 -0
- package/dist/test/test/revisions/store.test.d.ts.map +1 -0
- package/dist/test/test/revisions/store.test.js +245 -0
- package/dist/test/test/revisions/store.test.js.map +1 -0
- package/dist/test/test/server.test.d.ts +2 -0
- package/dist/test/test/server.test.d.ts.map +1 -0
- package/dist/test/test/server.test.js +157 -0
- package/dist/test/test/server.test.js.map +1 -0
- package/dist/test/test/skill-tools.test.d.ts +2 -0
- package/dist/test/test/skill-tools.test.d.ts.map +1 -0
- package/dist/test/test/skill-tools.test.js +84 -0
- package/dist/test/test/skill-tools.test.js.map +1 -0
- package/dist/test/test/smoke.test.d.ts +2 -0
- package/dist/test/test/smoke.test.d.ts.map +1 -0
- package/dist/test/test/smoke.test.js +8 -0
- package/dist/test/test/smoke.test.js.map +1 -0
- package/dist/test/test/tools/asset-generate.test.d.ts +2 -0
- package/dist/test/test/tools/asset-generate.test.d.ts.map +1 -0
- package/dist/test/test/tools/asset-generate.test.js +66 -0
- package/dist/test/test/tools/asset-generate.test.js.map +1 -0
- package/dist/test/test/tools/edit.test.d.ts +2 -0
- package/dist/test/test/tools/edit.test.d.ts.map +1 -0
- package/dist/test/test/tools/edit.test.js +205 -0
- package/dist/test/test/tools/edit.test.js.map +1 -0
- package/dist/test/test/tools/export.test.d.ts +2 -0
- package/dist/test/test/tools/export.test.d.ts.map +1 -0
- package/dist/test/test/tools/export.test.js +144 -0
- package/dist/test/test/tools/export.test.js.map +1 -0
- package/dist/test/test/tools/history.test.d.ts +2 -0
- package/dist/test/test/tools/history.test.d.ts.map +1 -0
- package/dist/test/test/tools/history.test.js +29 -0
- package/dist/test/test/tools/history.test.js.map +1 -0
- package/dist/test/test/tools/inspect.test.d.ts +2 -0
- package/dist/test/test/tools/inspect.test.d.ts.map +1 -0
- package/dist/test/test/tools/inspect.test.js +62 -0
- package/dist/test/test/tools/inspect.test.js.map +1 -0
- package/dist/test/test/tools/list.test.d.ts +2 -0
- package/dist/test/test/tools/list.test.d.ts.map +1 -0
- package/dist/test/test/tools/list.test.js +23 -0
- package/dist/test/test/tools/list.test.js.map +1 -0
- package/dist/test/test/tools/open-editor.test.d.ts +2 -0
- package/dist/test/test/tools/open-editor.test.d.ts.map +1 -0
- package/dist/test/test/tools/open-editor.test.js +53 -0
- package/dist/test/test/tools/open-editor.test.js.map +1 -0
- package/dist/test/test/tools/preview.test.d.ts +2 -0
- package/dist/test/test/tools/preview.test.d.ts.map +1 -0
- package/dist/test/test/tools/preview.test.js +73 -0
- package/dist/test/test/tools/preview.test.js.map +1 -0
- package/dist/test/test/tools/rename.test.d.ts +2 -0
- package/dist/test/test/tools/rename.test.d.ts.map +1 -0
- package/dist/test/test/tools/rename.test.js +17 -0
- package/dist/test/test/tools/rename.test.js.map +1 -0
- package/dist/test/test/viewer/broadcaster.test.d.ts +2 -0
- package/dist/test/test/viewer/broadcaster.test.d.ts.map +1 -0
- package/dist/test/test/viewer/broadcaster.test.js +53 -0
- package/dist/test/test/viewer/broadcaster.test.js.map +1 -0
- package/dist/test/test/viewer/resource-route.test.d.ts +2 -0
- package/dist/test/test/viewer/resource-route.test.d.ts.map +1 -0
- package/dist/test/test/viewer/resource-route.test.js +70 -0
- package/dist/test/test/viewer/resource-route.test.js.map +1 -0
- package/dist/test/test/viewer/router.test.d.ts +2 -0
- package/dist/test/test/viewer/router.test.d.ts.map +1 -0
- package/dist/test/test/viewer/router.test.js +171 -0
- package/dist/test/test/viewer/router.test.js.map +1 -0
- package/dist/test/test/viewer/url-builder.test.d.ts +2 -0
- package/dist/test/test/viewer/url-builder.test.d.ts.map +1 -0
- package/dist/test/test/viewer/url-builder.test.js +31 -0
- package/dist/test/test/viewer/url-builder.test.js.map +1 -0
- package/dist/test/test/workspace/hosted-stub.test.d.ts +2 -0
- package/dist/test/test/workspace/hosted-stub.test.d.ts.map +1 -0
- package/dist/test/test/workspace/hosted-stub.test.js +30 -0
- package/dist/test/test/workspace/hosted-stub.test.js.map +1 -0
- package/dist/test/test/workspace/in-memory.test.d.ts +2 -0
- package/dist/test/test/workspace/in-memory.test.d.ts.map +1 -0
- package/dist/test/test/workspace/in-memory.test.js +4 -0
- package/dist/test/test/workspace/in-memory.test.js.map +1 -0
- package/dist/test/test/workspace/node-fs.test.d.ts +2 -0
- package/dist/test/test/workspace/node-fs.test.d.ts.map +1 -0
- package/dist/test/test/workspace/node-fs.test.js +20 -0
- package/dist/test/test/workspace/node-fs.test.js.map +1 -0
- package/dist/test/test/workspace/shared-contract.d.ts +3 -0
- package/dist/test/test/workspace/shared-contract.d.ts.map +1 -0
- package/dist/test/test/workspace/shared-contract.js +92 -0
- package/dist/test/test/workspace/shared-contract.js.map +1 -0
- package/dist/test/tsconfig.test.tsbuildinfo +1 -0
- package/dist/test/vitest.config.d.ts +3 -0
- package/dist/test/vitest.config.d.ts.map +1 -0
- package/dist/test/vitest.config.js +8 -0
- package/dist/test/vitest.config.js.map +1 -0
- package/dist/tools/asset-generate.d.ts +12 -0
- package/dist/tools/asset-generate.d.ts.map +1 -0
- package/dist/tools/asset-generate.js +112 -0
- package/dist/tools/asset-generate.js.map +1 -0
- package/dist/tools/asset-search.d.ts +10 -0
- package/dist/tools/asset-search.d.ts.map +1 -0
- package/dist/tools/asset-search.js +120 -0
- package/dist/tools/asset-search.js.map +1 -0
- package/dist/tools/content-types.d.ts +11 -0
- package/dist/tools/content-types.d.ts.map +1 -0
- package/dist/tools/content-types.js +2 -0
- package/dist/tools/content-types.js.map +1 -0
- package/dist/tools/edit.d.ts +29 -0
- package/dist/tools/edit.d.ts.map +1 -0
- package/dist/tools/edit.js +165 -0
- package/dist/tools/edit.js.map +1 -0
- package/dist/tools/engine.d.ts +31 -0
- package/dist/tools/engine.d.ts.map +1 -0
- package/dist/tools/engine.js +59 -0
- package/dist/tools/engine.js.map +1 -0
- package/dist/tools/export.d.ts +19 -0
- package/dist/tools/export.d.ts.map +1 -0
- package/dist/tools/export.js +179 -0
- package/dist/tools/export.js.map +1 -0
- package/dist/tools/history.d.ts +7 -0
- package/dist/tools/history.d.ts.map +1 -0
- package/dist/tools/history.js +54 -0
- package/dist/tools/history.js.map +1 -0
- package/dist/tools/index.d.ts +35 -0
- package/dist/tools/index.d.ts.map +1 -0
- package/dist/tools/index.js +72 -0
- package/dist/tools/index.js.map +1 -0
- package/dist/tools/inspect.d.ts +7 -0
- package/dist/tools/inspect.d.ts.map +1 -0
- package/dist/tools/inspect.js +80 -0
- package/dist/tools/inspect.js.map +1 -0
- package/dist/tools/list.d.ts +7 -0
- package/dist/tools/list.d.ts.map +1 -0
- package/dist/tools/list.js +18 -0
- package/dist/tools/list.js.map +1 -0
- package/dist/tools/metrics.d.ts +11 -0
- package/dist/tools/metrics.d.ts.map +1 -0
- package/dist/tools/metrics.js +28 -0
- package/dist/tools/metrics.js.map +1 -0
- package/dist/tools/open-editor.d.ts +10 -0
- package/dist/tools/open-editor.d.ts.map +1 -0
- package/dist/tools/open-editor.js +62 -0
- package/dist/tools/open-editor.js.map +1 -0
- package/dist/tools/preview.d.ts +12 -0
- package/dist/tools/preview.d.ts.map +1 -0
- package/dist/tools/preview.js +104 -0
- package/dist/tools/preview.js.map +1 -0
- package/dist/tools/rename.d.ts +7 -0
- package/dist/tools/rename.d.ts.map +1 -0
- package/dist/tools/rename.js +39 -0
- package/dist/tools/rename.js.map +1 -0
- package/dist/tools/result.d.ts +12 -0
- package/dist/tools/result.d.ts.map +1 -0
- package/dist/tools/result.js +55 -0
- package/dist/tools/result.js.map +1 -0
- package/dist/tools/save.d.ts +19 -0
- package/dist/tools/save.d.ts.map +1 -0
- package/dist/tools/save.js +117 -0
- package/dist/tools/save.js.map +1 -0
- package/dist/viewer/broadcaster.d.ts +13 -0
- package/dist/viewer/broadcaster.d.ts.map +1 -0
- package/dist/viewer/broadcaster.js +44 -0
- package/dist/viewer/broadcaster.js.map +1 -0
- package/dist/viewer/index.d.ts +7 -0
- package/dist/viewer/index.d.ts.map +1 -0
- package/dist/viewer/index.js +7 -0
- package/dist/viewer/index.js.map +1 -0
- package/dist/viewer/listener.d.ts +16 -0
- package/dist/viewer/listener.d.ts.map +1 -0
- package/dist/viewer/listener.js +30 -0
- package/dist/viewer/listener.js.map +1 -0
- package/dist/viewer/presigned-r2-url-builder.d.ts +30 -0
- package/dist/viewer/presigned-r2-url-builder.d.ts.map +1 -0
- package/dist/viewer/presigned-r2-url-builder.js +40 -0
- package/dist/viewer/presigned-r2-url-builder.js.map +1 -0
- package/dist/viewer/resource-route.d.ts +9 -0
- package/dist/viewer/resource-route.d.ts.map +1 -0
- package/dist/viewer/resource-route.js +59 -0
- package/dist/viewer/resource-route.js.map +1 -0
- package/dist/viewer/router.d.ts +20 -0
- package/dist/viewer/router.d.ts.map +1 -0
- package/dist/viewer/router.js +142 -0
- package/dist/viewer/router.js.map +1 -0
- package/dist/viewer/session-mount.d.ts +10 -0
- package/dist/viewer/session-mount.d.ts.map +1 -0
- package/dist/viewer/session-mount.js +24 -0
- package/dist/viewer/session-mount.js.map +1 -0
- package/dist/viewer/spa-assets.generated.d.ts +2 -0
- package/dist/viewer/spa-assets.generated.d.ts.map +1 -0
- package/dist/viewer/spa-assets.generated.js +989 -0
- package/dist/viewer/spa-assets.generated.js.map +1 -0
- package/dist/viewer/url-builder.d.ts +48 -0
- package/dist/viewer/url-builder.d.ts.map +1 -0
- package/dist/viewer/url-builder.js +38 -0
- package/dist/viewer/url-builder.js.map +1 -0
- package/dist/workspace/hosted-stub.d.ts +28 -0
- package/dist/workspace/hosted-stub.d.ts.map +1 -0
- package/dist/workspace/hosted-stub.js +44 -0
- package/dist/workspace/hosted-stub.js.map +1 -0
- package/dist/workspace/in-memory.d.ts +23 -0
- package/dist/workspace/in-memory.d.ts.map +1 -0
- package/dist/workspace/in-memory.js +161 -0
- package/dist/workspace/in-memory.js.map +1 -0
- package/dist/workspace/index.d.ts +6 -0
- package/dist/workspace/index.d.ts.map +1 -0
- package/dist/workspace/index.js +6 -0
- package/dist/workspace/index.js.map +1 -0
- package/dist/workspace/node-fs.d.ts +23 -0
- package/dist/workspace/node-fs.d.ts.map +1 -0
- package/dist/workspace/node-fs.js +90 -0
- package/dist/workspace/node-fs.js.map +1 -0
- package/dist/workspace/s3.d.ts +32 -0
- package/dist/workspace/s3.d.ts.map +1 -0
- package/dist/workspace/s3.js +191 -0
- package/dist/workspace/s3.js.map +1 -0
- package/dist/workspace/scoped.d.ts +32 -0
- package/dist/workspace/scoped.d.ts.map +1 -0
- package/dist/workspace/scoped.js +76 -0
- package/dist/workspace/scoped.js.map +1 -0
- package/dist/workspace/types.d.ts +75 -0
- package/dist/workspace/types.d.ts.map +1 -0
- package/dist/workspace/types.js +18 -0
- package/dist/workspace/types.js.map +1 -0
- package/package.json +80 -0
|
@@ -0,0 +1,884 @@
|
|
|
1
|
+
> This is one page of the CE.SDK Vanilla JS/TS documentation. For a complete overview, see the [Vanilla JS/TS Documentation Index](https://img.ly/docs/cesdk/js.md). For all docs in one file, see [llms-full.txt](./llms-full.txt.md).
|
|
2
|
+
|
|
3
|
+
**Navigation:** [Starter Kits](./starterkits.md) > [Video Editing](./starterkits/video-editing.md) > [Video Captions](./starterkits/video-captions.md)
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Enhance video creation by importing, customizing, and styling captions directly within the editor.
|
|
8
|
+
|
|
9
|
+

|
|
10
|
+
|
|
11
|
+
> **Reading time:** 10 minutes
|
|
12
|
+
>
|
|
13
|
+
> **Resources:**
|
|
14
|
+
>
|
|
15
|
+
> - [Download examples](https://github.com/imgly/starterkit-video-captions-react-web/archive/refs/tags/release-$UBQ_VERSION$.zip)
|
|
16
|
+
> - [View source on GitHub](https://github.com/imgly/starterkit-video-captions-react-web/tree/release-$UBQ_VERSION$)
|
|
17
|
+
> - [Open in StackBlitz](https://stackblitz.com/github/imgly/starterkit-video-captions-react-web/tree/release-$UBQ_VERSION$)
|
|
18
|
+
> - [Live demo](https://img.ly/docs/cesdk/examples/starterkit-video-captions/)
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Pre-requisites
|
|
23
|
+
|
|
24
|
+
This guide assumes basic familiarity with JavaScript or TypeScript.
|
|
25
|
+
|
|
26
|
+
- **Node.js v20+** with npm – [Download](https://nodejs.org/)
|
|
27
|
+
- **Supported browsers** – Chrome 114+, Edge 114+, Firefox 115+, Safari 15.6+<br />
|
|
28
|
+
See [Browser Support](./browser-support.md) for the full list
|
|
29
|
+
- **fal.ai API key** (for autocaption mode) – [Get your API key](https://fal.ai/dashboard/keys)<br />
|
|
30
|
+
Required for AI-powered caption generation with ElevenLabs Scribe V2
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
<Tabs syncKey="project-type">
|
|
35
|
+
<TabItem label="New Project">
|
|
36
|
+
## Get Started
|
|
37
|
+
|
|
38
|
+
Start fresh with a standalone Video Captions project. This creates a complete, ready-to-run application.
|
|
39
|
+
|
|
40
|
+
## Step 1: Clone the Repository
|
|
41
|
+
|
|
42
|
+
<TerminalTabs>
|
|
43
|
+
<TerminalTab label="git">
|
|
44
|
+
git clone https://github.com/imgly/starterkit-video-captions-react-web.git
|
|
45
|
+
</TerminalTab>
|
|
46
|
+
|
|
47
|
+
<TerminalTab label="degit">
|
|
48
|
+
npx degit imgly/starterkit-video-captions-react-web starterkit-video-captions-react-web
|
|
49
|
+
</TerminalTab>
|
|
50
|
+
</TerminalTabs>
|
|
51
|
+
|
|
52
|
+
The `src/` folder contains the editor code:
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
src/
|
|
56
|
+
├── app/ # Demo application
|
|
57
|
+
├── imgly/
|
|
58
|
+
│ ├── config/
|
|
59
|
+
│ │ ├── actions.ts # Export/import actions
|
|
60
|
+
│ │ ├── features.ts # Feature toggles
|
|
61
|
+
│ │ ├── i18n.ts # Translations
|
|
62
|
+
│ │ ├── plugin.ts # Main configuration plugin
|
|
63
|
+
│ │ ├── settings.ts # Engine settings
|
|
64
|
+
│ │ └── ui/
|
|
65
|
+
│ │ ├── canvas.ts # Canvas configuration
|
|
66
|
+
│ │ ├── components.ts # Custom component registration
|
|
67
|
+
│ │ ├── dock.ts # Dock layout configuration
|
|
68
|
+
│ │ ├── index.ts # Combines UI customization exports
|
|
69
|
+
│ │ ├── inspectorBar.ts # Inspector bar layout
|
|
70
|
+
│ │ ├── navigationBar.ts # Navigation bar layout
|
|
71
|
+
│ │ └── panel.ts # Panel configuration
|
|
72
|
+
│ ├── index.ts # Editor initialization function
|
|
73
|
+
│ └── plugins/
|
|
74
|
+
│ └── auto-caption.ts
|
|
75
|
+
└── index.tsx # Application entry point
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Step 2: Install Dependencies
|
|
79
|
+
|
|
80
|
+
Install the required packages:
|
|
81
|
+
|
|
82
|
+
<TerminalTabs syncKey="package-manager">
|
|
83
|
+
<TerminalTab label="npm">
|
|
84
|
+
cd starterkit-video-captions-react-web
|
|
85
|
+
npm install
|
|
86
|
+
</TerminalTab>
|
|
87
|
+
|
|
88
|
+
<TerminalTab label="pnpm">
|
|
89
|
+
cd starterkit-video-captions-react-web
|
|
90
|
+
pnpm install
|
|
91
|
+
</TerminalTab>
|
|
92
|
+
|
|
93
|
+
<TerminalTab label="yarn">
|
|
94
|
+
cd starterkit-video-captions-react-web
|
|
95
|
+
yarn
|
|
96
|
+
</TerminalTab>
|
|
97
|
+
</TerminalTabs>
|
|
98
|
+
|
|
99
|
+
## Step 3: Download Assets
|
|
100
|
+
|
|
101
|
+
CE.SDK requires engine assets (fonts, icons, UI elements) to function. These must be served as static files from your project's `public/` directory.
|
|
102
|
+
|
|
103
|
+
<TerminalTabs>
|
|
104
|
+
<TerminalTab label="Download">
|
|
105
|
+
curl -O https://cdn.img.ly/packages/imgly/cesdk-js/$UBQ\_VERSION$/imgly-assets.zip
|
|
106
|
+
unzip imgly-assets.zip -d public/
|
|
107
|
+
rm imgly-assets.zip
|
|
108
|
+
</TerminalTab>
|
|
109
|
+
</TerminalTabs>
|
|
110
|
+
|
|
111
|
+
> **Asset Configuration:** The starter kit is pre-configured to load assets from `/assets`. If you place assets in a different location, update the `baseURL` in `src/index.tsx`.
|
|
112
|
+
|
|
113
|
+
```typescript title="src/index.tsx"
|
|
114
|
+
const config = {
|
|
115
|
+
// ...
|
|
116
|
+
baseURL: '/assets'
|
|
117
|
+
// ...
|
|
118
|
+
};
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
## Step 4: Run the Development Server
|
|
122
|
+
|
|
123
|
+
<TerminalTabs syncKey="package-manager">
|
|
124
|
+
<TerminalTab label="npm">
|
|
125
|
+
npm run dev
|
|
126
|
+
</TerminalTab>
|
|
127
|
+
|
|
128
|
+
<TerminalTab label="pnpm">
|
|
129
|
+
pnpm run dev
|
|
130
|
+
</TerminalTab>
|
|
131
|
+
|
|
132
|
+
<TerminalTab label="yarn">
|
|
133
|
+
yarn dev
|
|
134
|
+
</TerminalTab>
|
|
135
|
+
</TerminalTabs>
|
|
136
|
+
|
|
137
|
+
Open `http://localhost:5173` in your browser.
|
|
138
|
+
|
|
139
|
+
</TabItem>
|
|
140
|
+
|
|
141
|
+
<TabItem label="Existing Project">
|
|
142
|
+
## Get Started
|
|
143
|
+
|
|
144
|
+
Integrate the Video Captions into an existing web application. This adds the editor configuration to your current project structure.
|
|
145
|
+
|
|
146
|
+
## Step 1: Clone
|
|
147
|
+
|
|
148
|
+
<TerminalTabs>
|
|
149
|
+
<TerminalTab label="Navigate">
|
|
150
|
+
cd your-project
|
|
151
|
+
</TerminalTab>
|
|
152
|
+
</TerminalTabs>
|
|
153
|
+
|
|
154
|
+
Clone the starter kit and copy the editor configuration to your project:
|
|
155
|
+
|
|
156
|
+
<TerminalTabs>
|
|
157
|
+
<TerminalTab label="git">
|
|
158
|
+
git clone https://github.com/imgly/starterkit-video-captions-react-web.git
|
|
159
|
+
cp -r starterkit-video-captions-react-web/src/imgly ./src/imgly
|
|
160
|
+
rm -rf starterkit-video-captions-react-web
|
|
161
|
+
</TerminalTab>
|
|
162
|
+
|
|
163
|
+
<TerminalTab label="degit">
|
|
164
|
+
npx degit imgly/starterkit-video-captions-react-web/src/imgly ./src/imgly
|
|
165
|
+
</TerminalTab>
|
|
166
|
+
</TerminalTabs>
|
|
167
|
+
|
|
168
|
+
> **Adjust Path:** The default destination is `./src/imgly`. Adjust the path to match your project structure.
|
|
169
|
+
|
|
170
|
+
The `imgly/` folder contains the editor configuration:
|
|
171
|
+
|
|
172
|
+
```
|
|
173
|
+
imgly/
|
|
174
|
+
├── config/
|
|
175
|
+
│ ├── actions.ts # Export/import actions
|
|
176
|
+
│ ├── features.ts # Feature toggles
|
|
177
|
+
│ ├── i18n.ts # Translations
|
|
178
|
+
│ ├── plugin.ts # Main configuration plugin
|
|
179
|
+
│ ├── settings.ts # Engine settings
|
|
180
|
+
│ └── ui/
|
|
181
|
+
│ ├── canvas.ts # Canvas configuration
|
|
182
|
+
│ ├── components.ts # Custom component registration
|
|
183
|
+
│ ├── dock.ts # Dock layout configuration
|
|
184
|
+
│ ├── index.ts # Combines UI customization exports
|
|
185
|
+
│ ├── inspectorBar.ts # Inspector bar layout
|
|
186
|
+
│ ├── navigationBar.ts # Navigation bar layout
|
|
187
|
+
│ └── panel.ts # Panel configuration
|
|
188
|
+
├── index.ts # Editor initialization function
|
|
189
|
+
└── plugins/
|
|
190
|
+
└── auto-caption.ts
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
## Step 2: Install Dependencies
|
|
194
|
+
|
|
195
|
+
Install the required packages for the editor:
|
|
196
|
+
|
|
197
|
+
### Core Editor
|
|
198
|
+
|
|
199
|
+
Install the Creative Editor SDK:
|
|
200
|
+
|
|
201
|
+
<TerminalTabs syncKey="package-manager">
|
|
202
|
+
<TerminalTab label="npm">
|
|
203
|
+
npm install @cesdk/cesdk-js@$UBQ\_VERSION$
|
|
204
|
+
</TerminalTab>
|
|
205
|
+
|
|
206
|
+
<TerminalTab label="pnpm">
|
|
207
|
+
pnpm add @cesdk/cesdk-js@$UBQ\_VERSION$
|
|
208
|
+
</TerminalTab>
|
|
209
|
+
|
|
210
|
+
<TerminalTab label="yarn">
|
|
211
|
+
yarn add @cesdk/cesdk-js@$UBQ\_VERSION$
|
|
212
|
+
</TerminalTab>
|
|
213
|
+
</TerminalTabs>
|
|
214
|
+
|
|
215
|
+
### Autocaption Plugin
|
|
216
|
+
|
|
217
|
+
Add AI-powered caption generation with ElevenLabs Scribe V2:
|
|
218
|
+
|
|
219
|
+
<TerminalTabs syncKey="package-manager">
|
|
220
|
+
<TerminalTab label="npm">
|
|
221
|
+
npm install @imgly/plugin-autocaption-web@$UBQ\_VERSION$
|
|
222
|
+
</TerminalTab>
|
|
223
|
+
|
|
224
|
+
<TerminalTab label="pnpm">
|
|
225
|
+
pnpm add @imgly/plugin-autocaption-web@$UBQ\_VERSION$
|
|
226
|
+
</TerminalTab>
|
|
227
|
+
|
|
228
|
+
<TerminalTab label="yarn">
|
|
229
|
+
yarn add @imgly/plugin-autocaption-web@$UBQ\_VERSION$
|
|
230
|
+
</TerminalTab>
|
|
231
|
+
</TerminalTabs>
|
|
232
|
+
|
|
233
|
+
This plugin provides automatic speech-to-text transcription and caption generation for videos.
|
|
234
|
+
|
|
235
|
+
## Step 3: Download Assets
|
|
236
|
+
|
|
237
|
+
CE.SDK requires engine assets (fonts, icons, UI elements) to function. These must be served as static files from your project's `public/` directory.
|
|
238
|
+
|
|
239
|
+
<TerminalTabs>
|
|
240
|
+
<TerminalTab label="Download">
|
|
241
|
+
curl -O https://cdn.img.ly/packages/imgly/cesdk-js/$UBQ\_VERSION$/imgly-assets.zip
|
|
242
|
+
unzip imgly-assets.zip -d public/
|
|
243
|
+
rm imgly-assets.zip
|
|
244
|
+
</TerminalTab>
|
|
245
|
+
</TerminalTabs>
|
|
246
|
+
|
|
247
|
+
> **Asset Configuration:** The starter kit is pre-configured to load assets from `/assets`. If you place assets in a different location, update the `baseURL` in Step 5: Initialize the Editor.
|
|
248
|
+
|
|
249
|
+
## Step 4: Add a Container Element
|
|
250
|
+
|
|
251
|
+
Add a container element to your HTML where the editor will be mounted:
|
|
252
|
+
|
|
253
|
+
```html
|
|
254
|
+
<div id="cesdk_container" style="width: 100%; height: 100vh;"></div>
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
## Step 5: Initialize the Editor
|
|
258
|
+
|
|
259
|
+
Choose your caption mode and initialize the editor accordingly:
|
|
260
|
+
|
|
261
|
+
<Tabs syncKey="editor-mode">
|
|
262
|
+
<TabItem label="Autocaption">
|
|
263
|
+
```typescript title="src/index.tsx"
|
|
264
|
+
import CreativeEditorSDK from '@cesdk/cesdk-js';
|
|
265
|
+
|
|
266
|
+
import { initVideoCaptionsAutocaptionEditor } from './imgly';
|
|
267
|
+
|
|
268
|
+
const config = {
|
|
269
|
+
userId: 'your-user-id',
|
|
270
|
+
baseURL: '/assets'
|
|
271
|
+
// license: 'YOUR_LICENSE_KEY',
|
|
272
|
+
};
|
|
273
|
+
|
|
274
|
+
CreativeEditorSDK.create('#cesdk_container', config)
|
|
275
|
+
.then(async (cesdk) => {
|
|
276
|
+
await initVideoCaptionsAutocaptionEditor(cesdk);
|
|
277
|
+
})
|
|
278
|
+
.catch((error) => {
|
|
279
|
+
console.error('Failed to initialize CE.SDK:', error);
|
|
280
|
+
});
|
|
281
|
+
```
|
|
282
|
+
</TabItem>
|
|
283
|
+
|
|
284
|
+
<TabItem label="Blank">
|
|
285
|
+
```typescript title="src/index.tsx"
|
|
286
|
+
import CreativeEditorSDK from '@cesdk/cesdk-js';
|
|
287
|
+
|
|
288
|
+
import { initVideoCaptionsBlankEditor } from './imgly';
|
|
289
|
+
|
|
290
|
+
const config = {
|
|
291
|
+
userId: 'your-user-id',
|
|
292
|
+
baseURL: '/assets'
|
|
293
|
+
// license: 'YOUR_LICENSE_KEY',
|
|
294
|
+
};
|
|
295
|
+
|
|
296
|
+
CreativeEditorSDK.create('#cesdk_container', config)
|
|
297
|
+
.then(async (cesdk) => {
|
|
298
|
+
await initVideoCaptionsBlankEditor(cesdk);
|
|
299
|
+
})
|
|
300
|
+
.catch((error) => {
|
|
301
|
+
console.error('Failed to initialize CE.SDK:', error);
|
|
302
|
+
});
|
|
303
|
+
```
|
|
304
|
+
</TabItem>
|
|
305
|
+
|
|
306
|
+
<TabItem label="Import">
|
|
307
|
+
```typescript title="src/index.tsx"
|
|
308
|
+
import CreativeEditorSDK from '@cesdk/cesdk-js';
|
|
309
|
+
|
|
310
|
+
import { initVideoCaptionsImportEditor } from './imgly';
|
|
311
|
+
|
|
312
|
+
const config = {
|
|
313
|
+
userId: 'your-user-id',
|
|
314
|
+
baseURL: '/assets'
|
|
315
|
+
// license: 'YOUR_LICENSE_KEY',
|
|
316
|
+
};
|
|
317
|
+
|
|
318
|
+
CreativeEditorSDK.create('#cesdk_container', config)
|
|
319
|
+
.then(async (cesdk) => {
|
|
320
|
+
await initVideoCaptionsImportEditor(cesdk);
|
|
321
|
+
})
|
|
322
|
+
.catch((error) => {
|
|
323
|
+
console.error('Failed to initialize CE.SDK:', error);
|
|
324
|
+
});
|
|
325
|
+
```
|
|
326
|
+
</TabItem>
|
|
327
|
+
|
|
328
|
+
<TabItem label="Pre-captioned">
|
|
329
|
+
```typescript title="src/index.tsx"
|
|
330
|
+
import CreativeEditorSDK from '@cesdk/cesdk-js';
|
|
331
|
+
|
|
332
|
+
import { initVideoCaptionsPreCaptionedEditor } from './imgly';
|
|
333
|
+
|
|
334
|
+
const config = {
|
|
335
|
+
userId: 'your-user-id',
|
|
336
|
+
baseURL: '/assets'
|
|
337
|
+
// license: 'YOUR_LICENSE_KEY',
|
|
338
|
+
};
|
|
339
|
+
|
|
340
|
+
CreativeEditorSDK.create('#cesdk_container', config)
|
|
341
|
+
.then(async (cesdk) => {
|
|
342
|
+
await initVideoCaptionsPreCaptionedEditor(cesdk);
|
|
343
|
+
})
|
|
344
|
+
.catch((error) => {
|
|
345
|
+
console.error('Failed to initialize CE.SDK:', error);
|
|
346
|
+
});
|
|
347
|
+
```
|
|
348
|
+
</TabItem>
|
|
349
|
+
</Tabs>
|
|
350
|
+
|
|
351
|
+
</TabItem>
|
|
352
|
+
</Tabs>
|
|
353
|
+
|
|
354
|
+
## Caption Modes
|
|
355
|
+
|
|
356
|
+
The Video Captions starter kit supports four distinct workflows for working with video captions:
|
|
357
|
+
|
|
358
|
+
### Autocaption Mode
|
|
359
|
+
|
|
360
|
+
Auto-generate captions using AI-powered speech-to-text transcription with ElevenLabs Scribe V2:
|
|
361
|
+
|
|
362
|
+
```typescript title="src/index.ts"
|
|
363
|
+
await initVideoCaptionsAutocaptionEditor(cesdk);
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
This mode:
|
|
367
|
+
|
|
368
|
+
- Loads a video with audio ready for transcription
|
|
369
|
+
- Integrates the `@imgly/plugin-autocaption-web` plugin
|
|
370
|
+
- Configures the ElevenLabs Scribe V2 provider via fal.ai proxy
|
|
371
|
+
- Automatically transcribes speech and generates styled captions
|
|
372
|
+
- Opens the caption inspector panel for editing
|
|
373
|
+
|
|
374
|
+
**Prerequisites:**
|
|
375
|
+
|
|
376
|
+
- fal.ai API key configured in `VITE_AUTOCAPTION_PROXY_URL` environment variable
|
|
377
|
+
- Default proxy: `https://proxy.img.ly/api/proxy/falai`
|
|
378
|
+
|
|
379
|
+
### Blank Mode
|
|
380
|
+
|
|
381
|
+
Start with an empty video canvas for manual caption creation:
|
|
382
|
+
|
|
383
|
+
```typescript title="src/index.ts"
|
|
384
|
+
await initVideoCaptionsBlankEditor(cesdk);
|
|
385
|
+
```
|
|
386
|
+
|
|
387
|
+
This mode:
|
|
388
|
+
|
|
389
|
+
- Creates a new blank video scene (1280x720)
|
|
390
|
+
- Lets you import your own videos
|
|
391
|
+
- Manually create and style captions from scratch
|
|
392
|
+
- No AI processing required
|
|
393
|
+
|
|
394
|
+
### Import Mode
|
|
395
|
+
|
|
396
|
+
Import existing SRT subtitle files and edit them:
|
|
397
|
+
|
|
398
|
+
```typescript title="src/index.ts"
|
|
399
|
+
await initVideoCaptionsImportEditor(cesdk);
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
This mode:
|
|
403
|
+
|
|
404
|
+
- Loads a video for caption placement
|
|
405
|
+
- Allows importing SRT files with existing captions
|
|
406
|
+
- Edit timing, styling, and positioning
|
|
407
|
+
- Export back to video with embedded captions
|
|
408
|
+
|
|
409
|
+
### Pre-captioned Mode
|
|
410
|
+
|
|
411
|
+
Edit videos that already have embedded captions:
|
|
412
|
+
|
|
413
|
+
```typescript title="src/index.ts"
|
|
414
|
+
await initVideoCaptionsPreCaptionedEditor(cesdk);
|
|
415
|
+
```
|
|
416
|
+
|
|
417
|
+
This mode:
|
|
418
|
+
|
|
419
|
+
- Loads a video with captions already embedded
|
|
420
|
+
- Automatically selects the first caption for editing
|
|
421
|
+
- Full access to caption styling and timing controls
|
|
422
|
+
- Refine existing captions without re-transcribing
|
|
423
|
+
|
|
424
|
+
## Autocaption Setup
|
|
425
|
+
|
|
426
|
+
To enable AI-powered caption generation, configure the fal.ai proxy URL:
|
|
427
|
+
|
|
428
|
+
```typescript title="src/imgly/index.ts"
|
|
429
|
+
import AutocaptionPlugin from '@imgly/plugin-autocaption-web';
|
|
430
|
+
import { ElevenLabsScribeV2 } from '@imgly/plugin-autocaption-web/fal-ai';
|
|
431
|
+
|
|
432
|
+
// Configure the proxy URL (default: https://proxy.img.ly/api/proxy/falai)
|
|
433
|
+
const AUTOCAPTION_PROXY_URL =
|
|
434
|
+
import.meta.env.VITE_AUTOCAPTION_PROXY_URL ||
|
|
435
|
+
'https://proxy.img.ly/api/proxy/falai';
|
|
436
|
+
|
|
437
|
+
// Add the autocaption plugin with ElevenLabs Scribe V2 provider
|
|
438
|
+
await cesdk.addPlugin(
|
|
439
|
+
AutocaptionPlugin({
|
|
440
|
+
provider: ElevenLabsScribeV2({
|
|
441
|
+
proxyUrl: AUTOCAPTION_PROXY_URL
|
|
442
|
+
})
|
|
443
|
+
})
|
|
444
|
+
);
|
|
445
|
+
```
|
|
446
|
+
|
|
447
|
+
The proxy URL should point to a server that forwards requests to fal.ai with your API key. For production use, deploy your own proxy to keep the API key secure.
|
|
448
|
+
|
|
449
|
+
## Caption Inspector Panel
|
|
450
|
+
|
|
451
|
+
The caption inspector panel provides comprehensive controls for editing captions:
|
|
452
|
+
|
|
453
|
+
```typescript
|
|
454
|
+
// Open the caption inspector panel programmatically
|
|
455
|
+
cesdk.ui.openPanel('//ly.img.panel/inspector/caption');
|
|
456
|
+
```
|
|
457
|
+
|
|
458
|
+
The panel includes:
|
|
459
|
+
|
|
460
|
+
- **Caption text editor** - Edit caption content with live preview
|
|
461
|
+
- **Timing controls** - Adjust start time and duration
|
|
462
|
+
- **Styling options** - Font, size, color, background, alignment
|
|
463
|
+
- **Positioning** - Move captions anywhere on the video
|
|
464
|
+
- **Caption presets** - Apply pre-designed caption styles
|
|
465
|
+
|
|
466
|
+
The panel automatically opens when using `autocaption` mode, but you can open it manually in any mode using the code above.
|
|
467
|
+
|
|
468
|
+
## Set Up a Scene
|
|
469
|
+
|
|
470
|
+
Each caption mode has a dedicated init function that handles scene setup automatically.
|
|
471
|
+
|
|
472
|
+
For custom workflows beyond the predefined modes, you can load content manually:
|
|
473
|
+
|
|
474
|
+
```typescript title="src/index.ts"
|
|
475
|
+
// After initialization, load your own video
|
|
476
|
+
await cesdk.createFromVideo('https://example.com/video.mp4');
|
|
477
|
+
|
|
478
|
+
// Or load from a template archive with captions
|
|
479
|
+
await cesdk.loadFromArchiveURL('https://example.com/template.zip');
|
|
480
|
+
|
|
481
|
+
// Or load from a scene file
|
|
482
|
+
await cesdk.loadFromURL('https://example.com/scene.json');
|
|
483
|
+
```
|
|
484
|
+
|
|
485
|
+
The predefined init functions load appropriate scenes:
|
|
486
|
+
|
|
487
|
+
- **autocaption** - Loads a video ready for AI transcription
|
|
488
|
+
- **blank** - Creates an empty 1280x720 video scene
|
|
489
|
+
- **import** - Loads a video for SRT import
|
|
490
|
+
- **pre-captioned** - Loads a video with embedded captions
|
|
491
|
+
|
|
492
|
+
> **More Loading Options:** See [Open the Editor](./open-the-editor.md) for all available loading methods.
|
|
493
|
+
|
|
494
|
+
## Customize Assets
|
|
495
|
+
|
|
496
|
+
The Video Captions uses asset source plugins to provide built-in libraries for video clips, audio, effects, stickers, and fonts. The starter kit includes a curated selection—customize what's included based on your needs.
|
|
497
|
+
|
|
498
|
+
Asset sources are added via plugins in `src/index.ts`. Enable or disable individual sources:
|
|
499
|
+
|
|
500
|
+
```typescript title="src/index.ts"
|
|
501
|
+
import {
|
|
502
|
+
FiltersAssetSource,
|
|
503
|
+
StickerAssetSource,
|
|
504
|
+
TextAssetSource,
|
|
505
|
+
VectorShapeAssetSource,
|
|
506
|
+
EffectsAssetSource
|
|
507
|
+
// ...
|
|
508
|
+
} from '@cesdk/cesdk-js/plugins';
|
|
509
|
+
|
|
510
|
+
// Add only the sources you need
|
|
511
|
+
await cesdk.addPlugin(new FiltersAssetSource());
|
|
512
|
+
await cesdk.addPlugin(new StickerAssetSource());
|
|
513
|
+
await cesdk.addPlugin(new TextAssetSource());
|
|
514
|
+
await cesdk.addPlugin(new VectorShapeAssetSource());
|
|
515
|
+
await cesdk.addPlugin(new EffectsAssetSource());
|
|
516
|
+
// ...
|
|
517
|
+
```
|
|
518
|
+
|
|
519
|
+
> **Available Asset Sources:** See [Asset Source Plugins](./plugins/asset-sources.md) for the complete list of available sources.
|
|
520
|
+
|
|
521
|
+
For production deployments, self-hosting assets is required—the IMG.LY CDN is intended for development only. See [Serve Assets](./serve-assets.md) for downloading assets, configuring `baseURL`, and excluding unused sources to optimize load times.
|
|
522
|
+
|
|
523
|
+
## Configure Actions
|
|
524
|
+
|
|
525
|
+
Actions are functions that handle user interactions like exporting videos, saving scenes, and importing files. CE.SDK provides built-in actions that you can run directly or override with custom implementations.
|
|
526
|
+
|
|
527
|
+
**Key built-in actions:**
|
|
528
|
+
|
|
529
|
+
- `exportDesign` – Export the current video to MP4 format
|
|
530
|
+
- `saveScene` – Save the scene as a JSON string for later editing
|
|
531
|
+
- `importScene` – Import a previously saved scene (supports `.scene` and `.cesdk` formats)
|
|
532
|
+
- `exportScene` – Export the scene as a JSON file or `.cesdk` archive with all assets
|
|
533
|
+
- `uploadFile` – Handle file uploads with progress tracking
|
|
534
|
+
|
|
535
|
+
Use `cesdk.actions.run()` to execute any action:
|
|
536
|
+
|
|
537
|
+
```typescript
|
|
538
|
+
// Run a built-in action
|
|
539
|
+
await cesdk.actions.run('exportDesign', { mimeType: 'video/mp4' });
|
|
540
|
+
```
|
|
541
|
+
|
|
542
|
+
#### Import from File Picker
|
|
543
|
+
|
|
544
|
+
```typescript title="src/imgly/config/actions.ts"
|
|
545
|
+
// Let users open videos from their device
|
|
546
|
+
cesdk.actions.register('importVideo', async () => {
|
|
547
|
+
const blobURL = await cesdk.utils.loadFile({
|
|
548
|
+
accept: 'video/*',
|
|
549
|
+
returnType: 'objectURL'
|
|
550
|
+
});
|
|
551
|
+
await cesdk.createFromVideo(blobURL);
|
|
552
|
+
});
|
|
553
|
+
```
|
|
554
|
+
|
|
555
|
+
#### Export and Save
|
|
556
|
+
|
|
557
|
+
```typescript title="src/imgly/config/actions.ts"
|
|
558
|
+
// Register export action that downloads the edited video
|
|
559
|
+
cesdk.actions.register('exportDesign', async (exportOptions) => {
|
|
560
|
+
const { blobs, options } = await cesdk.utils.export(exportOptions);
|
|
561
|
+
await cesdk.utils.downloadFile(blobs[0], options.mimeType);
|
|
562
|
+
});
|
|
563
|
+
```
|
|
564
|
+
|
|
565
|
+
#### Upload to Your Backend
|
|
566
|
+
|
|
567
|
+
```typescript title="src/imgly/config/actions.ts"
|
|
568
|
+
// Override the built-in exportDesign action to send to your server
|
|
569
|
+
cesdk.actions.register('exportDesign', async (exportOptions) => {
|
|
570
|
+
const { blobs } = await cesdk.utils.export(exportOptions);
|
|
571
|
+
|
|
572
|
+
const formData = new FormData();
|
|
573
|
+
formData.append('video', blobs[0], 'edited-video.mp4');
|
|
574
|
+
|
|
575
|
+
const response = await fetch('/api/upload', {
|
|
576
|
+
method: 'POST',
|
|
577
|
+
body: formData
|
|
578
|
+
});
|
|
579
|
+
|
|
580
|
+
const { url } = await response.json();
|
|
581
|
+
console.log('Uploaded to:', url);
|
|
582
|
+
});
|
|
583
|
+
```
|
|
584
|
+
|
|
585
|
+
> **Learn More:** See [Actions](./actions.md) for the full list of built-in actions, how to run them, and how to register custom actions.
|
|
586
|
+
|
|
587
|
+
---
|
|
588
|
+
|
|
589
|
+
## Customize (Optional)
|
|
590
|
+
|
|
591
|
+
### Theming
|
|
592
|
+
|
|
593
|
+
CE.SDK supports light and dark themes out of the box, plus automatic system preference detection. Switch between themes programmatically:
|
|
594
|
+
|
|
595
|
+
```typescript title="src/imgly/config/settings.ts"
|
|
596
|
+
// 'light' | 'dark' | 'system' | (() => 'light' | 'dark')
|
|
597
|
+
cesdk.ui.setTheme('dark');
|
|
598
|
+
```
|
|
599
|
+
|
|
600
|
+
See [Theming](./user-interface/appearance/theming.md) for custom color schemes, CSS variables, and advanced styling options.
|
|
601
|
+
|
|
602
|
+
### Localization
|
|
603
|
+
|
|
604
|
+
Customize UI labels and add support for multiple languages. The i18n system supports translation keys for all UI elements:
|
|
605
|
+
|
|
606
|
+
```typescript title="src/imgly/config/i18n.ts"
|
|
607
|
+
// Override specific labels
|
|
608
|
+
cesdk.i18n.setTranslations({
|
|
609
|
+
en: {
|
|
610
|
+
'actions.export.video': 'Download Video',
|
|
611
|
+
'common.cancel': 'Cancel',
|
|
612
|
+
'common.apply': 'Apply'
|
|
613
|
+
}
|
|
614
|
+
});
|
|
615
|
+
|
|
616
|
+
// Add a new language
|
|
617
|
+
cesdk.i18n.setTranslations({
|
|
618
|
+
de: {
|
|
619
|
+
'actions.export.video': 'Video herunterladen'
|
|
620
|
+
}
|
|
621
|
+
});
|
|
622
|
+
|
|
623
|
+
// Set the active locale
|
|
624
|
+
cesdk.i18n.setLocale('de');
|
|
625
|
+
```
|
|
626
|
+
|
|
627
|
+
See [Localization](./user-interface/localization.md) for supported languages, translation key reference, and right-to-left language support.
|
|
628
|
+
|
|
629
|
+
### UI Layout
|
|
630
|
+
|
|
631
|
+

|
|
632
|
+
|
|
633
|
+
Customize the editor interface by modifying the dock, inspector bar, navigation bar, and canvas menu. CE.SDK provides Order APIs to control which components appear and in what sequence.
|
|
634
|
+
|
|
635
|
+
```typescript title="src/imgly/config/ui/navigationBar.ts"
|
|
636
|
+
// Get current navigation bar components
|
|
637
|
+
const navOrder = cesdk.ui.getNavigationBarOrder();
|
|
638
|
+
|
|
639
|
+
// Add a custom button to the navigation bar
|
|
640
|
+
cesdk.ui.insertNavigationBarOrderComponent(
|
|
641
|
+
'ly.img.spacer',
|
|
642
|
+
{ id: 'my-custom-action' },
|
|
643
|
+
'after'
|
|
644
|
+
);
|
|
645
|
+
|
|
646
|
+
// Rearrange dock items
|
|
647
|
+
cesdk.ui.setDockOrder([
|
|
648
|
+
'ly.img.assetLibrary.dock',
|
|
649
|
+
'ly.img.separator',
|
|
650
|
+
'my-custom-dock-item'
|
|
651
|
+
]);
|
|
652
|
+
|
|
653
|
+
// Customize the inspector bar
|
|
654
|
+
cesdk.ui.setInspectorBarOrder([
|
|
655
|
+
'ly.img.fill.inspectorBar',
|
|
656
|
+
'ly.img.separator',
|
|
657
|
+
'ly.img.filter.inspectorBar'
|
|
658
|
+
]);
|
|
659
|
+
```
|
|
660
|
+
|
|
661
|
+
The Order API methods follow a consistent pattern across all UI areas:
|
|
662
|
+
|
|
663
|
+
- `get*Order()` – Retrieve the current component order
|
|
664
|
+
- `set*Order()` – Replace the entire order
|
|
665
|
+
- `insert*OrderComponent()` – Add components relative to existing ones
|
|
666
|
+
|
|
667
|
+
See [Dock](./user-interface/customization/dock.md), [Inspector Bar](./user-interface/customization/inspector-bar.md), [Navigation Bar](./user-interface/customization/navigation-bar.md), [Canvas Menu](./user-interface/customization/canvas-menu.md), and [Canvas](./user-interface/customization/canvas.md) for detailed layout customization options.
|
|
668
|
+
|
|
669
|
+
### Custom Components
|
|
670
|
+
|
|
671
|
+
Build custom UI components using the builder system and integrate them in the editor. Custom components receive reactive state updates and can interact with the engine API.
|
|
672
|
+
|
|
673
|
+
```typescript title="src/imgly/config/ui/components.ts"
|
|
674
|
+
// Register a custom component
|
|
675
|
+
cesdk.ui.registerComponent('my-custom-button', ({ builder, engine }) => {
|
|
676
|
+
const selectedBlocks = engine.block.findAllSelected();
|
|
677
|
+
|
|
678
|
+
builder.Button('apply-effect', {
|
|
679
|
+
label: 'Apply Effect',
|
|
680
|
+
isDisabled: selectedBlocks.length === 0,
|
|
681
|
+
onClick: () => {
|
|
682
|
+
// Apply custom logic to selected blocks
|
|
683
|
+
}
|
|
684
|
+
});
|
|
685
|
+
});
|
|
686
|
+
|
|
687
|
+
// Add the component to the navigation bar
|
|
688
|
+
cesdk.ui.insertNavigationBarOrderComponent(
|
|
689
|
+
'ly.img.spacer',
|
|
690
|
+
'my-custom-button',
|
|
691
|
+
'after'
|
|
692
|
+
);
|
|
693
|
+
```
|
|
694
|
+
|
|
695
|
+
Custom components automatically re-render when the engine state they depend on changes—no manual subscription management required.
|
|
696
|
+
|
|
697
|
+
See [Register New Component](./user-interface/ui-extensions/register-new-component.md) for the complete builder API and component patterns.
|
|
698
|
+
|
|
699
|
+
### Settings & Features
|
|
700
|
+
|
|
701
|
+
Fine-tune editor behavior through settings and features.
|
|
702
|
+
|
|
703
|
+
**Settings** configure core engine behavior—rendering, input handling, and history management:
|
|
704
|
+
|
|
705
|
+
```typescript title="src/imgly/config/settings.ts"
|
|
706
|
+
cesdk.engine.editor.setSettingBool('page/dimOutOfPageAreas', true);
|
|
707
|
+
cesdk.engine.editor.setSettingBool('mouse/enableZoomControl', true);
|
|
708
|
+
cesdk.engine.editor.setSettingBool('features/undoHistory', true);
|
|
709
|
+
```
|
|
710
|
+
|
|
711
|
+
**Features** toggle which editing tools and panels appear in the UI:
|
|
712
|
+
|
|
713
|
+
```typescript title="src/imgly/config/features.ts"
|
|
714
|
+
// Toggle editor features
|
|
715
|
+
cesdk.feature.enable('ly.img.trim', true);
|
|
716
|
+
cesdk.feature.enable('ly.img.filter', true);
|
|
717
|
+
cesdk.feature.enable('ly.img.adjustment', true);
|
|
718
|
+
```
|
|
719
|
+
|
|
720
|
+
See [Settings](./settings.md) and [Features](./user-interface/customization/disable-or-enable.md) for the complete reference.
|
|
721
|
+
|
|
722
|
+
### Explore Plugins
|
|
723
|
+
|
|
724
|
+
CE.SDK has a rich plugin ecosystem that extends the editor with powerful capabilities. Plugins can add new features, integrate third-party services, or customize editor behavior.
|
|
725
|
+
|
|
726
|
+
#### AI Integration
|
|
727
|
+
|
|
728
|
+
Extend the editor with generative AI capabilities for text-to-image generation, image enhancement, and intelligent editing features. CE.SDK integrates with various AI providers.
|
|
729
|
+
|
|
730
|
+
```typescript title="src/imgly/config/plugin.ts"
|
|
731
|
+
import AIPlugin from '@imgly/plugin-ai-generation';
|
|
732
|
+
|
|
733
|
+
// Configure AI generation
|
|
734
|
+
await cesdk.addPlugin(
|
|
735
|
+
AIPlugin({
|
|
736
|
+
provider: 'your-ai-provider',
|
|
737
|
+
apiKey: 'your-api-key'
|
|
738
|
+
})
|
|
739
|
+
);
|
|
740
|
+
```
|
|
741
|
+
|
|
742
|
+
See [AI Integration](./user-interface/ai-integration.md) for provider setup and supported AI features.
|
|
743
|
+
|
|
744
|
+
#### Custom Asset Sources
|
|
745
|
+
|
|
746
|
+
Connect external asset libraries like Unsplash, Getty Images, or your own content management system. Asset sources let users browse and insert content from any source.
|
|
747
|
+
|
|
748
|
+
```typescript title="src/imgly/config/plugin.ts"
|
|
749
|
+
import UnsplashAssetSource from '@imgly/plugin-unsplash';
|
|
750
|
+
|
|
751
|
+
// Add Unsplash integration
|
|
752
|
+
await cesdk.addPlugin(
|
|
753
|
+
UnsplashAssetSource({
|
|
754
|
+
accessKey: 'your-unsplash-access-key'
|
|
755
|
+
})
|
|
756
|
+
);
|
|
757
|
+
```
|
|
758
|
+
|
|
759
|
+
See [Custom Asset Sources](./import-media/from-remote-source/unsplash.md) for integration patterns.
|
|
760
|
+
|
|
761
|
+
#### Discover More Plugins
|
|
762
|
+
|
|
763
|
+
Explore the full plugin ecosystem in the [IMG.LY plugins repository](https://github.com/imgly/plugins). Available plugins include:
|
|
764
|
+
|
|
765
|
+
- **Vectorizer** – Convert raster images to vectors
|
|
766
|
+
- **Design Presets** – Pre-built design templates
|
|
767
|
+
- **Social Media Templates** – Platform-specific sizing
|
|
768
|
+
- **And more** – Check the repository for the latest additions
|
|
769
|
+
|
|
770
|
+
---
|
|
771
|
+
|
|
772
|
+
## Key Capabilities
|
|
773
|
+
|
|
774
|
+
The Video Captions starter kit includes everything needed for professional video captioning.
|
|
775
|
+
|
|
776
|
+
<CapabilityGrid
|
|
777
|
+
features={[
|
|
778
|
+
{
|
|
779
|
+
title: 'AI Caption Generation',
|
|
780
|
+
description:
|
|
781
|
+
'Auto-generate accurate captions using ElevenLabs Scribe V2 speech-to-text technology.',
|
|
782
|
+
imageId: 'text-editing',
|
|
783
|
+
},
|
|
784
|
+
{
|
|
785
|
+
title: 'Caption Styling',
|
|
786
|
+
description:
|
|
787
|
+
'Customize fonts, colors, backgrounds, alignment, and positioning with professional presets.',
|
|
788
|
+
imageId: 'filters',
|
|
789
|
+
},
|
|
790
|
+
{
|
|
791
|
+
title: 'SRT Import/Export',
|
|
792
|
+
description:
|
|
793
|
+
'Import existing SRT subtitle files and export captions in standard subtitle formats.',
|
|
794
|
+
imageId: 'asset-libraries',
|
|
795
|
+
},
|
|
796
|
+
{
|
|
797
|
+
title: 'Timeline Control',
|
|
798
|
+
description:
|
|
799
|
+
'Precise timing controls for caption start time and duration with visual timeline feedback.',
|
|
800
|
+
imageId: 'transform',
|
|
801
|
+
},
|
|
802
|
+
{
|
|
803
|
+
title: 'Caption Inspector',
|
|
804
|
+
description:
|
|
805
|
+
'Dedicated inspector panel for editing caption text, timing, styling, and positioning.',
|
|
806
|
+
imageId: 'text-editing',
|
|
807
|
+
},
|
|
808
|
+
{
|
|
809
|
+
title: 'Video Export',
|
|
810
|
+
description:
|
|
811
|
+
'Export videos with embedded captions to MP4 format with customizable quality settings.',
|
|
812
|
+
imageId: 'client-side',
|
|
813
|
+
},
|
|
814
|
+
]}
|
|
815
|
+
/>
|
|
816
|
+
|
|
817
|
+
<br />
|
|
818
|
+
|
|
819
|
+
> **Free Trial:** [Sign up for a free trial](https://img.ly/forms/free-trial) to get a license key and remove the watermark.
|
|
820
|
+
|
|
821
|
+
---
|
|
822
|
+
|
|
823
|
+
## Troubleshooting
|
|
824
|
+
|
|
825
|
+
### Editor doesn't load
|
|
826
|
+
|
|
827
|
+
- **Check the container element exists**: Ensure your container element is in the DOM before calling `create()`
|
|
828
|
+
- **Verify the baseURL**: Assets must be accessible from the CDN or your self-hosted location
|
|
829
|
+
- **Check console errors**: Look for CORS or network errors in browser developer tools
|
|
830
|
+
|
|
831
|
+
### Autocaption doesn't work
|
|
832
|
+
|
|
833
|
+
- **Check fal.ai API key**: Verify your API key is configured correctly in the proxy URL
|
|
834
|
+
- **Verify proxy URL**: Ensure `VITE_AUTOCAPTION_PROXY_URL` points to a working proxy server
|
|
835
|
+
- **Check network requests**: Look for failed requests to the fal.ai API in DevTools Network tab
|
|
836
|
+
- **Video has no audio**: The autocaption feature requires audio to transcribe
|
|
837
|
+
|
|
838
|
+
### Caption Inspector doesn't open
|
|
839
|
+
|
|
840
|
+
- **Check video captions feature**: Ensure `features/videoCaptionsEnabled` is set to `true` in settings
|
|
841
|
+
- **Verify caption mode**: The inspector opens automatically in `autocaption` mode
|
|
842
|
+
- **Open manually**: Use `cesdk.ui.openPanel('//ly.img.panel/inspector/caption')` to open it programmatically
|
|
843
|
+
|
|
844
|
+
### SRT import fails
|
|
845
|
+
|
|
846
|
+
- **Check file format**: Ensure the SRT file follows standard subtitle formatting
|
|
847
|
+
- **Verify encoding**: SRT files should use UTF-8 encoding
|
|
848
|
+
- **Check timestamps**: Timestamps must be in the format `HH:MM:SS,mmm --> HH:MM:SS,mmm`
|
|
849
|
+
|
|
850
|
+
### Captions don't appear in export
|
|
851
|
+
|
|
852
|
+
- **Wait for caption rendering**: Ensure captions are visible in the editor before exporting
|
|
853
|
+
- **Check caption timing**: Verify caption start times and durations are correct
|
|
854
|
+
- **Export as MP4**: Captions are embedded in the video during MP4 export
|
|
855
|
+
|
|
856
|
+
### Video export takes too long
|
|
857
|
+
|
|
858
|
+
- **Reduce resolution**: Lower output resolution significantly improves encoding speed
|
|
859
|
+
- **Shorten clip length**: Longer videos take proportionally longer to encode
|
|
860
|
+
- **Check system resources**: Video encoding is CPU-intensive; close other applications
|
|
861
|
+
|
|
862
|
+
### Watermark appears in production
|
|
863
|
+
|
|
864
|
+
- **Add your license key**: Set the `license` property in your configuration
|
|
865
|
+
- **Sign up for a trial**: Get a free trial license at [img.ly/forms/free-trial](https://img.ly/forms/free-trial)
|
|
866
|
+
|
|
867
|
+
---
|
|
868
|
+
|
|
869
|
+
## Next Steps
|
|
870
|
+
|
|
871
|
+
- [Configuration](./configuration.md) – Complete list of initialization options
|
|
872
|
+
- [Serve Assets](./serve-assets.md) – Self-host engine assets for production
|
|
873
|
+
- [Actions](./actions.md) – Build custom export and save workflows
|
|
874
|
+
- [Theming](./user-interface/appearance/theming.md) – Customize colors and appearance
|
|
875
|
+
- [Localization](./user-interface/localization.md) – Add translations and language support
|
|
876
|
+
|
|
877
|
+
---
|
|
878
|
+
|
|
879
|
+
## More Resources
|
|
880
|
+
|
|
881
|
+
- **[Vanilla JS/TS Documentation Index](https://img.ly/docs/cesdk/js.md)** - Browse all Vanilla JS/TS documentation
|
|
882
|
+
- **[Complete Documentation](./llms-full.txt.md)** - Full documentation in one file (for LLMs)
|
|
883
|
+
- **[Web Documentation](./js.md)** - Interactive documentation with examples
|
|
884
|
+
- **[Support](mailto:support@img.ly)** - Contact IMG.LY support
|