@shotstack/shotstack-studio 2.18.0 → 2.19.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +4 -0
- package/dist/index.d.ts +23 -0
- package/dist/internal.d.ts +23 -0
- package/dist/internal.es.js +9135 -8277
- package/dist/internal.umd.js +81 -93
- package/dist/shotstack-studio.es.js +13150 -12053
- package/dist/shotstack-studio.umd.js +174 -186
- package/package.json +1 -1
- package/readme.md +28 -0
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -16,6 +16,28 @@ Try Shotstack Studio in your preferred framework:
|
|
|
16
16
|
[](https://stackblitz.com/fork/github/shotstack/shotstack-studio-sdk-demos/tree/master/angular)
|
|
17
17
|
[](https://stackblitz.com/fork/github/shotstack/shotstack-studio-sdk-demos/tree/master/nextjs)
|
|
18
18
|
|
|
19
|
+
## Create a new project
|
|
20
|
+
|
|
21
|
+
The fastest way to get started is to scaffold a project. This creates a small app with the Studio SDK already set up, including the canvas, timeline, and controls.
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
npm create video-editor@latest
|
|
25
|
+
# or
|
|
26
|
+
npx create-video-editor
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
You'll be asked for a project name and a framework. The CLI then scaffolds the app, installs dependencies, starts the dev server, and opens a live editor in your browser.
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
npx create-video-editor my-video-editor
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
To skip the prompts, pass the project directory and framework directly:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
npx create-video-editor my-editor --template react --yes
|
|
39
|
+
```
|
|
40
|
+
|
|
19
41
|
## Features
|
|
20
42
|
|
|
21
43
|
- Template-driven editing with undo/redo command model
|
|
@@ -26,6 +48,8 @@ Try Shotstack Studio in your preferred framework:
|
|
|
26
48
|
|
|
27
49
|
## Installation
|
|
28
50
|
|
|
51
|
+
To add the SDK to an existing app, install it directly:
|
|
52
|
+
|
|
29
53
|
```bash
|
|
30
54
|
npm install @shotstack/shotstack-studio
|
|
31
55
|
```
|
|
@@ -203,6 +227,10 @@ edit.registerAssetGenerator(async ({ clipId, asset, signal }) => {
|
|
|
203
227
|
});
|
|
204
228
|
```
|
|
205
229
|
|
|
230
|
+
A host can trigger the same generation directly, without the toolbar: `await
|
|
231
|
+
edit.generateClip(clipId)` runs it for a prompt-bearing clip. Track progress with the events
|
|
232
|
+
`"clip:generationStarted"`, `"clip:generationCompleted"` and `"clip:generationFailed"`.
|
|
233
|
+
|
|
206
234
|
Pass a model catalogue as the registration's `catalogue` option to show model and option
|
|
207
235
|
controls. Entries must include their option schema; those without one are ignored. The
|
|
208
236
|
[Edit API](https://shotstack.io/docs/api/#shotstack-edit) returns this shape from
|