Skip to content

πŸŽ₯ Make videos programmatically with React

@remotion/sdk: Rename authoring package and docs

JonnyBurgercc59a568ed7a
diff --git a/bun.lock b/bun.lock
index 085b40b37b..25c325b861 100644
--- a/bun.lock
+++ b/bun.lock
@@ -234,8 +234,8 @@
"react-dom": ">=16.8.0",
},
},
- "packages/canvas": {
- "name": "@remotion/canvas",
+ "packages/sdk": {
+ "name": "@remotion/sdk",
"version": "4.0.530",
"dependencies": {
"@remotion/player": "workspace:*",
@@ -585,7 +585,7 @@
"@remotion/browser-bundler": "workspace:*",
"@remotion/browser-studio": "workspace:*",
"@remotion/bundler": "workspace:*",
- "@remotion/canvas": "workspace:*",
+ "@remotion/sdk": "workspace:*",
"@remotion/captions": "workspace:*",
"@remotion/cli": "workspace:*",
"@remotion/cloudrun": "workspace:*",
@@ -1863,7 +1863,7 @@
"version": "4.0.530",
"dependencies": {
"@jridgewell/trace-mapping": "0.3.31",
- "@remotion/canvas": "workspace:*",
+ "@remotion/sdk": "workspace:*",
"@remotion/captions": "workspace:*",
"@remotion/codemods": "workspace:*",
"@remotion/elevenlabs": "workspace:*",
@@ -2651,7 +2651,7 @@
"@radix-ui/react-tabs": "1.1.13",
"@radix-ui/react-tooltip": "1.2.8",
"@remotion/browser-bundler": "workspace:*",
- "@remotion/canvas": "workspace:*",
+ "@remotion/sdk": "workspace:*",
"@remotion/cli": "workspace:*",
"@remotion/codemods": "workspace:*",
"@remotion/player": "workspace:*",
@@ -4547,7 +4547,7 @@
"@remotion/bundler": ["@remotion/bundler@workspace:packages/bundler"],
- "@remotion/canvas": ["@remotion/canvas@workspace:packages/canvas"],
+ "@remotion/sdk": ["@remotion/sdk@workspace:packages/sdk"],
"@remotion/canvas-capture-extension": ["@remotion/canvas-capture-extension@workspace:packages/canvas-capture-extension"],
@@ -10691,9 +10691,9 @@
"@remotion/bundler/react-dom": ["[email protected]", "", { "dependencies": { "scheduler": "^0.27.0" }, "peerDependencies": { "react": "^19.2.3" } }, "sha512-yELu4WmLPw5Mr/lmeEpox5rw3RETacE++JgHqQzd2dg+YbJuat3jH4ingc+WPZhxaoFzdv9y33G+F7Nl5O0GBg=="],
- "@remotion/canvas/react": ["[email protected]", "", {}, "sha512-Ku/hhYbVjOQnXDZFv2+RibmLFGwFdeeKHFcOTlrt7xplBnya5OGn/hIRDsqDiSUcfORsDC7MPxwork8jBwsIWA=="],
+ "@remotion/sdk/react": ["[email protected]", "", {}, "sha512-Ku/hhYbVjOQnXDZFv2+RibmLFGwFdeeKHFcOTlrt7xplBnya5OGn/hIRDsqDiSUcfORsDC7MPxwork8jBwsIWA=="],
- "@remotion/canvas/react-dom": ["[email protected]", "", { "dependencies": { "scheduler": "^0.27.0" }, "peerDependencies": { "react": "^19.2.3" } }, "sha512-yELu4WmLPw5Mr/lmeEpox5rw3RETacE++JgHqQzd2dg+YbJuat3jH4ingc+WPZhxaoFzdv9y33G+F7Nl5O0GBg=="],
+ "@remotion/sdk/react-dom": ["[email protected]", "", { "dependencies": { "scheduler": "^0.27.0" }, "peerDependencies": { "react": "^19.2.3" } }, "sha512-yELu4WmLPw5Mr/lmeEpox5rw3RETacE++JgHqQzd2dg+YbJuat3jH4ingc+WPZhxaoFzdv9y33G+F7Nl5O0GBg=="],
"@remotion/canvas-capture-extension/react": ["[email protected]", "", {}, "sha512-Ku/hhYbVjOQnXDZFv2+RibmLFGwFdeeKHFcOTlrt7xplBnya5OGn/hIRDsqDiSUcfORsDC7MPxwork8jBwsIWA=="],
diff --git a/packages/STATS.md b/packages/STATS.md
index 4740c52a0a..da046737d7 100644
--- a/packages/STATS.md
+++ b/packages/STATS.md
@@ -6,7 +6,6 @@ Monthly downloads of Remotion packages
[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/browser-bundler.svg?style=flat&color=black&label=@remotion/browser-bundler)](https://npmcharts.com/compare/@remotion/browser-bundler?minimal=true)
[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/browser-studio.svg?style=flat&color=black&label=@remotion/browser-studio)](https://npmcharts.com/compare/@remotion/browser-studio?minimal=true)
[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/bundler.svg?style=flat&color=black&label=@remotion/bundler)](https://npmcharts.com/compare/@remotion/bundler?minimal=true)
-[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/canvas.svg?style=flat&color=black&label=@remotion/canvas)](https://npmcharts.com/compare/@remotion/canvas?minimal=true)
[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/captions.svg?style=flat&color=black&label=@remotion/captions)](https://npmcharts.com/compare/@remotion/captions?minimal=true)
[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/cli.svg?style=flat&color=black&label=@remotion/cli)](https://npmcharts.com/compare/@remotion/cli?minimal=true)
[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/cloudrun.svg?style=flat&color=black&label=@remotion/cloudrun)](https://npmcharts.com/compare/@remotion/cloudrun?minimal=true)
@@ -56,6 +55,7 @@ Monthly downloads of Remotion packages
[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/rive.svg?style=flat&color=black&label=@remotion/rive)](https://npmcharts.com/compare/@remotion/rive?minimal=true)
[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/rough-notation.svg?style=flat&color=black&label=@remotion/rough-notation)](https://npmcharts.com/compare/@remotion/rough-notation?minimal=true)
[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/rounded-text-box.svg?style=flat&color=black&label=@remotion/rounded-text-box)](https://npmcharts.com/compare/@remotion/rounded-text-box?minimal=true)
+[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/sdk.svg?style=flat&color=black&label=@remotion/sdk)](https://npmcharts.com/compare/@remotion/sdk?minimal=true)<br />
[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/serverless.svg?style=flat&color=black&label=@remotion/serverless)](https://npmcharts.com/compare/@remotion/serverless?minimal=true)
[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/sfx.svg?style=flat&color=black&label=@remotion/sfx)](https://npmcharts.com/compare/@remotion/sfx?minimal=true)
[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/shapes.svg?style=flat&color=black&label=@remotion/shapes)](https://npmcharts.com/compare/@remotion/shapes?minimal=true)
diff --git a/packages/cli/src/list-of-remotion-packages.ts b/packages/cli/src/list-of-remotion-packages.ts
index c69dfbd697..a008618480 100644
--- a/packages/cli/src/list-of-remotion-packages.ts
+++ b/packages/cli/src/list-of-remotion-packages.ts
@@ -10,7 +10,7 @@ export const listOfRemotionPackages = [
'@remotion/bundler',
'@remotion/browser-bundler',
'@remotion/browser-studio',
- '@remotion/canvas',
+ '@remotion/sdk',
'@remotion/claude-code-plugin',
'@remotion/cli',
'@remotion/cloudrun',
diff --git a/packages/core/src/with-interactivity-schema.ts b/packages/core/src/with-interactivity-schema.ts
index fe959055f2..1cec2addef 100644
--- a/packages/core/src/with-interactivity-schema.ts
+++ b/packages/core/src/with-interactivity-schema.ts
@@ -183,7 +183,7 @@ export const DisableInteractivityProvider: React.FC<{
);
};
-// Authoring surfaces outside the Studio, such as @remotion/canvas, opt into
+// Authoring surfaces outside the Studio, such as @remotion/sdk, opt into
// populating `controls` and applying Visual Mode overrides.
const EnableInteractivityContext = createContext(false);
diff --git a/packages/create-video/src/list-of-remotion-packages.ts b/packages/create-video/src/list-of-remotion-packages.ts
index c69dfbd697..a008618480 100644
--- a/packages/create-video/src/list-of-remotion-packages.ts
+++ b/packages/create-video/src/list-of-remotion-packages.ts
@@ -10,7 +10,7 @@ export const listOfRemotionPackages = [
'@remotion/bundler',
'@remotion/browser-bundler',
'@remotion/browser-studio',
- '@remotion/canvas',
+ '@remotion/sdk',
'@remotion/claude-code-plugin',
'@remotion/cli',
'@remotion/cloudrun',
diff --git a/packages/docs/docs/browser-bundler/create-browser-bundle-runtime.mdx b/packages/docs/docs/browser-bundler/create-browser-bundle-runtime.mdx
index 3ddf1758e7..95d18467d7 100644
--- a/packages/docs/docs/browser-bundler/create-browser-bundle-runtime.mdx
+++ b/packages/docs/docs/browser-bundler/create-browser-bundle-runtime.mdx
@@ -73,7 +73,7 @@ Calling [`getBrowserComposition()`](/docs/browser-bundler/get-browser-compositio
## Source locations<AvailableFrom v="4.0.529" />
-Development bundles record the file, line and column of every JSX element. The runtime forwards this location to Remotion's built-in elements and to components wrapped with [`Interactive.withSchema()`](/docs/interactive-with-schema) when the bundle renders them. Rendering the composition with [`<Canvas>`](/docs/canvas/canvas) exposes the location of each mounted sequence through [`getCanvasSequenceSourceLocation()`](/docs/canvas/get-canvas-sequence-source-location), so an editor can map a track to its source node.
+Development bundles record the file, line and column of every JSX element. The runtime forwards this location to Remotion's built-in elements and to components wrapped with [`Interactive.withSchema()`](/docs/interactive-with-schema) when the bundle renders them. Rendering the composition with [`<Canvas>`](/docs/sdk/canvas) exposes the location of each mounted sequence through [`getCanvasSequenceSourceLocation()`](/docs/sdk/get-canvas-sequence-source-location), so an editor can map a track to its source node.
Only the bundle's own JSX carries locations. Elements created by dependencies resolved over HTTP do not, and their location is `null`. The host's React is not modified.
@@ -87,7 +87,7 @@ Accepts a complete [`BrowserBundle`](/docs/browser-bundler/create-browser-bundle
The first call evaluates the full bundle. Later calls apply Rspack's hot-update assets to the existing module graph and run React Fast Refresh. Compatible component edits preserve React state; changing hook signatures or component types can reset the affected component.
-Immediately before a Fast Refresh update is applied, the runtime dispatches a `remotion-react-refresh-started` event on `window`, and a `remotion-react-refresh-finished` event once React refreshed its roots<AvailableFrom v="4.0.530" inline />. A [`<Canvas>`](/docs/canvas/canvas) in the preview document uses the started event to commit [queued node-path remappings](/docs/canvas/create-canvas-controller#queuesequencenodepathremappings) in the same task as the refreshed tree.
+Immediately before a Fast Refresh update is applied, the runtime dispatches a `remotion-react-refresh-started` event on `window`, and a `remotion-react-refresh-finished` event once React refreshed its roots<AvailableFrom v="4.0.530" inline />. A [`<Canvas>`](/docs/sdk/canvas) in the preview document uses the started event to commit [queued node-path remappings](/docs/sdk/create-canvas-controller#queuesequencenodepathremappings) in the same task as the refreshed tree.
Calls are serialized. Apply every successfully compiled bundle in order, even when newer edits are pending. Skipping compiled updates breaks the hot-update chain and rejects the promise.
diff --git a/packages/docs/docs/codemods/index.mdx b/packages/docs/docs/codemods/index.mdx
index 48a5f6c04b..e8318fd5bf 100644
--- a/packages/docs/docs/codemods/index.mdx
+++ b/packages/docs/docs/codemods/index.mdx
@@ -127,7 +127,7 @@ Node and registration mutations return `nodePathRemappings`. Each entry contains
Use `insertedNode`, `insertedNodes`, or `updatedNode` when returned instead of trying to reconstruct a path. Adding hooks, duplicating elements, changing wrappers, or moving registrations can move other nodes as well. After manual source changes, discover nodes again.
-Editors that keep mounted sequences attached to their source nodes, such as [`<Canvas>`](/docs/canvas/canvas), accept these mappings through [`queueSequenceNodePathRemappings()`](/docs/canvas/create-canvas-controller#queuesequencenodepathremappings).
+Editors that keep mounted sequences attached to their source nodes, such as [`<Canvas>`](/docs/sdk/canvas), accept these mappings through [`queueSequenceNodePathRemappings()`](/docs/sdk/create-canvas-controller#queuesequencenodepathremappings).
## Effect references<AvailableFrom v="4.0.528" />
diff --git a/packages/docs/docs/canvas/canvas.mdx b/packages/docs/docs/sdk/canvas.mdx
similarity index 66%
rename from packages/docs/docs/canvas/canvas.mdx
rename to packages/docs/docs/sdk/canvas.mdx
index 4499b2c3c2..254335570e 100644
--- a/packages/docs/docs/canvas/canvas.mdx
+++ b/packages/docs/docs/sdk/canvas.mdx
@@ -1,15 +1,15 @@
---
-image: /generated/articles-docs-canvas-canvas.png
+image: /generated/articles-docs-sdk-canvas.png
title: '<Canvas>'
-slug: /canvas/canvas
-crumb: '@remotion/canvas'
+slug: /sdk/canvas
+crumb: '@remotion/sdk'
---
# &lt;Canvas&gt;<AvailableFrom v="4.0.527" />
Renders a Remotion composition using [`<Player>`](/docs/player/player), registers its timeline tracks, and optionally overlays selection outlines that can be dragged to move elements.
-Unlike a plain `<Player>`, the Canvas enables the interactivity of the mounted elements: each track exposes its [`controls`](/docs/canvas/create-canvas-controller#sequencecontrols) and the controller can [preview prop values](/docs/canvas/create-canvas-controller#overrides) without changing the source.
+Unlike a plain `<Player>`, the Canvas enables the interactivity of the mounted elements: each track exposes its [`controls`](/docs/sdk/create-canvas-controller#sequencecontrols) and the controller can [preview prop values](/docs/sdk/create-canvas-controller#overrides) without changing the source.
:::warning
@@ -18,7 +18,7 @@ _Experimental API_: This package is not stable. Its public API may change withou
:::
```tsx title="Preview.tsx"
-import {Canvas, useCanvasController} from '@remotion/canvas';
+import {Canvas, useCanvasController} from '@remotion/sdk';
import {Video} from './Video';
export const Preview = () => {
@@ -43,7 +43,7 @@ export const Preview = () => {
### controller
-A [`CanvasController`](/docs/canvas/create-canvas-controller) shared with your timeline and selection UI. Keep it stable while the Canvas is mounted.
+A [`CanvasController`](/docs/sdk/create-canvas-controller) shared with your timeline and selection UI. Keep it stable while the Canvas is mounted.
### showOutlines?
@@ -55,11 +55,11 @@ Clicking empty canvas space or pressing Escape while the overlay is focused clea
Enables moving elements on the canvas. Dragging a selected outline moves every selected element; the arrow keys nudge the selection by one pixel, ten with Shift, while the overlay is focused. Shift locks a drag to the dominant axis. The moved elements snap to the edges and the center of the composition, unless Command or Ctrl is held.
-While the gesture is in progress, the new `style.translate` values are previewed through [`controller.overrides`](/docs/canvas/create-canvas-controller#overrides). When the gesture ends with a changed value, the callback receives one `CanvasSequencePropChange` per moved source node with `nodePathInfo`, the schema `key`, the `value` and the element's `schema`. A change with `type: 'static'` also carries the schema `defaultValue`; write it with [`updateNodeProps()`](/docs/codemods/update-node-props). A change with `type: 'keyframe'` carries the `frame` at which to add a keyframe with [`updateNodeKeyframes()`](/docs/codemods/update-node-keyframes); it is reported for props that [`getSequencePropStatuses`](#getsequencepropstatuses) describes as keyframed. Clear the overrides once the update is applied; until then, the canvas keeps showing the new position.
+While the gesture is in progress, the new `style.translate` values are previewed through [`controller.overrides`](/docs/sdk/create-canvas-controller#overrides). When the gesture ends with a changed value, the callback receives one `CanvasSequencePropChange` per moved source node with `nodePathInfo`, the schema `key`, the `value` and the element's `schema`. A change with `type: 'static'` also carries the schema `defaultValue`; write it with [`updateNodeProps()`](/docs/codemods/update-node-props). A change with `type: 'keyframe'` carries the `frame` at which to add a keyframe with [`updateNodeKeyframes()`](/docs/codemods/update-node-keyframes); it is reported for props that [`getSequencePropStatuses`](#getsequencepropstatuses) describes as keyframed. Clear the overrides once the update is applied; until then, the canvas keeps showing the new position.
```tsx twoslash title="Persisting a move"
// @moduleResolution: bundler
-import type {CanvasController, CanvasSequencePropChange} from '@remotion/canvas';
+import type {CanvasController, CanvasSequencePropChange} from '@remotion/sdk';
declare const controller: CanvasController;
declare const persist: (change: CanvasSequencePropChange) => Promise<void>;
// ---cut---
@@ -71,7 +71,7 @@ export const onSequencePropsChange = async (changes: readonly CanvasSequenceProp
};
```
-Elements can be moved when they expose a `style.translate` field in their [`controls`](/docs/canvas/create-canvas-controller#sequencecontrols) and their source node is registered with [`setSequenceNodePaths()`](/docs/canvas/create-canvas-controller#setsequencenodepaths). Without the callback, outlines can be selected but not moved.
+Elements can be moved when they expose a `style.translate` field in their [`controls`](/docs/sdk/create-canvas-controller#sequencecontrols) and their source node is registered with [`setSequenceNodePaths()`](/docs/sdk/create-canvas-controller#setsequencenodepaths). Without the callback, outlines can be selected but not moved.
### getSequencePropStatuses?<AvailableFrom v="4.0.530" />
@@ -83,7 +83,7 @@ By default, the source is unknown: every prop starts from the runtime value of t
```tsx twoslash title="Reading the source"
// @moduleResolution: bundler
-import type {CanvasSequencePropStatusResolver} from '@remotion/canvas';
+import type {CanvasSequencePropStatusResolver} from '@remotion/sdk';
import {getNodeProps, type CodemodProject} from '@remotion/codemods';
declare const project: CodemodProject;
// ---cut---
@@ -99,7 +99,7 @@ export const getSequencePropStatuses: CanvasSequencePropStatusResolver = (nodePa
### resolveSequenceNodePathInfo?
-A `CanvasSequenceNodePathResolver` called with a [`TimelineTrackData`](/docs/canvas/create-canvas-controller#timeline) and its index. It returns a `SequenceNodePathInfo` identity or `null` to make the track unselectable. The default is [`getCanvasSequenceNodePathInfo()`](/docs/canvas/get-canvas-sequence-node-path-info), which uses the identities registered with [`setSequenceNodePaths()`](/docs/canvas/create-canvas-controller#setsequencenodepaths).
+A `CanvasSequenceNodePathResolver` called with a [`TimelineTrackData`](/docs/sdk/create-canvas-controller#timeline) and its index. It returns a `SequenceNodePathInfo` identity or `null` to make the track unselectable. The default is [`getCanvasSequenceNodePathInfo()`](/docs/sdk/get-canvas-sequence-node-path-info), which uses the identities registered with [`setSequenceNodePaths()`](/docs/sdk/create-canvas-controller#setsequencenodepaths).
Use the same resolver when constructing selection items for the layer list. Keep its function identity stable where possible, for example with `useCallback()`.
@@ -109,6 +109,6 @@ Use the same resolver when constructing selection items for the layer list. Keep
## See also
-- [Canvas overview and layer list example](/docs/canvas)
-- [`useCanvasController()`](/docs/canvas/use-canvas-controller)
-- [`useCanvasSelection()`](/docs/canvas/use-canvas-selection)
+- [Canvas overview and layer list example](/docs/sdk)
+- [`useCanvasController()`](/docs/sdk/use-canvas-controller)
+- [`useCanvasSelection()`](/docs/sdk/use-canvas-selection)
diff --git a/packages/docs/docs/canvas/create-canvas-controller.mdx b/packages/docs/docs/sdk/create-canvas-controller.mdx
similarity index 81%
rename from packages/docs/docs/canvas/create-canvas-controller.mdx
rename to packages/docs/docs/sdk/create-canvas-controller.mdx
index 0d542f5f5d..7168c10548 100644
--- a/packages/docs/docs/canvas/create-canvas-controller.mdx
+++ b/packages/docs/docs/sdk/create-canvas-controller.mdx
@@ -1,12 +1,12 @@
---
-image: /generated/articles-docs-canvas-create-canvas-controller.png
+image: /generated/articles-docs-sdk-create-canvas-controller.png
title: createCanvasController()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# createCanvasController()<AvailableFrom v="4.0.527" />
-Creates a `CanvasController` to share between [`<Canvas>`](/docs/canvas/canvas) and your editor UI. In React components, [`useCanvasController()`](/docs/canvas/use-canvas-controller) keeps one controller across renders.
+Creates a `CanvasController` to share between [`<Canvas>`](/docs/sdk/canvas) and your editor UI. In React components, [`useCanvasController()`](/docs/sdk/use-canvas-controller) keeps one controller across renders.
:::warning
@@ -15,7 +15,7 @@ _Experimental API_: This package is not stable. Its public API may change withou
:::
```ts title="controller.ts"
-import {createCanvasController} from '@remotion/canvas';
+import {createCanvasController} from '@remotion/sdk';
export const controller = createCanvasController();
```
@@ -26,7 +26,7 @@ The function takes no arguments.
### timeline
-An external store of `readonly TimelineTrackData[]`. Subscribe with `timeline.subscribe(listener)` and read with `timeline.getSnapshot()`. In React, pass both to `useSyncExternalStore()` as shown in the [overview](/docs/canvas#basic-example). Tracks are populated while the composition is mounted and cleared when `<Canvas>` unmounts.
+An external store of `readonly TimelineTrackData[]`. Subscribe with `timeline.subscribe(listener)` and read with `timeline.getSnapshot()`. In React, pass both to `useSyncExternalStore()` as shown in the [overview](/docs/sdk#basic-example). Tracks are populated while the composition is mounted and cleared when `<Canvas>` unmounts.
Each track includes `sequence` registration data, `depth`, `nodePathInfo`, and timing fields such as `cascadedStart`, `localStart`, `keyframeDisplayOffset`, `keyframePlaybackRate`, and `sequenceFrameOffset`. The sequence's `from` and `duration` are its visible timeline range. `nodePathInfo` is `null` until a source identity is registered with [`setSequenceNodePaths()`](#setsequencenodepaths).
@@ -38,7 +38,7 @@ The interactivity data of the mounted element, or `null` for elements that do no
### selection
-A `CanvasSelectionController` with `getSnapshot()` and `subscribe(listener)` for reading selection. Use [`useCanvasSelection()`](/docs/canvas/use-canvas-selection) in React.
+A `CanvasSelectionController` with `getSnapshot()` and `subscribe(listener)` for reading selection. Use [`useCanvasSelection()`](/docs/sdk/use-canvas-selection) in React.
#### select()
@@ -58,15 +58,15 @@ A `CanvasSelectionController` with `getSnapshot()` and `subscribe(listener)` for
### hover
-A `CanvasHoverController` with `getSnapshot()`, `subscribe(listener)`, `setHoveredSequence(valueOrUpdater)`, and `clear(source)`. Use [`useCanvasSequenceHover()`](/docs/canvas/use-canvas-sequence-hover) for a layer row or [`useCanvasHover()`](/docs/canvas/use-canvas-hover) to read the current hover. `clear('canvas')` or `clear('timeline')` only clears hover from that source; `clear(null)` clears either source.
+A `CanvasHoverController` with `getSnapshot()`, `subscribe(listener)`, `setHoveredSequence(valueOrUpdater)`, and `clear(source)`. Use [`useCanvasSequenceHover()`](/docs/sdk/use-canvas-sequence-hover) for a layer row or [`useCanvasHover()`](/docs/sdk/use-canvas-hover) to read the current hover. `clear('canvas')` or `clear('timeline')` only clears hover from that source; `clear(null)` clears either source.
### setSequenceNodePaths()<AvailableFrom v="4.0.529" />
`setSequenceNodePaths(nodePaths)` tells the Canvas which source node each mounted sequence was created from. `nodePaths` is a `Record<string, SequencePropsSubscriptionKey>` keyed by `track.sequence.controls.overrideId`. Import the `SequencePropsSubscriptionKey` type from `remotion`; its `absolutePath` and `nodePath` identify the JSX node, as returned by [`getNodes()`](/docs/codemods/get-nodes). Pass empty arrays for `sequenceKeys` and `effectKeys`, and `track.sequence.controls.videoConfigValues` or `null` for `videoConfigValues`.
-Afterwards, the affected tracks carry a `nodePathInfo` with that `sequenceSubscriptionKey`. Tracks rendered from the same source node are numbered through `index` and `numberOfSequencesWithThisNodePath`. [`getCanvasSequenceNodePathInfo()`](/docs/canvas/get-canvas-sequence-node-path-info) returns the registered identity, so selection and hover stay attached to the source node across remounts.
+Afterwards, the affected tracks carry a `nodePathInfo` with that `sequenceSubscriptionKey`. Tracks rendered from the same source node are numbered through `index` and `numberOfSequencesWithThisNodePath`. [`getCanvasSequenceNodePathInfo()`](/docs/sdk/get-canvas-sequence-node-path-info) returns the registered identity, so selection and hover stay attached to the source node across remounts.
-Passing an unchanged mapping is a no-op, so the function may be called from a `timeline` subscription. Call it again after the source changed. [`getCanvasSequenceSourceLocation()`](/docs/canvas/get-canvas-sequence-source-location) shows how to derive the mapping from the compiled source locations.
+Passing an unchanged mapping is a no-op, so the function may be called from a `timeline` subscription. Call it again after the source changed. [`getCanvasSequenceSourceLocation()`](/docs/sdk/get-canvas-sequence-source-location) shows how to derive the mapping from the compiled source locations.
### queueSequenceNodePathRemappings()<AvailableFrom v="4.0.530" />
@@ -76,7 +76,7 @@ Queue the remappings when you apply the edit to your project. The Canvas commits
```tsx twoslash title="Applying an edit"
// @moduleResolution: bundler
-import type {CanvasController} from '@remotion/canvas';
+import type {CanvasController} from '@remotion/sdk';
import {
applyCodemodChanges,
deleteNodes,
@@ -105,7 +105,7 @@ Selected items whose node was removed leave the selection, other selected items
Preview prop values on mounted sequences without changing the source. Overrides are applied to sequences that have a `nodePathInfo`, so register node paths first. They are kept while the composition stays mounted and are not persisted; write the final value to the source, for example with [`updateNodeProps()`](/docs/codemods/update-node-props), and clear the override once the update has been applied.
-The Canvas sets overrides itself while an outline is being [moved](/docs/canvas/canvas#onsequencepropschange), and [`startCanvasKeyframeDrag()`](/docs/canvas/start-canvas-keyframe-drag) sets them while keyframes are dragged. Both leave them in place for you to clear after persisting. [`getCanvasKeyframeChangeOverride()`](/docs/canvas/get-canvas-keyframe-change-override) computes the value that previews any other keyframe change, such as a new easing.
+The Canvas sets overrides itself while an outline is being [moved](/docs/sdk/canvas#onsequencepropschange), and [`startCanvasKeyframeDrag()`](/docs/sdk/start-canvas-keyframe-drag) sets them while keyframes are dragged. Both leave them in place for you to clear after persisting. [`getCanvasKeyframeChangeOverride()`](/docs/sdk/get-canvas-keyframe-change-override) computes the value that previews any other keyframe change, such as a new easing.
#### set()
@@ -115,7 +115,7 @@ The Canvas sets overrides itself while an outline is being [moved](/docs/canvas/
```tsx twoslash title="Scrubbing a value"
// @moduleResolution: bundler
-import type {CanvasController, SequenceNodePathInfo} from '@remotion/canvas';
+import type {CanvasController, SequenceNodePathInfo} from '@remotion/sdk';
declare const controller: CanvasController;
declare const nodePathInfo: SequenceNodePathInfo;
declare const persist: (value: number) => Promise<void>;
@@ -145,7 +145,7 @@ The `runtimeValues` of the track keep reporting the values from the source while
## See also
-- [`<Canvas>`](/docs/canvas/canvas)
-- [`useCanvasController()`](/docs/canvas/use-canvas-controller)
-- [`useCanvasSelection()`](/docs/canvas/use-canvas-selection)
-- [`getCanvasSequenceSourceLocation()`](/docs/canvas/get-canvas-sequence-source-location)
+- [`<Canvas>`](/docs/sdk/canvas)
+- [`useCanvasController()`](/docs/sdk/use-canvas-controller)
+- [`useCanvasSelection()`](/docs/sdk/use-canvas-selection)
+- [`getCanvasSequenceSourceLocation()`](/docs/sdk/get-canvas-sequence-source-location)
diff --git a/packages/docs/docs/canvas/create-canvas-hover-controller.mdx b/packages/docs/docs/sdk/create-canvas-hover-controller.mdx
similarity index 68%
rename from packages/docs/docs/canvas/create-canvas-hover-controller.mdx
rename to packages/docs/docs/sdk/create-canvas-hover-controller.mdx
index 6976de684c..1c5c4725e2 100644
--- a/packages/docs/docs/canvas/create-canvas-hover-controller.mdx
+++ b/packages/docs/docs/sdk/create-canvas-hover-controller.mdx
@@ -1,12 +1,12 @@
---
-image: /generated/articles-docs-canvas-create-canvas-hover-controller.png
+image: /generated/articles-docs-sdk-create-canvas-hover-controller.png
title: createCanvasHoverController()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# createCanvasHoverController()<AvailableFrom v="4.0.527" />
-Creates a standalone `CanvasHoverController`. [`createCanvasController()`](/docs/canvas/create-canvas-controller) already creates one at `controller.hover`; use this function when hover has a separate lifetime.
+Creates a standalone `CanvasHoverController`. [`createCanvasController()`](/docs/sdk/create-canvas-controller) already creates one at `controller.hover`; use this function when hover has a separate lifetime.
:::warning
@@ -15,13 +15,13 @@ _Experimental API_: This package is not stable. Its public API may change withou
:::
```ts title="hover.ts"
-import {createCanvasHoverController} from '@remotion/canvas';
+import {createCanvasHoverController} from '@remotion/sdk';
export const hover = createCanvasHoverController();
hover.clear(null);
```
-The function takes no arguments. The initial snapshot is `null`. Read and subscribe with [`useCanvasHover()`](/docs/canvas/use-canvas-hover), or use `getSnapshot()` and `subscribe(listener)` outside React.
+The function takes no arguments. The initial snapshot is `null`. Read and subscribe with [`useCanvasHover()`](/docs/sdk/use-canvas-hover), or use `getSnapshot()` and `subscribe(listener)` outside React.
## Methods
@@ -47,5 +47,5 @@ Returns the current `CanvasHover` or `null`.
## See also
-- [`useCanvasHover()`](/docs/canvas/use-canvas-hover)
-- [`useCanvasSequenceHover()`](/docs/canvas/use-canvas-sequence-hover)
+- [`useCanvasHover()`](/docs/sdk/use-canvas-hover)
+- [`useCanvasSequenceHover()`](/docs/sdk/use-canvas-sequence-hover)
diff --git a/packages/docs/docs/canvas/create-canvas-selection-controller.mdx b/packages/docs/docs/sdk/create-canvas-selection-controller.mdx
similarity index 73%
rename from packages/docs/docs/canvas/create-canvas-selection-controller.mdx
rename to packages/docs/docs/sdk/create-canvas-selection-controller.mdx
index 92df2f6e63..9d372793b8 100644
--- a/packages/docs/docs/canvas/create-canvas-selection-controller.mdx
+++ b/packages/docs/docs/sdk/create-canvas-selection-controller.mdx
@@ -1,12 +1,12 @@
---
-image: /generated/articles-docs-canvas-create-canvas-selection-controller.png
+image: /generated/articles-docs-sdk-create-canvas-selection-controller.png
title: createCanvasSelectionController()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# createCanvasSelectionController()<AvailableFrom v="4.0.527" />
-Creates a standalone `CanvasSelectionController`. [`createCanvasController()`](/docs/canvas/create-canvas-controller) already creates one at `controller.selection`; use this function when selection has a separate lifetime.
+Creates a standalone `CanvasSelectionController`. [`createCanvasController()`](/docs/sdk/create-canvas-controller) already creates one at `controller.selection`; use this function when selection has a separate lifetime.
:::warning
@@ -15,13 +15,13 @@ _Experimental API_: This package is not stable. Its public API may change withou
:::
```ts title="selection.ts"
-import {createCanvasSelectionController} from '@remotion/canvas';
+import {createCanvasSelectionController} from '@remotion/sdk';
export const selection = createCanvasSelectionController();
selection.setSelectedItems([]);
```
-The function takes no arguments. The initial snapshot is `{selectedItems: [], anchor: null}`. Read and subscribe to it with [`useCanvasSelection()`](/docs/canvas/use-canvas-selection), or use `getSnapshot()` and `subscribe(listener)` outside React.
+The function takes no arguments. The initial snapshot is `{selectedItems: [], anchor: null}`. Read and subscribe to it with [`useCanvasSelection()`](/docs/sdk/use-canvas-selection), or use `getSnapshot()` and `subscribe(listener)` outside React.
## Methods
@@ -55,5 +55,5 @@ Returns the current `CanvasSelectionSnapshot`.
## See also
-- [`useCanvasSelection()`](/docs/canvas/use-canvas-selection)
-- [`createCanvasController()`](/docs/canvas/create-canvas-controller)
+- [`useCanvasSelection()`](/docs/sdk/use-canvas-selection)
+- [`createCanvasController()`](/docs/sdk/create-canvas-controller)
diff --git a/packages/docs/docs/canvas/get-canvas-keyframe-change-override.mdx b/packages/docs/docs/sdk/get-canvas-keyframe-change-override.mdx
similarity index 67%
rename from packages/docs/docs/canvas/get-canvas-keyframe-change-override.mdx
rename to packages/docs/docs/sdk/get-canvas-keyframe-change-override.mdx
index f0dab61498..dfd86fd04a 100644
--- a/packages/docs/docs/canvas/get-canvas-keyframe-change-override.mdx
+++ b/packages/docs/docs/sdk/get-canvas-keyframe-change-override.mdx
@@ -1,12 +1,12 @@
---
-image: /generated/articles-docs-canvas-get-canvas-keyframe-change-override.png
+image: /generated/articles-docs-sdk-get-canvas-keyframe-change-override.png
title: getCanvasKeyframeChangeOverride()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# getCanvasKeyframeChangeOverride()<AvailableFrom v="4.0.530" />
-Shows a keyframe change on the canvas before the source is updated. It returns how the prop is written after the change, as a value for [`controller.overrides`](/docs/canvas/create-canvas-controller#overrides). Use it to preview an easing while its curve is being dragged, or to apply a preset without waiting for the bundler.
+Shows a keyframe change on the canvas before the source is updated. It returns how the prop is written after the change, as a value for [`controller.overrides`](/docs/sdk/create-canvas-controller#overrides). Use it to preview an easing while its curve is being dragged, or to apply a preset without waiting for the bundler.
:::warning
@@ -20,7 +20,7 @@ import {
getCanvasKeyframeChangeOverride,
type CanvasController,
type CanvasKeyframeChange,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
import type {CanUpdateSequencePropStatus} from 'remotion';
declare const controller: CanvasController;
declare const propStatus: CanUpdateSequencePropStatus;
@@ -37,7 +37,7 @@ export const applyChange = async (change: CanvasKeyframeChange) => {
};
```
-Clear the override once the composition renders the updated source. Until then, the canvas shows the change even though the source has not caught up, like after [`startCanvasKeyframeDrag()`](/docs/canvas/start-canvas-keyframe-drag).
+Clear the override once the composition renders the updated source. Until then, the canvas shows the change even though the source has not caught up, like after [`startCanvasKeyframeDrag()`](/docs/sdk/start-canvas-keyframe-drag).
## Parameters
@@ -49,7 +49,7 @@ How the prop is written in the source before the change, as the `props` of [`get
### change
-The `CanvasKeyframeChange` to preview, from [`getCanvasKeyframeEasingChange()`](/docs/canvas/get-canvas-keyframe-easing-change), [`getCanvasKeyframeSettingsChange()`](/docs/canvas/get-canvas-keyframe-settings-change), [`getCanvasKeyframeToggle()`](/docs/canvas/get-canvas-keyframe-toggle) or [`startCanvasKeyframeDrag()`](/docs/canvas/start-canvas-keyframe-drag). Every operation is supported: `add`, `remove`, `move`, `easing` and `settings`.
+The `CanvasKeyframeChange` to preview, from [`getCanvasKeyframeEasingChange()`](/docs/sdk/get-canvas-keyframe-easing-change), [`getCanvasKeyframeSettingsChange()`](/docs/sdk/get-canvas-keyframe-settings-change), [`getCanvasKeyframeToggle()`](/docs/sdk/get-canvas-keyframe-toggle) or [`startCanvasKeyframeDrag()`](/docs/sdk/start-canvas-keyframe-drag). Every operation is supported: `add`, `remove`, `move`, `easing` and `settings`.
## Return value
@@ -61,6 +61,6 @@ A `DragOverrideValue`: `{type: 'keyframed', status}` with the keyframed status a
## See also
-- [`controller.overrides`](/docs/canvas/create-canvas-controller#overrides)
-- [`getCanvasKeyframeEasingChange()`](/docs/canvas/get-canvas-keyframe-easing-change)
-- [`getCanvasKeyframeSettingsChange()`](/docs/canvas/get-canvas-keyframe-settings-change)
+- [`controller.overrides`](/docs/sdk/create-canvas-controller#overrides)
+- [`getCanvasKeyframeEasingChange()`](/docs/sdk/get-canvas-keyframe-easing-change)
+- [`getCanvasKeyframeSettingsChange()`](/docs/sdk/get-canvas-keyframe-settings-change)
diff --git a/packages/docs/docs/canvas/get-canvas-keyframe-display-frame.mdx b/packages/docs/docs/sdk/get-canvas-keyframe-display-frame.mdx
similarity index 77%
rename from packages/docs/docs/canvas/get-canvas-keyframe-display-frame.mdx
rename to packages/docs/docs/sdk/get-canvas-keyframe-display-frame.mdx
index 9604ab5236..c93df48630 100644
--- a/packages/docs/docs/canvas/get-canvas-keyframe-display-frame.mdx
+++ b/packages/docs/docs/sdk/get-canvas-keyframe-display-frame.mdx
@@ -1,12 +1,12 @@
---
-image: /generated/articles-docs-canvas-get-canvas-keyframe-display-frame.png
+image: /generated/articles-docs-sdk-get-canvas-keyframe-display-frame.png
title: getCanvasKeyframeDisplayFrame()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# getCanvasKeyframeDisplayFrame()<AvailableFrom v="4.0.530" />
-Converts a frame of a prop's `interpolate()` expression to a composition frame. It is the inverse of [`getCanvasKeyframeSourceFrame()`](/docs/canvas/get-canvas-keyframe-source-frame).
+Converts a frame of a prop's `interpolate()` expression to a composition frame. It is the inverse of [`getCanvasKeyframeSourceFrame()`](/docs/sdk/get-canvas-keyframe-source-frame).
:::warning
@@ -16,7 +16,7 @@ _Experimental API_: This package is not stable. Its public API may change withou
```ts twoslash title="seek-to-keyframe.ts"
// @moduleResolution: bundler
-import {getCanvasKeyframeDisplayFrame, type TimelineTrackData} from '@remotion/canvas';
+import {getCanvasKeyframeDisplayFrame, type TimelineTrackData} from '@remotion/sdk';
import type {CanUpdateSequencePropStatus} from 'remotion';
declare const track: TimelineTrackData;
declare const propStatus: CanUpdateSequencePropStatus;
@@ -33,7 +33,7 @@ An object with the following properties:
### track
-The `TimelineTrackData` of the sequence from [`controller.timeline`](/docs/canvas/create-canvas-controller#timeline). Only `keyframeDisplayOffset` and `keyframePlaybackRate` are read.
+The `TimelineTrackData` of the sequence from [`controller.timeline`](/docs/sdk/create-canvas-controller#timeline). Only `keyframeDisplayOffset` and `keyframePlaybackRate` are read.
### propStatus
@@ -53,5 +53,5 @@ The composition frame at which the keyframe applies. It may be fractional when t
## See also
-- [`getCanvasKeyframeSourceFrame()`](/docs/canvas/get-canvas-keyframe-source-frame)
-- [`getCanvasKeyframes()`](/docs/canvas/get-canvas-keyframes)
+- [`getCanvasKeyframeSourceFrame()`](/docs/sdk/get-canvas-keyframe-source-frame)
+- [`getCanvasKeyframes()`](/docs/sdk/get-canvas-keyframes)
diff --git a/packages/docs/docs/canvas/get-canvas-keyframe-easing-change.mdx b/packages/docs/docs/sdk/get-canvas-keyframe-easing-change.mdx
similarity index 83%
rename from packages/docs/docs/canvas/get-canvas-keyframe-easing-change.mdx
rename to packages/docs/docs/sdk/get-canvas-keyframe-easing-change.mdx
index e3ca556fe3..763f31f27c 100644
--- a/packages/docs/docs/canvas/get-canvas-keyframe-easing-change.mdx
+++ b/packages/docs/docs/sdk/get-canvas-keyframe-easing-change.mdx
@@ -1,7 +1,7 @@
---
-image: /generated/articles-docs-canvas-get-canvas-keyframe-easing-change.png
+image: /generated/articles-docs-sdk-get-canvas-keyframe-easing-change.png
title: getCanvasKeyframeEasingChange()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# getCanvasKeyframeEasingChange()<AvailableFrom v="4.0.530" />
@@ -21,7 +21,7 @@ import {
getCanvasKeyframeEasingChange,
type CanvasKeyframeChange,
type SequenceNodePathInfo,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
import type {CanUpdateSequencePropStatus, InteractivitySchema} from 'remotion';
declare const nodePathInfo: SequenceNodePathInfo;
declare const schema: InteractivitySchema;
@@ -67,7 +67,7 @@ The `SequenceNodePathInfo` of the sequence, from a track or a selection item. It
### schema
-The interactivity schema of the element, from [`track.sequence.controls`](/docs/canvas/create-canvas-controller#sequencecontrols).
+The interactivity schema of the element, from [`track.sequence.controls`](/docs/sdk/create-canvas-controller#sequencecontrols).
### key
@@ -79,7 +79,7 @@ How the prop is written in the source, as the `props` of [`getNodeProps()`](/doc
### segmentIndex
-The segment to change, as reported by [`getCanvasKeyframeEasingSegments()`](/docs/canvas/get-canvas-keyframe-easing-segments).
+The segment to change, as reported by [`getCanvasKeyframeEasingSegments()`](/docs/sdk/get-canvas-keyframe-easing-segments).
### easing
@@ -87,9 +87,9 @@ The new `CanvasKeyframeEasing`: `{type: 'linear'}`, `{type: 'step1'}` for a hold
## Return value
-A `CanvasKeyframeChange` whose `operation` is `{type: 'easing', segmentIndex, easing}`, or `null` when the prop is not keyframed, its easing cannot be edited or the segment does not exist. Persist it with [`updateNodeKeyframes()`](/docs/codemods/update-node-keyframes) like the changes of [`getCanvasKeyframeToggle()`](/docs/canvas/get-canvas-keyframe-toggle#change).
+A `CanvasKeyframeChange` whose `operation` is `{type: 'easing', segmentIndex, easing}`, or `null` when the prop is not keyframed, its easing cannot be edited or the segment does not exist. Persist it with [`updateNodeKeyframes()`](/docs/codemods/update-node-keyframes) like the changes of [`getCanvasKeyframeToggle()`](/docs/sdk/get-canvas-keyframe-toggle#change).
-To show the easing on the canvas before the source is updated, for example while a bezier handle is being dragged, pass the change to [`getCanvasKeyframeChangeOverride()`](/docs/canvas/get-canvas-keyframe-change-override).
+To show the easing on the canvas before the source is updated, for example while a bezier handle is being dragged, pass the change to [`getCanvasKeyframeChangeOverride()`](/docs/sdk/get-canvas-keyframe-change-override).
## Presets
@@ -101,7 +101,7 @@ To show the easing on the canvas before the source is updated, for example while
## See also
-- [`getCanvasKeyframeEasingSegments()`](/docs/canvas/get-canvas-keyframe-easing-segments)
-- [`getCanvasKeyframeChangeOverride()`](/docs/canvas/get-canvas-keyframe-change-override)
-- [`getCanvasKeyframeSettingsChange()`](/docs/canvas/get-canvas-keyframe-settings-change)
+- [`getCanvasKeyframeEasingSegments()`](/docs/sdk/get-canvas-keyframe-easing-segments)
+- [`getCanvasKeyframeChangeOverride()`](/docs/sdk/get-canvas-keyframe-change-override)
+- [`getCanvasKeyframeSettingsChange()`](/docs/sdk/get-canvas-keyframe-settings-change)
- [`updateNodeKeyframes()`](/docs/codemods/update-node-keyframes)
diff --git a/packages/docs/docs/canvas/get-canvas-keyframe-easing-segments.mdx b/packages/docs/docs/sdk/get-canvas-keyframe-easing-segments.mdx
similarity index 81%
rename from packages/docs/docs/canvas/get-canvas-keyframe-easing-segments.mdx
rename to packages/docs/docs/sdk/get-canvas-keyframe-easing-segments.mdx
index 9d72b5ce08..628c26fa8c 100644
--- a/packages/docs/docs/canvas/get-canvas-keyframe-easing-segments.mdx
+++ b/packages/docs/docs/sdk/get-canvas-keyframe-easing-segments.mdx
@@ -1,7 +1,7 @@
---
-image: /generated/articles-docs-canvas-get-canvas-keyframe-easing-segments.png
+image: /generated/articles-docs-sdk-get-canvas-keyframe-easing-segments.png
title: getCanvasKeyframeEasingSegments()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# getCanvasKeyframeEasingSegments()<AvailableFrom v="4.0.530" />
@@ -20,7 +20,7 @@ import {
getCanvasKeyframeEasingSegments,
type CanvasKeyframeEasingSegment,
type TimelineTrackData,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
import type {CanUpdateSequencePropStatus, InteractivitySchema} from 'remotion';
declare const track: TimelineTrackData;
declare const schema: InteractivitySchema;
@@ -62,11 +62,11 @@ An object with the following properties:
### track
-The `TimelineTrackData` of the sequence from [`controller.timeline`](/docs/canvas/create-canvas-controller#timeline). Its `keyframeDisplayOffset` and `keyframePlaybackRate` place the segments on the composition timeline.
+The `TimelineTrackData` of the sequence from [`controller.timeline`](/docs/sdk/create-canvas-controller#timeline). Its `keyframeDisplayOffset` and `keyframePlaybackRate` place the segments on the composition timeline.
### schema
-The interactivity schema of the element, from [`track.sequence.controls`](/docs/canvas/create-canvas-controller#sequencecontrols). It decides whether the field holds its value between keyframes.
+The interactivity schema of the element, from [`track.sequence.controls`](/docs/sdk/create-canvas-controller#sequencecontrols). It decides whether the field holds its value between keyframes.
### key
@@ -82,11 +82,11 @@ An array of `CanvasKeyframeEasingSegment` objects, ordered like the keyframes.
### segmentIndex
-Indexes the easing of the prop; the segment after the first keyframe has index `0`. Pass it to [`getCanvasKeyframeEasingChange()`](/docs/canvas/get-canvas-keyframe-easing-change) and use it in an `easing` selection item.
+Indexes the easing of the prop; the segment after the first keyframe has index `0`. Pass it to [`getCanvasKeyframeEasingChange()`](/docs/sdk/get-canvas-keyframe-easing-change) and use it in an `easing` selection item.
### fromFrame
-The composition frame of the keyframe that starts the segment, as [`getCanvasKeyframes()`](/docs/canvas/get-canvas-keyframes) reports it.
+The composition frame of the keyframe that starts the segment, as [`getCanvasKeyframes()`](/docs/sdk/get-canvas-keyframes) reports it.
### toFrame
@@ -102,6 +102,6 @@ The current `CanvasKeyframeEasing` of the segment: `{type: 'linear'}`, `{type: '
## See also
-- [`getCanvasKeyframeEasingChange()`](/docs/canvas/get-canvas-keyframe-easing-change)
-- [`getCanvasKeyframes()`](/docs/canvas/get-canvas-keyframes)
+- [`getCanvasKeyframeEasingChange()`](/docs/sdk/get-canvas-keyframe-easing-change)
+- [`getCanvasKeyframes()`](/docs/sdk/get-canvas-keyframes)
- [`Easing`](/docs/easing)
diff --git a/packages/docs/docs/canvas/get-canvas-keyframe-settings-change.mdx b/packages/docs/docs/sdk/get-canvas-keyframe-settings-change.mdx
similarity index 73%
rename from packages/docs/docs/canvas/get-canvas-keyframe-settings-change.mdx
rename to packages/docs/docs/sdk/get-canvas-keyframe-settings-change.mdx
index ee9228128c..90b7a3d74b 100644
--- a/packages/docs/docs/canvas/get-canvas-keyframe-settings-change.mdx
+++ b/packages/docs/docs/sdk/get-canvas-keyframe-settings-change.mdx
@@ -1,7 +1,7 @@
---
-image: /generated/articles-docs-canvas-get-canvas-keyframe-settings-change.png
+image: /generated/articles-docs-sdk-get-canvas-keyframe-settings-change.png
title: getCanvasKeyframeSettingsChange()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# getCanvasKeyframeSettingsChange()<AvailableFrom v="4.0.530" />
@@ -21,7 +21,7 @@ import {
getCanvasKeyframeSettingsChange,
type CanvasKeyframeChange,
type SequenceNodePathInfo,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
import type {
CanUpdateSequencePropStatusKeyframed,
InteractivitySchema,
@@ -65,7 +65,7 @@ The `SequenceNodePathInfo` of the sequence, from a track or a selection item. It
### schema
-The interactivity schema of the element, from [`track.sequence.controls`](/docs/canvas/create-canvas-controller#sequencecontrols).
+The interactivity schema of the element, from [`track.sequence.controls`](/docs/sdk/create-canvas-controller#sequencecontrols).
### key
@@ -77,11 +77,11 @@ The `'keyframed'` prop status of the prop, as the `props` of [`getNodeProps()`](
### settings
-The `CanvasKeyframeSettings` to write. Take the object returned by [`getCanvasKeyframeSettings()`](/docs/canvas/get-canvas-keyframe-settings) and replace the values that changed. Options the interpolation function does not have are left as they are, and a `posterize` of `null` or `0` removes the option. Only offer the `extrapolateTypes` of the settings: `interpolatePaths()` rejects `'identity'`.
+The `CanvasKeyframeSettings` to write. Take the object returned by [`getCanvasKeyframeSettings()`](/docs/sdk/get-canvas-keyframe-settings) and replace the values that changed. Options the interpolation function does not have are left as they are, and a `posterize` of `null` or `0` removes the option. Only offer the `extrapolateTypes` of the settings: `interpolatePaths()` rejects `'identity'`.
## Return value
-A `CanvasKeyframeChange` whose `operation` is `{type: 'settings', clamping, posterize, output}`. Persist it with [`updateNodeKeyframes()`](/docs/codemods/update-node-keyframes) like the changes of [`getCanvasKeyframeToggle()`](/docs/canvas/get-canvas-keyframe-toggle#change), and pass it to [`getCanvasKeyframeChangeOverride()`](/docs/canvas/get-canvas-keyframe-change-override) to show the result on the canvas right away.
+A `CanvasKeyframeChange` whose `operation` is `{type: 'settings', clamping, posterize, output}`. Persist it with [`updateNodeKeyframes()`](/docs/codemods/update-node-keyframes) like the changes of [`getCanvasKeyframeToggle()`](/docs/sdk/get-canvas-keyframe-toggle#change), and pass it to [`getCanvasKeyframeChangeOverride()`](/docs/sdk/get-canvas-keyframe-change-override) to show the result on the canvas right away.
## Compatibility
@@ -89,6 +89,6 @@ A `CanvasKeyframeChange` whose `operation` is `{type: 'settings', clamping, post
## See also
-- [`getCanvasKeyframeSettings()`](/docs/canvas/get-canvas-keyframe-settings)
-- [`getCanvasKeyframeEasingChange()`](/docs/canvas/get-canvas-keyframe-easing-change)
+- [`getCanvasKeyframeSettings()`](/docs/sdk/get-canvas-keyframe-settings)
+- [`getCanvasKeyframeEasingChange()`](/docs/sdk/get-canvas-keyframe-easing-change)
- [`updateNodeKeyframes()`](/docs/codemods/update-node-keyframes)
diff --git a/packages/docs/docs/canvas/get-canvas-keyframe-settings.mdx b/packages/docs/docs/sdk/get-canvas-keyframe-settings.mdx
similarity index 90%
rename from packages/docs/docs/canvas/get-canvas-keyframe-settings.mdx
rename to packages/docs/docs/sdk/get-canvas-keyframe-settings.mdx
index 30c6ccddaa..e7a142428d 100644
--- a/packages/docs/docs/canvas/get-canvas-keyframe-settings.mdx
+++ b/packages/docs/docs/sdk/get-canvas-keyframe-settings.mdx
@@ -1,7 +1,7 @@
---
-image: /generated/articles-docs-canvas-get-canvas-keyframe-settings.png
+image: /generated/articles-docs-sdk-get-canvas-keyframe-settings.png
title: getCanvasKeyframeSettings()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# getCanvasKeyframeSettings()<AvailableFrom v="4.0.530" />
@@ -16,7 +16,7 @@ _Experimental API_: This package is not stable. Its public API may change withou
```tsx twoslash title="InterpolationSettings.tsx"
// @moduleResolution: bundler
-import {getCanvasKeyframeSettings} from '@remotion/canvas';
+import {getCanvasKeyframeSettings} from '@remotion/sdk';
import type {CanUpdateSequencePropStatusKeyframed} from 'remotion';
declare const propStatus: CanUpdateSequencePropStatusKeyframed;
// ---cut---
@@ -69,5 +69,5 @@ The `output` option, `'linear'` or `'perceptual-scale'`. `null` when the interpo
## See also
-- [`getCanvasKeyframeSettingsChange()`](/docs/canvas/get-canvas-keyframe-settings-change)
+- [`getCanvasKeyframeSettingsChange()`](/docs/sdk/get-canvas-keyframe-settings-change)
- [`interpolate()`](/docs/interpolate)
diff --git a/packages/docs/docs/canvas/get-canvas-keyframe-source-frame.mdx b/packages/docs/docs/sdk/get-canvas-keyframe-source-frame.mdx
similarity index 83%
rename from packages/docs/docs/canvas/get-canvas-keyframe-source-frame.mdx
rename to packages/docs/docs/sdk/get-canvas-keyframe-source-frame.mdx
index 288f5448e7..a9e10e4db2 100644
--- a/packages/docs/docs/canvas/get-canvas-keyframe-source-frame.mdx
+++ b/packages/docs/docs/sdk/get-canvas-keyframe-source-frame.mdx
@@ -1,7 +1,7 @@
---
-image: /generated/articles-docs-canvas-get-canvas-keyframe-source-frame.png
+image: /generated/articles-docs-sdk-get-canvas-keyframe-source-frame.png
title: getCanvasKeyframeSourceFrame()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# getCanvasKeyframeSourceFrame()<AvailableFrom v="4.0.530" />
@@ -21,7 +21,7 @@ import {
type CanvasKeyframeChange,
type SequenceNodePathInfo,
type TimelineTrackData,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
import type {CanUpdateSequencePropStatus, InteractivitySchema} from 'remotion';
declare const nodePathInfo: SequenceNodePathInfo;
declare const track: TimelineTrackData;
@@ -49,7 +49,7 @@ An object with the following properties:
### track
-The `TimelineTrackData` of the sequence from [`controller.timeline`](/docs/canvas/create-canvas-controller#timeline). Only `keyframeDisplayOffset` and `keyframePlaybackRate` are read.
+The `TimelineTrackData` of the sequence from [`controller.timeline`](/docs/sdk/create-canvas-controller#timeline). Only `keyframeDisplayOffset` and `keyframePlaybackRate` are read.
### propStatus
@@ -69,6 +69,6 @@ The frame in the clock of the interpolation. Pass it as `frame` of an `add` or `
## See also
-- [`getCanvasKeyframeDisplayFrame()`](/docs/canvas/get-canvas-keyframe-display-frame)
-- [`getCanvasKeyframes()`](/docs/canvas/get-canvas-keyframes)
-- [`getCanvasKeyframeToggle()`](/docs/canvas/get-canvas-keyframe-toggle)
+- [`getCanvasKeyframeDisplayFrame()`](/docs/sdk/get-canvas-keyframe-display-frame)
+- [`getCanvasKeyframes()`](/docs/sdk/get-canvas-keyframes)
+- [`getCanvasKeyframeToggle()`](/docs/sdk/get-canvas-keyframe-toggle)
diff --git a/packages/docs/docs/canvas/get-canvas-keyframe-toggle.mdx b/packages/docs/docs/sdk/get-canvas-keyframe-toggle.mdx
similarity index 87%
rename from packages/docs/docs/canvas/get-canvas-keyframe-toggle.mdx
rename to packages/docs/docs/sdk/get-canvas-keyframe-toggle.mdx
index 1e5ba83f8d..53ca8f5a55 100644
--- a/packages/docs/docs/canvas/get-canvas-keyframe-toggle.mdx
+++ b/packages/docs/docs/sdk/get-canvas-keyframe-toggle.mdx
@@ -1,7 +1,7 @@
---
-image: /generated/articles-docs-canvas-get-canvas-keyframe-toggle.png
+image: /generated/articles-docs-sdk-get-canvas-keyframe-toggle.png
title: getCanvasKeyframeToggle()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# getCanvasKeyframeToggle()<AvailableFrom v="4.0.530" />
@@ -21,7 +21,7 @@ import {
type CanvasKeyframeChange,
type SequenceNodePathInfo,
type TimelineTrackData,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
import type {CanUpdateSequencePropStatus, InteractivitySchema} from 'remotion';
declare const nodePathInfo: SequenceNodePathInfo;
declare const track: TimelineTrackData;
@@ -81,11 +81,11 @@ The `SequenceNodePathInfo` of the sequence, from a track or a selection item. It
### track
-The `TimelineTrackData` of the sequence from [`controller.timeline`](/docs/canvas/create-canvas-controller#timeline). Its `keyframeDisplayOffset` and `keyframePlaybackRate` convert `frame` to the frame clock of the interpolation.
+The `TimelineTrackData` of the sequence from [`controller.timeline`](/docs/sdk/create-canvas-controller#timeline). Its `keyframeDisplayOffset` and `keyframePlaybackRate` convert `frame` to the frame clock of the interpolation.
### schema
-The interactivity schema of the element, from [`track.sequence.controls`](/docs/canvas/create-canvas-controller#sequencecontrols). It decides whether the field can be keyframed and provides the default value of an unset prop.
+The interactivity schema of the element, from [`track.sequence.controls`](/docs/sdk/create-canvas-controller#sequencecontrols). It decides whether the field can be keyframed and provides the default value of an unset prop.
### key
@@ -131,7 +131,7 @@ A `CanvasKeyframeChange`, or `null` when neither adding nor removing is possible
```tsx twoslash title="Persisting a change"
// @moduleResolution: bundler
-import type {CanvasKeyframeChange} from '@remotion/canvas';
+import type {CanvasKeyframeChange} from '@remotion/sdk';
import {updateNodeKeyframes, type CodemodProject} from '@remotion/codemods';
declare const project: CodemodProject;
// ---cut---
@@ -152,6 +152,6 @@ export const persist = (change: CanvasKeyframeChange) => {
## See also
-- [`getCanvasKeyframes()`](/docs/canvas/get-canvas-keyframes)
-- [`getCanvasPropValueAtFrame()`](/docs/canvas/get-canvas-prop-value-at-frame)
+- [`getCanvasKeyframes()`](/docs/sdk/get-canvas-keyframes)
+- [`getCanvasPropValueAtFrame()`](/docs/sdk/get-canvas-prop-value-at-frame)
- [`updateNodeKeyframes()`](/docs/codemods/update-node-keyframes)
diff --git a/packages/docs/docs/canvas/get-canvas-keyframes.mdx b/packages/docs/docs/sdk/get-canvas-keyframes.mdx
similarity index 82%
rename from packages/docs/docs/canvas/get-canvas-keyframes.mdx
rename to packages/docs/docs/sdk/get-canvas-keyframes.mdx
index a1d4d0275b..45db294cac 100644
--- a/packages/docs/docs/canvas/get-canvas-keyframes.mdx
+++ b/packages/docs/docs/sdk/get-canvas-keyframes.mdx
@@ -1,7 +1,7 @@
---
-image: /generated/articles-docs-canvas-get-canvas-keyframes.png
+image: /generated/articles-docs-sdk-get-canvas-keyframes.png
title: getCanvasKeyframes()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# getCanvasKeyframes()<AvailableFrom v="4.0.530" />
@@ -16,7 +16,7 @@ _Experimental API_: This package is not stable. Its public API may change withou
```tsx twoslash title="KeyframeRow.tsx"
// @moduleResolution: bundler
-import {getCanvasKeyframes, type TimelineTrackData} from '@remotion/canvas';
+import {getCanvasKeyframes, type TimelineTrackData} from '@remotion/sdk';
import type {CanUpdateSequencePropStatus} from 'remotion';
declare const track: TimelineTrackData;
declare const propStatus: CanUpdateSequencePropStatus;
@@ -47,7 +47,7 @@ An object with the following properties:
### track
-The `TimelineTrackData` of the sequence from [`controller.timeline`](/docs/canvas/create-canvas-controller#timeline). Only `keyframeDisplayOffset` and `keyframePlaybackRate` are read.
+The `TimelineTrackData` of the sequence from [`controller.timeline`](/docs/sdk/create-canvas-controller#timeline). Only `keyframeDisplayOffset` and `keyframePlaybackRate` are read.
### propStatus
@@ -63,6 +63,6 @@ An array of `CanvasKeyframe` objects with `frame` in composition frames and `val
## See also
-- [`getCanvasKeyframeToggle()`](/docs/canvas/get-canvas-keyframe-toggle)
-- [`startCanvasKeyframeDrag()`](/docs/canvas/start-canvas-keyframe-drag)
-- [`getCanvasKeyframeSourceFrame()`](/docs/canvas/get-canvas-keyframe-source-frame)
+- [`getCanvasKeyframeToggle()`](/docs/sdk/get-canvas-keyframe-toggle)
+- [`startCanvasKeyframeDrag()`](/docs/sdk/start-canvas-keyframe-drag)
+- [`getCanvasKeyframeSourceFrame()`](/docs/sdk/get-canvas-keyframe-source-frame)
diff --git a/packages/docs/docs/canvas/get-canvas-prop-value-at-frame.mdx b/packages/docs/docs/sdk/get-canvas-prop-value-at-frame.mdx
similarity index 77%
rename from packages/docs/docs/canvas/get-canvas-prop-value-at-frame.mdx
rename to packages/docs/docs/sdk/get-canvas-prop-value-at-frame.mdx
index 85134e402d..7e244b9d20 100644
--- a/packages/docs/docs/canvas/get-canvas-prop-value-at-frame.mdx
+++ b/packages/docs/docs/sdk/get-canvas-prop-value-at-frame.mdx
@@ -1,7 +1,7 @@
---
-image: /generated/articles-docs-canvas-get-canvas-prop-value-at-frame.png
+image: /generated/articles-docs-sdk-get-canvas-prop-value-at-frame.png
title: getCanvasPropValueAtFrame()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# getCanvasPropValueAtFrame()<AvailableFrom v="4.0.530" />
@@ -16,7 +16,7 @@ _Experimental API_: This package is not stable. Its public API may change withou
```tsx twoslash title="OpacityField.tsx"
// @moduleResolution: bundler
-import {getCanvasPropValueAtFrame, type TimelineTrackData} from '@remotion/canvas';
+import {getCanvasPropValueAtFrame, type TimelineTrackData} from '@remotion/sdk';
import type {CanUpdateSequencePropStatus, InteractivitySchema} from 'remotion';
declare const track: TimelineTrackData;
declare const schema: InteractivitySchema;
@@ -41,11 +41,11 @@ An object with the following properties:
### track
-The `TimelineTrackData` of the sequence from [`controller.timeline`](/docs/canvas/create-canvas-controller#timeline). Only `keyframeDisplayOffset` and `keyframePlaybackRate` are read.
+The `TimelineTrackData` of the sequence from [`controller.timeline`](/docs/sdk/create-canvas-controller#timeline). Only `keyframeDisplayOffset` and `keyframePlaybackRate` are read.
### schema
-The interactivity schema of the element, from [`track.sequence.controls`](/docs/canvas/create-canvas-controller#sequencecontrols). It provides the default of an unset prop.
+The interactivity schema of the element, from [`track.sequence.controls`](/docs/sdk/create-canvas-controller#sequencecontrols). It provides the default of an unset prop.
### key
@@ -63,7 +63,7 @@ The composition frame at which to read the value.
The interpolated value of a `'keyframed'` prop at the frame, the code value of a `'static'` prop, or the schema default when the prop is not set. `null` for a `'computed'` prop or when no value is known.
-The value reflects the source, not an active override from [`controller.overrides`](/docs/canvas/create-canvas-controller#overrides).
+The value reflects the source, not an active override from [`controller.overrides`](/docs/sdk/create-canvas-controller#overrides).
## Compatibility
@@ -71,5 +71,5 @@ The value reflects the source, not an active override from [`controller.override
## See also
-- [`getCanvasKeyframeToggle()`](/docs/canvas/get-canvas-keyframe-toggle)
-- [`getCanvasKeyframeSourceFrame()`](/docs/canvas/get-canvas-keyframe-source-frame)
+- [`getCanvasKeyframeToggle()`](/docs/sdk/get-canvas-keyframe-toggle)
+- [`getCanvasKeyframeSourceFrame()`](/docs/sdk/get-canvas-keyframe-source-frame)
diff --git a/packages/docs/docs/canvas/get-canvas-selection-item-key.mdx b/packages/docs/docs/sdk/get-canvas-selection-item-key.mdx
similarity index 79%
rename from packages/docs/docs/canvas/get-canvas-selection-item-key.mdx
rename to packages/docs/docs/sdk/get-canvas-selection-item-key.mdx
index 4a531677f2..f79ac84ab4 100644
--- a/packages/docs/docs/canvas/get-canvas-selection-item-key.mdx
+++ b/packages/docs/docs/sdk/get-canvas-selection-item-key.mdx
@@ -1,7 +1,7 @@
---
-image: /generated/articles-docs-canvas-get-canvas-selection-item-key.png
+image: /generated/articles-docs-sdk-get-canvas-selection-item-key.png
title: getCanvasSelectionItemKey()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# getCanvasSelectionItemKey()<AvailableFrom v="4.0.527" />
@@ -19,7 +19,7 @@ import {
getCanvasSelectionItemKey,
type CanvasSelectionItem,
type CanvasSelectionSnapshot,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
export const isSelected = (
item: CanvasSelectionItem,
@@ -37,7 +37,7 @@ A `CanvasSelectionItem`, such as `{type: 'sequence', nodePathInfo}`. Other item
## Return value
-A string that is equal for items with the same selection identity. Treat its format as opaque; it may change while the package is experimental. If an item's `nodePathInfo` uses the fallback mounted sequence ID from [`getCanvasSequenceNodePathInfo()`](/docs/canvas/get-canvas-sequence-node-path-info), its key can change after a remount.
+A string that is equal for items with the same selection identity. Treat its format as opaque; it may change while the package is experimental. If an item's `nodePathInfo` uses the fallback mounted sequence ID from [`getCanvasSequenceNodePathInfo()`](/docs/sdk/get-canvas-sequence-node-path-info), its key can change after a remount.
## Compatibility
@@ -45,5 +45,5 @@ A string that is equal for items with the same selection identity. Treat its for
## See also
-- [`useCanvasSelection()`](/docs/canvas/use-canvas-selection)
-- [`getCanvasSequenceNodePathInfo()`](/docs/canvas/get-canvas-sequence-node-path-info)
+- [`useCanvasSelection()`](/docs/sdk/use-canvas-selection)
+- [`getCanvasSequenceNodePathInfo()`](/docs/sdk/get-canvas-sequence-node-path-info)
diff --git a/packages/docs/docs/canvas/get-canvas-sequence-node-path-info.mdx b/packages/docs/docs/sdk/get-canvas-sequence-node-path-info.mdx
similarity index 84%
rename from packages/docs/docs/canvas/get-canvas-sequence-node-path-info.mdx
rename to packages/docs/docs/sdk/get-canvas-sequence-node-path-info.mdx
index f119de922c..0574cd93ae 100644
--- a/packages/docs/docs/canvas/get-canvas-sequence-node-path-info.mdx
+++ b/packages/docs/docs/sdk/get-canvas-sequence-node-path-info.mdx
@@ -1,12 +1,12 @@
---
-image: /generated/articles-docs-canvas-get-canvas-sequence-node-path-info.png
+image: /generated/articles-docs-sdk-get-canvas-sequence-node-path-info.png
title: getCanvasSequenceNodePathInfo()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# getCanvasSequenceNodePathInfo()<AvailableFrom v="4.0.527" />
-Returns the selection identity for a timeline track. This is the default resolver used by [`<Canvas>`](/docs/canvas/canvas).
+Returns the selection identity for a timeline track. This is the default resolver used by [`<Canvas>`](/docs/sdk/canvas).
:::warning
@@ -19,7 +19,7 @@ import {
getCanvasSequenceNodePathInfo,
type CanvasSelectionItem,
type TimelineTrackData,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
export const getItem = (track: TimelineTrackData): CanvasSelectionItem => ({
type: 'sequence',
@@ -31,7 +31,7 @@ export const getItem = (track: TimelineTrackData): CanvasSelectionItem => ({
### track
-A `TimelineTrackData` from [`controller.timeline`](/docs/canvas/create-canvas-controller#timeline).
+A `TimelineTrackData` from [`controller.timeline`](/docs/sdk/create-canvas-controller#timeline).
## Return value
@@ -67,5 +67,5 @@ For an editor that knows which source file and JSX node produced each track, pas
## See also
-- [`<Canvas>`](/docs/canvas/canvas)
-- [`getCanvasSelectionItemKey()`](/docs/canvas/get-canvas-selection-item-key)
+- [`<Canvas>`](/docs/sdk/canvas)
+- [`getCanvasSelectionItemKey()`](/docs/sdk/get-canvas-selection-item-key)
diff --git a/packages/docs/docs/canvas/get-canvas-sequence-source-location.mdx b/packages/docs/docs/sdk/get-canvas-sequence-source-location.mdx
similarity index 83%
rename from packages/docs/docs/canvas/get-canvas-sequence-source-location.mdx
rename to packages/docs/docs/sdk/get-canvas-sequence-source-location.mdx
index 3512d5ec94..ec4841976b 100644
--- a/packages/docs/docs/canvas/get-canvas-sequence-source-location.mdx
+++ b/packages/docs/docs/sdk/get-canvas-sequence-source-location.mdx
@@ -1,12 +1,12 @@
---
-image: /generated/articles-docs-canvas-get-canvas-sequence-source-location.png
+image: /generated/articles-docs-sdk-get-canvas-sequence-source-location.png
title: getCanvasSequenceSourceLocation()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# getCanvasSequenceSourceLocation()<AvailableFrom v="4.0.529" />
-Returns where the JSX element of a timeline track was written, if the bundler recorded it. Use it to look up the source node of a mounted sequence, for example with [`getNodes()`](/docs/codemods/get-nodes) from [`@remotion/codemods`](/docs/codemods), and pass the result to [`controller.setSequenceNodePaths()`](/docs/canvas/create-canvas-controller#setsequencenodepaths).
+Returns where the JSX element of a timeline track was written, if the bundler recorded it. Use it to look up the source node of a mounted sequence, for example with [`getNodes()`](/docs/codemods/get-nodes) from [`@remotion/codemods`](/docs/codemods), and pass the result to [`controller.setSequenceNodePaths()`](/docs/sdk/create-canvas-controller#setsequencenodepaths).
:::warning
@@ -16,12 +16,12 @@ _Experimental API_: This package is not stable. Its public API may change withou
```ts twoslash title="resolve-node-paths.ts"
// @moduleResolution: bundler
-import type {CanvasController} from '@remotion/canvas';
+import type {CanvasController} from '@remotion/sdk';
import type {CodemodProject} from '@remotion/codemods';
declare const controller: CanvasController;
declare const project: CodemodProject;
// ---cut---
-import {getCanvasSequenceSourceLocation} from '@remotion/canvas';
+import {getCanvasSequenceSourceLocation} from '@remotion/sdk';
import {getNodes} from '@remotion/codemods';
import type {SequencePropsSubscriptionKey} from 'remotion';
@@ -62,7 +62,7 @@ The function reads the mounted sequence's current location. After applying a Fas
### track
-A `TimelineTrackData` from [`controller.timeline`](/docs/canvas/create-canvas-controller#timeline).
+A `TimelineTrackData` from [`controller.timeline`](/docs/sdk/create-canvas-controller#timeline).
## Return value
@@ -86,6 +86,6 @@ The 0-based column of the JSX element. This matches the `location` of [`getNodes
## See also
-- [`createCanvasController()`](/docs/canvas/create-canvas-controller)
-- [`getCanvasSequenceNodePathInfo()`](/docs/canvas/get-canvas-sequence-node-path-info)
+- [`createCanvasController()`](/docs/sdk/create-canvas-controller)
+- [`getCanvasSequenceNodePathInfo()`](/docs/sdk/get-canvas-sequence-node-path-info)
- [`getNodes()`](/docs/codemods/get-nodes)
diff --git a/packages/docs/docs/canvas/index.mdx b/packages/docs/docs/sdk/index.mdx
similarity index 51%
rename from packages/docs/docs/canvas/index.mdx
rename to packages/docs/docs/sdk/index.mdx
index 132f384d19..83c246fecb 100644
--- a/packages/docs/docs/canvas/index.mdx
+++ b/packages/docs/docs/sdk/index.mdx
@@ -1,11 +1,11 @@
---
-image: /generated/articles-docs-canvas-index.png
+image: /generated/articles-docs-sdk-index.png
sidebar_label: Overview
-title: '@remotion/canvas'
-crumb: '@remotion/canvas'
+title: '@remotion/sdk'
+crumb: '@remotion/sdk'
---
-# @remotion/canvas<AvailableFrom v="4.0.527" />
+# @remotion/sdk<AvailableFrom v="4.0.527" />
Build a composition preview and layer list for a Remotion authoring interface. The package combines [`<Player>`](/docs/player/player) playback with registered sequence data, selection, and synchronized hover.
@@ -17,13 +17,13 @@ _Experimental API_: This package is not stable. Its public API may change withou
## Installation
-<Installation pkg="@remotion/canvas" />
+<Installation pkg="@remotion/sdk" />
Install [`@remotion/player`](/docs/player/installation) as well. Keep the Remotion packages on the same version.
## Basic example
-Pass the same controller to [`<Canvas>`](/docs/canvas/canvas) and your layer list. `showOutlines` enables hover and selection on the composition.
+Pass the same controller to [`<Canvas>`](/docs/sdk/canvas) and your layer list. `showOutlines` enables hover and selection on the composition.
```tsx title="Editor.tsx"
import {
@@ -35,7 +35,7 @@ import {
useCanvasSequenceHover,
type CanvasSelectionItem,
type TimelineTrackData,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
import {useSyncExternalStore} from 'react';
import {Video} from './Video';
@@ -120,27 +120,27 @@ The timeline contains registered [`<Sequence>`](/docs/sequence) and other sequen
## Selection identity
-The built-in [`getCanvasSequenceNodePathInfo()`](/docs/canvas/get-canvas-sequence-node-path-info) uses a source identity when available. Otherwise it falls back to a mounted sequence ID, which can change after a remount.
+The built-in [`getCanvasSequenceNodePathInfo()`](/docs/sdk/get-canvas-sequence-node-path-info) uses a source identity when available. Otherwise it falls back to a mounted sequence ID, which can change after a remount.
-If your editor has the source code, register the source node of each sequence with [`setSequenceNodePaths()`](/docs/canvas/create-canvas-controller#setsequencenodepaths). For projects compiled with [`@remotion/browser-bundler`](/docs/browser-bundler), [`getCanvasSequenceSourceLocation()`](/docs/canvas/get-canvas-sequence-source-location) returns the file and position of each sequence's JSX element, which [`getNodes()`](/docs/codemods/get-nodes) maps to a node path. Alternatively, pass a custom `resolveSequenceNodePathInfo` to `<Canvas>` and use the same resolver for layer items. Return `null` for tracks that should not be selectable.
+If your editor has the source code, register the source node of each sequence with [`setSequenceNodePaths()`](/docs/sdk/create-canvas-controller#setsequencenodepaths). For projects compiled with [`@remotion/browser-bundler`](/docs/browser-bundler), [`getCanvasSequenceSourceLocation()`](/docs/sdk/get-canvas-sequence-source-location) returns the file and position of each sequence's JSX element, which [`getNodes()`](/docs/codemods/get-nodes) maps to a node path. Alternatively, pass a custom `resolveSequenceNodePathInfo` to `<Canvas>` and use the same resolver for layer items. Return `null` for tracks that should not be selectable.
An outline requires a registered DOM element. A `<Sequence layout="none">` has no outline of its own.
## Editing
-The Canvas exposes the [`controls`](/docs/canvas/create-canvas-controller#sequencecontrols) of each mounted element: its interactivity schema and current prop values. Use them to build an inspector, and write changes to the source with [`@remotion/codemods`](/docs/codemods).
+The Canvas exposes the [`controls`](/docs/sdk/create-canvas-controller#sequencecontrols) of each mounted element: its interactivity schema and current prop values. Use them to build an inspector, and write changes to the source with [`@remotion/codemods`](/docs/codemods).
-While a value is being dragged, [`controller.overrides`](/docs/canvas/create-canvas-controller#overrides) previews it on the canvas immediately. Persist the final value when the gesture ends, then clear the override.
+While a value is being dragged, [`controller.overrides`](/docs/sdk/create-canvas-controller#overrides) previews it on the canvas immediately. Persist the final value when the gesture ends, then clear the override.
-Pass [`onSequencePropsChange`](/docs/canvas/canvas#onsequencepropschange) to `<Canvas>` to let users move elements by dragging their outlines or pressing the arrow keys. The Canvas previews the movement itself and reports the final `style.translate` values to the callback. With [`getSequencePropStatuses`](/docs/canvas/canvas#getsequencepropstatuses), it respects how the source is written: computed values cannot be moved and keyframed values receive a keyframe.
+Pass [`onSequencePropsChange`](/docs/sdk/canvas#onsequencepropschange) to `<Canvas>` to let users move elements by dragging their outlines or pressing the arrow keys. The Canvas previews the movement itself and reports the final `style.translate` values to the callback. With [`getSequencePropStatuses`](/docs/sdk/canvas#getsequencepropstatuses), it respects how the source is written: computed values cannot be moved and keyframed values receive a keyframe.
## Keyframes<AvailableFrom v="4.0.530" />
Props animated with `interpolate()` are reported as `keyframed` by [`getNodeProps()`](/docs/codemods/get-node-props). The package converts between the frame clock of the interpolation and the composition timeline, so a timeline can show and edit those keyframes like the Remotion Studio does.
-[`getCanvasKeyframes()`](/docs/canvas/get-canvas-keyframes) places the keyframes of a prop on the timeline. [`getCanvasKeyframeToggle()`](/docs/canvas/get-canvas-keyframe-toggle) describes a keyframe button at the playhead and returns the change that adds or removes a keyframe there, while [`getCanvasPropValueAtFrame()`](/docs/canvas/get-canvas-prop-value-at-frame) reads the animated value for an inspector. [`startCanvasKeyframeDrag()`](/docs/canvas/start-canvas-keyframe-drag) moves keyframes with the pointer, previewing the result through `controller.overrides`. Every edit is a `CanvasKeyframeChange` whose `operation` you pass to [`updateNodeKeyframes()`](/docs/codemods/update-node-keyframes).
+[`getCanvasKeyframes()`](/docs/sdk/get-canvas-keyframes) places the keyframes of a prop on the timeline. [`getCanvasKeyframeToggle()`](/docs/sdk/get-canvas-keyframe-toggle) describes a keyframe button at the playhead and returns the change that adds or removes a keyframe there, while [`getCanvasPropValueAtFrame()`](/docs/sdk/get-canvas-prop-value-at-frame) reads the animated value for an inspector. [`startCanvasKeyframeDrag()`](/docs/sdk/start-canvas-keyframe-drag) moves keyframes with the pointer, previewing the result through `controller.overrides`. Every edit is a `CanvasKeyframeChange` whose `operation` you pass to [`updateNodeKeyframes()`](/docs/codemods/update-node-keyframes).
-Between two keyframes, [`getCanvasKeyframeEasingSegments()`](/docs/canvas/get-canvas-keyframe-easing-segments) describes the segments a timeline can draw and select, and [`getCanvasKeyframeEasingChange()`](/docs/canvas/get-canvas-keyframe-easing-change) sets the easing of one, with `canvasKeyframeEasingPresets` for a picker. [`getCanvasKeyframeSettings()`](/docs/canvas/get-canvas-keyframe-settings) and [`getCanvasKeyframeSettingsChange()`](/docs/canvas/get-canvas-keyframe-settings-change) read and write the extrapolation, `output` mode and `posterize` of the interpolation. [`getCanvasKeyframeChangeOverride()`](/docs/canvas/get-canvas-keyframe-change-override) turns any change into an override, so the canvas shows it before the source is updated.
+Between two keyframes, [`getCanvasKeyframeEasingSegments()`](/docs/sdk/get-canvas-keyframe-easing-segments) describes the segments a timeline can draw and select, and [`getCanvasKeyframeEasingChange()`](/docs/sdk/get-canvas-keyframe-easing-change) sets the easing of one, with `canvasKeyframeEasingPresets` for a picker. [`getCanvasKeyframeSettings()`](/docs/sdk/get-canvas-keyframe-settings) and [`getCanvasKeyframeSettingsChange()`](/docs/sdk/get-canvas-keyframe-settings-change) read and write the extrapolation, `output` mode and `posterize` of the interpolation. [`getCanvasKeyframeChangeOverride()`](/docs/sdk/get-canvas-keyframe-change-override) turns any change into an override, so the canvas shows it before the source is updated.
## APIs
diff --git a/packages/docs/docs/canvas/start-canvas-keyframe-drag.mdx b/packages/docs/docs/sdk/start-canvas-keyframe-drag.mdx
similarity index 86%
rename from packages/docs/docs/canvas/start-canvas-keyframe-drag.mdx
rename to packages/docs/docs/sdk/start-canvas-keyframe-drag.mdx
index 9cd6734d3c..6b0a3a441c 100644
--- a/packages/docs/docs/canvas/start-canvas-keyframe-drag.mdx
+++ b/packages/docs/docs/sdk/start-canvas-keyframe-drag.mdx
@@ -1,12 +1,12 @@
---
-image: /generated/articles-docs-canvas-start-canvas-keyframe-drag.png
+image: /generated/articles-docs-sdk-start-canvas-keyframe-drag.png
title: startCanvasKeyframeDrag()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# startCanvasKeyframeDrag()<AvailableFrom v="4.0.530" />
-Moves keyframes along the timeline with the pointer. Call it from the `pointerdown` handler of a keyframe marker. While the pointer moves, the new positions are previewed on the canvas through [`controller.overrides`](/docs/canvas/create-canvas-controller#overrides); when it is released, the resulting moves are reported for you to persist.
+Moves keyframes along the timeline with the pointer. Call it from the `pointerdown` handler of a keyframe marker. While the pointer moves, the new positions are previewed on the canvas through [`controller.overrides`](/docs/sdk/create-canvas-controller#overrides); when it is released, the resulting moves are reported for you to persist.
:::warning
@@ -21,7 +21,7 @@ import {
type CanvasController,
type CanvasKeyframeChange,
type CanvasKeyframeDragTarget,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
declare const controller: CanvasController;
declare const target: CanvasKeyframeDragTarget;
declare const pixelsPerFrame: number;
@@ -96,7 +96,7 @@ The `'keyframed'` prop status of the prop, as the `props` of [`getNodeProps()`](
#### frame
-The composition frame of the keyframe, as returned by [`getCanvasKeyframes()`](/docs/canvas/get-canvas-keyframes). Targets that do not correspond to a keyframe of the prop are ignored.
+The composition frame of the keyframe, as returned by [`getCanvasKeyframes()`](/docs/sdk/get-canvas-keyframes). Targets that do not correspond to a keyframe of the prop are ignored.
### pixelsPerFrame
@@ -108,7 +108,7 @@ The duration of the composition, which bounds the movement.
### overrides
-The [`overrides`](/docs/canvas/create-canvas-controller#overrides) of the `CanvasController` that previews the composition.
+The [`overrides`](/docs/sdk/create-canvas-controller#overrides) of the `CanvasController` that previews the composition.
### onDragStart
@@ -150,6 +150,6 @@ A function that cancels the gesture.
## See also
-- [`getCanvasKeyframes()`](/docs/canvas/get-canvas-keyframes)
-- [`getCanvasKeyframeToggle()`](/docs/canvas/get-canvas-keyframe-toggle)
-- [`createCanvasController()`](/docs/canvas/create-canvas-controller)
+- [`getCanvasKeyframes()`](/docs/sdk/get-canvas-keyframes)
+- [`getCanvasKeyframeToggle()`](/docs/sdk/get-canvas-keyframe-toggle)
+- [`createCanvasController()`](/docs/sdk/create-canvas-controller)
diff --git a/packages/docs/docs/canvas/table-of-contents.tsx b/packages/docs/docs/sdk/table-of-contents.tsx
similarity index 69%
rename from packages/docs/docs/canvas/table-of-contents.tsx
rename to packages/docs/docs/sdk/table-of-contents.tsx
index f965c17eff..86cf3d488e 100644
--- a/packages/docs/docs/canvas/table-of-contents.tsx
+++ b/packages/docs/docs/sdk/table-of-contents.tsx
@@ -6,91 +6,91 @@ export const TableOfContents: React.FC = () => {
return (
<div>
<Grid>
- <TOCItem link="/docs/canvas/canvas">
+ <TOCItem link="/docs/sdk/canvas">
<strong>{'<Canvas>'}</strong>
<div>Preview a composition with selectable, movable outlines</div>
</TOCItem>
- <TOCItem link="/docs/canvas/create-canvas-controller">
+ <TOCItem link="/docs/sdk/create-canvas-controller">
<strong>createCanvasController()</strong>
<div>Connect the canvas, timeline, selection, and hover</div>
</TOCItem>
- <TOCItem link="/docs/canvas/use-canvas-controller">
+ <TOCItem link="/docs/sdk/use-canvas-controller">
<strong>useCanvasController()</strong>
<div>Create a stable controller in a React component</div>
</TOCItem>
- <TOCItem link="/docs/canvas/create-canvas-selection-controller">
+ <TOCItem link="/docs/sdk/create-canvas-selection-controller">
<strong>createCanvasSelectionController()</strong>
<div>Create a standalone selection store</div>
</TOCItem>
- <TOCItem link="/docs/canvas/create-canvas-hover-controller">
+ <TOCItem link="/docs/sdk/create-canvas-hover-controller">
<strong>createCanvasHoverController()</strong>
<div>Create a standalone hover store</div>
</TOCItem>
- <TOCItem link="/docs/canvas/use-canvas-selection">
+ <TOCItem link="/docs/sdk/use-canvas-selection">
<strong>useCanvasSelection()</strong>
<div>Subscribe to selected layers and other items</div>
</TOCItem>
- <TOCItem link="/docs/canvas/use-canvas-sequence-hover">
+ <TOCItem link="/docs/sdk/use-canvas-sequence-hover">
<strong>useCanvasSequenceHover()</strong>
<div>Synchronize hover between a layer list and the canvas</div>
</TOCItem>
- <TOCItem link="/docs/canvas/use-canvas-hover">
+ <TOCItem link="/docs/sdk/use-canvas-hover">
<strong>useCanvasHover()</strong>
<div>Subscribe to the current hovered sequence</div>
</TOCItem>
- <TOCItem link="/docs/canvas/get-canvas-sequence-node-path-info">
+ <TOCItem link="/docs/sdk/get-canvas-sequence-node-path-info">
<strong>getCanvasSequenceNodePathInfo()</strong>
<div>Resolve a timeline track's selection identity</div>
</TOCItem>
- <TOCItem link="/docs/canvas/get-canvas-sequence-source-location">
+ <TOCItem link="/docs/sdk/get-canvas-sequence-source-location">
<strong>getCanvasSequenceSourceLocation()</strong>
<div>Find where a timeline track's JSX element was written</div>
</TOCItem>
- <TOCItem link="/docs/canvas/get-canvas-selection-item-key">
+ <TOCItem link="/docs/sdk/get-canvas-selection-item-key">
<strong>getCanvasSelectionItemKey()</strong>
<div>Compare selection items by identity</div>
</TOCItem>
- <TOCItem link="/docs/canvas/get-canvas-keyframes">
+ <TOCItem link="/docs/sdk/get-canvas-keyframes">
<strong>getCanvasKeyframes()</strong>
<div>Place the keyframes of a prop on the timeline</div>
</TOCItem>
- <TOCItem link="/docs/canvas/get-canvas-keyframe-toggle">
+ <TOCItem link="/docs/sdk/get-canvas-keyframe-toggle">
<strong>getCanvasKeyframeToggle()</strong>
<div>Add, remove and navigate keyframes at a frame</div>
</TOCItem>
- <TOCItem link="/docs/canvas/start-canvas-keyframe-drag">
+ <TOCItem link="/docs/sdk/start-canvas-keyframe-drag">
<strong>startCanvasKeyframeDrag()</strong>
<div>Move keyframes along the timeline with the pointer</div>
</TOCItem>
- <TOCItem link="/docs/canvas/get-canvas-keyframe-easing-segments">
+ <TOCItem link="/docs/sdk/get-canvas-keyframe-easing-segments">
<strong>getCanvasKeyframeEasingSegments()</strong>
<div>Describe the segments between keyframes on the timeline</div>
</TOCItem>
- <TOCItem link="/docs/canvas/get-canvas-keyframe-easing-change">
+ <TOCItem link="/docs/sdk/get-canvas-keyframe-easing-change">
<strong>getCanvasKeyframeEasingChange()</strong>
<div>Set the easing between two keyframes</div>
</TOCItem>
- <TOCItem link="/docs/canvas/get-canvas-keyframe-settings">
+ <TOCItem link="/docs/sdk/get-canvas-keyframe-settings">
<strong>getCanvasKeyframeSettings()</strong>
<div>Read the extrapolation, output and posterize options</div>
</TOCItem>
- <TOCItem link="/docs/canvas/get-canvas-keyframe-settings-change">
+ <TOCItem link="/docs/sdk/get-canvas-keyframe-settings-change">
<strong>getCanvasKeyframeSettingsChange()</strong>
<div>Write the interpolation options of a keyframed prop</div>
</TOCItem>
- <TOCItem link="/docs/canvas/get-canvas-keyframe-change-override">
+ <TOCItem link="/docs/sdk/get-canvas-keyframe-change-override">
<strong>getCanvasKeyframeChangeOverride()</strong>
<div>Show a keyframe change before the source is updated</div>
</TOCItem>
- <TOCItem link="/docs/canvas/get-canvas-prop-value-at-frame">
+ <TOCItem link="/docs/sdk/get-canvas-prop-value-at-frame">
<strong>getCanvasPropValueAtFrame()</strong>
<div>Read the value of a prop at a frame from the source</div>
</TOCItem>
- <TOCItem link="/docs/canvas/get-canvas-keyframe-source-frame">
+ <TOCItem link="/docs/sdk/get-canvas-keyframe-source-frame">
<strong>getCanvasKeyframeSourceFrame()</strong>
<div>Convert a composition frame to the interpolation clock</div>
</TOCItem>
- <TOCItem link="/docs/canvas/get-canvas-keyframe-display-frame">
+ <TOCItem link="/docs/sdk/get-canvas-keyframe-display-frame">
<strong>getCanvasKeyframeDisplayFrame()</strong>
<div>Convert an interpolation frame to the composition</div>
</TOCItem>
diff --git a/packages/docs/docs/canvas/use-canvas-controller.mdx b/packages/docs/docs/sdk/use-canvas-controller.mdx
similarity index 69%
rename from packages/docs/docs/canvas/use-canvas-controller.mdx
rename to packages/docs/docs/sdk/use-canvas-controller.mdx
index a3533213d5..cf2ad442bb 100644
--- a/packages/docs/docs/canvas/use-canvas-controller.mdx
+++ b/packages/docs/docs/sdk/use-canvas-controller.mdx
@@ -1,12 +1,12 @@
---
-image: /generated/articles-docs-canvas-use-canvas-controller.png
+image: /generated/articles-docs-sdk-use-canvas-controller.png
title: useCanvasController()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# useCanvasController()<AvailableFrom v="4.0.527" />
-Creates one [`CanvasController`](/docs/canvas/create-canvas-controller) for a React component and returns the same object on later renders.
+Creates one [`CanvasController`](/docs/sdk/create-canvas-controller) for a React component and returns the same object on later renders.
:::warning
@@ -15,7 +15,7 @@ _Experimental API_: This package is not stable. Its public API may change withou
:::
```tsx title="Preview.tsx"
-import {Canvas, useCanvasController} from '@remotion/canvas';
+import {Canvas, useCanvasController} from '@remotion/sdk';
import {Video} from './Video';
export const Preview = () => {
@@ -32,5 +32,5 @@ The hook takes no arguments. Share its returned controller with your layer list
## See also
-- [`createCanvasController()`](/docs/canvas/create-canvas-controller)
-- [`<Canvas>`](/docs/canvas/canvas)
+- [`createCanvasController()`](/docs/sdk/create-canvas-controller)
+- [`<Canvas>`](/docs/sdk/canvas)
diff --git a/packages/docs/docs/canvas/use-canvas-hover.mdx b/packages/docs/docs/sdk/use-canvas-hover.mdx
similarity index 67%
rename from packages/docs/docs/canvas/use-canvas-hover.mdx
rename to packages/docs/docs/sdk/use-canvas-hover.mdx
index b427f2f376..95acb58a2c 100644
--- a/packages/docs/docs/canvas/use-canvas-hover.mdx
+++ b/packages/docs/docs/sdk/use-canvas-hover.mdx
@@ -1,7 +1,7 @@
---
-image: /generated/articles-docs-canvas-use-canvas-hover.png
+image: /generated/articles-docs-sdk-use-canvas-hover.png
title: useCanvasHover()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# useCanvasHover()<AvailableFrom v="4.0.527" />
@@ -15,7 +15,7 @@ _Experimental API_: This package is not stable. Its public API may change withou
:::
```tsx title="HoverStatus.tsx"
-import {useCanvasHover, type CanvasController} from '@remotion/canvas';
+import {useCanvasHover, type CanvasController} from '@remotion/sdk';
export const HoverStatus = ({controller}: {controller: CanvasController}) => {
const hover = useCanvasHover(controller.hover);
@@ -27,7 +27,7 @@ export const HoverStatus = ({controller}: {controller: CanvasController}) => {
### controller
-A `CanvasHoverController`, usually `controller.hover` from [`useCanvasController()`](/docs/canvas/use-canvas-controller).
+A `CanvasHoverController`, usually `controller.hover` from [`useCanvasController()`](/docs/sdk/use-canvas-controller).
## Return value
@@ -45,7 +45,7 @@ The source node identity shared by instances of that source node.
`'canvas'` or `'timeline'`, indicating which surface set the hover.
-For a single layer row, use [`useCanvasSequenceHover()`](/docs/canvas/use-canvas-sequence-hover) instead. It returns a boolean and pointer handlers for that row.
+For a single layer row, use [`useCanvasSequenceHover()`](/docs/sdk/use-canvas-sequence-hover) instead. It returns a boolean and pointer handlers for that row.
## Compatibility
@@ -53,5 +53,5 @@ For a single layer row, use [`useCanvasSequenceHover()`](/docs/canvas/use-canvas
## See also
-- [`useCanvasSequenceHover()`](/docs/canvas/use-canvas-sequence-hover)
-- [`createCanvasController()`](/docs/canvas/create-canvas-controller)
+- [`useCanvasSequenceHover()`](/docs/sdk/use-canvas-sequence-hover)
+- [`createCanvasController()`](/docs/sdk/create-canvas-controller)
diff --git a/packages/docs/docs/canvas/use-canvas-selection.mdx b/packages/docs/docs/sdk/use-canvas-selection.mdx
similarity index 76%
rename from packages/docs/docs/canvas/use-canvas-selection.mdx
rename to packages/docs/docs/sdk/use-canvas-selection.mdx
index 805865e879..2b20935896 100644
--- a/packages/docs/docs/canvas/use-canvas-selection.mdx
+++ b/packages/docs/docs/sdk/use-canvas-selection.mdx
@@ -1,7 +1,7 @@
---
-image: /generated/articles-docs-canvas-use-canvas-selection.png
+image: /generated/articles-docs-sdk-use-canvas-selection.png
title: useCanvasSelection()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# useCanvasSelection()<AvailableFrom v="4.0.527" />
@@ -15,7 +15,7 @@ _Experimental API_: This package is not stable. Its public API may change withou
:::
```tsx title="SelectionCount.tsx"
-import {useCanvasSelection, type CanvasController} from '@remotion/canvas';
+import {useCanvasSelection, type CanvasController} from '@remotion/sdk';
export const SelectionCount = ({controller}: {controller: CanvasController}) => {
const {selectedItems} = useCanvasSelection(controller.selection);
@@ -27,7 +27,7 @@ export const SelectionCount = ({controller}: {controller: CanvasController}) =>
### controller
-A `CanvasSelectionController`, usually `controller.selection` from [`useCanvasController()`](/docs/canvas/use-canvas-controller).
+A `CanvasSelectionController`, usually `controller.selection` from [`useCanvasController()`](/docs/sdk/use-canvas-controller).
## Return value
@@ -35,13 +35,13 @@ A `CanvasSelectionSnapshot` with the following properties.
### selectedItems
-A readonly array of `CanvasSelectionItem` values. An item has a `type` discriminator. The `sequence` variant contains `nodePathInfo`; other variants represent a sequence property, effect, keyframe, easing segment, or guide. Use [`getCanvasSelectionItemKey()`](/docs/canvas/get-canvas-selection-item-key) to compare items by identity.
+A readonly array of `CanvasSelectionItem` values. An item has a `type` discriminator. The `sequence` variant contains `nodePathInfo`; other variants represent a sequence property, effect, keyframe, easing segment, or guide. Use [`getCanvasSelectionItemKey()`](/docs/sdk/get-canvas-selection-item-key) to compare items by identity.
### anchor
The `CanvasSelectionItem` used as the starting point for a subsequent Shift selection, or `null` when there is no anchor.
-The controller's `select()` method accepts `shiftKey`, `toggleKey`, and the ordered selectable items. See [`createCanvasController()`](/docs/canvas/create-canvas-controller#select).
+The controller's `select()` method accepts `shiftKey`, `toggleKey`, and the ordered selectable items. See [`createCanvasController()`](/docs/sdk/create-canvas-controller#select).
## Compatibility
@@ -49,5 +49,5 @@ The controller's `select()` method accepts `shiftKey`, `toggleKey`, and the orde
## See also
-- [`createCanvasController()`](/docs/canvas/create-canvas-controller)
-- [`getCanvasSelectionItemKey()`](/docs/canvas/get-canvas-selection-item-key)
+- [`createCanvasController()`](/docs/sdk/create-canvas-controller)
+- [`getCanvasSelectionItemKey()`](/docs/sdk/get-canvas-selection-item-key)
diff --git a/packages/docs/docs/canvas/use-canvas-sequence-hover.mdx b/packages/docs/docs/sdk/use-canvas-sequence-hover.mdx
similarity index 82%
rename from packages/docs/docs/canvas/use-canvas-sequence-hover.mdx
rename to packages/docs/docs/sdk/use-canvas-sequence-hover.mdx
index 55c43d932e..b9e9f4f846 100644
--- a/packages/docs/docs/canvas/use-canvas-sequence-hover.mdx
+++ b/packages/docs/docs/sdk/use-canvas-sequence-hover.mdx
@@ -1,7 +1,7 @@
---
-image: /generated/articles-docs-canvas-use-canvas-sequence-hover.png
+image: /generated/articles-docs-sdk-use-canvas-sequence-hover.png
title: useCanvasSequenceHover()
-crumb: '@remotion/canvas'
+crumb: '@remotion/sdk'
---
# useCanvasSequenceHover()<AvailableFrom v="4.0.527" />
@@ -20,7 +20,7 @@ import {
type CanvasController,
type TimelineTrackData,
getCanvasSequenceNodePathInfo,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
export const LayerRow = ({controller, track}: {
controller: CanvasController;
@@ -49,11 +49,11 @@ export const LayerRow = ({controller, track}: {
### controller
-The `CanvasHoverController`, normally `controller.hover` from [`useCanvasController()`](/docs/canvas/use-canvas-controller).
+The `CanvasHoverController`, normally `controller.hover` from [`useCanvasController()`](/docs/sdk/use-canvas-controller).
### nodePathInfo
-The track's `SequenceNodePathInfo`, or `null` for a row that cannot be hovered. Resolve it with [`getCanvasSequenceNodePathInfo()`](/docs/canvas/get-canvas-sequence-node-path-info) or the same custom resolver passed to [`<Canvas>`](/docs/canvas/canvas#resolvesequencenodepathinfo).
+The track's `SequenceNodePathInfo`, or `null` for a row that cannot be hovered. Resolve it with [`getCanvasSequenceNodePathInfo()`](/docs/sdk/get-canvas-sequence-node-path-info) or the same custom resolver passed to [`<Canvas>`](/docs/sdk/canvas#resolvesequencenodepathinfo).
### source
@@ -79,5 +79,5 @@ Call when the pointer leaves the row or it loses focus. It clears hover only if
## See also
-- [`useCanvasHover()`](/docs/canvas/use-canvas-hover)
-- [`<Canvas>`](/docs/canvas/canvas)
+- [`useCanvasHover()`](/docs/sdk/use-canvas-hover)
+- [`<Canvas>`](/docs/sdk/canvas)
diff --git a/packages/docs/package.json b/packages/docs/package.json
index 3f6bdfd387..976f4a9a63 100644
--- a/packages/docs/package.json
+++ b/packages/docs/package.json
@@ -52,7 +52,7 @@
"@remotion/browser-studio": "workspace:*",
"@remotion/bundler": "workspace:*",
"@remotion/captions": "workspace:*",
- "@remotion/canvas": "workspace:*",
+ "@remotion/sdk": "workspace:*",
"@remotion/cli": "workspace:*",
"@remotion/cloudrun": "workspace:*",
"@remotion/convert": "workspace:*",
diff --git a/packages/docs/sidebars.ts b/packages/docs/sidebars.ts
index f9f4fc1d6e..cea0829262 100644
--- a/packages/docs/sidebars.ts
+++ b/packages/docs/sidebars.ts
@@ -2054,37 +2054,37 @@ const sidebars: SidebarsConfig = {
],
},
],
- canvasSidebar: [
- {
- type: 'category',
- label: '@remotion/canvas',
- link: {
- type: 'doc',
- id: 'canvas/index',
- },
- items: [
- 'canvas/canvas',
- 'canvas/create-canvas-controller',
- 'canvas/use-canvas-controller',
- 'canvas/create-canvas-selection-controller',
- 'canvas/create-canvas-hover-controller',
- 'canvas/use-canvas-selection',
- 'canvas/use-canvas-sequence-hover',
- 'canvas/use-canvas-hover',
- 'canvas/get-canvas-sequence-node-path-info',
- 'canvas/get-canvas-sequence-source-location',
- 'canvas/get-canvas-selection-item-key',
- 'canvas/get-canvas-keyframes',
- 'canvas/get-canvas-keyframe-toggle',
- 'canvas/start-canvas-keyframe-drag',
- 'canvas/get-canvas-keyframe-easing-segments',
- 'canvas/get-canvas-keyframe-easing-change',
- 'canvas/get-canvas-keyframe-settings',
- 'canvas/get-canvas-keyframe-settings-change',
- 'canvas/get-canvas-keyframe-change-override',
- 'canvas/get-canvas-prop-value-at-frame',
- 'canvas/get-canvas-keyframe-source-frame',
- 'canvas/get-canvas-keyframe-display-frame',
+ sdkSidebar: [
+ {
+ type: 'category',
+ label: '@remotion/sdk',
+ link: {
+ type: 'doc',
+ id: 'sdk/index',
+ },
+ items: [
+ 'sdk/canvas',
+ 'sdk/create-canvas-controller',
+ 'sdk/use-canvas-controller',
+ 'sdk/create-canvas-selection-controller',
+ 'sdk/create-canvas-hover-controller',
+ 'sdk/use-canvas-selection',
+ 'sdk/use-canvas-sequence-hover',
+ 'sdk/use-canvas-hover',
+ 'sdk/get-canvas-sequence-node-path-info',
+ 'sdk/get-canvas-sequence-source-location',
+ 'sdk/get-canvas-selection-item-key',
+ 'sdk/get-canvas-keyframes',
+ 'sdk/get-canvas-keyframe-toggle',
+ 'sdk/start-canvas-keyframe-drag',
+ 'sdk/get-canvas-keyframe-easing-segments',
+ 'sdk/get-canvas-keyframe-easing-change',
+ 'sdk/get-canvas-keyframe-settings',
+ 'sdk/get-canvas-keyframe-settings-change',
+ 'sdk/get-canvas-keyframe-change-override',
+ 'sdk/get-canvas-prop-value-at-frame',
+ 'sdk/get-canvas-keyframe-source-frame',
+ 'sdk/get-canvas-keyframe-display-frame',
],
},
],
diff --git a/packages/docs/src/data/articles.ts b/packages/docs/src/data/articles.ts
index 5f073cb6f2..a7cd5deba7 100644
--- a/packages/docs/src/data/articles.ts
+++ b/packages/docs/src/data/articles.ts
@@ -640,211 +640,211 @@ export const articles = [
slug: 'canvas-capture/installation',
},
{
- id: 'canvas/canvas',
+ id: 'sdk/canvas',
title: '<Canvas>',
- relativePath: 'docs/canvas/canvas.mdx',
- compId: 'articles-docs-canvas-canvas',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/canvas.mdx',
+ compId: 'articles-docs-sdk-canvas',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/canvas',
+ slug: 'sdk/canvas',
},
{
- id: 'canvas/create-canvas-controller',
+ id: 'sdk/create-canvas-controller',
title: 'createCanvasController()',
- relativePath: 'docs/canvas/create-canvas-controller.mdx',
- compId: 'articles-docs-canvas-create-canvas-controller',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/create-canvas-controller.mdx',
+ compId: 'articles-docs-sdk-create-canvas-controller',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/create-canvas-controller',
+ slug: 'sdk/create-canvas-controller',
},
{
- id: 'canvas/create-canvas-hover-controller',
+ id: 'sdk/create-canvas-hover-controller',
title: 'createCanvasHoverController()',
- relativePath: 'docs/canvas/create-canvas-hover-controller.mdx',
- compId: 'articles-docs-canvas-create-canvas-hover-controller',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/create-canvas-hover-controller.mdx',
+ compId: 'articles-docs-sdk-create-canvas-hover-controller',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/create-canvas-hover-controller',
+ slug: 'sdk/create-canvas-hover-controller',
},
{
- id: 'canvas/create-canvas-selection-controller',
+ id: 'sdk/create-canvas-selection-controller',
title: 'createCanvasSelectionController()',
- relativePath: 'docs/canvas/create-canvas-selection-controller.mdx',
- compId: 'articles-docs-canvas-create-canvas-selection-controller',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/create-canvas-selection-controller.mdx',
+ compId: 'articles-docs-sdk-create-canvas-selection-controller',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/create-canvas-selection-controller',
+ slug: 'sdk/create-canvas-selection-controller',
},
{
- id: 'canvas/get-canvas-keyframe-change-override',
+ id: 'sdk/get-canvas-keyframe-change-override',
title: 'getCanvasKeyframeChangeOverride()',
- relativePath: 'docs/canvas/get-canvas-keyframe-change-override.mdx',
- compId: 'articles-docs-canvas-get-canvas-keyframe-change-override',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/get-canvas-keyframe-change-override.mdx',
+ compId: 'articles-docs-sdk-get-canvas-keyframe-change-override',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/get-canvas-keyframe-change-override',
+ slug: 'sdk/get-canvas-keyframe-change-override',
},
{
- id: 'canvas/get-canvas-keyframe-display-frame',
+ id: 'sdk/get-canvas-keyframe-display-frame',
title: 'getCanvasKeyframeDisplayFrame()',
- relativePath: 'docs/canvas/get-canvas-keyframe-display-frame.mdx',
- compId: 'articles-docs-canvas-get-canvas-keyframe-display-frame',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/get-canvas-keyframe-display-frame.mdx',
+ compId: 'articles-docs-sdk-get-canvas-keyframe-display-frame',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/get-canvas-keyframe-display-frame',
+ slug: 'sdk/get-canvas-keyframe-display-frame',
},
{
- id: 'canvas/get-canvas-keyframe-easing-change',
+ id: 'sdk/get-canvas-keyframe-easing-change',
title: 'getCanvasKeyframeEasingChange()',
- relativePath: 'docs/canvas/get-canvas-keyframe-easing-change.mdx',
- compId: 'articles-docs-canvas-get-canvas-keyframe-easing-change',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/get-canvas-keyframe-easing-change.mdx',
+ compId: 'articles-docs-sdk-get-canvas-keyframe-easing-change',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/get-canvas-keyframe-easing-change',
+ slug: 'sdk/get-canvas-keyframe-easing-change',
},
{
- id: 'canvas/get-canvas-keyframe-easing-segments',
+ id: 'sdk/get-canvas-keyframe-easing-segments',
title: 'getCanvasKeyframeEasingSegments()',
- relativePath: 'docs/canvas/get-canvas-keyframe-easing-segments.mdx',
- compId: 'articles-docs-canvas-get-canvas-keyframe-easing-segments',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/get-canvas-keyframe-easing-segments.mdx',
+ compId: 'articles-docs-sdk-get-canvas-keyframe-easing-segments',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/get-canvas-keyframe-easing-segments',
+ slug: 'sdk/get-canvas-keyframe-easing-segments',
},
{
- id: 'canvas/get-canvas-keyframe-settings-change',
+ id: 'sdk/get-canvas-keyframe-settings-change',
title: 'getCanvasKeyframeSettingsChange()',
- relativePath: 'docs/canvas/get-canvas-keyframe-settings-change.mdx',
- compId: 'articles-docs-canvas-get-canvas-keyframe-settings-change',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/get-canvas-keyframe-settings-change.mdx',
+ compId: 'articles-docs-sdk-get-canvas-keyframe-settings-change',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/get-canvas-keyframe-settings-change',
+ slug: 'sdk/get-canvas-keyframe-settings-change',
},
{
- id: 'canvas/get-canvas-keyframe-settings',
+ id: 'sdk/get-canvas-keyframe-settings',
title: 'getCanvasKeyframeSettings()',
- relativePath: 'docs/canvas/get-canvas-keyframe-settings.mdx',
- compId: 'articles-docs-canvas-get-canvas-keyframe-settings',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/get-canvas-keyframe-settings.mdx',
+ compId: 'articles-docs-sdk-get-canvas-keyframe-settings',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/get-canvas-keyframe-settings',
+ slug: 'sdk/get-canvas-keyframe-settings',
},
{
- id: 'canvas/get-canvas-keyframe-source-frame',
+ id: 'sdk/get-canvas-keyframe-source-frame',
title: 'getCanvasKeyframeSourceFrame()',
- relativePath: 'docs/canvas/get-canvas-keyframe-source-frame.mdx',
- compId: 'articles-docs-canvas-get-canvas-keyframe-source-frame',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/get-canvas-keyframe-source-frame.mdx',
+ compId: 'articles-docs-sdk-get-canvas-keyframe-source-frame',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/get-canvas-keyframe-source-frame',
+ slug: 'sdk/get-canvas-keyframe-source-frame',
},
{
- id: 'canvas/get-canvas-keyframe-toggle',
+ id: 'sdk/get-canvas-keyframe-toggle',
title: 'getCanvasKeyframeToggle()',
- relativePath: 'docs/canvas/get-canvas-keyframe-toggle.mdx',
- compId: 'articles-docs-canvas-get-canvas-keyframe-toggle',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/get-canvas-keyframe-toggle.mdx',
+ compId: 'articles-docs-sdk-get-canvas-keyframe-toggle',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/get-canvas-keyframe-toggle',
+ slug: 'sdk/get-canvas-keyframe-toggle',
},
{
- id: 'canvas/get-canvas-keyframes',
+ id: 'sdk/get-canvas-keyframes',
title: 'getCanvasKeyframes()',
- relativePath: 'docs/canvas/get-canvas-keyframes.mdx',
- compId: 'articles-docs-canvas-get-canvas-keyframes',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/get-canvas-keyframes.mdx',
+ compId: 'articles-docs-sdk-get-canvas-keyframes',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/get-canvas-keyframes',
+ slug: 'sdk/get-canvas-keyframes',
},
{
- id: 'canvas/get-canvas-prop-value-at-frame',
+ id: 'sdk/get-canvas-prop-value-at-frame',
title: 'getCanvasPropValueAtFrame()',
- relativePath: 'docs/canvas/get-canvas-prop-value-at-frame.mdx',
- compId: 'articles-docs-canvas-get-canvas-prop-value-at-frame',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/get-canvas-prop-value-at-frame.mdx',
+ compId: 'articles-docs-sdk-get-canvas-prop-value-at-frame',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/get-canvas-prop-value-at-frame',
+ slug: 'sdk/get-canvas-prop-value-at-frame',
},
{
- id: 'canvas/get-canvas-selection-item-key',
+ id: 'sdk/get-canvas-selection-item-key',
title: 'getCanvasSelectionItemKey()',
- relativePath: 'docs/canvas/get-canvas-selection-item-key.mdx',
- compId: 'articles-docs-canvas-get-canvas-selection-item-key',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/get-canvas-selection-item-key.mdx',
+ compId: 'articles-docs-sdk-get-canvas-selection-item-key',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/get-canvas-selection-item-key',
+ slug: 'sdk/get-canvas-selection-item-key',
},
{
- id: 'canvas/get-canvas-sequence-node-path-info',
+ id: 'sdk/get-canvas-sequence-node-path-info',
title: 'getCanvasSequenceNodePathInfo()',
- relativePath: 'docs/canvas/get-canvas-sequence-node-path-info.mdx',
- compId: 'articles-docs-canvas-get-canvas-sequence-node-path-info',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/get-canvas-sequence-node-path-info.mdx',
+ compId: 'articles-docs-sdk-get-canvas-sequence-node-path-info',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/get-canvas-sequence-node-path-info',
+ slug: 'sdk/get-canvas-sequence-node-path-info',
},
{
- id: 'canvas/get-canvas-sequence-source-location',
+ id: 'sdk/get-canvas-sequence-source-location',
title: 'getCanvasSequenceSourceLocation()',
- relativePath: 'docs/canvas/get-canvas-sequence-source-location.mdx',
- compId: 'articles-docs-canvas-get-canvas-sequence-source-location',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/get-canvas-sequence-source-location.mdx',
+ compId: 'articles-docs-sdk-get-canvas-sequence-source-location',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/get-canvas-sequence-source-location',
+ slug: 'sdk/get-canvas-sequence-source-location',
},
{
- id: 'canvas/index',
- title: '@remotion/canvas',
- relativePath: 'docs/canvas/index.mdx',
- compId: 'articles-docs-canvas-index',
- crumb: '@remotion/canvas',
+ id: 'sdk/index',
+ title: '@remotion/sdk',
+ relativePath: 'docs/sdk/index.mdx',
+ compId: 'articles-docs-sdk-index',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/index',
+ slug: 'sdk/index',
},
{
- id: 'canvas/start-canvas-keyframe-drag',
+ id: 'sdk/start-canvas-keyframe-drag',
title: 'startCanvasKeyframeDrag()',
- relativePath: 'docs/canvas/start-canvas-keyframe-drag.mdx',
- compId: 'articles-docs-canvas-start-canvas-keyframe-drag',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/start-canvas-keyframe-drag.mdx',
+ compId: 'articles-docs-sdk-start-canvas-keyframe-drag',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/start-canvas-keyframe-drag',
+ slug: 'sdk/start-canvas-keyframe-drag',
},
{
- id: 'canvas/use-canvas-controller',
+ id: 'sdk/use-canvas-controller',
title: 'useCanvasController()',
- relativePath: 'docs/canvas/use-canvas-controller.mdx',
- compId: 'articles-docs-canvas-use-canvas-controller',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/use-canvas-controller.mdx',
+ compId: 'articles-docs-sdk-use-canvas-controller',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/use-canvas-controller',
+ slug: 'sdk/use-canvas-controller',
},
{
- id: 'canvas/use-canvas-hover',
+ id: 'sdk/use-canvas-hover',
title: 'useCanvasHover()',
- relativePath: 'docs/canvas/use-canvas-hover.mdx',
- compId: 'articles-docs-canvas-use-canvas-hover',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/use-canvas-hover.mdx',
+ compId: 'articles-docs-sdk-use-canvas-hover',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/use-canvas-hover',
+ slug: 'sdk/use-canvas-hover',
},
{
- id: 'canvas/use-canvas-selection',
+ id: 'sdk/use-canvas-selection',
title: 'useCanvasSelection()',
- relativePath: 'docs/canvas/use-canvas-selection.mdx',
- compId: 'articles-docs-canvas-use-canvas-selection',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/use-canvas-selection.mdx',
+ compId: 'articles-docs-sdk-use-canvas-selection',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/use-canvas-selection',
+ slug: 'sdk/use-canvas-selection',
},
{
- id: 'canvas/use-canvas-sequence-hover',
+ id: 'sdk/use-canvas-sequence-hover',
title: 'useCanvasSequenceHover()',
- relativePath: 'docs/canvas/use-canvas-sequence-hover.mdx',
- compId: 'articles-docs-canvas-use-canvas-sequence-hover',
- crumb: '@remotion/canvas',
+ relativePath: 'docs/sdk/use-canvas-sequence-hover.mdx',
+ compId: 'articles-docs-sdk-use-canvas-sequence-hover',
+ crumb: '@remotion/sdk',
noAi: false,
- slug: 'canvas/use-canvas-sequence-hover',
+ slug: 'sdk/use-canvas-sequence-hover',
},
{
id: 'canvasimage',
diff --git a/packages/docs/static/generated/articles-docs-canvas-canvas.png b/packages/docs/static/generated/articles-docs-canvas-canvas.png
deleted file mode 100644
index 0400acffe6..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-canvas.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-create-canvas-controller.png b/packages/docs/static/generated/articles-docs-canvas-create-canvas-controller.png
deleted file mode 100644
index 6b0def897d..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-create-canvas-controller.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-create-canvas-hover-controller.png b/packages/docs/static/generated/articles-docs-canvas-create-canvas-hover-controller.png
deleted file mode 100644
index 969c82f395..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-create-canvas-hover-controller.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-create-canvas-selection-controller.png b/packages/docs/static/generated/articles-docs-canvas-create-canvas-selection-controller.png
deleted file mode 100644
index 4e8f12c74b..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-create-canvas-selection-controller.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-change-override.png b/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-change-override.png
deleted file mode 100644
index fecee5aaab..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-change-override.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-display-frame.png b/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-display-frame.png
deleted file mode 100644
index 488e29f66d..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-display-frame.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-easing-change.png b/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-easing-change.png
deleted file mode 100644
index 9b03532bf9..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-easing-change.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-easing-segments.png b/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-easing-segments.png
deleted file mode 100644
index 3f54e849e6..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-easing-segments.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-settings-change.png b/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-settings-change.png
deleted file mode 100644
index ce358b827b..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-settings-change.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-settings.png b/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-settings.png
deleted file mode 100644
index a2cc0bc6fa..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-settings.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-source-frame.png b/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-source-frame.png
deleted file mode 100644
index 80eeb435c8..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-source-frame.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-toggle.png b/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-toggle.png
deleted file mode 100644
index b7767a21be..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframe-toggle.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframes.png b/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframes.png
deleted file mode 100644
index 59c1586f4b..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-get-canvas-keyframes.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-get-canvas-prop-value-at-frame.png b/packages/docs/static/generated/articles-docs-canvas-get-canvas-prop-value-at-frame.png
deleted file mode 100644
index 04e311fe12..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-get-canvas-prop-value-at-frame.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-get-canvas-selection-item-key.png b/packages/docs/static/generated/articles-docs-canvas-get-canvas-selection-item-key.png
deleted file mode 100644
index 0f18464f45..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-get-canvas-selection-item-key.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-get-canvas-sequence-node-path-info.png b/packages/docs/static/generated/articles-docs-canvas-get-canvas-sequence-node-path-info.png
deleted file mode 100644
index 6fff4a513f..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-get-canvas-sequence-node-path-info.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-get-canvas-sequence-source-location.png b/packages/docs/static/generated/articles-docs-canvas-get-canvas-sequence-source-location.png
deleted file mode 100644
index 00c83c145c..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-get-canvas-sequence-source-location.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-index.png b/packages/docs/static/generated/articles-docs-canvas-index.png
deleted file mode 100644
index 9ede7da51a..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-index.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-start-canvas-keyframe-drag.png b/packages/docs/static/generated/articles-docs-canvas-start-canvas-keyframe-drag.png
deleted file mode 100644
index a9fc3f742f..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-start-canvas-keyframe-drag.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-use-canvas-controller.png b/packages/docs/static/generated/articles-docs-canvas-use-canvas-controller.png
deleted file mode 100644
index bcccbec1ed..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-use-canvas-controller.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-use-canvas-hover.png b/packages/docs/static/generated/articles-docs-canvas-use-canvas-hover.png
deleted file mode 100644
index 6d2eedb6e8..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-use-canvas-hover.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-use-canvas-selection.png b/packages/docs/static/generated/articles-docs-canvas-use-canvas-selection.png
deleted file mode 100644
index 382a3b8bed..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-use-canvas-selection.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-canvas-use-canvas-sequence-hover.png b/packages/docs/static/generated/articles-docs-canvas-use-canvas-sequence-hover.png
deleted file mode 100644
index 746af5e57a..0000000000
Binary files a/packages/docs/static/generated/articles-docs-canvas-use-canvas-sequence-hover.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-canvas.png b/packages/docs/static/generated/articles-docs-sdk-canvas.png
new file mode 100644
index 0000000000..72092f401a
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-canvas.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-create-canvas-controller.png b/packages/docs/static/generated/articles-docs-sdk-create-canvas-controller.png
new file mode 100644
index 0000000000..91aa27d7e3
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-create-canvas-controller.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-create-canvas-hover-controller.png b/packages/docs/static/generated/articles-docs-sdk-create-canvas-hover-controller.png
new file mode 100644
index 0000000000..afbe0e347c
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-create-canvas-hover-controller.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-create-canvas-selection-controller.png b/packages/docs/static/generated/articles-docs-sdk-create-canvas-selection-controller.png
new file mode 100644
index 0000000000..196b0499f6
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-create-canvas-selection-controller.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-change-override.png b/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-change-override.png
new file mode 100644
index 0000000000..e813503370
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-change-override.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-display-frame.png b/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-display-frame.png
new file mode 100644
index 0000000000..d745e9b509
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-display-frame.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-easing-change.png b/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-easing-change.png
new file mode 100644
index 0000000000..fd514cd682
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-easing-change.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-easing-segments.png b/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-easing-segments.png
new file mode 100644
index 0000000000..7251b69a0e
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-easing-segments.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-settings-change.png b/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-settings-change.png
new file mode 100644
index 0000000000..6e2e9c0dc9
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-settings-change.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-settings.png b/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-settings.png
new file mode 100644
index 0000000000..629e13f960
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-settings.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-source-frame.png b/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-source-frame.png
new file mode 100644
index 0000000000..0681ac3a53
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-source-frame.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-toggle.png b/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-toggle.png
new file mode 100644
index 0000000000..a55e936a00
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframe-toggle.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframes.png b/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframes.png
new file mode 100644
index 0000000000..b58d86b3e5
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-get-canvas-keyframes.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-get-canvas-prop-value-at-frame.png b/packages/docs/static/generated/articles-docs-sdk-get-canvas-prop-value-at-frame.png
new file mode 100644
index 0000000000..1bc1f1b8e3
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-get-canvas-prop-value-at-frame.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-get-canvas-selection-item-key.png b/packages/docs/static/generated/articles-docs-sdk-get-canvas-selection-item-key.png
new file mode 100644
index 0000000000..5eaaa73310
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-get-canvas-selection-item-key.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-get-canvas-sequence-node-path-info.png b/packages/docs/static/generated/articles-docs-sdk-get-canvas-sequence-node-path-info.png
new file mode 100644
index 0000000000..443be623cb
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-get-canvas-sequence-node-path-info.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-get-canvas-sequence-source-location.png b/packages/docs/static/generated/articles-docs-sdk-get-canvas-sequence-source-location.png
new file mode 100644
index 0000000000..acfafe509b
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-get-canvas-sequence-source-location.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-index.png b/packages/docs/static/generated/articles-docs-sdk-index.png
new file mode 100644
index 0000000000..ba026c0c5a
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-index.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-start-canvas-keyframe-drag.png b/packages/docs/static/generated/articles-docs-sdk-start-canvas-keyframe-drag.png
new file mode 100644
index 0000000000..ed9091d457
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-start-canvas-keyframe-drag.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-use-canvas-controller.png b/packages/docs/static/generated/articles-docs-sdk-use-canvas-controller.png
new file mode 100644
index 0000000000..37e03323c4
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-use-canvas-controller.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-use-canvas-hover.png b/packages/docs/static/generated/articles-docs-sdk-use-canvas-hover.png
new file mode 100644
index 0000000000..e613a34fb3
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-use-canvas-hover.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-use-canvas-selection.png b/packages/docs/static/generated/articles-docs-sdk-use-canvas-selection.png
new file mode 100644
index 0000000000..ee126e5fb0
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-use-canvas-selection.png differ
diff --git a/packages/docs/static/generated/articles-docs-sdk-use-canvas-sequence-hover.png b/packages/docs/static/generated/articles-docs-sdk-use-canvas-sequence-hover.png
new file mode 100644
index 0000000000..0d6e9805a3
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-sdk-use-canvas-sequence-hover.png differ
diff --git a/packages/docusaurus-plugin/src/twoslash-cache.ts b/packages/docusaurus-plugin/src/twoslash-cache.ts
index b61108cdd0..2dba1e891a 100644
--- a/packages/docusaurus-plugin/src/twoslash-cache.ts
+++ b/packages/docusaurus-plugin/src/twoslash-cache.ts
@@ -117,7 +117,7 @@ const getRepositoryRoot = (docsRoot: string): string => {
);
};
-const getTrackedPackageJsonFiles = (repositoryRoot: string): string[] => {
+const getWorkspacePackageJsonFiles = (repositoryRoot: string): string[] => {
try {
const output = execFileSync(
'git',
@@ -126,13 +126,20 @@ const getTrackedPackageJsonFiles = (repositoryRoot: string): string[] => {
repositoryRoot,
'ls-files',
'-z',
+ '--cached',
+ '--others',
+ '--exclude-standard',
'--',
':(glob)packages/**/package.json',
],
{encoding: 'buffer', maxBuffer: 10 * 1024 * 1024},
);
- return output.toString('utf8').split('\0').filter(Boolean).sort();
+ return output
+ .toString('utf8')
+ .split('\0')
+ .filter((path) => path && existsSync(join(repositoryRoot, path)))
+ .sort();
} catch {
return [];
}
@@ -206,7 +213,7 @@ const getTwoslashWorkspacePackages = (
const repositoryRoot = getRepositoryRoot(docsRoot);
const packages: Record<string, TwoslashWorkspacePackage> = {};
- for (const relativePackageJsonPath of getTrackedPackageJsonFiles(
+ for (const relativePackageJsonPath of getWorkspacePackageJsonFiles(
repositoryRoot,
)) {
const packageJsonPath = join(repositoryRoot, relativePackageJsonPath);
diff --git a/packages/canvas/.npmignore b/packages/sdk/.npmignore
similarity index 100%
rename from packages/canvas/.npmignore
rename to packages/sdk/.npmignore
diff --git a/packages/canvas/README.md b/packages/sdk/README.md
similarity index 50%
rename from packages/canvas/README.md
rename to packages/sdk/README.md
index f32ad2a9f5..26e9f2bf64 100644
--- a/packages/canvas/README.md
+++ b/packages/sdk/README.md
@@ -1,13 +1,13 @@
-# @remotion/canvas
+# @remotion/sdk
Experimental primitives for building Remotion authoring interfaces
-[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/canvas.svg?style=flat&color=black&label=Downloads)](https://npmcharts.com/compare/@remotion/canvas?minimal=true)
+[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/sdk.svg?style=flat&color=black&label=Downloads)](https://npmcharts.com/compare/@remotion/sdk?minimal=true)
## Installation
```bash
-npm install @remotion/canvas --save-exact
+npm install @remotion/sdk --save-exact
```
When installing a Remotion package, make sure to align the version of all `remotion` and `@remotion/*` packages to the same version.
@@ -15,4 +15,4 @@ Remove the `^` character from the version number to use the exact version.
## Usage
-See the [documentation](https://www.remotion.dev/docs/canvas) for more information.
+See the [documentation](https://www.remotion.dev/docs/sdk) for more information.
diff --git a/packages/canvas/bundle.ts b/packages/sdk/bundle.ts
similarity index 100%
rename from packages/canvas/bundle.ts
rename to packages/sdk/bundle.ts
diff --git a/packages/canvas/bunfig.toml b/packages/sdk/bunfig.toml
similarity index 100%
rename from packages/canvas/bunfig.toml
rename to packages/sdk/bunfig.toml
diff --git a/packages/canvas/eslint.config.mjs b/packages/sdk/eslint.config.mjs
similarity index 100%
rename from packages/canvas/eslint.config.mjs
rename to packages/sdk/eslint.config.mjs
diff --git a/packages/canvas/happydom.ts b/packages/sdk/happydom.ts
similarity index 100%
rename from packages/canvas/happydom.ts
rename to packages/sdk/happydom.ts
diff --git a/packages/canvas/package.json b/packages/sdk/package.json
similarity index 94%
rename from packages/canvas/package.json
rename to packages/sdk/package.json
index 506f1cee6a..22c2fd52cd 100644
--- a/packages/canvas/package.json
+++ b/packages/sdk/package.json
@@ -1,8 +1,8 @@
{
"repository": {
- "url": "https://github.com/remotion-dev/remotion/tree/main/packages/canvas"
+ "url": "https://github.com/remotion-dev/remotion/tree/main/packages/sdk"
},
- "name": "@remotion/canvas",
+ "name": "@remotion/sdk",
"version": "4.0.530",
"description": "Experimental primitives for building Remotion authoring interfaces",
"main": "dist/index.cjs",
@@ -58,5 +58,5 @@
"publishConfig": {
"access": "public"
},
- "homepage": "https://www.remotion.dev/docs/canvas"
+ "homepage": "https://www.remotion.dev/docs/sdk"
}
diff --git a/packages/canvas/src/calculate-timeline.ts b/packages/sdk/src/calculate-timeline.ts
similarity index 100%
rename from packages/canvas/src/calculate-timeline.ts
rename to packages/sdk/src/calculate-timeline.ts
diff --git a/packages/canvas/src/canvas-controller.ts b/packages/sdk/src/canvas-controller.ts
similarity index 100%
rename from packages/canvas/src/canvas-controller.ts
rename to packages/sdk/src/canvas-controller.ts
diff --git a/packages/canvas/src/canvas-internals.ts b/packages/sdk/src/canvas-internals.ts
similarity index 100%
rename from packages/canvas/src/canvas-internals.ts
rename to packages/sdk/src/canvas-internals.ts
diff --git a/packages/canvas/src/canvas-outline-overlay.tsx b/packages/sdk/src/canvas-outline-overlay.tsx
similarity index 100%
rename from packages/canvas/src/canvas-outline-overlay.tsx
rename to packages/sdk/src/canvas-outline-overlay.tsx
diff --git a/packages/canvas/src/canvas-outline-polygon.tsx b/packages/sdk/src/canvas-outline-polygon.tsx
similarity index 100%
rename from packages/canvas/src/canvas-outline-polygon.tsx
rename to packages/sdk/src/canvas-outline-polygon.tsx
diff --git a/packages/canvas/src/canvas-outline-snap-lines.tsx b/packages/sdk/src/canvas-outline-snap-lines.tsx
similarity index 100%
rename from packages/canvas/src/canvas-outline-snap-lines.tsx
rename to packages/sdk/src/canvas-outline-snap-lines.tsx
diff --git a/packages/canvas/src/canvas.tsx b/packages/sdk/src/canvas.tsx
similarity index 100%
rename from packages/canvas/src/canvas.tsx
rename to packages/sdk/src/canvas.tsx
diff --git a/packages/canvas/src/get-box-quads-polyfill-internals.js b/packages/sdk/src/get-box-quads-polyfill-internals.js
similarity index 100%
rename from packages/canvas/src/get-box-quads-polyfill-internals.js
rename to packages/sdk/src/get-box-quads-polyfill-internals.js
diff --git a/packages/canvas/src/get-box-quads-ponyfill.ts b/packages/sdk/src/get-box-quads-ponyfill.ts
similarity index 100%
rename from packages/canvas/src/get-box-quads-ponyfill.ts
rename to packages/sdk/src/get-box-quads-ponyfill.ts
diff --git a/packages/canvas/src/get-connected-compositions.ts b/packages/sdk/src/get-connected-compositions.ts
similarity index 100%
rename from packages/canvas/src/get-connected-compositions.ts
rename to packages/sdk/src/get-connected-compositions.ts
diff --git a/packages/canvas/src/get-sequence-visible-range.ts b/packages/sdk/src/get-sequence-visible-range.ts
similarity index 100%
rename from packages/canvas/src/get-sequence-visible-range.ts
rename to packages/sdk/src/get-sequence-visible-range.ts
diff --git a/packages/canvas/src/get-timeline-nestedness.ts b/packages/sdk/src/get-timeline-nestedness.ts
similarity index 100%
rename from packages/canvas/src/get-timeline-nestedness.ts
rename to packages/sdk/src/get-timeline-nestedness.ts
diff --git a/packages/canvas/src/get-timeline-sequence-sort-key.ts b/packages/sdk/src/get-timeline-sequence-sort-key.ts
similarity index 100%
rename from packages/canvas/src/get-timeline-sequence-sort-key.ts
rename to packages/sdk/src/get-timeline-sequence-sort-key.ts
diff --git a/packages/canvas/src/hover.ts b/packages/sdk/src/hover.ts
similarity index 100%
rename from packages/canvas/src/hover.ts
rename to packages/sdk/src/hover.ts
diff --git a/packages/canvas/src/index.ts b/packages/sdk/src/index.ts
similarity index 100%
rename from packages/canvas/src/index.ts
rename to packages/sdk/src/index.ts
diff --git a/packages/canvas/src/install-fiber-sequence-order-observer.ts b/packages/sdk/src/install-fiber-sequence-order-observer.ts
similarity index 100%
rename from packages/canvas/src/install-fiber-sequence-order-observer.ts
rename to packages/sdk/src/install-fiber-sequence-order-observer.ts
diff --git a/packages/canvas/src/keyframe-drag.ts b/packages/sdk/src/keyframe-drag.ts
similarity index 100%
rename from packages/canvas/src/keyframe-drag.ts
rename to packages/sdk/src/keyframe-drag.ts
diff --git a/packages/canvas/src/keyframe-easing.ts b/packages/sdk/src/keyframe-easing.ts
similarity index 100%
rename from packages/canvas/src/keyframe-easing.ts
rename to packages/sdk/src/keyframe-easing.ts
diff --git a/packages/canvas/src/keyframe-frames.ts b/packages/sdk/src/keyframe-frames.ts
similarity index 100%
rename from packages/canvas/src/keyframe-frames.ts
rename to packages/sdk/src/keyframe-frames.ts
diff --git a/packages/canvas/src/keyframe-move.ts b/packages/sdk/src/keyframe-move.ts
similarity index 100%
rename from packages/canvas/src/keyframe-move.ts
rename to packages/sdk/src/keyframe-move.ts
diff --git a/packages/canvas/src/keyframe-navigation.ts b/packages/sdk/src/keyframe-navigation.ts
similarity index 100%
rename from packages/canvas/src/keyframe-navigation.ts
rename to packages/sdk/src/keyframe-navigation.ts
diff --git a/packages/canvas/src/keyframe-override.ts b/packages/sdk/src/keyframe-override.ts
similarity index 100%
rename from packages/canvas/src/keyframe-override.ts
rename to packages/sdk/src/keyframe-override.ts
diff --git a/packages/canvas/src/keyframe-settings.ts b/packages/sdk/src/keyframe-settings.ts
similarity index 100%
rename from packages/canvas/src/keyframe-settings.ts
rename to packages/sdk/src/keyframe-settings.ts
diff --git a/packages/canvas/src/keyframe-value.ts b/packages/sdk/src/keyframe-value.ts
similarity index 100%
rename from packages/canvas/src/keyframe-value.ts
rename to packages/sdk/src/keyframe-value.ts
diff --git a/packages/canvas/src/keyframes.ts b/packages/sdk/src/keyframes.ts
similarity index 100%
rename from packages/canvas/src/keyframes.ts
rename to packages/sdk/src/keyframes.ts
diff --git a/packages/canvas/src/outline-geometry.ts b/packages/sdk/src/outline-geometry.ts
similarity index 100%
rename from packages/canvas/src/outline-geometry.ts
rename to packages/sdk/src/outline-geometry.ts
diff --git a/packages/canvas/src/outline-interaction.ts b/packages/sdk/src/outline-interaction.ts
similarity index 100%
rename from packages/canvas/src/outline-interaction.ts
rename to packages/sdk/src/outline-interaction.ts
diff --git a/packages/canvas/src/outline-measurement.ts b/packages/sdk/src/outline-measurement.ts
similarity index 100%
rename from packages/canvas/src/outline-measurement.ts
rename to packages/sdk/src/outline-measurement.ts
diff --git a/packages/canvas/src/outline-nodes.ts b/packages/sdk/src/outline-nodes.ts
similarity index 100%
rename from packages/canvas/src/outline-nodes.ts
rename to packages/sdk/src/outline-nodes.ts
diff --git a/packages/canvas/src/outline-order.ts b/packages/sdk/src/outline-order.ts
similarity index 100%
rename from packages/canvas/src/outline-order.ts
rename to packages/sdk/src/outline-order.ts
diff --git a/packages/canvas/src/outline-snap.ts b/packages/sdk/src/outline-snap.ts
similarity index 100%
rename from packages/canvas/src/outline-snap.ts
rename to packages/sdk/src/outline-snap.ts
diff --git a/packages/canvas/src/outline-targets.ts b/packages/sdk/src/outline-targets.ts
similarity index 100%
rename from packages/canvas/src/outline-targets.ts
rename to packages/sdk/src/outline-targets.ts
diff --git a/packages/canvas/src/outline-translate-drag.ts b/packages/sdk/src/outline-translate-drag.ts
similarity index 100%
rename from packages/canvas/src/outline-translate-drag.ts
rename to packages/sdk/src/outline-translate-drag.ts
diff --git a/packages/canvas/src/pointer-session.ts b/packages/sdk/src/pointer-session.ts
similarity index 100%
rename from packages/canvas/src/pointer-session.ts
rename to packages/sdk/src/pointer-session.ts
diff --git a/packages/canvas/src/selection.ts b/packages/sdk/src/selection.ts
similarity index 100%
rename from packages/canvas/src/selection.ts
rename to packages/sdk/src/selection.ts
diff --git a/packages/canvas/src/sequence-node-path-remapping.ts b/packages/sdk/src/sequence-node-path-remapping.ts
similarity index 100%
rename from packages/canvas/src/sequence-node-path-remapping.ts
rename to packages/sdk/src/sequence-node-path-remapping.ts
diff --git a/packages/canvas/src/sequence-node-path.ts b/packages/sdk/src/sequence-node-path.ts
similarity index 100%
rename from packages/canvas/src/sequence-node-path.ts
rename to packages/sdk/src/sequence-node-path.ts
diff --git a/packages/canvas/src/sequence-props-change.ts b/packages/sdk/src/sequence-props-change.ts
similarity index 100%
rename from packages/canvas/src/sequence-props-change.ts
rename to packages/sdk/src/sequence-props-change.ts
diff --git a/packages/canvas/src/sort-by-commit-order.ts b/packages/sdk/src/sort-by-commit-order.ts
similarity index 100%
rename from packages/canvas/src/sort-by-commit-order.ts
rename to packages/sdk/src/sort-by-commit-order.ts
diff --git a/packages/canvas/src/test/calculate-timeline.test.ts b/packages/sdk/src/test/calculate-timeline.test.ts
similarity index 100%
rename from packages/canvas/src/test/calculate-timeline.test.ts
rename to packages/sdk/src/test/calculate-timeline.test.ts
diff --git a/packages/canvas/src/test/canvas.test.tsx b/packages/sdk/src/test/canvas.test.tsx
similarity index 100%
rename from packages/canvas/src/test/canvas.test.tsx
rename to packages/sdk/src/test/canvas.test.tsx
diff --git a/packages/canvas/src/test/connected-compositions.test.ts b/packages/sdk/src/test/connected-compositions.test.ts
similarity index 100%
rename from packages/canvas/src/test/connected-compositions.test.ts
rename to packages/sdk/src/test/connected-compositions.test.ts
diff --git a/packages/canvas/src/test/keyframe-easing.test.ts b/packages/sdk/src/test/keyframe-easing.test.ts
similarity index 100%
rename from packages/canvas/src/test/keyframe-easing.test.ts
rename to packages/sdk/src/test/keyframe-easing.test.ts
diff --git a/packages/canvas/src/test/keyframe-move.test.ts b/packages/sdk/src/test/keyframe-move.test.ts
similarity index 100%
rename from packages/canvas/src/test/keyframe-move.test.ts
rename to packages/sdk/src/test/keyframe-move.test.ts
diff --git a/packages/canvas/src/test/keyframe-navigation.test.ts b/packages/sdk/src/test/keyframe-navigation.test.ts
similarity index 100%
rename from packages/canvas/src/test/keyframe-navigation.test.ts
rename to packages/sdk/src/test/keyframe-navigation.test.ts
diff --git a/packages/canvas/src/test/normalize-font-weight-for-keyframe.test.ts b/packages/sdk/src/test/normalize-font-weight-for-keyframe.test.ts
similarity index 100%
rename from packages/canvas/src/test/normalize-font-weight-for-keyframe.test.ts
rename to packages/sdk/src/test/normalize-font-weight-for-keyframe.test.ts
diff --git a/packages/canvas/src/test/outline-snap.test.ts b/packages/sdk/src/test/outline-snap.test.ts
similarity index 100%
rename from packages/canvas/src/test/outline-snap.test.ts
rename to packages/sdk/src/test/outline-snap.test.ts
diff --git a/packages/canvas/src/test/outline-translate-drag.test.ts b/packages/sdk/src/test/outline-translate-drag.test.ts
similarity index 100%
rename from packages/canvas/src/test/outline-translate-drag.test.ts
rename to packages/sdk/src/test/outline-translate-drag.test.ts
diff --git a/packages/canvas/src/test/pointer-session.test.ts b/packages/sdk/src/test/pointer-session.test.ts
similarity index 100%
rename from packages/canvas/src/test/pointer-session.test.ts
rename to packages/sdk/src/test/pointer-session.test.ts
diff --git a/packages/canvas/src/test/selection.test.ts b/packages/sdk/src/test/selection.test.ts
similarity index 100%
rename from packages/canvas/src/test/selection.test.ts
rename to packages/sdk/src/test/selection.test.ts
diff --git a/packages/canvas/src/test/sort-by-commit-order.test.ts b/packages/sdk/src/test/sort-by-commit-order.test.ts
similarity index 100%
rename from packages/canvas/src/test/sort-by-commit-order.test.ts
rename to packages/sdk/src/test/sort-by-commit-order.test.ts
diff --git a/packages/canvas/src/test/translate-value.test.ts b/packages/sdk/src/test/translate-value.test.ts
similarity index 100%
rename from packages/canvas/src/test/translate-value.test.ts
rename to packages/sdk/src/test/translate-value.test.ts
diff --git a/packages/canvas/src/timeline-sequence-node-path-to-key.ts b/packages/sdk/src/timeline-sequence-node-path-to-key.ts
similarity index 100%
rename from packages/canvas/src/timeline-sequence-node-path-to-key.ts
rename to packages/sdk/src/timeline-sequence-node-path-to-key.ts
diff --git a/packages/canvas/src/translate-value.ts b/packages/sdk/src/translate-value.ts
similarity index 100%
rename from packages/canvas/src/translate-value.ts
rename to packages/sdk/src/translate-value.ts
diff --git a/packages/canvas/src/use-canvas-outline-measurements.ts b/packages/sdk/src/use-canvas-outline-measurements.ts
similarity index 100%
rename from packages/canvas/src/use-canvas-outline-measurements.ts
rename to packages/sdk/src/use-canvas-outline-measurements.ts
diff --git a/packages/canvas/src/use-canvas-outlines.ts b/packages/sdk/src/use-canvas-outlines.ts
similarity index 100%
rename from packages/canvas/src/use-canvas-outlines.ts
rename to packages/sdk/src/use-canvas-outlines.ts
diff --git a/packages/canvas/src/use-runtime-value-snapshots.ts b/packages/sdk/src/use-runtime-value-snapshots.ts
similarity index 100%
rename from packages/canvas/src/use-runtime-value-snapshots.ts
rename to packages/sdk/src/use-runtime-value-snapshots.ts
diff --git a/packages/canvas/src/use-sync-external-store.ts b/packages/sdk/src/use-sync-external-store.ts
similarity index 100%
rename from packages/canvas/src/use-sync-external-store.ts
rename to packages/sdk/src/use-sync-external-store.ts
diff --git a/packages/canvas/tsconfig.json b/packages/sdk/tsconfig.json
similarity index 100%
rename from packages/canvas/tsconfig.json
rename to packages/sdk/tsconfig.json
diff --git a/packages/studio-shared/src/package-info.ts b/packages/studio-shared/src/package-info.ts
index 2972596969..499b034b17 100644
--- a/packages/studio-shared/src/package-info.ts
+++ b/packages/studio-shared/src/package-info.ts
@@ -12,7 +12,7 @@ const allPackages = [
'bundler',
'browser-bundler',
'browser-studio',
- 'canvas',
+ 'sdk',
'claude-code-plugin',
'cli',
'cloudrun',
@@ -189,7 +189,7 @@ export const descriptions: {[key in Pkgs]: string | null} = {
bundler: 'Bundle Remotion compositions using Webpack',
'browser-bundler': 'Compile virtual Remotion projects in the browser',
'browser-studio': 'Run Remotion Studio in the browser',
- canvas: 'Experimental primitives for building Remotion authoring interfaces',
+ sdk: 'Experimental primitives for building Remotion authoring interfaces',
codemods: 'Codemods for Remotion projects',
'studio-server': 'Run a Remotion Studio with a server backend',
'install-whisper-cpp': 'Helpers for installing and using Whisper.cpp',
@@ -303,7 +303,7 @@ export const installableMap: {[key in Pkgs]: boolean} = {
bundler: false,
'browser-bundler': false,
'browser-studio': false,
- canvas: false,
+ sdk: false,
cli: false,
cloudrun: true,
'claude-code-plugin': false,
@@ -431,7 +431,7 @@ export const apiDocs: {[key in Pkgs]: string | null} = {
bundler: 'https://www.remotion.dev/docs/bundler',
'browser-bundler': 'https://www.remotion.dev/docs/browser-bundler',
'browser-studio': null,
- canvas: 'https://www.remotion.dev/docs/canvas',
+ sdk: 'https://www.remotion.dev/docs/sdk',
codemods: 'https://www.remotion.dev/docs/codemods',
'lambda-client': null,
'serverless-client': null,
diff --git a/packages/studio/bundle.ts b/packages/studio/bundle.ts
index f0fc881340..c138dc728b 100644
--- a/packages/studio/bundle.ts
+++ b/packages/studio/bundle.ts
@@ -3,7 +3,7 @@ import {buildPackage} from '../.monorepo/builder';
const external = [
'react',
'remotion',
- '@remotion/canvas',
+ '@remotion/sdk',
'react-dom',
'react',
'@remotion/media-utils',
diff --git a/packages/studio/package.json b/packages/studio/package.json
index a83fbb403b..a77494ca40 100644
--- a/packages/studio/package.json
+++ b/packages/studio/package.json
@@ -35,7 +35,7 @@
},
"dependencies": {
"@jridgewell/trace-mapping": "0.3.31",
- "@remotion/canvas": "workspace:*",
+ "@remotion/sdk": "workspace:*",
"@remotion/captions": "workspace:*",
"@remotion/elevenlabs": "workspace:*",
"@remotion/openai-whisper": "workspace:*",
diff --git a/packages/studio/src/components/InspectorPanel/KeyframeInspector.tsx b/packages/studio/src/components/InspectorPanel/KeyframeInspector.tsx
index a9fa6e8063..24ee1dc32d 100644
--- a/packages/studio/src/components/InspectorPanel/KeyframeInspector.tsx
+++ b/packages/studio/src/components/InspectorPanel/KeyframeInspector.tsx
@@ -1,4 +1,4 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
import {
canMoveKeyframesWithoutCollisions,
moveKeyframesInPropStatus,
diff --git a/packages/studio/src/components/InspectorPanel/KeyframeSettings.tsx b/packages/studio/src/components/InspectorPanel/KeyframeSettings.tsx
index 3bd41c8947..4930250944 100644
--- a/packages/studio/src/components/InspectorPanel/KeyframeSettings.tsx
+++ b/packages/studio/src/components/InspectorPanel/KeyframeSettings.tsx
@@ -2,7 +2,7 @@ import {
getCanvasKeyframeSettings,
getCanvasKeyframeSettingsChange,
type CanvasKeyframeSettings,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
import React, {
useCallback,
useContext,
diff --git a/packages/studio/src/components/NewComposition/NewComposition.tsx b/packages/studio/src/components/NewComposition/NewComposition.tsx
index 97434f0313..6aee3189e1 100644
--- a/packages/studio/src/components/NewComposition/NewComposition.tsx
+++ b/packages/studio/src/components/NewComposition/NewComposition.tsx
@@ -1,4 +1,4 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
import type {
ChangeEventHandler,
Dispatch,
diff --git a/packages/studio/src/components/SelectedOutlineKeyboardControls.tsx b/packages/studio/src/components/SelectedOutlineKeyboardControls.tsx
index 633b222f9d..79203ff6c6 100644
--- a/packages/studio/src/components/SelectedOutlineKeyboardControls.tsx
+++ b/packages/studio/src/components/SelectedOutlineKeyboardControls.tsx
@@ -1,8 +1,5 @@
-import {
- CanvasInternals,
- type CanvasOutlineNudgeDirection,
-} from '@remotion/canvas';
import {PlayerInternals} from '@remotion/player';
+import {CanvasInternals, type CanvasOutlineNudgeDirection} from '@remotion/sdk';
import type React from 'react';
import {useCallback, useContext, useEffect, useRef} from 'react';
import {Internals} from 'remotion';
diff --git a/packages/studio/src/components/SelectedOutlineOverlay.tsx b/packages/studio/src/components/SelectedOutlineOverlay.tsx
index f82433cf15..fa841ad794 100644
--- a/packages/studio/src/components/SelectedOutlineOverlay.tsx
+++ b/packages/studio/src/components/SelectedOutlineOverlay.tsx
@@ -1,5 +1,5 @@
-import {CanvasInternals} from '@remotion/canvas';
import {PlayerInternals} from '@remotion/player';
+import {CanvasInternals} from '@remotion/sdk';
import React, {
useCallback,
useContext,
diff --git a/packages/studio/src/components/SelectedOutlinePolygon.tsx b/packages/studio/src/components/SelectedOutlinePolygon.tsx
index 27aaefa3d3..e98b9e6ff0 100644
--- a/packages/studio/src/components/SelectedOutlinePolygon.tsx
+++ b/packages/studio/src/components/SelectedOutlinePolygon.tsx
@@ -1,4 +1,4 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
import React, {useContext, useMemo, useRef, useState} from 'react';
import {Internals} from 'remotion';
import {StudioServerConnectionCtx} from '../helpers/client-id';
diff --git a/packages/studio/src/components/SelectedOutlineRenderer.tsx b/packages/studio/src/components/SelectedOutlineRenderer.tsx
index 7da2061625..9896d309ab 100644
--- a/packages/studio/src/components/SelectedOutlineRenderer.tsx
+++ b/packages/studio/src/components/SelectedOutlineRenderer.tsx
@@ -1,4 +1,4 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
import React, {
useCallback,
useContext,
diff --git a/packages/studio/src/components/SelectedOutlineSnapIndicators.tsx b/packages/studio/src/components/SelectedOutlineSnapIndicators.tsx
index 136812fd29..79c8a284fa 100644
--- a/packages/studio/src/components/SelectedOutlineSnapIndicators.tsx
+++ b/packages/studio/src/components/SelectedOutlineSnapIndicators.tsx
@@ -1,4 +1,4 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
import React, {useLayoutEffect, useState} from 'react';
import {
selectedOutlineSnapIndicatorColor,
diff --git a/packages/studio/src/components/Timeline/EasingEditorModal.tsx b/packages/studio/src/components/Timeline/EasingEditorModal.tsx
index 24b6fdce88..aee319a9cd 100644
--- a/packages/studio/src/components/Timeline/EasingEditorModal.tsx
+++ b/packages/studio/src/components/Timeline/EasingEditorModal.tsx
@@ -1,7 +1,7 @@
import {
canvasKeyframeEasingPresets,
type CanvasKeyframeEasingPreset,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
import {HOLD_KEYFRAME_EASING} from '@remotion/studio-shared';
import React, {
useCallback,
diff --git a/packages/studio/src/components/Timeline/TimelineExpandedKeyframeRow.tsx b/packages/studio/src/components/Timeline/TimelineExpandedKeyframeRow.tsx
index 0d2ab58179..93cf87951c 100644
--- a/packages/studio/src/components/Timeline/TimelineExpandedKeyframeRow.tsx
+++ b/packages/studio/src/components/Timeline/TimelineExpandedKeyframeRow.tsx
@@ -1,4 +1,4 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
import React, {useContext} from 'react';
import {areSequenceNodePathInfosEqual} from '../../helpers/are-sequence-node-path-infos-equal';
import type {SequenceNodePathInfo} from '../../helpers/get-timeline-sequence-sort-key';
diff --git a/packages/studio/src/components/Timeline/TimelineKeyframeControls.tsx b/packages/studio/src/components/Timeline/TimelineKeyframeControls.tsx
index 00822758ec..0d19a9f001 100644
--- a/packages/studio/src/components/Timeline/TimelineKeyframeControls.tsx
+++ b/packages/studio/src/components/Timeline/TimelineKeyframeControls.tsx
@@ -1,4 +1,4 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
import React, {useCallback, useContext, useMemo} from 'react';
import type {
CanUpdateSequencePropStatus,
diff --git a/packages/studio/src/components/Timeline/TimelineKeyframeEasingLine.tsx b/packages/studio/src/components/Timeline/TimelineKeyframeEasingLine.tsx
index 8c87f0e477..b28f2ae44a 100644
--- a/packages/studio/src/components/Timeline/TimelineKeyframeEasingLine.tsx
+++ b/packages/studio/src/components/Timeline/TimelineKeyframeEasingLine.tsx
@@ -1,4 +1,4 @@
-import {canvasKeyframeEasingPresets} from '@remotion/canvas';
+import {canvasKeyframeEasingPresets} from '@remotion/sdk';
import React, {useCallback, useContext, useMemo, useRef} from 'react';
import {Internals, useVideoConfig} from 'remotion';
import {StudioServerConnectionCtx} from '../../helpers/client-id';
diff --git a/packages/studio/src/components/Timeline/TimelineSelection.tsx b/packages/studio/src/components/Timeline/TimelineSelection.tsx
index 2dce6cf14e..da1a423b96 100644
--- a/packages/studio/src/components/Timeline/TimelineSelection.tsx
+++ b/packages/studio/src/components/Timeline/TimelineSelection.tsx
@@ -2,12 +2,12 @@ import type {
CanvasSelectionInteraction,
CanvasSelectionItem,
CanvasSelectionSnapshot,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
import {
CanvasInternals,
getCanvasSelectionItemKey,
useCanvasSelection,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
import {
stringifySequenceExpandedRowKey,
type SequenceNodePathMutation,
diff --git a/packages/studio/src/components/Timeline/TimelineSequence.tsx b/packages/studio/src/components/Timeline/TimelineSequence.tsx
index 3d8620b18c..b9078eb3cc 100644
--- a/packages/studio/src/components/Timeline/TimelineSequence.tsx
+++ b/packages/studio/src/components/Timeline/TimelineSequence.tsx
@@ -1,5 +1,5 @@
-import {CanvasInternals} from '@remotion/canvas';
-import type {TimelineTrackData} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
+import type {TimelineTrackData} from '@remotion/sdk';
import {stringifySequenceSubscriptionKey} from '@remotion/studio-shared';
import type {WaveformVolume} from '@remotion/timeline-utils';
import React, {
diff --git a/packages/studio/src/components/Timeline/TimelineSequenceRightEdgeDragHandle.tsx b/packages/studio/src/components/Timeline/TimelineSequenceRightEdgeDragHandle.tsx
index 0a6ef2145d..9cf8cd29d2 100644
--- a/packages/studio/src/components/Timeline/TimelineSequenceRightEdgeDragHandle.tsx
+++ b/packages/studio/src/components/Timeline/TimelineSequenceRightEdgeDragHandle.tsx
@@ -1,4 +1,4 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
import {
stringifySequenceExpandedRowKey,
stringifySequenceSubscriptionKey,
diff --git a/packages/studio/src/components/Timeline/get-keyframed-sequence-drag-targets.ts b/packages/studio/src/components/Timeline/get-keyframed-sequence-drag-targets.ts
index f6fd7e8c8d..e2a5ab88a8 100644
--- a/packages/studio/src/components/Timeline/get-keyframed-sequence-drag-targets.ts
+++ b/packages/studio/src/components/Timeline/get-keyframed-sequence-drag-targets.ts
@@ -1,4 +1,4 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
import type {
CanUpdateSequencePropStatusKeyframed,
InteractivitySchema,
diff --git a/packages/studio/src/components/Timeline/get-node-keyframes.ts b/packages/studio/src/components/Timeline/get-node-keyframes.ts
index 0f81e11268..cbfdaa5a37 100644
--- a/packages/studio/src/components/Timeline/get-node-keyframes.ts
+++ b/packages/studio/src/components/Timeline/get-node-keyframes.ts
@@ -1,4 +1,4 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
import {
Internals,
type DragOverrideValue,
diff --git a/packages/studio/src/components/Timeline/get-timeline-keyframes.ts b/packages/studio/src/components/Timeline/get-timeline-keyframes.ts
index 331c89e61c..541cee2edf 100644
--- a/packages/studio/src/components/Timeline/get-timeline-keyframes.ts
+++ b/packages/studio/src/components/Timeline/get-timeline-keyframes.ts
@@ -1,6 +1,6 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
-export type {KeyframeSourceFrame} from '@remotion/canvas';
+export type {KeyframeSourceFrame} from '@remotion/sdk';
export const {
getKeyframeDisplayOffset,
diff --git a/packages/studio/src/components/Timeline/timeline-translate-utils.ts b/packages/studio/src/components/Timeline/timeline-translate-utils.ts
index ec42191d61..3f6f83931d 100644
--- a/packages/studio/src/components/Timeline/timeline-translate-utils.ts
+++ b/packages/studio/src/components/Timeline/timeline-translate-utils.ts
@@ -1,10 +1,10 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
export type {
ParsedTranslate,
ParsedTranslateWithUnits,
TranslateUnit,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
export const {
parseTranslate,
diff --git a/packages/studio/src/components/Timeline/update-selected-easing.ts b/packages/studio/src/components/Timeline/update-selected-easing.ts
index d0937dfc6d..bde8a3e233 100644
--- a/packages/studio/src/components/Timeline/update-selected-easing.ts
+++ b/packages/studio/src/components/Timeline/update-selected-easing.ts
@@ -2,7 +2,7 @@ import {
CanvasInternals,
getCanvasKeyframeChangeOverride,
type CanvasKeyframeEasing,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
import type {
CanUpdateSequencePropStatusKeyframed,
DragOverrideValue,
diff --git a/packages/studio/src/components/Timeline/use-timeline-keyframe-drag.ts b/packages/studio/src/components/Timeline/use-timeline-keyframe-drag.ts
index 7290e6584f..e477876556 100644
--- a/packages/studio/src/components/Timeline/use-timeline-keyframe-drag.ts
+++ b/packages/studio/src/components/Timeline/use-timeline-keyframe-drag.ts
@@ -1,4 +1,4 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
import type React from 'react';
import {useCallback, useContext} from 'react';
import type {
diff --git a/packages/studio/src/components/selected-outline-drag.ts b/packages/studio/src/components/selected-outline-drag.ts
index 9c52a6baf6..c1f914c8bf 100644
--- a/packages/studio/src/components/selected-outline-drag.ts
+++ b/packages/studio/src/components/selected-outline-drag.ts
@@ -3,7 +3,7 @@ import {
type CanvasOutlineDragChange,
type CanvasOutlineKeyframedDragChange,
type CanvasOutlineStaticDragChange,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
import type {
CanUpdateSequencePropStatus,
DragOverrideValue,
@@ -96,7 +96,7 @@ export const getSelectedOutlineActiveSchema = ({
return Internals.flattenActiveSchema(schema, (key) => valuesDotNotation[key]);
};
-// Moving outlines is shared with @remotion/canvas; the Studio adds scale,
+// Moving outlines is shared with @remotion/sdk; the Studio adds scale,
// rotation, crop and transform-origin editing on top.
export const {
isCanvasOutlineDragPastThreshold: isSelectedOutlineDragPastThreshold,
diff --git a/packages/studio/src/components/selected-outline-geometry.ts b/packages/studio/src/components/selected-outline-geometry.ts
index 3f5fd3c69b..5519d4db26 100644
--- a/packages/studio/src/components/selected-outline-geometry.ts
+++ b/packages/studio/src/components/selected-outline-geometry.ts
@@ -1,9 +1,9 @@
-import type {CanvasOutlinePoint as OutlinePoint} from '@remotion/canvas';
+import type {CanvasOutlinePoint as OutlinePoint} from '@remotion/sdk';
export type {
CanvasOutline as SelectedOutline,
CanvasOutlinePoint as OutlinePoint,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
export const clamp = (value: number, min: number, max: number): number => {
return Math.min(max, Math.max(min, value));
diff --git a/packages/studio/src/components/selected-outline-measurement.ts b/packages/studio/src/components/selected-outline-measurement.ts
index 00ba578f80..9c7153185c 100644
--- a/packages/studio/src/components/selected-outline-measurement.ts
+++ b/packages/studio/src/components/selected-outline-measurement.ts
@@ -1,4 +1,4 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
import type {_InternalTypes, OverrideIdToNodePaths, TSequence} from 'remotion';
import {calculateTimeline} from '../helpers/calculate-timeline';
import {BLACK, WHITE} from '../helpers/colors';
diff --git a/packages/studio/src/components/selected-outline-order.ts b/packages/studio/src/components/selected-outline-order.ts
index f2e07a6f5d..69a5bf5758 100644
--- a/packages/studio/src/components/selected-outline-order.ts
+++ b/packages/studio/src/components/selected-outline-order.ts
@@ -1,3 +1,3 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
export const {orderCanvasOutlinesForRendering: orderOutlinesForRendering} =
CanvasInternals;
diff --git a/packages/studio/src/components/selected-outline-snap.ts b/packages/studio/src/components/selected-outline-snap.ts
index 67bdad00f6..5b6d22066a 100644
--- a/packages/studio/src/components/selected-outline-snap.ts
+++ b/packages/studio/src/components/selected-outline-snap.ts
@@ -1,4 +1,4 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
import {SELECTED_OUTLINE_SNAP_COLOR} from '../helpers/colors';
export type {
@@ -8,7 +8,7 @@ export type {
CanvasOutlineSnapResult as SelectedOutlineSnapResult,
CanvasOutlineSnapTarget as SelectedOutlineSnapTarget,
CanvasOutlineSnapTargetType as SelectedOutlineSnapTargetType,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
export const {
canvasOutlineSnapThresholdPx: selectedOutlineSnapThresholdPx,
diff --git a/packages/studio/src/components/selected-outline-types.ts b/packages/studio/src/components/selected-outline-types.ts
index dadee67514..3af71a9edf 100644
--- a/packages/studio/src/components/selected-outline-types.ts
+++ b/packages/studio/src/components/selected-outline-types.ts
@@ -7,7 +7,7 @@ import {
type CanvasOutlineTranslateSession,
type CanvasOutlineTranslateTarget,
type CanvasSelectableOutline,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
import type {
CanUpdateSequencePropStatus,
CanUpdateSequencePropStatusKeyframed,
diff --git a/packages/studio/src/components/selected-outline-uv.ts b/packages/studio/src/components/selected-outline-uv.ts
index 9c73bd7f3d..610f339850 100644
--- a/packages/studio/src/components/selected-outline-uv.ts
+++ b/packages/studio/src/components/selected-outline-uv.ts
@@ -1,4 +1,4 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
import type {
CanUpdateSequencePropStatusKeyframed,
CanUpdateSequencePropStatusStatic,
diff --git a/packages/studio/src/components/use-selected-outline-control-target.ts b/packages/studio/src/components/use-selected-outline-control-target.ts
index 0dbe6941a0..000c5bffe3 100644
--- a/packages/studio/src/components/use-selected-outline-control-target.ts
+++ b/packages/studio/src/components/use-selected-outline-control-target.ts
@@ -1,4 +1,4 @@
-import {useCanvasSequenceHover} from '@remotion/canvas';
+import {useCanvasSequenceHover} from '@remotion/sdk';
import React, {useContext, useLayoutEffect, useRef} from 'react';
import {TimelineSequenceHoverContext} from '../state/timeline-sequence-hover';
import type {
diff --git a/packages/studio/src/helpers/calculate-timeline.ts b/packages/studio/src/helpers/calculate-timeline.ts
index 80cbdceee2..d1b17fc236 100644
--- a/packages/studio/src/helpers/calculate-timeline.ts
+++ b/packages/studio/src/helpers/calculate-timeline.ts
@@ -1,2 +1,2 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
export const {calculateTimeline} = CanvasInternals;
diff --git a/packages/studio/src/helpers/create-folder-tree.ts b/packages/studio/src/helpers/create-folder-tree.ts
index a76a0214d6..97bef124d3 100644
--- a/packages/studio/src/helpers/create-folder-tree.ts
+++ b/packages/studio/src/helpers/create-folder-tree.ts
@@ -1,4 +1,4 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
import type {_InternalTypes, StaticFile, TFolder} from 'remotion';
import type {CompositionSelectorItemType} from '../components/CompositionSelectorItem';
import {openFolderKey} from './persist-open-folders';
diff --git a/packages/studio/src/helpers/get-connected-compositions.ts b/packages/studio/src/helpers/get-connected-compositions.ts
index bd8f80cac6..c15d33ca64 100644
--- a/packages/studio/src/helpers/get-connected-compositions.ts
+++ b/packages/studio/src/helpers/get-connected-compositions.ts
@@ -1,2 +1,2 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
export const {getConnectedCompositions} = CanvasInternals;
diff --git a/packages/studio/src/helpers/get-sequence-visible-range.ts b/packages/studio/src/helpers/get-sequence-visible-range.ts
index ddbad08bfb..33df99c396 100644
--- a/packages/studio/src/helpers/get-sequence-visible-range.ts
+++ b/packages/studio/src/helpers/get-sequence-visible-range.ts
@@ -1,4 +1,4 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
export const {
getParentSequencePlaybackRate,
getCascadedStart,
diff --git a/packages/studio/src/helpers/get-timeline-nestedness.ts b/packages/studio/src/helpers/get-timeline-nestedness.ts
index 09abb03d68..7c5fefdce4 100644
--- a/packages/studio/src/helpers/get-timeline-nestedness.ts
+++ b/packages/studio/src/helpers/get-timeline-nestedness.ts
@@ -1,2 +1,2 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
export const {getTimelineNestedLevel} = CanvasInternals;
diff --git a/packages/studio/src/helpers/get-timeline-sequence-sort-key.ts b/packages/studio/src/helpers/get-timeline-sequence-sort-key.ts
index 8a885df981..62cfa44f04 100644
--- a/packages/studio/src/helpers/get-timeline-sequence-sort-key.ts
+++ b/packages/studio/src/helpers/get-timeline-sequence-sort-key.ts
@@ -1,7 +1,7 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
export const {getTimelineSequenceSortKey} = CanvasInternals;
export type {
SequenceNodePathInfo,
TimelineTrackData,
TimelineTrackWithOriginalTimings,
-} from '@remotion/canvas';
+} from '@remotion/sdk';
diff --git a/packages/studio/src/helpers/pointer-session.ts b/packages/studio/src/helpers/pointer-session.ts
index 04895fb56c..b187741307 100644
--- a/packages/studio/src/helpers/pointer-session.ts
+++ b/packages/studio/src/helpers/pointer-session.ts
@@ -1,6 +1,6 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
-export type {PointerSessionEndReason} from '@remotion/canvas';
+export type {PointerSessionEndReason} from '@remotion/sdk';
export const {
isPointerSessionRelease,
diff --git a/packages/studio/src/helpers/timeline-node-path-key.ts b/packages/studio/src/helpers/timeline-node-path-key.ts
index 0798c9706d..164778f675 100644
--- a/packages/studio/src/helpers/timeline-node-path-key.ts
+++ b/packages/studio/src/helpers/timeline-node-path-key.ts
@@ -1,4 +1,4 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
import {stringifySequenceExpandedRowKey} from '@remotion/studio-shared';
import type {SequenceNodePathInfo} from './get-timeline-sequence-sort-key';
diff --git a/packages/studio/src/helpers/use-runtime-values.ts b/packages/studio/src/helpers/use-runtime-values.ts
index e623dd1402..1508aee260 100644
--- a/packages/studio/src/helpers/use-runtime-values.ts
+++ b/packages/studio/src/helpers/use-runtime-values.ts
@@ -1,4 +1,4 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
import {useCallback, useMemo} from 'react';
import {
type RuntimeValueStore,
diff --git a/packages/studio/src/previewEntry.tsx b/packages/studio/src/previewEntry.tsx
index bca80c8238..4e4efce0f1 100644
--- a/packages/studio/src/previewEntry.tsx
+++ b/packages/studio/src/previewEntry.tsx
@@ -1,4 +1,4 @@
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
import React from 'react';
import ReactDOM from 'react-dom/client';
import {Internals} from 'remotion';
diff --git a/packages/studio/src/state/timeline-sequence-hover.ts b/packages/studio/src/state/timeline-sequence-hover.ts
index c37d4a5b57..7ef34d9a33 100644
--- a/packages/studio/src/state/timeline-sequence-hover.ts
+++ b/packages/studio/src/state/timeline-sequence-hover.ts
@@ -3,8 +3,8 @@ import {
createCanvasHoverController,
useCanvasHover,
useCanvasSequenceHover,
-} from '@remotion/canvas';
-import type {CanvasHover, CanvasHoverController} from '@remotion/canvas';
+} from '@remotion/sdk';
+import type {CanvasHover, CanvasHoverController} from '@remotion/sdk';
import {createContext, useContext} from 'react';
import type {SequenceNodePathInfo} from '../helpers/get-timeline-sequence-sort-key';
diff --git a/packages/studio/src/test/fiber-sequence-order-observer.test.ts b/packages/studio/src/test/fiber-sequence-order-observer.test.ts
index e5fef7632c..dbab280c9f 100644
--- a/packages/studio/src/test/fiber-sequence-order-observer.test.ts
+++ b/packages/studio/src/test/fiber-sequence-order-observer.test.ts
@@ -1,5 +1,5 @@
import {afterEach, expect, test} from 'bun:test';
-import {CanvasInternals} from '@remotion/canvas';
+import {CanvasInternals} from '@remotion/sdk';
import {Internals} from 'remotion';
const {collectCommitOrderFromFiber, installFiberCommitOrderObserver} =
diff --git a/packages/studio/tsconfig.json b/packages/studio/tsconfig.json
index 49796a7c5a..2995bde0f9 100644
--- a/packages/studio/tsconfig.json
+++ b/packages/studio/tsconfig.json
@@ -10,7 +10,7 @@
"include": ["src"],
"references": [
{
- "path": "../canvas"
+ "path": "../sdk"
},
{
"path": "../core"
diff --git a/packages/template-vibe-code/README.md b/packages/template-vibe-code/README.md
index 61c3053300..dd0207c4c2 100644
--- a/packages/template-vibe-code/README.md
+++ b/packages/template-vibe-code/README.md
@@ -3,7 +3,7 @@
A Remotion template that turns the browser into a motion graphics editor: write React code, watch it compile instantly, and edit the result on the canvas, in the timeline and in the inspector β€” no backend, no bundler process.
- **Live compilation** – the project is compiled in a Web Worker with [`@remotion/browser-bundler`](https://www.remotion.dev/docs/browser-bundler) and hot-swapped with Fast Refresh, so component state survives edits.
-- **Canvas** – [`@remotion/canvas`](https://www.remotion.dev/docs/canvas) renders the composition with selection outlines. Click a layer on the canvas or in the timeline to select it, drag it to move it (it snaps to the edges and center of the composition, Shift locks the axis, ⌘ disables snapping) or nudge it with the arrow keys. Switch to β€œInteract” mode to use the composition’s own buttons and inputs.
+- **Canvas** – [`@remotion/sdk`](https://www.remotion.dev/docs/sdk) renders the composition with selection outlines. Click a layer on the canvas or in the timeline to select it, drag it to move it (it snaps to the edges and center of the composition, Shift locks the axis, ⌘ disables snapping) or nudge it with the arrow keys. Switch to β€œInteract” mode to use the composition’s own buttons and inputs.
- **Timeline** – every mounted sequence shows up as a track. Drag a track to change its `from`, drag its edges to trim `durationInFrames`, split it at the playhead, duplicate, reorder, wrap and delete. In/out points, zoomable ruler, scrubbing.
- **Keyframes** – props animated with `interpolate()` get a keyframe row under their track. Drag keyframes to retime them, click to select them (Shift and ⌘ extend the selection), double-click to jump to them, press ⌫ to delete them. In the inspector, a diamond next to each animatable prop adds or removes a keyframe at the playhead and the arrows jump to the neighboring keyframes.
- **Easing** – click the line between two keyframes to edit the easing of that segment: pick a preset (ease in/out, hold, springs), tweak the bezier handles or the spring parameters with live preview, or right-click the line for a preset. The same inspector edits the `interpolate()` options of the prop: extrapolation, `output` mode and `posterize`. ⌫ resets a selected easing to linear.
@@ -41,7 +41,7 @@ npx remotion render # render it with the CLI
β”‚ codemods (@remotion/codemods) rewrite the files when you edit visually β”‚
β”‚ β”‚ applyBundle() β”‚
β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€ iframe (development React) ─────────┐ β”‚
-β”‚ β”‚ @remotion/browser-bundler/runtime ──▢ <Canvas> from @remotion/canvas β”‚ β”‚
+β”‚ β”‚ @remotion/browser-bundler/runtime ──▢ <Canvas> from @remotion/sdk β”‚ β”‚
β”‚ β”‚ Fast Refresh Β· CanvasController (timeline / selection / hover) Β· web-renderer β”‚ β”‚
β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
@@ -62,19 +62,19 @@ The browser bundler compiles with WebAssembly and shared memory, which requires
### How layers are linked to code
-The browser bundler records where every JSX element was written, and the Canvas exposes that location for each mounted sequence through [`getCanvasSequenceSourceLocation()`](https://www.remotion.dev/docs/canvas/get-canvas-sequence-source-location). The editor looks the location up in the compiled files with `getNodes()` and registers the resulting node paths with [`controller.setSequenceNodePaths()`](https://www.remotion.dev/docs/canvas/create-canvas-controller#setsequencenodepaths), so selection, the timeline and the inspector all refer to the same source node β€” also for elements rendered in a `.map()` loop. Elements created by dependencies have no source location and are shown but not editable.
+The browser bundler records where every JSX element was written, and the Canvas exposes that location for each mounted sequence through [`getCanvasSequenceSourceLocation()`](https://www.remotion.dev/docs/sdk/get-canvas-sequence-source-location). The editor looks the location up in the compiled files with `getNodes()` and registers the resulting node paths with [`controller.setSequenceNodePaths()`](https://www.remotion.dev/docs/sdk/create-canvas-controller#setsequencenodepaths), so selection, the timeline and the inspector all refer to the same source node β€” also for elements rendered in a `.map()` loop. Elements created by dependencies have no source location and are shown but not editable.
### Live previews
-Dragging a value in the inspector or a track in the timeline does not rewrite the source on every pointer move. The editor previews the value on the canvas with [`controller.overrides`](https://www.remotion.dev/docs/canvas/create-canvas-controller#overrides) and writes it with a codemod once the gesture ends. The preview stays in place until the recompiled project is running, so the canvas never flashes the old value.
+Dragging a value in the inspector or a track in the timeline does not rewrite the source on every pointer move. The editor previews the value on the canvas with [`controller.overrides`](https://www.remotion.dev/docs/sdk/create-canvas-controller#overrides) and writes it with a codemod once the gesture ends. The preview stays in place until the recompiled project is running, so the canvas never flashes the old value.
-Moving an outline on the canvas works the same way, but the Canvas owns the gesture: it previews `style.translate` while dragging and reports the final values through the [`onSequencePropsChange`](https://www.remotion.dev/docs/canvas/canvas#onsequencepropschange) prop. The editor writes them with `updateMultipleNodeProps()` in one undoable step and releases the previews once the new bundle runs. Before a move starts, the Canvas asks the editor through [`getSequencePropStatuses`](https://www.remotion.dev/docs/canvas/canvas#getsequencepropstatuses) how the position is written: a position animated with `interpolate()` gets a keyframe at the playhead via `updateNodeKeyframes()`, and a position computed in code cannot be moved.
+Moving an outline on the canvas works the same way, but the Canvas owns the gesture: it previews `style.translate` while dragging and reports the final values through the [`onSequencePropsChange`](https://www.remotion.dev/docs/sdk/canvas#onsequencepropschange) prop. The editor writes them with `updateMultipleNodeProps()` in one undoable step and releases the previews once the new bundle runs. Before a move starts, the Canvas asks the editor through [`getSequencePropStatuses`](https://www.remotion.dev/docs/sdk/canvas#getsequencepropstatuses) how the position is written: a position animated with `interpolate()` gets a keyframe at the playhead via `updateNodeKeyframes()`, and a position computed in code cannot be moved.
### Keyframes
-The keyframe rows of the timeline read the `interpolate()` calls of each layer with `getNodeProps()` and place them on the composition timeline with [`getCanvasKeyframes()`](https://www.remotion.dev/docs/canvas/get-canvas-keyframes), which accounts for nested sequences and playback rates. Dragging a keyframe runs [`startCanvasKeyframeDrag()`](https://www.remotion.dev/docs/canvas/start-canvas-keyframe-drag) from `@remotion/canvas`: it previews the moved keyframes through `controller.overrides`, keeps them inside the composition, and reports the move when the pointer is released. The diamond buttons of the inspector are described by [`getCanvasKeyframeToggle()`](https://www.remotion.dev/docs/canvas/get-canvas-keyframe-toggle). Every keyframe edit is a `CanvasKeyframeChange`, which the editor passes to `updateNodeKeyframes()`.
+The keyframe rows of the timeline read the `interpolate()` calls of each layer with `getNodeProps()` and place them on the composition timeline with [`getCanvasKeyframes()`](https://www.remotion.dev/docs/sdk/get-canvas-keyframes), which accounts for nested sequences and playback rates. Dragging a keyframe runs [`startCanvasKeyframeDrag()`](https://www.remotion.dev/docs/sdk/start-canvas-keyframe-drag) from `@remotion/sdk`: it previews the moved keyframes through `controller.overrides`, keeps them inside the composition, and reports the move when the pointer is released. The diamond buttons of the inspector are described by [`getCanvasKeyframeToggle()`](https://www.remotion.dev/docs/sdk/get-canvas-keyframe-toggle). Every keyframe edit is a `CanvasKeyframeChange`, which the editor passes to `updateNodeKeyframes()`.
-The lines between keyframes come from [`getCanvasKeyframeEasingSegments()`](https://www.remotion.dev/docs/canvas/get-canvas-keyframe-easing-segments), which skips props whose easing cannot be edited, such as booleans. Picking a preset or dragging a parameter in the easing inspector builds a change with [`getCanvasKeyframeEasingChange()`](https://www.remotion.dev/docs/canvas/get-canvas-keyframe-easing-change) and the interpolation section uses [`getCanvasKeyframeSettings()`](https://www.remotion.dev/docs/canvas/get-canvas-keyframe-settings) and [`getCanvasKeyframeSettingsChange()`](https://www.remotion.dev/docs/canvas/get-canvas-keyframe-settings-change). Before a change is written, [`getCanvasKeyframeChangeOverride()`](https://www.remotion.dev/docs/canvas/get-canvas-keyframe-change-override) turns it into an override so the canvas shows the new curve immediately.
+The lines between keyframes come from [`getCanvasKeyframeEasingSegments()`](https://www.remotion.dev/docs/sdk/get-canvas-keyframe-easing-segments), which skips props whose easing cannot be edited, such as booleans. Picking a preset or dragging a parameter in the easing inspector builds a change with [`getCanvasKeyframeEasingChange()`](https://www.remotion.dev/docs/sdk/get-canvas-keyframe-easing-change) and the interpolation section uses [`getCanvasKeyframeSettings()`](https://www.remotion.dev/docs/sdk/get-canvas-keyframe-settings) and [`getCanvasKeyframeSettingsChange()`](https://www.remotion.dev/docs/sdk/get-canvas-keyframe-settings-change). Before a change is written, [`getCanvasKeyframeChangeOverride()`](https://www.remotion.dev/docs/sdk/get-canvas-keyframe-change-override) turns it into an override so the canvas shows the new curve immediately.
## Commands
diff --git a/packages/template-vibe-code/package.json b/packages/template-vibe-code/package.json
index 28ea793178..41f7d090ce 100644
--- a/packages/template-vibe-code/package.json
+++ b/packages/template-vibe-code/package.json
@@ -26,7 +26,7 @@
"@radix-ui/react-tabs": "1.1.13",
"@radix-ui/react-tooltip": "1.2.8",
"@remotion/browser-bundler": "workspace:*",
- "@remotion/canvas": "workspace:*",
+ "@remotion/sdk": "workspace:*",
"@remotion/cli": "workspace:*",
"@remotion/codemods": "workspace:*",
"@remotion/player": "workspace:*",
diff --git a/packages/template-vibe-code/src/editor/Editor.tsx b/packages/template-vibe-code/src/editor/Editor.tsx
index 7dac0c9528..2124de4614 100644
--- a/packages/template-vibe-code/src/editor/Editor.tsx
+++ b/packages/template-vibe-code/src/editor/Editor.tsx
@@ -3,7 +3,7 @@
import type {
CanvasSequencePropChange,
CanvasSequencePropStatusResolver,
-} from "@remotion/canvas";
+} from "@remotion/sdk";
import { resolveCompositionComponent } from "@remotion/codemods";
import React, {
useCallback,
diff --git a/packages/template-vibe-code/src/editor/components/EasingCurve.tsx b/packages/template-vibe-code/src/editor/components/EasingCurve.tsx
index b9e04eec62..55d0e4647a 100644
--- a/packages/template-vibe-code/src/editor/components/EasingCurve.tsx
+++ b/packages/template-vibe-code/src/editor/components/EasingCurve.tsx
@@ -1,4 +1,4 @@
-import type { CanvasKeyframeEasing } from "@remotion/canvas";
+import type { CanvasKeyframeEasing } from "@remotion/sdk";
import React, { useMemo } from "react";
import { Easing } from "remotion";
import { cn } from "@/lib/utils";
diff --git a/packages/template-vibe-code/src/editor/components/Inspector/EasingInspector.tsx b/packages/template-vibe-code/src/editor/components/Inspector/EasingInspector.tsx
index 47c2cad12a..4a75350f7d 100644
--- a/packages/template-vibe-code/src/editor/components/Inspector/EasingInspector.tsx
+++ b/packages/template-vibe-code/src/editor/components/Inspector/EasingInspector.tsx
@@ -6,7 +6,7 @@ import {
getCanvasKeyframeSettingsChange,
type CanvasKeyframeEasing,
type CanvasKeyframeSettings,
-} from "@remotion/canvas";
+} from "@remotion/sdk";
import { ChevronLeftIcon } from "lucide-react";
import React, { useState } from "react";
import type { ExtrapolateType, InterpolateOutputOption } from "remotion";
diff --git a/packages/template-vibe-code/src/editor/components/Inspector/InspectorPanel.tsx b/packages/template-vibe-code/src/editor/components/Inspector/InspectorPanel.tsx
index e2fef70692..73e677ba41 100644
--- a/packages/template-vibe-code/src/editor/components/Inspector/InspectorPanel.tsx
+++ b/packages/template-vibe-code/src/editor/components/Inspector/InspectorPanel.tsx
@@ -3,7 +3,7 @@
import {
getCanvasSelectionItemKey,
useCanvasSelection,
-} from "@remotion/canvas";
+} from "@remotion/sdk";
import React, { useMemo } from "react";
import { Button } from "@/components/ui/button";
import { Tabs, TabsContent, TabsList, TabsTrigger } from "@/components/ui/tabs";
diff --git a/packages/template-vibe-code/src/editor/components/Inspector/LayerInspector.tsx b/packages/template-vibe-code/src/editor/components/Inspector/LayerInspector.tsx
index 5fb7271fc9..9a6c0871cb 100644
--- a/packages/template-vibe-code/src/editor/components/Inspector/LayerInspector.tsx
+++ b/packages/template-vibe-code/src/editor/components/Inspector/LayerInspector.tsx
@@ -4,7 +4,7 @@ import {
getCanvasKeyframeSourceFrame,
getCanvasKeyframeToggle,
getCanvasPropValueAtFrame,
-} from "@remotion/canvas";
+} from "@remotion/sdk";
import { getNodeProps, type SequencePropUpdate } from "@remotion/codemods";
import { ChevronLeftIcon, ChevronRightIcon, RotateCcwIcon } from "lucide-react";
import React, { useMemo } from "react";
diff --git a/packages/template-vibe-code/src/editor/components/Timeline/Timeline.tsx b/packages/template-vibe-code/src/editor/components/Timeline/Timeline.tsx
index d4f3575232..99afe69577 100644
--- a/packages/template-vibe-code/src/editor/components/Timeline/Timeline.tsx
+++ b/packages/template-vibe-code/src/editor/components/Timeline/Timeline.tsx
@@ -9,7 +9,7 @@ import {
type CanvasKeyframeDragTarget,
type CanvasKeyframeEasingSegment,
type CanvasSelectionInteraction,
-} from "@remotion/canvas";
+} from "@remotion/sdk";
import { getNodeProps } from "@remotion/codemods";
import {
ChevronDownIcon,
diff --git a/packages/template-vibe-code/src/editor/hooks/use-editor-actions.ts b/packages/template-vibe-code/src/editor/hooks/use-editor-actions.ts
index a05dd0ed14..c9dd5229b3 100644
--- a/packages/template-vibe-code/src/editor/hooks/use-editor-actions.ts
+++ b/packages/template-vibe-code/src/editor/hooks/use-editor-actions.ts
@@ -9,7 +9,7 @@ import {
type CanvasSelectionInteraction,
type CanvasSequencePropChange,
type SequenceNodePathInfo,
-} from "@remotion/canvas";
+} from "@remotion/sdk";
import {
addComposition,
addElement,
diff --git a/packages/template-vibe-code/src/editor/hooks/use-editor-shortcuts.ts b/packages/template-vibe-code/src/editor/hooks/use-editor-shortcuts.ts
index 2ab4a116e0..c67aa7807b 100644
--- a/packages/template-vibe-code/src/editor/hooks/use-editor-shortcuts.ts
+++ b/packages/template-vibe-code/src/editor/hooks/use-editor-shortcuts.ts
@@ -1,6 +1,6 @@
"use client";
-import { getCanvasSelectionItemKey } from "@remotion/canvas";
+import { getCanvasSelectionItemKey } from "@remotion/sdk";
import { useCallback, useEffect, useRef } from "react";
import type { PreviewHost, PreviewKeyEvent } from "@/preview/bridge";
import type { CompositionInfo } from "../model/compositions";
diff --git a/packages/template-vibe-code/src/editor/hooks/use-layers.ts b/packages/template-vibe-code/src/editor/hooks/use-layers.ts
index 5d175a5cac..b26f64c325 100644
--- a/packages/template-vibe-code/src/editor/hooks/use-layers.ts
+++ b/packages/template-vibe-code/src/editor/hooks/use-layers.ts
@@ -1,6 +1,6 @@
"use client";
-import type { TimelineTrackData } from "@remotion/canvas";
+import type { TimelineTrackData } from "@remotion/sdk";
import type { CodemodProject } from "@remotion/codemods";
import { useEffect, useMemo, useSyncExternalStore } from "react";
import type { PreviewHost } from "@/preview/bridge";
diff --git a/packages/template-vibe-code/src/editor/hooks/use-preview-host.ts b/packages/template-vibe-code/src/editor/hooks/use-preview-host.ts
index 8cf4e56c0b..aa12a92f87 100644
--- a/packages/template-vibe-code/src/editor/hooks/use-preview-host.ts
+++ b/packages/template-vibe-code/src/editor/hooks/use-preview-host.ts
@@ -3,7 +3,7 @@
import type {
CanvasSequencePropChange,
CanvasSequencePropStatusResolver,
-} from "@remotion/canvas";
+} from "@remotion/sdk";
import { useEffect, useRef, useState } from "react";
import { BASE_PATH } from "@/lib/base-path";
import type { PreviewHost, PreviewKeyEvent } from "@/preview/bridge";
diff --git a/packages/template-vibe-code/src/editor/model/keyframes.ts b/packages/template-vibe-code/src/editor/model/keyframes.ts
index 6a7ae1b642..ae39cf9f19 100644
--- a/packages/template-vibe-code/src/editor/model/keyframes.ts
+++ b/packages/template-vibe-code/src/editor/model/keyframes.ts
@@ -9,7 +9,7 @@ import {
type CanvasKeyframeEasingSegment,
type CanvasSelectionItem,
type SequenceNodePathInfo,
-} from "@remotion/canvas";
+} from "@remotion/sdk";
import { getNodeProps, type CodemodProject } from "@remotion/codemods";
import type {
CanUpdateSequencePropStatusKeyframed,
diff --git a/packages/template-vibe-code/src/editor/model/layers.ts b/packages/template-vibe-code/src/editor/model/layers.ts
index fe38ead0e6..20f3a33a75 100644
--- a/packages/template-vibe-code/src/editor/model/layers.ts
+++ b/packages/template-vibe-code/src/editor/model/layers.ts
@@ -4,7 +4,7 @@ import {
type CanvasSelectionItem,
type SequenceNodePathInfo,
type TimelineTrackData,
-} from "@remotion/canvas";
+} from "@remotion/sdk";
import {
getNodeProps,
getNodes,
diff --git a/packages/template-vibe-code/src/editor/state/fallback-selection.ts b/packages/template-vibe-code/src/editor/state/fallback-selection.ts
index 454be6027e..320c168289 100644
--- a/packages/template-vibe-code/src/editor/state/fallback-selection.ts
+++ b/packages/template-vibe-code/src/editor/state/fallback-selection.ts
@@ -1,4 +1,4 @@
-import { createCanvasSelectionController } from "@remotion/canvas";
+import { createCanvasSelectionController } from "@remotion/sdk";
// Used by components that render before the preview iframe is connected.
export const fallbackSelectionController = createCanvasSelectionController();
diff --git a/packages/template-vibe-code/src/preview/bridge.ts b/packages/template-vibe-code/src/preview/bridge.ts
index 843f513f71..6ef8972aee 100644
--- a/packages/template-vibe-code/src/preview/bridge.ts
+++ b/packages/template-vibe-code/src/preview/bridge.ts
@@ -11,7 +11,7 @@ import type {
CanvasController,
CanvasSequencePropChange,
CanvasSequencePropStatusResolver,
-} from "@remotion/canvas";
+} from "@remotion/sdk";
import type { PlayerRef } from "@remotion/player";
import type {
CanRenderMediaOnWebResult,
diff --git a/packages/template-vibe-code/src/preview/runtime.tsx b/packages/template-vibe-code/src/preview/runtime.tsx
index 7f3f344ddd..eaaa9c2644 100644
--- a/packages/template-vibe-code/src/preview/runtime.tsx
+++ b/packages/template-vibe-code/src/preview/runtime.tsx
@@ -8,7 +8,7 @@ import {
createCanvasController,
type CanvasSequencePropsChangeHandler,
type CanvasSequencePropStatusResolver,
-} from "@remotion/canvas";
+} from "@remotion/sdk";
import type { PlayerRef } from "@remotion/player";
import {
canRenderMediaOnWeb,
diff --git a/tsconfig.json b/tsconfig.json
index d9300a5a81..d2abfdd3b2 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -31,7 +31,7 @@
"path": "./packages/browser-studio"
},
{
- "path": "./packages/canvas"
+ "path": "./packages/sdk"
},
{
"path": "./packages/cloudrun"