@shotstack/shotstack-studio 2.0.0-rc.3 → 2.0.0-rc.4

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/package.json CHANGED
@@ -3,9 +3,10 @@
3
3
  "author": "Shotstack <support@shotstack.io>",
4
4
  "contributors": [
5
5
  "cpuccino",
6
- "dazzatron"
6
+ "dazzatron",
7
+ "kratos2k7"
7
8
  ],
8
- "version": "2.0.0-rc.3",
9
+ "version": "2.0.0-rc.4",
9
10
  "description": "A video editing library for creating and editing videos with Shotstack",
10
11
  "type": "module",
11
12
  "main": "dist/shotstack-studio.umd.js",
package/readme.md CHANGED
@@ -37,7 +37,8 @@ yarn add @shotstack/shotstack-studio
37
37
  ## Quick Start
38
38
 
39
39
  ```typescript
40
- import { Edit, Canvas, Controls, Timeline, UIController } from "@shotstack/shotstack-studio";
40
+ import { Edit, Canvas, Controls, Timeline, UIController, VERSION } from "@shotstack/shotstack-studio";
41
+ import type { EditConfig, UIControllerOptions, ToolbarButtonConfig } from "@shotstack/shotstack-studio";
41
42
 
42
43
  // 1) Load a template
43
44
  const response = await fetch("https://shotstack-assets.s3.amazonaws.com/templates/hello-world/hello.json");
@@ -128,7 +129,20 @@ await edit.deleteClip(0, 0);
128
129
  await edit.undo();
129
130
  await edit.redo();
130
131
 
132
+ // Clip operations
133
+ await edit.deleteTrack(0);
134
+
135
+ // Output settings
136
+ await edit.setOutputSize(1920, 1080);
137
+ await edit.setOutputFps(30);
138
+ await edit.setOutputFormat("mp4");
139
+ await edit.setOutputResolution("hd");
140
+ await edit.setOutputAspectRatio("16:9");
141
+ await edit.setTimelineBackground("#000000");
142
+
131
143
  // Read state
144
+ const time = edit.playbackTime;
145
+ const playing = edit.isPlaying;
132
146
  const clip = edit.getClip(0, 0);
133
147
  const track = edit.getTrack(0);
134
148
  const snapshot = edit.getEdit();
@@ -160,14 +174,13 @@ Available event names:
160
174
 
161
175
  - Playback: `playback:play`, `playback:pause`
162
176
  - Timeline: `timeline:updated`, `timeline:backgroundChanged`
163
- - Clip lifecycle: `clip:added`, `clip:split`, `clip:selected`, `clip:updated`, `clip:deleted`, `clip:restored`, `clip:copied`, `clip:loadFailed`, `clip:unresolved`
177
+ - Clip lifecycle: `clip:added`, `clip:selected`, `clip:updated`, `clip:deleted`, `clip:restored`, `clip:copied`, `clip:loadFailed`, `clip:unresolved`
164
178
  - Selection: `selection:cleared`
165
179
  - Edit state: `edit:changed`, `edit:undo`, `edit:redo`
166
180
  - Track: `track:added`, `track:removed`
167
181
  - Duration: `duration:changed`
168
182
  - Output: `output:resized`, `output:resolutionChanged`, `output:aspectRatioChanged`, `output:fpsChanged`, `output:formatChanged`, `output:destinationsChanged`
169
183
  - Merge fields: `mergefield:changed`
170
- - Luma masking: `luma:attached`, `luma:detached`
171
184
 
172
185
  ### Canvas
173
186
 
@@ -183,6 +196,7 @@ canvas.centerEdit();
183
196
  canvas.zoomToFit();
184
197
  canvas.setZoom(1.25);
185
198
  canvas.resize();
199
+ const zoom = canvas.getZoom();
186
200
  canvas.dispose();
187
201
  ```
188
202