@kitionstage/sdk 0.0.0-stage → 0.5.2-stage.13

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.
Files changed (259) hide show
  1. package/README.md +73 -2
  2. package/dist/LICENSE +177 -0
  3. package/dist/THIRD_PARTY_NOTICES +28 -0
  4. package/dist/lib/assets/kitEngine.worker-3iMvwtlI.js +12732 -0
  5. package/dist/lib/assets/loro_wasm_bg-Gulzks_0.wasm +0 -0
  6. package/dist/lib/chunks/batch-BWpAyHvP.js +789 -0
  7. package/dist/lib/chunks/canonical-BIWfVCL-.js +87 -0
  8. package/dist/lib/chunks/envelope-D6MGY-ZN.js +61 -0
  9. package/dist/lib/chunks/replica-D8w3I4sn.js +2472 -0
  10. package/dist/lib/chunks/runtime-BVJHE1Pg.js +997 -0
  11. package/dist/lib/chunks/session-BqXC9a1-.js +281 -0
  12. package/dist/lib/chunks/toolIds-BCeSGHpV.js +821 -0
  13. package/dist/lib/chunks/workspaceTree-Destqupf.js +23 -0
  14. package/dist/lib/convergence/index.js +1035 -0
  15. package/dist/lib/convergence/node.js +8 -0
  16. package/dist/lib/embed-server/callbacks.js +37 -0
  17. package/dist/lib/embed-server/cli.js +19 -0
  18. package/dist/lib/embed-server/index.js +272 -0
  19. package/dist/lib/extensions/index.js +439 -0
  20. package/dist/lib/extensions/panel.html +208 -0
  21. package/dist/lib/extensions/runtime.js +198 -0
  22. package/dist/lib/extensions/sandbox.html +35 -0
  23. package/dist/lib/kdm/index.js +437 -0
  24. package/dist/lib/kit-dev-host/checkUiIds.mjs +44 -0
  25. package/dist/lib/kit-dev-host/index.js +308 -0
  26. package/dist/lib/kit-dev-host/lineRow.mjs +47 -0
  27. package/dist/lib/kit-dev-host/modeSmoke.mjs +178 -0
  28. package/dist/lib/kit-editor/index.js +6481 -0
  29. package/dist/lib/kit-editor/styles.css +807 -0
  30. package/dist/lib/kit-editor/workspaceTree.js +1 -0
  31. package/dist/lib/kit-engine/index.js +7 -0
  32. package/dist/lib/kit-host/index.js +530 -0
  33. package/dist/lib/kit-ui-protocol/index.js +336 -0
  34. package/dist/lib/node-only/embed-server-callbacks.js +2 -0
  35. package/dist/lib/node-only/embed-server.js +2 -0
  36. package/dist/lib/sync/index.js +1008 -0
  37. package/dist/lib/sync/openToken.js +201 -0
  38. package/dist/lib/sync/replicaVersions.js +51 -0
  39. package/dist/standalone/chunks/batch-CAGYk6m4.js +789 -0
  40. package/dist/standalone/chunks/client-B9xkOcvf.js +772 -0
  41. package/dist/standalone/chunks/collab-CTQZ9h7J.js +1022 -0
  42. package/dist/standalone/chunks/comment-Ds9t8xSE.js +94 -0
  43. package/dist/standalone/chunks/comments-uVDS8Wxp.js +41 -0
  44. package/dist/standalone/chunks/document-B5MMuYyN.js +324 -0
  45. package/dist/standalone/chunks/envelope-GX4Cynkx.js +7612 -0
  46. package/dist/standalone/chunks/index-BEgEEnhU.js +287 -0
  47. package/dist/standalone/chunks/index-EEl8hGbP.js +1967 -0
  48. package/dist/standalone/chunks/kits-Cp51mDlw.js +9 -0
  49. package/dist/standalone/chunks/replica-Di2iCPiD.js +3281 -0
  50. package/dist/standalone/chunks/replicaVersions-C3rJxnk9.js +50 -0
  51. package/dist/standalone/chunks/touched-T9jKJjxn.js +78 -0
  52. package/dist/standalone/index.js +12 -0
  53. package/dist/standalone/script/index.js +339 -0
  54. package/dist/standalone/script/kits/board.js +5 -0
  55. package/dist/standalone/script/kits/cad.js +5 -0
  56. package/dist/standalone/script/kits/design.js +5 -0
  57. package/dist/standalone/script/kits/doc.js +5 -0
  58. package/dist/standalone/script/kits/film.js +5 -0
  59. package/dist/standalone/script/kits/html.js +5 -0
  60. package/dist/standalone/script/kits/index.js +38 -0
  61. package/dist/standalone/script/kits/layout.js +5 -0
  62. package/dist/standalone/script/kits/motion.js +5 -0
  63. package/dist/standalone/script/kits/note.js +5 -0
  64. package/dist/standalone/script/kits/pdf.js +5 -0
  65. package/dist/standalone/script/kits/photo.js +5 -0
  66. package/dist/standalone/script/kits/scene.js +5 -0
  67. package/dist/standalone/script/kits/sheet.js +5 -0
  68. package/dist/standalone/script/kits/slide.js +5 -0
  69. package/dist/standalone/script/kits/table.js +5 -0
  70. package/dist/standalone/script/kits/vector.js +5 -0
  71. package/dist/standalone/script/node.js +401 -0
  72. package/dist/standalone/script/proxy.js +254 -0
  73. package/dist/types/convergence/src/adapter.d.ts +131 -0
  74. package/dist/types/convergence/src/engine.d.ts +66 -0
  75. package/dist/types/convergence/src/index.d.ts +21 -0
  76. package/dist/types/convergence/src/net.d.ts +52 -0
  77. package/dist/types/convergence/src/node.d.ts +6 -0
  78. package/dist/types/convergence/src/report.d.ts +56 -0
  79. package/dist/types/convergence/src/rng.d.ts +12 -0
  80. package/dist/types/convergence/src/scenarios.d.ts +15 -0
  81. package/dist/types/convergence/src/state.d.ts +67 -0
  82. package/dist/types/embed/src/agent.d.ts +88 -0
  83. package/dist/types/embed/src/blobs.d.ts +2 -0
  84. package/dist/types/embed/src/collab.d.ts +250 -0
  85. package/dist/types/embed/src/comments.d.ts +30 -0
  86. package/dist/types/embed/src/errors.d.ts +24 -0
  87. package/dist/types/embed/src/handlers.d.ts +92 -0
  88. package/dist/types/embed/src/index.d.ts +20 -0
  89. package/dist/types/embed/src/mount.d.ts +39 -0
  90. package/dist/types/embed/src/replicaStore.d.ts +3 -0
  91. package/dist/types/embed/src/rooms.d.ts +40 -0
  92. package/dist/types/embed/src/schemas.d.ts +7 -0
  93. package/dist/types/embed/src/syncClients.d.ts +28 -0
  94. package/dist/types/embed/src/theme.d.ts +7 -0
  95. package/dist/types/embed/src/types.d.ts +596 -0
  96. package/dist/types/embed/src/ui.d.ts +33 -0
  97. package/dist/types/embed/src/version.d.ts +2 -0
  98. package/dist/types/embed-server/src/callbacks.d.ts +30 -0
  99. package/dist/types/embed-server/src/cli.d.ts +1 -0
  100. package/dist/types/embed-server/src/index.d.ts +19 -0
  101. package/dist/types/embed-server/src/page.d.ts +15 -0
  102. package/dist/types/embed-server/src/server.d.ts +39 -0
  103. package/dist/types/embed-server/src/session.d.ts +22 -0
  104. package/dist/types/extensions/src/gate.d.ts +17 -0
  105. package/dist/types/extensions/src/generated/runtime.d.ts +8 -0
  106. package/dist/types/extensions/src/host.d.ts +135 -0
  107. package/dist/types/extensions/src/index.d.ts +13 -0
  108. package/dist/types/extensions/src/manifest.d.ts +82 -0
  109. package/dist/types/extensions/src/protocol.d.ts +159 -0
  110. package/dist/types/extensions/src/rpc.d.ts +52 -0
  111. package/dist/types/extensions/src/runtime/document.d.ts +40 -0
  112. package/dist/types/extensions/src/runtime/index.d.ts +10 -0
  113. package/dist/types/extensions/src/runtime/panel.d.ts +19 -0
  114. package/dist/types/extensions/src/runtime/runtime.d.ts +54 -0
  115. package/dist/types/extensions/src/runtime/worker.d.ts +1 -0
  116. package/dist/types/extensions/src/sandbox.d.ts +41 -0
  117. package/dist/types/kdm/src/args.d.ts +12 -0
  118. package/dist/types/kdm/src/batch.d.ts +118 -0
  119. package/dist/types/kdm/src/canonical.d.ts +25 -0
  120. package/dist/types/kdm/src/comment.d.ts +114 -0
  121. package/dist/types/kdm/src/diff.d.ts +125 -0
  122. package/dist/types/kdm/src/envelope.d.ts +27 -0
  123. package/dist/types/kdm/src/errors.d.ts +28 -0
  124. package/dist/types/kdm/src/footprint.d.ts +21 -0
  125. package/dist/types/kdm/src/ids.d.ts +57 -0
  126. package/dist/types/kdm/src/index.d.ts +18 -0
  127. package/dist/types/kdm/src/marks.d.ts +32 -0
  128. package/dist/types/kdm/src/op.d.ts +124 -0
  129. package/dist/types/kdm/src/origin.d.ts +41 -0
  130. package/dist/types/kdm/src/overlay.d.ts +92 -0
  131. package/dist/types/kdm/src/projection.d.ts +29 -0
  132. package/dist/types/kdm/src/read.d.ts +90 -0
  133. package/dist/types/kdm/src/replica.d.ts +403 -0
  134. package/dist/types/kdm/src/schema.d.ts +185 -0
  135. package/dist/types/kdm/src/testing.d.ts +28 -0
  136. package/dist/types/kdm/src/toolIds.d.ts +61 -0
  137. package/dist/types/kdm/src/touched.d.ts +24 -0
  138. package/dist/types/kdm/src/tx.d.ts +215 -0
  139. package/dist/types/kdm/src/value.d.ts +23 -0
  140. package/dist/types/kit-dev-host/src/checkNoPaths.d.ts +19 -0
  141. package/dist/types/kit-dev-host/src/checkUiIds.d.mts +2 -0
  142. package/dist/types/kit-dev-host/src/index.d.ts +179 -0
  143. package/dist/types/kit-dev-host/src/lineRow.d.mts +14 -0
  144. package/dist/types/kit-dev-host/src/memoryFiles.d.ts +15 -0
  145. package/dist/types/kit-dev-host/src/modeSmoke.d.mts +8 -0
  146. package/dist/types/kit-editor/src/CommandDialog.d.ts +22 -0
  147. package/dist/types/kit-editor/src/CommentsPanel.d.ts +45 -0
  148. package/dist/types/kit-editor/src/CustomizeDialog.d.ts +32 -0
  149. package/dist/types/kit-editor/src/HostButtons.d.ts +11 -0
  150. package/dist/types/kit-editor/src/RenderFailure.d.ts +7 -0
  151. package/dist/types/kit-editor/src/TextSink.d.ts +6 -0
  152. package/dist/types/kit-editor/src/brand.d.ts +2 -0
  153. package/dist/types/kit-editor/src/catalogMenus.d.ts +27 -0
  154. package/dist/types/kit-editor/src/chart.d.ts +138 -0
  155. package/dist/types/kit-editor/src/conflicts.d.ts +12 -0
  156. package/dist/types/kit-editor/src/drawing.d.ts +83 -0
  157. package/dist/types/kit-editor/src/editor.d.ts +544 -0
  158. package/dist/types/kit-editor/src/engine/KitCanvas.d.ts +70 -0
  159. package/dist/types/kit-editor/src/engine/backdrop.d.ts +32 -0
  160. package/dist/types/kit-editor/src/engine/createKitFile.d.ts +12 -0
  161. package/dist/types/kit-editor/src/engine/decorations.d.ts +14 -0
  162. package/dist/types/kit-editor/src/engine/engineOverlays.d.ts +197 -0
  163. package/dist/types/kit-editor/src/engine/engineTools.d.ts +116 -0
  164. package/dist/types/kit-editor/src/engine/kitDraft.d.ts +70 -0
  165. package/dist/types/kit-editor/src/engine/kitEngine.d.ts +390 -0
  166. package/dist/types/kit-editor/src/engine/kitEngine.worker.d.ts +30 -0
  167. package/dist/types/kit-editor/src/engine/kitHost.d.ts +41 -0
  168. package/dist/types/kit-editor/src/engine/kitModel.d.ts +32 -0
  169. package/dist/types/kit-editor/src/engine/kitModelRunner.d.ts +99 -0
  170. package/dist/types/kit-editor/src/engine/kitModule.d.ts +185 -0
  171. package/dist/types/kit-editor/src/engine/kitShortcuts.d.ts +32 -0
  172. package/dist/types/kit-editor/src/engine/kitTools.d.ts +79 -0
  173. package/dist/types/kit-editor/src/engine/lazyFonts.d.ts +34 -0
  174. package/dist/types/kit-editor/src/engine/lentFiles.d.ts +29 -0
  175. package/dist/types/kit-editor/src/engine/rasterViewport.d.ts +178 -0
  176. package/dist/types/kit-editor/src/engine/readOnly.d.ts +78 -0
  177. package/dist/types/kit-editor/src/engine/refusal.d.ts +39 -0
  178. package/dist/types/kit-editor/src/engine/replica.d.ts +23 -0
  179. package/dist/types/kit-editor/src/engine/useKitDocument.d.ts +154 -0
  180. package/dist/types/kit-editor/src/engine/workerRelay.d.ts +62 -0
  181. package/dist/types/kit-editor/src/files.d.ts +74 -0
  182. package/dist/types/kit-editor/src/frame/EditorFrame.d.ts +74 -0
  183. package/dist/types/kit-editor/src/frame/FocusBar.d.ts +10 -0
  184. package/dist/types/kit-editor/src/frame/MenuNodes.d.ts +20 -0
  185. package/dist/types/kit-editor/src/frame/MenuRibbon.d.ts +8 -0
  186. package/dist/types/kit-editor/src/frame/ModeButton.d.ts +7 -0
  187. package/dist/types/kit-editor/src/frame/menus.d.ts +64 -0
  188. package/dist/types/kit-editor/src/frame/modes.d.ts +51 -0
  189. package/dist/types/kit-editor/src/frame/useFrameLayout.d.ts +34 -0
  190. package/dist/types/kit-editor/src/host.d.ts +127 -0
  191. package/dist/types/kit-editor/src/index.d.ts +85 -0
  192. package/dist/types/kit-editor/src/ink.d.ts +26 -0
  193. package/dist/types/kit-editor/src/lease.d.ts +53 -0
  194. package/dist/types/kit-editor/src/oneInFlight.d.ts +7 -0
  195. package/dist/types/kit-editor/src/phrases.d.ts +25 -0
  196. package/dist/types/kit-editor/src/presence.d.ts +79 -0
  197. package/dist/types/kit-editor/src/strings.d.ts +6 -0
  198. package/dist/types/kit-editor/src/toolIcons.d.ts +32 -0
  199. package/dist/types/kit-editor/src/uiCatalog.d.ts +59 -0
  200. package/dist/types/kit-editor/src/uiConfig.d.ts +53 -0
  201. package/dist/types/kit-editor/src/uiContext.d.ts +65 -0
  202. package/dist/types/kit-editor/src/uiStore.d.ts +20 -0
  203. package/dist/types/kit-editor/src/useCommentAnchors.d.ts +29 -0
  204. package/dist/types/kit-editor/src/useKitSession.d.ts +115 -0
  205. package/dist/types/kit-editor/src/workspaceTree.d.ts +5 -0
  206. package/dist/types/kit-engine/src/contract.d.ts +154 -0
  207. package/dist/types/kit-engine/src/index.d.ts +2 -0
  208. package/dist/types/kit-engine/src/session.d.ts +133 -0
  209. package/dist/types/kit-host/src/files.d.ts +163 -0
  210. package/dist/types/kit-host/src/index.d.ts +315 -0
  211. package/dist/types/kit-ui-protocol/src/index.d.ts +1145 -0
  212. package/dist/types/loro-crdt.d.ts +9 -0
  213. package/dist/types/script/kits/board.d.ts +534 -0
  214. package/dist/types/script/kits/cad.d.ts +2937 -0
  215. package/dist/types/script/kits/design.d.ts +3213 -0
  216. package/dist/types/script/kits/doc.d.ts +2575 -0
  217. package/dist/types/script/kits/film.d.ts +4067 -0
  218. package/dist/types/script/kits/html.d.ts +38 -0
  219. package/dist/types/script/kits/index.d.ts +20 -0
  220. package/dist/types/script/kits/layout.d.ts +3483 -0
  221. package/dist/types/script/kits/motion.d.ts +4826 -0
  222. package/dist/types/script/kits/note.d.ts +631 -0
  223. package/dist/types/script/kits/pdf.d.ts +829 -0
  224. package/dist/types/script/kits/photo.d.ts +7574 -0
  225. package/dist/types/script/kits/scene.d.ts +2962 -0
  226. package/dist/types/script/kits/sheet.d.ts +2419 -0
  227. package/dist/types/script/kits/slide.d.ts +1894 -0
  228. package/dist/types/script/kits/table.d.ts +654 -0
  229. package/dist/types/script/kits/vector.d.ts +5167 -0
  230. package/dist/types/script/src/agentRelay.d.ts +48 -0
  231. package/dist/types/script/src/capabilities.d.ts +21 -0
  232. package/dist/types/script/src/document.d.ts +87 -0
  233. package/dist/types/script/src/drafts.d.ts +141 -0
  234. package/dist/types/script/src/exchange.d.ts +30 -0
  235. package/dist/types/script/src/headless.d.ts +190 -0
  236. package/dist/types/script/src/index.d.ts +15 -0
  237. package/dist/types/script/src/kitModel.d.ts +17 -0
  238. package/dist/types/script/src/kits.d.ts +8 -0
  239. package/dist/types/script/src/node.d.ts +42 -0
  240. package/dist/types/script/src/port.d.ts +89 -0
  241. package/dist/types/script/src/proxy.d.ts +132 -0
  242. package/dist/types/script/src/room.d.ts +162 -0
  243. package/dist/types/script/src/sources.d.ts +73 -0
  244. package/dist/types/sync/src/backoff.d.ts +9 -0
  245. package/dist/types/sync/src/blobSection.d.ts +23 -0
  246. package/dist/types/sync/src/capabilities.d.ts +20 -0
  247. package/dist/types/sync/src/client.d.ts +253 -0
  248. package/dist/types/sync/src/framing.d.ts +35 -0
  249. package/dist/types/sync/src/hash.d.ts +2 -0
  250. package/dist/types/sync/src/index.d.ts +19 -0
  251. package/dist/types/sync/src/leases.d.ts +82 -0
  252. package/dist/types/sync/src/openToken.d.ts +104 -0
  253. package/dist/types/sync/src/protocol.d.ts +484 -0
  254. package/dist/types/sync/src/relay.d.ts +52 -0
  255. package/dist/types/sync/src/replicaVersions.d.ts +17 -0
  256. package/dist/types/sync/src/saveMachine.d.ts +83 -0
  257. package/dist/types/sync/src/saveRun.d.ts +52 -0
  258. package/dist/types/sync/src/transport.d.ts +19 -0
  259. package/package.json +229 -4
@@ -0,0 +1,4067 @@
1
+ import type { CommandMap, ModelDocument, ModelList, ModelObject, ModelTree, RequestContext } from '../src/index.js';
2
+ import { type KitDescriptor } from '../src/kits.js';
3
+ type Json = null | boolean | number | string | Json[] | {
4
+ [key: string]: Json;
5
+ };
6
+ /** kit.film: registered with @kition/sdk/script when this module loads. */
7
+ export declare const filmKit: KitDescriptor;
8
+ /** The fields a new `SearchPremises` takes (`list.add(fields)`). */
9
+ export type SearchPremisesFields = {};
10
+ /** A `SearchPremises` of kit.film. Read-only: the kit keeps it as it is (rule OM8); scripts read it and run commands. */
11
+ export interface SearchPremises extends ModelObject {
12
+ }
13
+ /** The fields a new `EditorPremises` takes (`list.add(fields)`). */
14
+ export type EditorPremisesFields = {
15
+ selection: Json;
16
+ };
17
+ /** A `EditorPremises` of kit.film. Read-only: the kit keeps it as it is (rule OM8); scripts read it and run commands. */
18
+ export interface EditorPremises extends ModelObject {
19
+ selection: Json;
20
+ }
21
+ /** The fields a new `ItemPremises` takes (`list.add(fields)`). */
22
+ export type ItemPremisesFields = {
23
+ items: Json;
24
+ };
25
+ /** A `ItemPremises` of kit.film. Read-only: the kit keeps it as it is (rule OM8); scripts read it and run commands. */
26
+ export interface ItemPremises extends ModelObject {
27
+ items: Json;
28
+ }
29
+ /** The fields a new `PremiseFact` takes (`list.add(fields)`). */
30
+ export type PremiseFactFields = {
31
+ value?: Json | null;
32
+ };
33
+ /** A `PremiseFact` of kit.film. Read-only: the kit keeps it as it is (rule OM8); scripts read it and run commands. */
34
+ export interface PremiseFact extends ModelObject {
35
+ /** Read-only: the kit keeps it as it is. */
36
+ readonly key: string;
37
+ value: Json | null;
38
+ }
39
+ /** The fields a new `Project` takes (`list.add(fields)`). */
40
+ export type ProjectFields = {
41
+ name: string;
42
+ settings: Json;
43
+ docState?: Json | null;
44
+ };
45
+ /** A `Project` of kit.film. */
46
+ export interface Project extends ModelObject {
47
+ name: string;
48
+ settings: Json;
49
+ readonly bins: ModelTree<Bin, BinFields>;
50
+ docState: Json | null;
51
+ }
52
+ /** The fields a new `Bin` takes (`list.add(fields)`). */
53
+ export type BinFields = {
54
+ name: string;
55
+ };
56
+ /** A `Bin` of kit.film. */
57
+ export interface Bin extends ModelObject {
58
+ name: string;
59
+ readonly entries: ModelList<Item, ItemFields>;
60
+ /** Read-only: the kit keeps it as it is. */
61
+ readonly binId: number | null;
62
+ }
63
+ /** The fields a new `Item` takes (`list.add(fields)`). */
64
+ export type ItemFields = {
65
+ kind: "media" | "sequence" | "subclip" | "adjustment" | "graphic";
66
+ name: string;
67
+ props?: Json | null;
68
+ sequence?: string | ModelObject | null;
69
+ };
70
+ /** A `Item` of kit.film. */
71
+ export interface Item extends ModelObject {
72
+ kind: "media" | "sequence" | "subclip" | "adjustment" | "graphic";
73
+ name: string;
74
+ props: Json | null;
75
+ /** The id of a `Sequence`. */
76
+ get sequence(): string | null;
77
+ set sequence(value: Sequence | string | null);
78
+ /** Read-only: the kit keeps it as it is. */
79
+ readonly itemId: number | null;
80
+ }
81
+ /** The fields a new `Sequence` takes (`list.add(fields)`). */
82
+ export type SequenceFields = {
83
+ settings: Json;
84
+ captionTracks?: Json | null;
85
+ markers?: Json | null;
86
+ mixer?: Json | null;
87
+ masterVolumeDb?: number | null;
88
+ };
89
+ /** A `Sequence` of kit.film. */
90
+ export interface Sequence extends ModelObject {
91
+ settings: Json;
92
+ /** Read-only: the kit keeps it as it is. */
93
+ readonly duration: string | null;
94
+ readonly videoTracks: ModelList<Track, TrackFields>;
95
+ readonly audioTracks: ModelList<Track, TrackFields>;
96
+ readonly submixTracks: ModelList<Track, TrackFields>;
97
+ captionTracks: Json | null;
98
+ markers: Json | null;
99
+ mixer: Json | null;
100
+ masterVolumeDb: number | null;
101
+ }
102
+ /** The fields a new `Track` takes (`list.add(fields)`). */
103
+ export type TrackFields = {
104
+ props?: Json | null;
105
+ volumeDb?: number | null;
106
+ pan?: number | null;
107
+ };
108
+ /** A `Track` of kit.film. */
109
+ export interface Track extends ModelObject {
110
+ props: Json | null;
111
+ volumeDb: number | null;
112
+ pan: number | null;
113
+ readonly effects: ModelList<Effect, EffectFields>;
114
+ readonly clips: ModelList<Clip, ClipFields>;
115
+ readonly transitions: ModelList<Transition, TransitionFields>;
116
+ /** Read-only: the kit keeps it as it is. */
117
+ readonly trackId: number | null;
118
+ }
119
+ /** The fields a new `Clip` takes (`list.add(fields)`). */
120
+ export type ClipFields = {
121
+ item?: string | ModelObject | null;
122
+ start: string;
123
+ duration: string;
124
+ sourceIn: string;
125
+ speed: number;
126
+ reverse: boolean;
127
+ link?: string | null;
128
+ group?: string | null;
129
+ gain?: Json | null;
130
+ markers?: Json | null;
131
+ props?: Json | null;
132
+ };
133
+ /** A `Clip` of kit.film. */
134
+ export interface Clip extends ModelObject {
135
+ /** The id of a `Item`. */
136
+ get item(): string | null;
137
+ set item(value: Item | string | null);
138
+ /** Read-only: the kit keeps it as it is. */
139
+ readonly missingItem: number | null;
140
+ start: string;
141
+ duration: string;
142
+ sourceIn: string;
143
+ speed: number;
144
+ reverse: boolean;
145
+ link: string | null;
146
+ group: string | null;
147
+ gain: Json | null;
148
+ markers: Json | null;
149
+ props: Json | null;
150
+ readonly effects: ModelList<Effect, EffectFields>;
151
+ /** Read-only: the kit keeps it as it is. */
152
+ readonly clipId: number | null;
153
+ }
154
+ /** The fields a new `Effect` takes (`list.add(fields)`). */
155
+ export type EffectFields = {
156
+ params?: Json | null;
157
+ };
158
+ /** A `Effect` of kit.film. */
159
+ export interface Effect extends ModelObject {
160
+ /** Read-only: the kit keeps it as it is. */
161
+ readonly def: string;
162
+ params: Json | null;
163
+ }
164
+ /** The fields a new `Transition` takes (`list.add(fields)`). */
165
+ export type TransitionFields = {
166
+ effect: string | ModelObject;
167
+ start: string;
168
+ duration: string;
169
+ from?: string | ModelObject | null;
170
+ to?: string | ModelObject | null;
171
+ align: string;
172
+ reverse: boolean;
173
+ };
174
+ /** A `Transition` of kit.film. */
175
+ export interface Transition extends ModelObject {
176
+ /** The id of a `Effect`. */
177
+ get effect(): string;
178
+ set effect(value: Effect | string);
179
+ start: string;
180
+ duration: string;
181
+ /** The id of a `Clip`. */
182
+ get from(): string | null;
183
+ set from(value: Clip | string | null);
184
+ /** The id of a `Clip`. */
185
+ get to(): string | null;
186
+ set to(value: Clip | string | null);
187
+ align: string;
188
+ reverse: boolean;
189
+ /** Read-only: the kit keeps it as it is. */
190
+ readonly transitionId: number | null;
191
+ }
192
+ /** Every command of kit.film, by id, with its parameters. */
193
+ export interface FilmCommands extends CommandMap {
194
+ /** Project. Replaces the current project with a new empty one named `name`; unsaved changes are not kept. Params: {"name":str}. Changes the document. */
195
+ "file.newProject": {
196
+ name?: string;
197
+ };
198
+ /** Demo Project. Replaces the current project with the built-in demo project and opens its sequence. Params: {}. Changes the document. */
199
+ "file.openDemoProject": Record<string, never>;
200
+ /** Sequence. Creates a sequence `name` (default 1920?1080, 23.976 fps, 48 kHz, 3 video and 3 audio tracks, or from `item`'s format) and opens it. Answers the new sequence id. Params: {"name":str,"width":u32=1920,"height":u32=1080,"fps":f64=23.976,"sampleRate":u32=48000,"video":n=3,"audio":n=3,"mix":"Stereo|Mono|5.1|Adaptive"?,"trackType":"Standard|Mono|5.1|Adaptive"?,"fromItem":itemId?}. Reads the mode. Changes the document. */
201
+ "file.newSequence": {
202
+ audio?: number;
203
+ fps?: number; /** a project item id */
204
+ fromItem?: number;
205
+ height?: number;
206
+ mix?: "Stereo" | "Mono" | "5.1" | "Adaptive";
207
+ name?: string;
208
+ sampleRate?: number;
209
+ trackType?: "Standard" | "Mono" | "5.1" | "Adaptive";
210
+ video?: number;
211
+ width?: number;
212
+ };
213
+ /** Sequence From Clip. Creates a sequence matching the format of each selected or listed clip `items` with that clip placed on it, and opens it. Params: {"items":[id]?}. Acts on `items`. Reads the selection, mode. Changes the document. */
214
+ "file.newSequenceFromClip": {
215
+ items?: Array<number>;
216
+ };
217
+ /** Bin. Creates a bin `name` (default New Bin) in bin `parent` (default root). Answers the new bin id. Params: {"name":str,"parent":binId?}. Changes the document. */
218
+ "file.newBin": {
219
+ name?: string; /** binId? */
220
+ parent?: number;
221
+ };
222
+ /** Bin From Selection. Creates a bin named `name` and moves the selected or listed `items` into it. Params: {"items":[id]?,"name":str?}. Acts on `items`. Reads the selection. Changes the document. */
223
+ "file.newBinFromSelection": {
224
+ items?: Array<number>;
225
+ name?: string;
226
+ };
227
+ /** Search Bin. Creates a search bin `name` that live-matches items by `column`/`operator`/`text` (or `rows` with `matchAll`). Params: {"name":str?,"column":str?,"operator":str?,"text":str?,"rows":[..]?,"matchAll":bool?,"caseSensitive":bool?}. Changes the document. */
228
+ "file.newSearchBin": {
229
+ caseSensitive?: boolean;
230
+ column?: string;
231
+ matchAll?: boolean;
232
+ name?: string;
233
+ operator?: string; /** [..]? */
234
+ rows?: Array<Json>;
235
+ text?: string;
236
+ };
237
+ /** Offline File. Creates an offline placeholder item with name, file and tape names, video/audio format, timecode and duration, to relink later. Params: {"name":str?,"fileName":str?,"tapeName":str?,"video":bool=true,"audio":bool=true,"width":u32?,"height":u32?,"fps":f64?,"sampleRate":u32=48000,"channels":u32=2,"timecode":"HH:MM:SS:FF"?,"seconds":f64=10,"description":str?}. Reads the part. Changes the document. */
238
+ "file.newOfflineFile": {
239
+ audio?: boolean;
240
+ channels?: number;
241
+ description?: string;
242
+ fileName?: string;
243
+ fps?: number; /** the time, as a frame of the sequence (one spelling of it) */
244
+ frame?: number;
245
+ height?: number;
246
+ name?: string;
247
+ sampleRate?: number;
248
+ seconds?: number;
249
+ tapeName?: string; /** the time, in ticks (one spelling of it) */
250
+ time?: number; /** like HH:MM:SS:FF */
251
+ timecode?: string;
252
+ video?: boolean;
253
+ width?: number;
254
+ };
255
+ /** Adjustment Layer. Creates an Adjustment Layer project item `seconds` long (default 5) at the active sequence's frame size; effects on it apply to the tracks below. Params: {"seconds":f64=5}. Reads the part. Changes the document. */
256
+ "file.newAdjustmentLayer": {
257
+ seconds?: number;
258
+ };
259
+ /** Bars and Tone. Creates an SMPTE bars and 1 kHz tone generator item `seconds` long (default 10). Params: {"seconds":f64=10}. Reads the part. Changes the document. */
260
+ "file.newBarsAndTone": {
261
+ height?: number; /** read by the command beside its listed parameters */
262
+ name?: string;
263
+ seconds?: number; /** read by the command beside its listed parameters */
264
+ width?: number;
265
+ };
266
+ /** Black Video. Creates a black video generator item `seconds` long. Params: {"seconds":f64}. Reads the part. Changes the document. */
267
+ "file.newBlackVideo": {
268
+ height?: number; /** read by the command beside its listed parameters */
269
+ name?: string;
270
+ seconds?: number; /** read by the command beside its listed parameters */
271
+ width?: number;
272
+ };
273
+ /** Color Matte. Creates a solid Color Matte item of `color` #rrggbb, `seconds` long. Params: {"color":"#rrggbb","seconds":f64}. Reads the part. Changes the document. */
274
+ "file.newColorMatte": {
275
+ color?: string; /** read by the command beside its listed parameters */
276
+ height?: number; /** read by the command beside its listed parameters */
277
+ name?: string;
278
+ seconds?: number; /** read by the command beside its listed parameters */
279
+ width?: number;
280
+ };
281
+ /** Color Matte Color. Changes a Color Matte item's color (`item` or the Project panel selection) to `color` #rrggbb; every clip of the matte follows. Params: {"item":id?,"color":"#rrggbb"}. Acts on `item`. Reads the selection. Changes the document. */
282
+ "project.matteColor": {
283
+ color?: string; /** an id */
284
+ item?: number;
285
+ };
286
+ /** Universal Counting Leader. Creates a Universal Counting Leader generator item (an 8-second countdown). Params: {}. Reads the part. Changes the document. */
287
+ "file.newCountingLeader": {
288
+ height?: number; /** read by the command beside its listed parameters */
289
+ name?: string; /** read by the command beside its listed parameters */
290
+ seconds?: number; /** read by the command beside its listed parameters */
291
+ width?: number;
292
+ };
293
+ /** Transparent Video. Creates a Transparent Video generator item (an empty clip for effects that draw their own content). Params: {}. Reads the part. Changes the document. */
294
+ "file.newTransparentVideo": {
295
+ height?: number; /** read by the command beside its listed parameters */
296
+ name?: string; /** read by the command beside its listed parameters */
297
+ seconds?: number; /** read by the command beside its listed parameters */
298
+ width?: number;
299
+ };
300
+ /** Demo Footage. Adds generated demo footage items (`scene` OceanSunset, Aurora, CityNight, Dunes, Plasma or Forest; all when omitted) to the project. Params: {"scene":"OceanSunset|Aurora|CityNight|Dunes|Plasma|Forest"}. Changes the document. */
301
+ "file.importDemoFootage": {
302
+ scene?: "OceanSunset" | "Aurora" | "CityNight" | "Dunes" | "Plasma" | "Forest";
303
+ };
304
+ /** Export Interchange. Writes the active (or `sequence`) sequence in an interchange `format`: edl, xml (FCP7), fcpxml, otio, aaf or omf, at `path`. Params: {"format":"edl|xml|fcpxml|otio|aaf|omf"=xml,"path":str,"sequence":id?}. Reads the part. Changes the document. */
305
+ "file.exportInterchange": {
306
+ format?: "edl" | "xml" | "fcpxml" | "otio" | "aaf" | "omf";
307
+ path?: Json; /** an id */
308
+ sequence?: number;
309
+ };
310
+ /** EDL. Writes the active sequence as a CMX 3600 EDL at `path` (video track V1 and its edits). Params: {"path":str}. Reads the part. Changes the document. */
311
+ "file.exportEdl": {
312
+ format?: string;
313
+ path?: Json;
314
+ };
315
+ /** Selection as Kition Film Project. Writes the selected or listed project `items` (and what they use) as a new Kition Film project at `path`. Params: {"path":str,"items":[id]?}. Acts on `items`. Reads the selection. Changes the document. */
316
+ "file.exportSelectionProject": {
317
+ items?: Array<number>;
318
+ path?: Json;
319
+ };
320
+ /** Avid Log Exchange. Writes an Avid Log Exchange (ALE) file at `path` listing the selected or listed media `items` with their metadata. Params: {"path":str,"items":[id]?}. Acts on `items`. Reads the selection. Changes the document. */
321
+ "file.exportAle": {
322
+ items?: Array<number>;
323
+ path?: Json;
324
+ };
325
+ /** OpenTimelineIO. Writes the active sequence as OpenTimelineIO (.otio) at `path`. Params: {"path":str}. Reads the part. Changes the document. */
326
+ "file.exportOtio": {
327
+ format?: string;
328
+ path?: Json;
329
+ };
330
+ /** Final Cut Pro XML. Writes the active sequence as Final Cut Pro 7 XML at `path` (Premiere/Resolve interchange). Params: {"path":str}. Reads the part. Changes the document. */
331
+ "file.exportFcp7Xml": {
332
+ format?: string;
333
+ path?: Json;
334
+ };
335
+ /** FCPXML. Writes the active sequence as FCPXML at `path` for Final Cut Pro. Params: {"path":str}. Reads the part. Changes the document. */
336
+ "file.exportFcpxml": {
337
+ format?: string;
338
+ path?: Json;
339
+ };
340
+ /** AAF. Writes the active (or `sequence`) sequence as AAF at `path` for Avid/Pro Tools, with audio embedded or separate, sample rate, bit depth, handles and optional video mixdown. Params: {"path":str,"sequence":id?,"mixdownVideo":bool?,"mixdownFormat":"mov|mxf"?,"breakoutToMono":bool?,"audio":"embedded|separate|linked"?,"audioFormat":"wav|aiff|mxf"?,"sampleRate":int?,"bitDepth":"16|24"?,"trimAudio":bool?,"handles":frames?,"renderAudioEffects":bool?,"smallSectors":bool?}. Reads the part. Changes the document. */
341
+ "file.exportAaf": {
342
+ audio?: "embedded" | "separate" | "linked";
343
+ audioFormat?: "wav" | "aiff" | "mxf";
344
+ bitDepth?: "16" | "24";
345
+ breakoutToMono?: boolean; /** frames */
346
+ handles?: number;
347
+ mixdownFormat?: "mov" | "mxf";
348
+ mixdownVideo?: boolean;
349
+ path?: Json;
350
+ renderAudioEffects?: boolean;
351
+ sampleRate?: number; /** an id */
352
+ sequence?: number;
353
+ smallSectors?: boolean;
354
+ trimAudio?: boolean;
355
+ };
356
+ /** OMF. Writes the active (or `sequence`) sequence's audio as OMF at `path` for Pro Tools, embedded or separate audio, sample rate, bit depth, handles. Params: {"path":str,"sequence":id?,"title":str?,"audio":"embedded|separate"?,"audioFormat":"wav|aiff"?,"sampleRate":int?,"bitDepth":"16|24"?,"trimAudio":bool?,"handles":frames?,"renderAudioEffects":bool?,"breakoutToMono":bool?}. Reads the part. Changes the document. */
357
+ "file.exportOmf": {
358
+ audio?: "embedded" | "separate";
359
+ audioFormat?: "wav" | "aiff";
360
+ bitDepth?: "16" | "24";
361
+ breakoutToMono?: boolean; /** frames */
362
+ handles?: number;
363
+ path?: Json;
364
+ renderAudioEffects?: boolean;
365
+ sampleRate?: number; /** an id */
366
+ sequence?: number;
367
+ title?: string;
368
+ trimAudio?: boolean;
369
+ };
370
+ /** Import AAF. Imports an AAF (or OMF) file at `path` as new sequences with their media. Params: {"path":str}. Changes the document. */
371
+ "file.importAaf": {
372
+ path?: Json;
373
+ };
374
+ /** Open Project. Opens the project file at `path`, replacing the current project. Params: {"path":str}. Reads the part. Changes the document. */
375
+ "file.open": {
376
+ path?: Json;
377
+ };
378
+ /** Close. Closes the active sequence's timeline tab (or `item`'s), like File ? Close; the project stays open. Params: {"item":id?}. Acts on `item`. Reads the part, active. Changes the document. */
379
+ "file.close": {
380
+ item?: number;
381
+ };
382
+ /** Close Project. Closes the project; refused with unsaved changes unless `force` discards them. Params: {"force":bool?}. Changes the document. */
383
+ "file.closeProject": {
384
+ force?: boolean;
385
+ };
386
+ /** Close All Projects. Closes the project, as file.closeProject; `force` discards unsaved changes. Params: {"force":bool?}. Changes the document. */
387
+ "file.closeAllProjects": {
388
+ force?: boolean;
389
+ };
390
+ /** Close All Other Projects. Closes every other open project; always refused, since a session holds one project. Params: {}. Changes the document. */
391
+ "file.closeAllOtherProjects": Record<string, never>;
392
+ /** Save. Saves the project to its file (or `path`). Needs a path once; use file.saveAs for a new file. Params: {"path":str?}. Reads the part, mode, active. Changes the document. */
393
+ "file.save": {
394
+ path?: Json;
395
+ };
396
+ /** Save As. Saves the project to `path` and makes that the project's file from now on. Params: {"path":str}. Reads the part, mode, active. Changes the document. */
397
+ "file.saveAs": {
398
+ path?: Json;
399
+ };
400
+ /** Save a Copy. Writes a copy of the project to `path`; the project keeps its own file. Params: {"path":str}. Reads the part, mode, active. Changes the document. */
401
+ "file.saveCopy": {
402
+ path?: Json;
403
+ };
404
+ /** Save as Template. Saves the project as a reusable template `name` (or at `path`). Params: {"name":str?,"path":str?}. Changes the document. */
405
+ "file.saveAsTemplate": {
406
+ name?: string;
407
+ path?: Json;
408
+ };
409
+ /** Save All. Saves the project, as file.save. Params: {}. Reads the part, mode, active. Changes the document. */
410
+ "file.saveAll": Record<string, never>;
411
+ /** Revert. Reloads the project from its last saved file, discarding changes since. Needs a saved project. Params: {}. Reads the part. Changes the document. */
412
+ "file.revert": Record<string, never>;
413
+ /** Recover Unsaved Changes. Loads a recoverable unsaved session (`id`, default newest) as the current unsaved project. Params: {"id":str?}. Reads the part. Changes the document. */
414
+ "file.recover": {
415
+ id?: string;
416
+ };
417
+ /** Discard Unsaved Changes. Deletes recoverable unsaved sessions: one by `id`, or `all`. Params: {"id":str?,"all":bool?}. Changes the document. */
418
+ "file.discardRecovery": {
419
+ all?: boolean;
420
+ id?: string;
421
+ };
422
+ /** List Recoverable Sessions. Lists recoverable unsaved sessions left by crashes or closed windows. Params: {}. */
423
+ "file.recoveryList": Record<string, never>;
424
+ /** Auto Save Now. Writes an auto-save of the current project immediately (desktop sessions with auto-save running). Answers the file written. Params: {}. Reads the mode. Changes the document. */
425
+ "file.autoSaveNow": Record<string, never>;
426
+ /** Auto Save Status. Reads the auto-save state: whether it runs, its preferences, data folder and the last save time. Params: {}. */
427
+ "file.autoSaveStatus": Record<string, never>;
428
+ /** Browse Auto-Saves. Lists the auto-save files of the current project, newest first, with their folder. Params: {}. */
429
+ "file.listAutoSaves": Record<string, never>;
430
+ /** Get Preferences. Reads preferences: one `key` (e.g. audio.scrubAudio, trim.largeTrimOffset) or all. Params: {"key":str?}. */
431
+ "prefs.get": {
432
+ key?: string;
433
+ };
434
+ /** Set Preferences. Sets preference `key` to `value`, or several `values`; see prefs.schema for keys and types. Params: {"key":str,"value":any}|{"values":{key:value}}. Reads the mode. Changes the document. */
435
+ "prefs.set": {
436
+ key?: string; /** in one of several forms of the parameters */
437
+ value?: Json; /** in one of several forms of the parameters */
438
+ values?: {
439
+ key?: Json;
440
+ };
441
+ };
442
+ /** Reset Preferences. Resets preferences to defaults: one `category` or all. Params: {"category":str?}. Reads the mode. Changes the document. */
443
+ "prefs.reset": {
444
+ category?: string;
445
+ };
446
+ /** Media. Renders the active sequence (In?Out when set) to a media file at `path`: `format` (h264, hevc, prores, dnxhr, png, wav...), size, fps, bitrate, quality, captions, loudness; or a `preset`. For H.264 a `quality` (0?100) without `bitrateKbps` or `bitrateMode` encodes at constant quality (CRF 51 at 0 to 12 at 100; 90 is CRF 15.9); otherwise the bitrate settings apply. Long jobs run in the background. Params: {"path":str,"preset":str?,"settings":ExportSettings?,"format":"h264|hevc|prores|dnxhr|apv|mjpeg|mxf-op1a|mxf-opatom|png|tiff|bmp|gif|wav|aiff"?,"width":u32?,"height":u32?,"fps":f64?,"bitrateKbps":u32?,"bitrateMode":"cbr|vbr1Pass|vbr2Pass|quality"?,"maxBitrateKbps":u32?,"keyframeDistance":u32?,"hardwareEncoding":"off|auto"?,"scale":f32=1,"audio":bool=true,"quality":0..100 (H.264: constant quality unless a bitrate is given)?,"burnCaptions":bool=false,"alpha":bool=false,"sdr":bool?,"captionSidecar":"srt|vtt"?,"loudnessLufs":f64?,"proresProfile":"proxy|lt|standard|hq"?,"dnxProfile":"lb|sq|hq|hqx"?,"apvProfile":"422-10|422-12|444-10|444-12"?,"mxfVideoCodec":"dnxhr|proRes|h264"?,"sequence":id?,"range":"entire|inOut|workArea|custom"?,"startSeconds":f64?,"endSeconds":f64?,"wait":bool=false}. Reads the part, time. Changes the document. */
447
+ "file.exportMedia": {
448
+ alpha?: boolean;
449
+ apvProfile?: "422-10" | "422-12" | "444-10" | "444-12";
450
+ audio?: boolean;
451
+ bitrateKbps?: number;
452
+ bitrateMode?: "cbr" | "vbr1Pass" | "vbr2Pass" | "quality";
453
+ burnCaptions?: boolean;
454
+ captionSidecar?: "srt" | "vtt";
455
+ dnxProfile?: "lb" | "sq" | "hq" | "hqx"; /** the end time, as a frame of the sequence (one spelling of it) */
456
+ endFrame?: number;
457
+ endSeconds?: number; /** the end time, in ticks (one spelling of it) */
458
+ endTime?: number; /** the end time, as a timecode (one spelling of it) */
459
+ endTimecode?: string;
460
+ format?: "h264" | "hevc" | "prores" | "dnxhr" | "apv" | "mjpeg" | "mxf-op1a" | "mxf-opatom" | "png" | "tiff" | "bmp" | "gif" | "wav" | "aiff";
461
+ fps?: number;
462
+ hardwareEncoding?: "off" | "auto";
463
+ height?: number;
464
+ keyframeDistance?: number;
465
+ loudnessLufs?: number;
466
+ maxBitrateKbps?: number;
467
+ mxfVideoCodec?: "dnxhr" | "proRes" | "h264";
468
+ path?: Json;
469
+ preset?: string;
470
+ proresProfile?: "proxy" | "lt" | "standard" | "hq"; /** 0 to 100; H.264: constant quality unless a bitrate is given */
471
+ quality?: number;
472
+ range?: "entire" | "inOut" | "workArea" | "custom";
473
+ scale?: number;
474
+ sdr?: boolean; /** an id */
475
+ sequence?: number; /** ExportSettings? */
476
+ settings?: Json; /** the start time, as a frame of the sequence (one spelling of it) */
477
+ startFrame?: number;
478
+ startSeconds?: number; /** the start time, in ticks (one spelling of it) */
479
+ startTime?: number; /** the start time, as a timecode (one spelling of it) */
480
+ startTimecode?: string;
481
+ wait?: boolean;
482
+ width?: number;
483
+ };
484
+ /** List Jobs. Lists background jobs (exports, proxies, analysis, renders) with id, kind, status and progress. Params: {}. */
485
+ "jobs.list": Record<string, never>;
486
+ /** Performance Statistics. Reads performance statistics: decode, render and cache timings and memory. Params: {}. */
487
+ "perf.stats": Record<string, never>;
488
+ /** Cancel Job. Cancels background `job` by id. Params: {"job":id}. Changes the document. */
489
+ "jobs.cancel": {
490
+ job?: number;
491
+ };
492
+ /** Undo. Undoes the last step in `scope` (person or agent; default the caller's own), so an agent's undo never takes back the person's edit. Answers {undone} with the step's label. Params: {"scope":"person|agent"?}. Reads the part, active. Changes the document. */
493
+ "edit.undo": {
494
+ scope?: "person" | "agent";
495
+ };
496
+ /** Redo. Redoes the last undone step in `scope` (person or agent; default the caller's own). Answers {redone} with the step's label. Params: {"scope":"person|agent"?}. Reads the part, active. Changes the document. */
497
+ "edit.redo": {
498
+ scope?: "person" | "agent";
499
+ };
500
+ /** Cut. Copies the selected clips (with linked partners) to the clipboard and deletes them, leaving gaps. Params: {}. Reads the part, selection, mode. Changes the document. */
501
+ "edit.cut": Record<string, never>;
502
+ /** Copy. Copies the selected timeline clips (with their tracks, offsets and markers) to the clipboard for edit.paste/pasteInsert/pasteAttributes. Answers {copied}. Params: {}. Reads the part, selection, mode. Changes the document. */
503
+ "edit.copy": Record<string, never>;
504
+ /** Paste. Pastes the clipboard's clips at the playhead on their original track layout, overwriting what is there; nothing moves. Use edit.pasteInsert to push later clips right. Params: {}. Reads the part, time, mode, active. Changes the document. */
505
+ "edit.paste": Record<string, never>;
506
+ /** Paste Insert. Pastes the clipboard's clips at the playhead as an insert: clips at and after the playhead move right by the pasted length on the affected tracks. Params: {}. Reads the part, time, mode, active. Changes the document. */
507
+ "edit.pasteInsert": Record<string, never>;
508
+ /** Paste Attributes. Pastes the copied clip's motion, opacity, time remapping, volume, channel volume, panner and `effects` (true or a list of effect ids) onto the selected or listed `clips`; `scaleTimes` fits keyframes to each clip's length. Params: {"clips":[id]?,"motion":bool=true,"opacity":bool=true,"timeRemapping":bool=true,"volume":bool=true,"channelVolume":bool=true,"panner":bool=true,"effects":bool|[effectId]=true,"scaleTimes":bool=true}. Acts on `clips`. Reads the part, selection, mode. Changes the document. */
509
+ "edit.pasteAttributes": {
510
+ channelVolume?: boolean;
511
+ clips?: Array<number>; /** bool|[effectId]=true; default true */
512
+ effects?: Array<Json>;
513
+ motion?: boolean;
514
+ opacity?: boolean;
515
+ panner?: boolean;
516
+ scaleTimes?: boolean;
517
+ timeRemapping?: boolean;
518
+ volume?: boolean;
519
+ };
520
+ /** Remove Attributes. Removes motion, opacity, time remapping, volume, channel volume, panner and/or `effects` from the selected or listed `clips`, resetting them to defaults. Params: {"clips":[id]?,"motion":bool=true,"opacity":bool=true,"timeRemapping":bool=true,"volume":bool=true,"channelVolume":bool=true,"panner":bool=true,"effects":bool|[effectId]=true}. Acts on `clips`. Reads the part, selection, mode. Changes the document. */
521
+ "edit.removeAttributes": {
522
+ channelVolume?: boolean;
523
+ clips?: Array<number>; /** bool|[effectId]=true; default true */
524
+ effects?: Array<Json>;
525
+ motion?: boolean;
526
+ opacity?: boolean;
527
+ panner?: boolean;
528
+ timeRemapping?: boolean;
529
+ volume?: boolean;
530
+ };
531
+ /** Clear. Deletes the selected (or listed `clips`) timeline clips with their linked partners, leaving gaps; with no clip selected it deletes the selected captions. Use edit.rippleDelete to close the gaps. Params: {"clips":[id]?}. Acts on `clips`. Reads the part, selection, mode. Changes the document. */
532
+ "edit.clear": {
533
+ clip?: number;
534
+ clips?: Array<number>;
535
+ };
536
+ /** Ripple Delete. Deletes the selected (or listed `clips`) clips and closes the gaps by moving later clips earlier; refused when nothing can close. With no clip selected it ripple-deletes the selected captions. Params: {"clips":[id]?}. Acts on `clips`. Reads the part, selection, mode. Changes the document. */
537
+ "edit.rippleDelete": {
538
+ clip?: number;
539
+ clips?: Array<number>;
540
+ };
541
+ /** Select All. Selects every clip on every track of the active sequence. Answers {selected}. Params: {}. Reads the part, selection. Changes the document. */
542
+ "edit.selectAll": Record<string, never>;
543
+ /** Select All Matching. Selects every clip in the active sequence that uses the same source item as the selected (or listed) clips. Answers {clips}. Params: {"clips":[id]?}. Acts on `clips`. Reads the part, selection. Changes the document. */
544
+ "edit.selectAllMatching": {
545
+ clips?: Array<number>;
546
+ };
547
+ /** Deselect All. Clears the timeline clip and caption selection. Params: {}. Changes the document. */
548
+ "edit.deselectAll": Record<string, never>;
549
+ /** Find. Finds project items (`scope` project) or timeline clips (timeline) by `column` and `operator` with `text`, or several `rows` (`matchAll`); selects and reveals the first match. Answers it and the match count. Params: {"scope":"project|timeline"?,"column":str?,"operator":"contains|matches|beginsWith|endsWith|doesNotContain"?,"text":str?,"rows":[{"column":str,"operator":str,"text":str}]?,"matchAll":bool=true,"caseSensitive":bool=false,"in":"all|clips|markers"?}. Reads the part, time, mode, active. Changes the document. */
550
+ "edit.find": {
551
+ caseSensitive?: boolean;
552
+ column?: string;
553
+ in?: "all" | "clips" | "markers";
554
+ matchAll?: boolean;
555
+ operator?: "contains" | "matches" | "beginsWith" | "endsWith" | "doesNotContain";
556
+ rows?: Array<{
557
+ column?: string;
558
+ operator?: string;
559
+ text?: string;
560
+ }>;
561
+ scope?: "project" | "timeline";
562
+ text?: string;
563
+ };
564
+ /** Find Next. Selects and reveals the next match of the last edit.find search. Needs a previous edit.find. Params: {}. Reads the part, time, mode, active. Changes the document. */
565
+ "edit.findNext": Record<string, never>;
566
+ /** Duplicate. Duplicates the selected Project panel items as new items named "<name> Copy" in the same bin. Answers the new item ids. Params: {}. Reads the selection. Changes the document. */
567
+ "edit.duplicate": Record<string, never>;
568
+ /** Select Label Group. Selects every timeline clip (or Project panel item, when no clip is selected) with the same color label as the current selection. Params: {}. Reads the part, selection. Changes the document. */
569
+ "edit.selectLabelGroup": Record<string, never>;
570
+ /** Violet. Sets the Violet color label on the selected (or listed `clips`) timeline clips and Project panel (`items`) items. Params: {"items":[id]?,"clips":[id]?}. Reads the part, selection. Changes the document. */
571
+ "edit.label.violet": {
572
+ clips?: Array<number>;
573
+ items?: Array<number>;
574
+ };
575
+ /** Iris. Sets the Iris color label on the selected (or listed `clips`) timeline clips and Project panel (`items`) items. Params: {"items":[id]?,"clips":[id]?}. Reads the part, selection. Changes the document. */
576
+ "edit.label.iris": {
577
+ clips?: Array<number>;
578
+ items?: Array<number>;
579
+ };
580
+ /** Caribbean. Sets the Caribbean color label on the selected (or listed `clips`) timeline clips and Project panel (`items`) items. Params: {"items":[id]?,"clips":[id]?}. Reads the part, selection. Changes the document. */
581
+ "edit.label.caribbean": {
582
+ clips?: Array<number>;
583
+ items?: Array<number>;
584
+ };
585
+ /** Lavender. Sets the Lavender color label on the selected (or listed `clips`) timeline clips and Project panel (`items`) items. Params: {"items":[id]?,"clips":[id]?}. Reads the part, selection. Changes the document. */
586
+ "edit.label.lavender": {
587
+ clips?: Array<number>;
588
+ items?: Array<number>;
589
+ };
590
+ /** Cerulean. Sets the Cerulean color label on the selected (or listed `clips`) timeline clips and Project panel (`items`) items. Params: {"items":[id]?,"clips":[id]?}. Reads the part, selection. Changes the document. */
591
+ "edit.label.cerulean": {
592
+ clips?: Array<number>;
593
+ items?: Array<number>;
594
+ };
595
+ /** Forest. Sets the Forest color label on the selected (or listed `clips`) timeline clips and Project panel (`items`) items. Params: {"items":[id]?,"clips":[id]?}. Reads the part, selection. Changes the document. */
596
+ "edit.label.forest": {
597
+ clips?: Array<number>;
598
+ items?: Array<number>;
599
+ };
600
+ /** Rose. Sets the Rose color label on the selected (or listed `clips`) timeline clips and Project panel (`items`) items. Params: {"items":[id]?,"clips":[id]?}. Reads the part, selection. Changes the document. */
601
+ "edit.label.rose": {
602
+ clips?: Array<number>;
603
+ items?: Array<number>;
604
+ };
605
+ /** Mango. Sets the Mango color label on the selected (or listed `clips`) timeline clips and Project panel (`items`) items. Params: {"items":[id]?,"clips":[id]?}. Reads the part, selection. Changes the document. */
606
+ "edit.label.mango": {
607
+ clips?: Array<number>;
608
+ items?: Array<number>;
609
+ };
610
+ /** Purple. Sets the Purple color label on the selected (or listed `clips`) timeline clips and Project panel (`items`) items. Params: {"items":[id]?,"clips":[id]?}. Reads the part, selection. Changes the document. */
611
+ "edit.label.purple": {
612
+ clips?: Array<number>;
613
+ items?: Array<number>;
614
+ };
615
+ /** Blue. Sets the Blue color label on the selected (or listed `clips`) timeline clips and Project panel (`items`) items. Params: {"items":[id]?,"clips":[id]?}. Reads the part, selection. Changes the document. */
616
+ "edit.label.blue": {
617
+ clips?: Array<number>;
618
+ items?: Array<number>;
619
+ };
620
+ /** Teal. Sets the Teal color label on the selected (or listed `clips`) timeline clips and Project panel (`items`) items. Params: {"items":[id]?,"clips":[id]?}. Reads the part, selection. Changes the document. */
621
+ "edit.label.teal": {
622
+ clips?: Array<number>;
623
+ items?: Array<number>;
624
+ };
625
+ /** Magenta. Sets the Magenta color label on the selected (or listed `clips`) timeline clips and Project panel (`items`) items. Params: {"items":[id]?,"clips":[id]?}. Reads the part, selection. Changes the document. */
626
+ "edit.label.magenta": {
627
+ clips?: Array<number>;
628
+ items?: Array<number>;
629
+ };
630
+ /** Tan. Sets the Tan color label on the selected (or listed `clips`) timeline clips and Project panel (`items`) items. Params: {"items":[id]?,"clips":[id]?}. Reads the part, selection. Changes the document. */
631
+ "edit.label.tan": {
632
+ clips?: Array<number>;
633
+ items?: Array<number>;
634
+ };
635
+ /** Green. Sets the Green color label on the selected (or listed `clips`) timeline clips and Project panel (`items`) items. Params: {"items":[id]?,"clips":[id]?}. Reads the part, selection. Changes the document. */
636
+ "edit.label.green": {
637
+ clips?: Array<number>;
638
+ items?: Array<number>;
639
+ };
640
+ /** Brown. Sets the Brown color label on the selected (or listed `clips`) timeline clips and Project panel (`items`) items. Params: {"items":[id]?,"clips":[id]?}. Reads the part, selection. Changes the document. */
641
+ "edit.label.brown": {
642
+ clips?: Array<number>;
643
+ items?: Array<number>;
644
+ };
645
+ /** Yellow. Sets the Yellow color label on the selected (or listed `clips`) timeline clips and Project panel (`items`) items. Params: {"items":[id]?,"clips":[id]?}. Reads the part, selection. Changes the document. */
646
+ "edit.label.yellow": {
647
+ clips?: Array<number>;
648
+ items?: Array<number>;
649
+ };
650
+ /** Remove Unused. Deletes every project item that no sequence uses (sequences and bins are kept). Answers {removed} item ids. Params: {}. Reads the active. Changes the document. */
651
+ "edit.removeUnused": Record<string, never>;
652
+ /** Consolidate Duplicates. Merges project items that refer to the same file or generator with the same interpretation: the oldest is kept and every clip using the others is relinked to it. Params: {}. Reads the selection, active. Changes the document. */
653
+ "edit.consolidateDuplicates": Record<string, never>;
654
+ /** Edit Original. Answers the media file paths of the selected clips or `items` so the host opens them in their original applications; changes nothing. Params: {"items":[id]?}. Acts on `items`. Reads the part, selection. */
655
+ "edit.editOriginal": {
656
+ items?: Array<number>;
657
+ };
658
+ /** Label. Sets the color `label` (Violet, Iris, Caribbean...) of the selected timeline clips and Project panel items. Params: {"label":"Violet|Iris|..."}. Reads the part, selection. Changes the document. */
659
+ "edit.label": {
660
+ label?: string;
661
+ };
662
+ /** Rename. Renames a timeline `clip` (default the first selected) or a project `item` to `name`. Params: {"clip":id?,"item":id?,"name":str}. Acts on `clip`. Reads the part. Changes the document. */
663
+ "clip.rename": {
664
+ clip?: number; /** an id */
665
+ item?: number;
666
+ name?: string;
667
+ };
668
+ /** Make Subclip. Creates a subclip project item from a master `item` or timeline `clip` between start and end (ticks or frames), default the item's In/Out; `restrictTrims` keeps edits inside that range. Answers the new item. Params: {"item":id?,"clip":id?,"name":str?,"start":ticks?,"end":ticks?,"startFrame":i64?,"endFrame":i64?,"restrictTrims":bool=true}. Reads the part, selection, active. Changes the document. */
669
+ "clip.makeSubclip": {
670
+ clip?: number; /** ticks (254016000000 per second) */
671
+ end?: number;
672
+ endFrame?: number; /** the end time, in seconds (one spelling of it) */
673
+ endSeconds?: number; /** the end time, in ticks (one spelling of it) */
674
+ endTime?: number; /** the end time, as a timecode (one spelling of it) */
675
+ endTimecode?: string; /** an id */
676
+ item?: number;
677
+ name?: string;
678
+ restrictTrims?: boolean; /** ticks (254016000000 per second) */
679
+ start?: number;
680
+ startFrame?: number; /** the start time, in seconds (one spelling of it) */
681
+ startSeconds?: number; /** the start time, in ticks (one spelling of it) */
682
+ startTime?: number; /** the start time, as a timecode (one spelling of it) */
683
+ startTimecode?: string;
684
+ };
685
+ /** Edit Subclip. Changes an existing subclip `item`'s start/end (ticks or frames of its master), `restrictTrims`, or converts it back to a master clip with `convertToMaster`. Params: {"item":id?,"start":ticks?,"end":ticks?,"startFrame":i64?,"endFrame":i64?,"restrictTrims":bool?,"convertToMaster":bool?}. Acts on `item`. Reads the selection. Changes the document. */
686
+ "clip.editSubclip": {
687
+ convertToMaster?: boolean; /** ticks (254016000000 per second) */
688
+ end?: number;
689
+ endFrame?: number; /** the end time, in seconds (one spelling of it) */
690
+ endSeconds?: number; /** the end time, in ticks (one spelling of it) */
691
+ endTime?: number; /** the end time, as a timecode (one spelling of it) */
692
+ endTimecode?: string; /** an id */
693
+ item?: number;
694
+ restrictTrims?: boolean; /** ticks (254016000000 per second) */
695
+ start?: number;
696
+ startFrame?: number; /** the start time, in seconds (one spelling of it) */
697
+ startSeconds?: number; /** the start time, in ticks (one spelling of it) */
698
+ startTime?: number; /** the start time, as a timecode (one spelling of it) */
699
+ startTimecode?: string;
700
+ };
701
+ /** Edit Offline. Edits the offline-file information of an offline `item`: media name, tape name, description, scene, shot and log note. Params: {"item":id?,"mediaName":str?,"tapeName":str?,"description":str?,"scene":str?,"shot":str?,"logNote":str?}. Acts on `item`. Reads the part, selection. Changes the document. */
702
+ "clip.editOffline": {
703
+ description?: string; /** an id */
704
+ item?: number;
705
+ logNote?: string;
706
+ mediaName?: string;
707
+ scene?: string;
708
+ shot?: string;
709
+ tapeName?: string;
710
+ };
711
+ /** Source Settings. Reads the source settings of a media `item` (codec-specific decode options) as Clip ? Source Settings shows them. Params: {"item":id?}. Acts on `item`. Reads the part, selection. */
712
+ "clip.sourceSettings": {
713
+ item?: number;
714
+ };
715
+ /** Audio Channels. Sets how project `items`' audio channels map to clips: `format` mono|stereo|5.1|adaptive and which source `channels` each clip carries. Applies to clips made after; existing timeline clips keep theirs. Params: {"items":[id]?,"format":"mono|stereo|5.1|adaptive","clips":[[channel]]?,"channels":[channel]?}. Reads the part, selection. Changes the document. */
716
+ "clip.audioChannels": {
717
+ channels?: Array<Json>; /** [[channel]]? */
718
+ clips?: Array<Array<Json>>;
719
+ format?: "mono" | "stereo" | "5.1" | "adaptive"; /** read by the command beside its listed parameters */
720
+ item?: number;
721
+ items?: Array<number>;
722
+ };
723
+ /** Interpret Footage. Sets the source color space of the selected or listed footage `items` (`colorSpace`: auto or an id from color.spaces). Params: {"items":[id]?,"colorSpace":"auto"|"<color space id>"}. Acts on `items`. Reads the part, selection. Changes the document. */
724
+ "clip.interpretFootage": {
725
+ colorSpace?: "auto" | "<color space id>";
726
+ items?: Array<number>;
727
+ };
728
+ /** Timecode. Sets the start `timecode` (or `frame`) and `tapeName` of a media `item`; `reset` restores the file's own timecode. Params: {"item":id?,"timecode":"HH:MM:SS:FF"?,"frame":i64?,"tapeName":str?,"reset":bool?}. Acts on `item`. Reads the selection. Changes the document. */
729
+ "clip.modifyTimecode": {
730
+ frame?: number; /** an id */
731
+ item?: number;
732
+ reset?: boolean; /** the time, in seconds (one spelling of it) */
733
+ seconds?: number;
734
+ tapeName?: string; /** the time, in ticks (one spelling of it) */
735
+ time?: number; /** like HH:MM:SS:FF */
736
+ timecode?: string;
737
+ };
738
+ /** Frame Hold Options. Turns a frame hold on or off for the selected or listed `clips` and chooses the held frame: sourceTimecode, sequenceTime, in, out or playhead; `holdFilters` also freezes effects. Params: {"clips":[id]?,"enabled":bool=true,"holdOn":"sourceTimecode|sequenceTime|in|out|playhead","time":ticks?,"timecode":str?,"holdFilters":bool=false}. Acts on `clips`. Reads the part, selection, time. Changes the document. */
739
+ "clip.frameHoldOptions": {
740
+ clip?: number;
741
+ clips?: Array<number>;
742
+ enabled?: boolean; /** the time, as a frame of the sequence (one spelling of it) */
743
+ frame?: number;
744
+ holdFilters?: boolean;
745
+ holdOn?: "sourceTimecode" | "sequenceTime" | "in" | "out" | "playhead"; /** the time, in seconds (one spelling of it) */
746
+ seconds?: number; /** ticks (254016000000 per second) */
747
+ time?: number;
748
+ timecode?: string;
749
+ };
750
+ /** Add Frame Hold. Splits the selected clips (or the targeted video clip under the playhead) at the playhead or `time` and freezes the frame there for the rest of the clip. Params: {"clips":[id]?,"time":ticks?}. Acts on `clips`. Reads the part, selection, time, active. Changes the document. */
751
+ "clip.frameHold": {
752
+ clip?: number;
753
+ clips?: Array<number>; /** ticks (254016000000 per second) */
754
+ time?: number;
755
+ };
756
+ /** Insert Frame Hold Segment. Inserts a frozen frame `seconds` long (default 2) at the playhead or `time` inside `clip` (default the one under the playhead), splitting it and pushing the rest later. Params: {"clip":id?,"time":ticks?,"seconds":f64=2}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
757
+ "clip.insertFrameHoldSegment": {
758
+ clip?: number; /** the time, as a frame of the sequence (one spelling of it) */
759
+ frame?: number;
760
+ seconds?: number; /** ticks (254016000000 per second) */
761
+ time?: number; /** the time, as a timecode (one spelling of it) */
762
+ timecode?: string;
763
+ };
764
+ /** Field Options. Sets interlaced field handling of the selected or listed `clips`: reverse field dominance, and `processing` none|alwaysDeinterlace|flickerRemoval. Params: {"clips":[id]?,"reverseFieldDominance":bool=false,"processing":"none|alwaysDeinterlace|flickerRemoval"}. Acts on `clips`. Reads the part, selection. Changes the document. */
765
+ "clip.fieldOptions": {
766
+ clips?: Array<number>;
767
+ processing?: "none" | "alwaysDeinterlace" | "flickerRemoval";
768
+ reverseFieldDominance?: boolean;
769
+ };
770
+ /** Frame Sampling. Sets the selected clips' time interpolation to Frame Sampling (repeats or drops whole frames when speed changes). Params: {"clips":[id]?}. Acts on `clips`. Reads the part, selection. Changes the document. */
771
+ "clip.timeInterpolation.frameSampling": {
772
+ clip?: number;
773
+ clips?: Array<number>;
774
+ };
775
+ /** Frame Blending. Sets the selected clips' time interpolation to Frame Blending (blends neighbouring frames when speed changes). Params: {"clips":[id]?}. Acts on `clips`. Reads the part, selection. Changes the document. */
776
+ "clip.timeInterpolation.frameBlending": {
777
+ clip?: number;
778
+ clips?: Array<number>;
779
+ };
780
+ /** Optical Flow. Sets the selected clips' time interpolation to Optical Flow (synthesises in-between frames when speed changes). Params: {"clips":[id]?}. Acts on `clips`. Reads the part, selection. Changes the document. */
781
+ "clip.timeInterpolation.opticalFlow": {
782
+ clip?: number;
783
+ clips?: Array<number>;
784
+ };
785
+ /** Scale to Frame Size. Toggles Scale to Frame Size on the selected clips: rendered at the frame size rather than their native resolution. Params: {}. Reads the part, selection. Changes the document. */
786
+ "clip.scaleToFrameSize": Record<string, never>;
787
+ /** Fit to frame. Scales and centres the selected or listed video `clips` so the whole picture is visible inside the frame (letterboxing). Use clip.fillFrame to cover the frame. Params: {"clips":[id]?}. Acts on `clips`. Reads the part, selection. Changes the document. */
788
+ "clip.fitToFrame": {
789
+ clip?: number;
790
+ clips?: Array<number>;
791
+ };
792
+ /** Fill frame. Scales and centres the selected or listed video `clips` so they cover the whole frame (cropping edges). Use clip.fitToFrame to show the whole picture. Params: {"clips":[id]?}. Acts on `clips`. Reads the part, selection. Changes the document. */
793
+ "clip.fillFrame": {
794
+ clip?: number;
795
+ clips?: Array<number>;
796
+ };
797
+ /** Audio Gain. Changes clip gain of the selected or listed audio `clips`: `mode` set (to `db`), adjust (by `db`), normalizeMax (loudest peak to `db`) or normalizeAll (each clip's peak to `db`). Params: {"clips":[id]?,"mode":"set|adjust|normalizeMax|normalizeAll"?,"db":f64,"relative":bool?}. Acts on `clips`. Reads the part, selection, mode. Changes the document. */
798
+ "clip.audioGain": {
799
+ clips?: Array<number>;
800
+ db?: number;
801
+ mode?: "set" | "adjust" | "normalizeMax" | "normalizeAll";
802
+ relative?: boolean;
803
+ };
804
+ /** Breakout to Mono. Creates one mono project item per audio channel of each selected item with audio, in the same bin. Answers the new items. Params: {"items":[id]?}. Acts on `items`. Reads the selection. Changes the document. */
805
+ "clip.breakoutToMono": {
806
+ items?: Array<number>;
807
+ };
808
+ /** Extract Audio. Renders the audio of the selected clips or `items` to new audio files (in `dir`) and imports them as project items; one undo step. Params: {"items":[id]?,"dir":str?}. Acts on `items`. Reads the part, selection. Changes the document. */
809
+ "clip.extractAudio": {
810
+ dir?: Json;
811
+ items?: Array<number>;
812
+ };
813
+ /** Speed/Duration. Changes the selected or listed `clips`' `speed` in percent (100 = normal; length scales by 100/speed), `reverse`, `ripple` (move later clips) and time `interpolation`. Params: {"clips":[id]?,"speed":percent=100,"reverse":bool,"ripple":bool,"interpolation":"frameSampling|frameBlending|opticalFlow"?}. Acts on `clips`. Reads the part, selection, mode. Changes the document. */
814
+ "clip.speedDuration": {
815
+ clips?: Array<number>;
816
+ interpolation?: "frameSampling" | "frameBlending" | "opticalFlow";
817
+ reverse?: boolean;
818
+ ripple?: boolean; /** percent */
819
+ speed?: number;
820
+ };
821
+ /** Scene Edit Detection. Detects shot changes in the selected video `clips` (`sensitivity` 0?100, minimum shot `minShotFrames`) and cuts there, and/or makes subclips or markers; `wait` blocks until analysis ends. Params: {"clips":[id]?,"sensitivity":0..100=50,"minShotFrames":n=6,"applyCuts":bool=true,"createSubclips":bool=false,"generateMarkers":bool=false,"wait":bool=false}. Acts on `clips`. Reads the part, selection, mode. Changes the document. */
822
+ "clip.sceneEditDetection": {
823
+ applyCuts?: boolean; /** read by the command beside its listed parameters */
824
+ clip?: number;
825
+ clips?: Array<number>;
826
+ createSubclips?: boolean;
827
+ generateMarkers?: boolean;
828
+ minShotFrames?: number; /** 0 to 100 */
829
+ sensitivity?: number;
830
+ wait?: boolean;
831
+ };
832
+ /** Enable. Toggles whether the selected or listed `clips` (with linked partners) play and render: all disabled when they were all enabled, else all enabled. Params: {"clips":[id]?}. Acts on `clips`. Reads the part, selection, mode. Changes the document. */
833
+ "clip.enable": {
834
+ clips?: Array<number>;
835
+ };
836
+ /** Link. Links the selected (or listed) video and audio clips so they select and move together; if they are all already linked, unlinks them instead. Params: {"clips":[id]?}. Acts on `clips`. Reads the part, selection. Changes the document. */
837
+ "clip.link": {
838
+ clip?: number;
839
+ clips?: Array<number>;
840
+ };
841
+ /** Group. Groups the selected clips so selecting or moving one selects or moves them all. Undo with clip.ungroup. Params: {}. Reads the part, selection. Changes the document. */
842
+ "clip.group": Record<string, never>;
843
+ /** Ungroup. Removes the selected clips from their groups. Params: {}. Reads the part, selection. Changes the document. */
844
+ "clip.ungroup": Record<string, never>;
845
+ /** Audio Clip Peak Amplitude. Reads the peak amplitude (dBFS) of the selected or listed audio clips at their current gain, as the Audio Gain dialog shows it. Params: {"clips":[id]?}. Acts on `clips`. Reads the part, selection, mode. */
846
+ "clip.audioPeak": {
847
+ clips?: Array<number>;
848
+ };
849
+ /** Nest. Moves the selected clips (with linked partners and their transitions) into a new nested sequence named `name` and replaces them with one clip of it. Params: {"name":str}. Reads the part, selection, mode. Changes the document. */
850
+ "clip.nest": {
851
+ name?: string;
852
+ };
853
+ /** Reveal in Project. Selects and shows in the Project panel the source item of `clip` (default the selected or topmost targeted clip under the playhead). Params: {"clip":id?}. Reads the part, selection, time, active. Changes the document. */
854
+ "clip.revealInProject": {
855
+ clip?: number; /** read by the command beside its listed parameters */
856
+ clips?: Array<Json>;
857
+ };
858
+ /** Reveal Sequence in Project. Selects and shows sequence `item` (default the active one) in the Project panel. Params: {"item":id?}. Acts on `item`. Reads the part. Changes the document. */
859
+ "sequence.revealInProject": {
860
+ item?: number;
861
+ };
862
+ /** Open in Timeline. Opens sequence `item` in a timeline tab and makes it the active sequence that other commands act on. Params: {"item":id}. Acts on `item`. Reads the active. Changes the document. */
863
+ "sequence.open": {
864
+ item?: number;
865
+ };
866
+ /** Close Sequence. Closes the timeline tab of sequence `item` (default the active one); the sequence stays in the project. Params: {"item":id?}. Acts on `item`. Reads the part, active. Changes the document. */
867
+ "sequence.close": {
868
+ item?: number;
869
+ };
870
+ /** Close Other Timeline Panels. Closes every open timeline tab except sequence `item` (default the active one). Params: {"item":id?}. Acts on `item`. Reads the part, active. Changes the document. */
871
+ "sequence.closeOthers": {
872
+ item?: number;
873
+ };
874
+ /** Move Sequence Tab. Moves the timeline tab of sequence `item` to position `index` (0-based) among the open tabs. Params: {"item":id?,"index":int}. Acts on `item`. Reads the part, active. Changes the document. */
875
+ "sequence.moveTab": {
876
+ index?: number; /** an id */
877
+ item?: number;
878
+ };
879
+ /** Sequence Settings. Changes the active sequence's settings: frame size, `fps`, name, sample rate, audio mix layout, drop-frame timecode, render quality and color working space; a new frame size or rate renames the preset (`WxH fps`). Params: {"width":u32?,"height":u32?,"fps":f64?,"name":str?,"sampleRate":u32?,"mix":"Stereo|Mono|5.1|Adaptive"?,"dropFrame":bool?,"maxRenderQuality":bool?,"workingSpace":"rec709"|"rec2100-pq"|"rec2100-hlg"?,"wideGamut":bool?,"autoToneMap":bool?,"scaleMotion":bool=false}. Reads the part. Changes the document. */
880
+ "sequence.settings": {
881
+ autoToneMap?: boolean;
882
+ dropFrame?: boolean;
883
+ fps?: number;
884
+ height?: number;
885
+ maxRenderQuality?: boolean;
886
+ mix?: "Stereo" | "Mono" | "5.1" | "Adaptive";
887
+ name?: string;
888
+ sampleRate?: number;
889
+ scaleMotion?: boolean;
890
+ wideGamut?: boolean;
891
+ width?: number;
892
+ workingSpace?: "rec709" | "rec2100-pq" | "rec2100-hlg";
893
+ };
894
+ /** Render Effects In to Out. Renders previews only for the segments with unrendered effects between In and Out; `wait` blocks until done. Params: {"wait":bool=false}. Reads the part, selection. Changes the document. */
895
+ "sequence.renderEffectsInToOut": {
896
+ wait?: boolean;
897
+ };
898
+ /** Render In to Out. Renders previews for every segment between In and Out; `wait` blocks until done. Params: {"wait":bool=false}. Reads the part, selection. Changes the document. */
899
+ "sequence.renderInToOut": {
900
+ wait?: boolean;
901
+ };
902
+ /** Render Selection. Renders previews for the time spanned by the selected clips; `wait` blocks until done. Params: {"wait":bool=false}. Reads the part, selection. Changes the document. */
903
+ "sequence.renderSelection": {
904
+ wait?: boolean;
905
+ };
906
+ /** Render Audio. Renders audio previews (float WAV) for In?Out or the whole sequence; `wait` blocks until done. Params: {"wait":bool=false}. Reads the part. Changes the document. */
907
+ "sequence.renderAudio": {
908
+ wait?: boolean;
909
+ };
910
+ /** Delete Render Files. Deletes all preview render files of the active sequence (it shows unrendered again). Params: {}. Reads the part. Changes the document. */
911
+ "sequence.deleteRenderFiles": Record<string, never>;
912
+ /** Delete Render Files In to Out. Deletes the preview render files between the sequence In and Out points. Params: {}. Reads the part. Changes the document. */
913
+ "sequence.deleteRenderFilesInToOut": Record<string, never>;
914
+ /** Match Frame. Opens the source of the topmost clip under the playhead in the Source monitor at the matching source frame. Params: {}. Reads the part, time. Changes the document. */
915
+ "sequence.matchFrame": Record<string, never>;
916
+ /** Reverse Match Frame. Finds the Source monitor's current frame in the active sequence (targeted tracks first) and moves the playhead there. Params: {}. Reads the part, time, active, mode. Changes the document. */
917
+ "sequence.reverseMatchFrame": Record<string, never>;
918
+ /** Add Edit. Cuts clips at the playhead or at `time` (ticks), `seconds`, `frame` or `timecode`: the selected clips under it if any, otherwise every clip on the targeted tracks. Use sequence.addEditAllTracks to cut all tracks. Params: {"time":ticks?,"seconds":f64?,"frame":i64?,"timecode":str?}. Reads the part, selection, time, active. Changes the document. */
919
+ "sequence.addEdit": {
920
+ frame?: number;
921
+ seconds?: number; /** ticks (254016000000 per second) */
922
+ time?: number;
923
+ timecode?: string;
924
+ };
925
+ /** Add Edit to All Tracks. Cuts every clip on all unlocked tracks (and caption tracks) at the playhead or at `time` (ticks), `seconds`, `frame` or `timecode`. Params: {"time":ticks?,"seconds":f64?,"frame":i64?,"timecode":str?}. Reads the part, time. Changes the document. */
926
+ "sequence.addEditAllTracks": {
927
+ frame?: number;
928
+ seconds?: number; /** ticks (254016000000 per second) */
929
+ time?: number;
930
+ timecode?: string;
931
+ };
932
+ /** Trim Edit. Enters trim mode: selects the roll edit point nearest the playhead on targeted tracks if none is selected. Answers {editPoints}. Params: {}. Reads the part, time, active. Changes the document. */
933
+ "trim.edit": Record<string, never>;
934
+ /** Apply Video Transition. Applies a video transition (`effect` e.g. cross_dissolve, `frames` long, default from preferences) at the edit nearest the playhead on targeted tracks, or at `clip`'s `edge`; `params` and `reverse` set it up. Params: {"clip":id?,"effect":"cross_dissolve|Cross Dissolve|..."?,"frames":i64?,"edge":"in"|"out"?,"params":{param:value}?,"reverse":bool?}. Acts on `clip`. Reads the part, time, active, mode. Changes the document. */
935
+ "sequence.applyVideoTransition": {
936
+ clip?: number;
937
+ edge?: "in" | "out"; /** for example cross_dissolve, Cross Dissolve */
938
+ effect?: string;
939
+ frames?: number;
940
+ params?: {
941
+ param?: Json;
942
+ };
943
+ reverse?: boolean;
944
+ };
945
+ /** Apply Audio Transition. Applies an audio transition (`effect`, default the default audio transition, `frames` long) at the edit nearest the playhead on targeted tracks, or at `clip`'s edge. Params: {"clip":id?,"effect":str?,"frames":i64?}. Acts on `clip`. Reads the part, time, active, mode. Changes the document. */
946
+ "sequence.applyAudioTransition": {
947
+ clip?: number; /** read by the command beside its listed parameters */
948
+ edge?: string;
949
+ effect?: string;
950
+ frames?: number; /** read by the command beside its listed parameters */
951
+ params?: {
952
+ [key: string]: Json;
953
+ }; /** read by the command beside its listed parameters */
954
+ reverse?: boolean;
955
+ };
956
+ /** Apply Default Transitions to Selection. Adds the default video/audio transition at each edge of the selected clips (centred on cuts, at a free edge otherwise), or at the selected edit points when no clips are selected. Edges that already have a transition keep it. Params: {"clips":[id]?}. Acts on `clips`. Reads the part, mode, active. Changes the document. */
957
+ "trim.applyDefaultTransition": {
958
+ clips?: Array<number>;
959
+ };
960
+ /** Lift. Removes the In?Out range on targeted tracks and leaves a gap; nothing moves. Needs In and Out. Use sequence.extract to close the gap. Params: {}. Reads the part, active. Changes the document. */
961
+ "sequence.lift": Record<string, never>;
962
+ /** Extract. Removes the In?Out range on targeted tracks and closes the gap (later clips move earlier; ripple sequence markers when on). Needs In and Out. Use sequence.lift to leave a gap. Params: {}. Reads the part, time, mode, active. Changes the document. */
963
+ "sequence.extract": Record<string, never>;
964
+ /** Close Gap. Closes the gap on `track` at `time` (default playhead) by moving the clips after it earlier (ripple delete of the gap). Params: {"track":"V1"|id,"time":ticks}. Reads the part, time, mode. Changes the document. */
965
+ "sequence.closeGap": {
966
+ time?: number; /** "V1"|id */
967
+ track?: Json;
968
+ };
969
+ /** Next in Sequence. Moves the playhead to the start of the next gap across the whole sequence. Params: {}. Reads the part, time, mode, active. Changes the document. */
970
+ "sequence.goToNextGap": Record<string, never>;
971
+ /** Previous in Sequence. Moves the playhead to the start of the previous gap across the whole sequence. Params: {}. Reads the part, time, mode, active. Changes the document. */
972
+ "sequence.goToPrevGap": Record<string, never>;
973
+ /** Next in Track. Moves the playhead to the start of the next gap on `track` (default the first targeted track). Params: {"track":"V1"|id?}. Reads the part, time, active, mode. Changes the document. */
974
+ "sequence.goToNextGapInTrack": {
975
+ track?: Json;
976
+ };
977
+ /** Previous in Track. Moves the playhead to the start of the previous gap on `track` (default the first targeted track). Params: {"track":"V1"|id?}. Reads the part, time, active, mode. Changes the document. */
978
+ "sequence.goToPrevGapInTrack": {
979
+ track?: Json;
980
+ };
981
+ /** Snap in Timeline. Sets whether timeline drags snap to edits, markers and the playhead (`on`, toggles when omitted). Params: {"on":bool?}. Reads the mode. Changes the document. */
982
+ "sequence.snap": {
983
+ on?: boolean;
984
+ };
985
+ /** Linked Selection. Sets whether selecting a clip also selects its linked video/audio partners (`on`, toggles when omitted). Params: {"on":bool?}. Reads the mode. Changes the document. */
986
+ "sequence.linkedSelection": {
987
+ on?: boolean;
988
+ };
989
+ /** Selection Follows Playhead. Sets whether the clips under the playhead on targeted tracks are selected automatically as it moves (`on`, toggles when omitted). Params: {"on":bool?}. Reads the part, time, mode, active. Changes the document. */
990
+ "sequence.selectionFollowsPlayhead": {
991
+ on?: boolean;
992
+ };
993
+ /** Show Through Edits. Sets whether through edits are marked in the timeline (`on`, toggles when omitted). View setting only. Params: {"on":bool?}. Reads the mode. Changes the document. */
994
+ "sequence.showThroughEdits": {
995
+ on?: boolean;
996
+ };
997
+ /** Normalize Mix Track. Sets the Mix track fader so the whole mix peaks at `db` (default 0 dBFS). Params: {"db":f64=0}. Reads the part. Changes the document. */
998
+ "sequence.normalizeMixTrack": {
999
+ db?: number;
1000
+ };
1001
+ /** Make Subsequence. Creates a new sequence named `name` from the clips between In and Out (or the selected clips) on targeted tracks; the original is unchanged. Params: {"name":str?}. Reads the part, selection, mode, active. Changes the document. */
1002
+ "sequence.makeSubsequence": {
1003
+ name?: string;
1004
+ };
1005
+ /** Transcribe Sequence. Transcribes the active sequence's audio (`track`: mix or an audio track) into a transcript, in `language` (auto detects), with speaker labels when `diarize`. Params: {"track":"mix"|"A1"|id?,"language":"en|auto"?,"diarize":bool?,"maxSpeakers":n?,"model":str?}. Reads the part. Changes the document. */
1006
+ "sequence.transcribe": {
1007
+ diarize?: boolean;
1008
+ language?: "en" | "auto";
1009
+ maxSpeakers?: number;
1010
+ model?: string; /** "mix"|"A1"|id? */
1011
+ track?: Json;
1012
+ };
1013
+ /** Simplify Sequence. Creates a simplified copy named `name` of the active sequence: removes disabled clips, empty tracks, effects or text and can close gaps or move clips down; `keep` both, video or audio. Params: {"name":str?,"removeDisabled":bool=true,"removeEmptyTracks":bool=true,"closeGaps":bool=false,"moveClipsDown":bool=false,"removeVideoEffects":bool=false,"removeAudioEffects":bool=false,"removeText":bool=false,"keep":"both|video|audio"}. Reads the part. Changes the document. */
1014
+ "sequence.simplify": {
1015
+ closeGaps?: boolean;
1016
+ keep?: "both" | "video" | "audio";
1017
+ moveClipsDown?: boolean;
1018
+ name?: string;
1019
+ removeAudioEffects?: boolean;
1020
+ removeDisabled?: boolean;
1021
+ removeEmptyTracks?: boolean;
1022
+ removeText?: boolean;
1023
+ removeVideoEffects?: boolean;
1024
+ };
1025
+ /** Add Tracks. Adds `video`, `audio` and `submix` tracks, each after a given track (`videoAfter` "first", "V2" or an index), with `audioType` and `submixType` channel layouts. Params: {"video":n=1,"audio":n=0,"submix":n=0,"videoAfter":"first"|"V2"|n?,"audioAfter":"first"|"A2"|n?,"submixAfter":"first"|"S1"|n?,"audioType":"standard|5.1|adaptive|mono"?,"submixType":"stereo|5.1|adaptive|mono"?}. Reads the part. Changes the document. */
1026
+ "sequence.addTracks": {
1027
+ audio?: number; /** "first"|"A2"|n? */
1028
+ audioAfter?: Json;
1029
+ audioType?: "standard" | "5.1" | "adaptive" | "mono";
1030
+ submix?: number; /** "first"|"S1"|n? */
1031
+ submixAfter?: Json;
1032
+ submixType?: "stereo" | "5.1" | "adaptive" | "mono";
1033
+ video?: number; /** "first"|"V2"|n? */
1034
+ videoAfter?: Json;
1035
+ };
1036
+ /** Delete Tracks. Deletes all empty video and/or audio tracks (`video`/`audio`: "empty") or one named track of each kind. Params: {"video":"empty"|"V2"|id?,"audio":"empty"|"A2"|id?}. Reads the part, active. Changes the document. */
1037
+ "sequence.deleteTracks": {
1038
+ audio?: Json; /** track id, V1/A1 ordinal, or empty to delete empty tracks */
1039
+ video?: Json;
1040
+ };
1041
+ /** Color Management. Sets the active sequence's color management: `workingSpace` rec709, rec2100-pq or rec2100-hlg, `wideGamut`, `autoToneMap`. Params: {"workingSpace":"rec709"|"rec2100-pq"|"rec2100-hlg"?,"wideGamut":bool?,"autoToneMap":bool?}. Reads the part. Changes the document. */
1042
+ "sequence.colorSettings": {
1043
+ autoToneMap?: boolean;
1044
+ wideGamut?: boolean;
1045
+ workingSpace?: "rec709" | "rec2100-pq" | "rec2100-hlg";
1046
+ };
1047
+ /** Add Audio Submix Track. Adds an audio submix track with `name` and `channels` Mono|Stereo|5.1 (default Stereo). Route tracks to it with mixer.setStrip `output` or mixer.addSend. Params: {"name":str?,"channels":"Mono|Stereo|5.1"?}. Reads the part. Changes the document. */
1048
+ "mixer.addSubmix": {
1049
+ channels?: "Mono" | "Stereo" | "5.1";
1050
+ name?: string;
1051
+ };
1052
+ /** Edit Transition Settings. Changes an applied `transition` by id: effect `params`, `reverse`, or `reset` to defaults. Params: {"transition":id,"params":{param:value}?,"reverse":bool?,"reset":bool?}. Reads the part. Changes the document. */
1053
+ "sequence.setTransition": {
1054
+ params?: {
1055
+ param?: Json;
1056
+ };
1057
+ reset?: boolean;
1058
+ reverse?: boolean; /** an id */
1059
+ transition?: number;
1060
+ };
1061
+ /** Join Through Edits. Removes through edits (cuts where the media continues uninterrupted) at the selected `clips`, or everywhere with `all`, rejoining the pieces. Params: {"clips":[id]?,"all":bool?}. Acts on `clips`. Reads the part, selection, mode. Changes the document. */
1062
+ "sequence.joinThroughEdits": {
1063
+ all?: boolean;
1064
+ clips?: Array<number>;
1065
+ };
1066
+ /** List Through Edits. Lists the through edits of the active sequence: {track, left, right, time ticks} for each cut where the media continues. Params: {}. Reads the part. */
1067
+ "sequence.throughEdits": Record<string, never>;
1068
+ /** Insert and overwrite sequences as nests or individual clips. Sets whether sequences placed into a timeline go in as one nested clip (`on`) or as their individual clips. Params: {"on":bool?}. Reads the mode. Changes the document. */
1069
+ "sequence.nestSequences": {
1070
+ on?: boolean;
1071
+ };
1072
+ /** Delete Track. Deletes `track` (V3, A2 or an id) and every clip on it. Params: {"track":"V3"|id}. Reads the part. Changes the document. */
1073
+ "sequence.deleteTrack": {
1074
+ track?: Json;
1075
+ };
1076
+ /** Render Bar. Reads the active sequence's render bar: the spans that are rendered, need rendering or play in real time. Params: {}. Reads the part. */
1077
+ "sequence.renderBar": Record<string, never>;
1078
+ /** Mark In. Sets the In point at the playhead or at `time` (ticks), `seconds`, `frame` or `timecode` on the sequence, or on the Source clip with target "source" (`time` or `seconds`). Params: {"time":ticks?,"seconds":f64?,"frame":i64?,"timecode":str?,"target":"program|source"}. Reads the part, time, active. Changes the document. */
1079
+ "markers.markIn": {
1080
+ frame?: number;
1081
+ seconds?: number;
1082
+ target?: "program" | "source"; /** ticks (254016000000 per second) */
1083
+ time?: number;
1084
+ timecode?: string;
1085
+ };
1086
+ /** Mark Out. Sets the Out point at the playhead or at `time` (ticks), `seconds`, `frame` or `timecode` on the sequence, or on the Source clip with target "source" (`time` or `seconds`). Params: {"time":ticks?,"seconds":f64?,"frame":i64?,"timecode":str?,"target":"program|source"}. Reads the part, time, active. Changes the document. */
1087
+ "markers.markOut": {
1088
+ frame?: number;
1089
+ seconds?: number;
1090
+ target?: "program" | "source"; /** ticks (254016000000 per second) */
1091
+ time?: number;
1092
+ timecode?: string;
1093
+ };
1094
+ /** Mark Clip. Sets In and Out around the clip under the playhead on the first targeted track. Params: {}. Reads the part, time, active. Changes the document. */
1095
+ "markers.markClip": Record<string, never>;
1096
+ /** Mark Selection. Sets In and Out around the selected clips (from the earliest start to the latest end). Needs a clip selection. Params: {}. Reads the part, selection. Changes the document. */
1097
+ "markers.markSelection": Record<string, never>;
1098
+ /** Video In. Sets a separate video In point (split edit) at the playhead or `time`; audio keeps its own In. Params: {"time":ticks?,"frame":i64?,"seconds":f64?,"timecode":str?,"target":"program|source"}. Reads the part, time, active. Changes the document. */
1099
+ "markers.markSplitVideoIn": {
1100
+ frame?: number;
1101
+ seconds?: number;
1102
+ target?: "program" | "source"; /** ticks (254016000000 per second) */
1103
+ time?: number;
1104
+ timecode?: string;
1105
+ };
1106
+ /** Video Out. Sets a separate video Out point (split edit) at the playhead or `time`. Params: {"time":ticks?,"frame":i64?,"seconds":f64?,"timecode":str?,"target":"program|source"}. Reads the part, time, active. Changes the document. */
1107
+ "markers.markSplitVideoOut": {
1108
+ frame?: number;
1109
+ seconds?: number;
1110
+ target?: "program" | "source"; /** ticks (254016000000 per second) */
1111
+ time?: number;
1112
+ timecode?: string;
1113
+ };
1114
+ /** Audio In. Sets a separate audio In point (a split edit, J/L cut) at the playhead or `time`; video keeps its own In. Params: {"time":ticks?,"frame":i64?,"seconds":f64?,"timecode":str?,"target":"program|source"}. Reads the part, time, active. Changes the document. */
1115
+ "markers.markSplitAudioIn": {
1116
+ frame?: number;
1117
+ seconds?: number;
1118
+ target?: "program" | "source"; /** ticks (254016000000 per second) */
1119
+ time?: number;
1120
+ timecode?: string;
1121
+ };
1122
+ /** Audio Out. Sets a separate audio Out point (split edit) at the playhead or `time`. Params: {"time":ticks?,"frame":i64?,"seconds":f64?,"timecode":str?,"target":"program|source"}. Reads the part, time, active. Changes the document. */
1123
+ "markers.markSplitAudioOut": {
1124
+ frame?: number;
1125
+ seconds?: number;
1126
+ target?: "program" | "source"; /** ticks (254016000000 per second) */
1127
+ time?: number;
1128
+ timecode?: string;
1129
+ };
1130
+ /** Go to In. Moves the playhead to the In point (the start when none is set). Params: {"target":"program|source"}. Reads the part, time, active, mode. Changes the document. */
1131
+ "markers.goToIn": {
1132
+ target?: "program" | "source";
1133
+ };
1134
+ /** Go to Out. Moves the playhead to the Out point (the end when none is set). Params: {"target":"program|source"}. Reads the part, time, active, mode. Changes the document. */
1135
+ "markers.goToOut": {
1136
+ target?: "program" | "source";
1137
+ };
1138
+ /** Video In. Moves the playhead to the split video In point. Needs a split edit. Params: {"target":"program|source"}. Reads the part, time, active, mode. Changes the document. */
1139
+ "markers.goToSplitVideoIn": {
1140
+ target?: "program" | "source";
1141
+ };
1142
+ /** Video Out. Moves the playhead to the split video Out point. Needs a split edit. Params: {"target":"program|source"}. Reads the part, time, active, mode. Changes the document. */
1143
+ "markers.goToSplitVideoOut": {
1144
+ target?: "program" | "source";
1145
+ };
1146
+ /** Audio In. Moves the playhead to the split audio In point. Needs a split edit. Params: {"target":"program|source"}. Reads the part, time, active, mode. Changes the document. */
1147
+ "markers.goToSplitAudioIn": {
1148
+ target?: "program" | "source";
1149
+ };
1150
+ /** Audio Out. Moves the playhead to the split audio Out point. Needs a split edit. Params: {"target":"program|source"}. Reads the part, time, active, mode. Changes the document. */
1151
+ "markers.goToSplitAudioOut": {
1152
+ target?: "program" | "source";
1153
+ };
1154
+ /** Clear In. Clears the In point (including split video/audio Ins) of the sequence or Source clip. Params: {"target":"program|source"}. Reads the part, active. Changes the document. */
1155
+ "markers.clearIn": {
1156
+ target?: "program" | "source";
1157
+ };
1158
+ /** Clear Out. Clears the Out point (including split video/audio Outs) of the sequence or Source clip. Params: {"target":"program|source"}. Reads the part, active. Changes the document. */
1159
+ "markers.clearOut": {
1160
+ target?: "program" | "source";
1161
+ };
1162
+ /** Clear In and Out. Clears both In and Out points (and any split edits) of the sequence or Source clip. Params: {"target":"program|source"}. Reads the part, active. Changes the document. */
1163
+ "markers.clearInOut": {
1164
+ target?: "program" | "source";
1165
+ };
1166
+ /** Add Marker. Adds a marker at the playhead or `time` (ticks; or `frame`, `timecode`, or `seconds`, on the frame that shows that time) with `name`, `comment`, `color` (a marker colour: Red, Orange, Yellow, Green, Cyan, Blue, Purple, or a label name; it reads back as the marker colour, Red for Rose; an unknown colour is refused) and optional `durationFrames` or `durationSeconds` (a range marker), on the sequence or, with target "source", the Source monitor clip. Answers the marker id. Params: {"target":"program|source","time":ticks?,"frame":i64?,"seconds":f64?,"timecode":str?,"name":str?,"comment":str?,"color":label?,"durationFrames":i64?,"durationSeconds":f64?}. Reads the part, time, active. Changes the document. */
1167
+ "markers.add": {
1168
+ color?: string;
1169
+ comment?: string;
1170
+ durationFrames?: number;
1171
+ durationSeconds?: number;
1172
+ frame?: number;
1173
+ name?: string;
1174
+ seconds?: number;
1175
+ target?: "program" | "source"; /** ticks (254016000000 per second) */
1176
+ time?: number;
1177
+ timecode?: string;
1178
+ };
1179
+ /** Add Range Marker. Adds a range marker starting at the playhead or `time` (or `frame`, `seconds`, `timecode`), `durationFrames` or `durationSeconds` long (1 second by default) or `duration` ticks. Params: {"time":ticks?,"frame":i64?,"seconds":f64?,"timecode":str?,"durationFrames":i64=1s,"durationSeconds":f64?,"duration":ticks?,"name":str?,"comment":str?,"color":label?}. Reads the part, time. Changes the document. */
1180
+ "markers.addRange": {
1181
+ color?: string;
1182
+ comment?: string; /** ticks (254016000000 per second) */
1183
+ duration?: number; /** default 1s */
1184
+ durationFrames?: number;
1185
+ durationSeconds?: number;
1186
+ frame?: number;
1187
+ name?: string;
1188
+ seconds?: number; /** ticks (254016000000 per second) */
1189
+ time?: number;
1190
+ timecode?: string;
1191
+ };
1192
+ /** Add Range Marker to In and Out. Adds a range marker spanning the sequence In to Out points. Needs both In and Out set. Params: {"name":str?,"comment":str?,"color":label?}. Reads the part. Changes the document. */
1193
+ "markers.addRangeInOut": {
1194
+ color?: string;
1195
+ comment?: string;
1196
+ name?: string;
1197
+ };
1198
+ /** Go to Next Marker. Moves the playhead to the next marker after it on the sequence (or Source clip). Params: {"target":"program|source"}. Reads the part, time, active, mode. Changes the document. */
1199
+ "markers.goNext": {
1200
+ target?: "program" | "source";
1201
+ };
1202
+ /** Go to Previous Marker. Moves the playhead to the previous marker before it on the sequence (or Source clip). Params: {"target":"program|source"}. Reads the part, time, active, mode. Changes the document. */
1203
+ "markers.goPrev": {
1204
+ target?: "program" | "source";
1205
+ };
1206
+ /** Clear Selected Marker. Removes the marker that starts exactly at the playhead. Params: {"target":"program|source"}. Reads the part, time, active. Changes the document. */
1207
+ "markers.clearCurrent": {
1208
+ target?: "program" | "source";
1209
+ };
1210
+ /** Clear Markers. Removes every marker from the sequence (or the Source clip with target "source"). Params: {"target":"program|source"}. Reads the part, active. Changes the document. */
1211
+ "markers.clearAll": {
1212
+ target?: "program" | "source";
1213
+ };
1214
+ /** Show All Marker Colors. Shows every marker color again in the Markers panel, clearing the color filter. Params: {}. Reads the mode. Changes the document. */
1215
+ "markers.showAllMarkerColors": Record<string, never>;
1216
+ /** Marker Colour Filter. Hides or shows marker colors in the Markers panel: `hidden` lists colors to hide, or `color` with `visible`. View filter only. Params: {"hidden":[label]}|{"color":label,"visible":bool?}. Reads the mode. Changes the document. */
1217
+ "markers.filterColors": {
1218
+ color?: Json; /** [label]; in one of several forms of the parameters */
1219
+ hidden?: Array<Json>; /** in one of several forms of the parameters */
1220
+ visible?: boolean;
1221
+ };
1222
+ /** Edit Marker. Changes a marker by id (`marker`): name, comment, `color` (a marker colour or label name) or `durationFrames`/`durationSeconds` (0 makes it a point marker). Params: {"target":"program|source","marker":id,"name":str?,"comment":str?,"color":label?,"durationFrames":i64?,"durationSeconds":f64?}. Reads the part, active. Changes the document. */
1223
+ "markers.edit": {
1224
+ color?: string;
1225
+ comment?: string;
1226
+ durationFrames?: number;
1227
+ durationSeconds?: number; /** an id */
1228
+ marker?: number;
1229
+ name?: string;
1230
+ target?: "program" | "source"; /** read by the command beside its listed parameters */
1231
+ time?: number;
1232
+ };
1233
+ /** Add Chapter Marker. Adds a chapter marker (exported as a chapter in MP4/DVD) at the playhead or `time` (or `frame`, `seconds`, `timecode`); named Chapter n by default. Params: {"time":ticks?,"frame":i64?,"seconds":f64?,"timecode":str?,"name":str?,"comment":str?,"color":label?}. Reads the part, time. Changes the document. */
1234
+ "markers.addChapter": {
1235
+ color?: string;
1236
+ comment?: string;
1237
+ frame?: number;
1238
+ name?: string;
1239
+ seconds?: number; /** ticks (254016000000 per second) */
1240
+ time?: number;
1241
+ timecode?: string;
1242
+ };
1243
+ /** Add Flash Cue Marker. Adds a Flash Cue marker (an event cue for interactive exports) at the playhead or `time` (or `frame`, `seconds`, `timecode`). Params: {"time":ticks?,"frame":i64?,"seconds":f64?,"timecode":str?,"name":str?,"comment":str?,"color":label?,"durationFrames":i64?,"durationSeconds":f64?}. Reads the part, time. Changes the document. */
1244
+ "markers.addFlashCue": {
1245
+ color?: string;
1246
+ comment?: string;
1247
+ durationFrames?: number;
1248
+ durationSeconds?: number;
1249
+ frame?: number;
1250
+ name?: string;
1251
+ seconds?: number; /** ticks (254016000000 per second) */
1252
+ time?: number;
1253
+ timecode?: string;
1254
+ };
1255
+ /** Ripple Sequence Markers. Sets whether ripple edits also move the sequence markers after the edit (`on`, toggles when omitted). Params: {"on":bool?}. Reads the mode. Changes the document. */
1256
+ "markers.rippleSequenceMarkers": {
1257
+ on?: boolean;
1258
+ };
1259
+ /** Copy Paste Includes Sequence Markers. Sets whether copying and pasting clips also carries the sequence markers over them (`on`, toggles when omitted). Params: {"on":bool?}. Reads the mode. Changes the document. */
1260
+ "markers.copyPasteIncludesSequenceMarkers": {
1261
+ on?: boolean;
1262
+ };
1263
+ /** Set Playhead. Moves the sequence playhead to `time` (ticks, 254016000000 per second), `frame` (0-based sequence frame), `seconds` or `timecode`. Answers {time} in ticks. Params: {"time":ticks|"frame":i64|"seconds":f64|"timecode":str}. Reads the part, time, mode, active. Changes the document. */
1264
+ "playhead.set": {
1265
+ frame?: number; /** one of several alternative parameters */
1266
+ seconds?: number; /** ticks (254016000000 per second); one of several alternative parameters */
1267
+ time?: number; /** one of several alternative parameters */
1268
+ timecode?: string;
1269
+ };
1270
+ /** Step Frames. Moves the playhead by `frames` sequence frames (negative steps back, stops at 0). Answers {frame}. Params: {"frames":i64}. Reads the part, time, mode, active. Changes the document. */
1271
+ "playhead.step": {
1272
+ frames?: number;
1273
+ };
1274
+ /** Step Forward One Frame. Moves the playhead one frame later. Params: {}. Reads the part, time, mode, active. Changes the document. */
1275
+ "playhead.stepForward": Record<string, never>;
1276
+ /** Step Back One Frame. Moves the playhead one frame earlier. Params: {}. Reads the part, time, mode, active. Changes the document. */
1277
+ "playhead.stepBack": Record<string, never>;
1278
+ /** Step Forward Five Frames. Moves the playhead forward by the Step Many Frames preference (5 by default). Params: {}. Reads the part, time, mode, active. Changes the document. */
1279
+ "playhead.stepForward5": Record<string, never>;
1280
+ /** Step Back Five Frames. Moves the playhead back by the Step Many Frames preference (5 by default). Params: {}. Reads the part, time, mode, active. Changes the document. */
1281
+ "playhead.stepBack5": Record<string, never>;
1282
+ /** Go to Next Edit Point. Moves the playhead to the next edit point on the targeted tracks (all tracks when none is targeted). Use playhead.nextEditAnyTrack to ignore targeting. Params: {}. Reads the part, time, mode, active. Changes the document. */
1283
+ "playhead.nextEdit": Record<string, never>;
1284
+ /** Go to Previous Edit Point. Moves the playhead to the previous edit point on the targeted tracks (all tracks when none is targeted). Params: {}. Reads the part, time, mode, active. Changes the document. */
1285
+ "playhead.prevEdit": Record<string, never>;
1286
+ /** Go to Sequence Start. Moves the playhead to the start of the active sequence (time 0). Params: {}. Reads the part, time, mode, active. Changes the document. */
1287
+ "playhead.start": Record<string, never>;
1288
+ /** Go to Sequence End. Moves the playhead to the end of the active sequence. Params: {}. Reads the part, time, mode, active. Changes the document. */
1289
+ "playhead.end": Record<string, never>;
1290
+ /** Open in Source Monitor. Opens a project `item` (default: the Project panel selection) in the Source monitor; a subclip opens at its In point. Params: {"item":id?}. Acts on `item`. Reads the selection. Changes the document. */
1291
+ "source.open": {
1292
+ item?: number;
1293
+ };
1294
+ /** Set Source Playhead. Moves the Source monitor playhead to `time` ticks, `frame` (source frame) or `seconds`. Needs a clip open in the Source monitor. Params: {"time":ticks|"frame":i64|"seconds":f64}. Reads the active. Changes the document. */
1295
+ "source.setPlayhead": {
1296
+ frame?: number; /** one of several alternative parameters */
1297
+ seconds?: number; /** ticks (254016000000 per second); one of several alternative parameters */
1298
+ time?: number; /** the time, as a timecode (one spelling of it) */
1299
+ timecode?: string;
1300
+ };
1301
+ /** Inspect Source Monitor. Reads the Source monitor: the open item, its In/Out, source playhead, frame size and streams. Answers {item:null} when nothing is open. Params: {}. Reads the active. */
1302
+ "source.inspect": Record<string, never>;
1303
+ /** Insert. Three-point edit: inserts the Source monitor's In?Out range at the sequence In point (else the playhead) on the source-patched tracks, pushing later clips right. Use source.overwrite to replace instead. Params: {}. Reads the part, time, active, mode. Changes the document. */
1304
+ "source.insert": Record<string, never>;
1305
+ /** Overwrite. Three-point edit: places the Source monitor's In?Out range at the sequence In point (else the playhead) on the source-patched tracks, replacing what is there; nothing moves. Params: {}. Reads the part, time, active, mode. Changes the document. */
1306
+ "source.overwrite": Record<string, never>;
1307
+ /** From Source Monitor. Replaces the source of the selected clips with the clip open in the Source monitor, starting at its In point. Params: {"clips":[id]?}. Reads the part, selection, mode, active. Changes the document. */
1308
+ "clip.replaceFromSource": {
1309
+ clips?: Array<number>; /** read by the command beside its listed parameters */
1310
+ item?: number; /** read by the command beside its listed parameters */
1311
+ keepSourceIn?: boolean;
1312
+ };
1313
+ /** From Source Monitor, Match Frame. Replaces the selected clips with the Source monitor clip so its frame at the Source playhead lines up with the sequence playhead. Params: {"clips":[id]?}. Reads the part, selection, time, mode, active. Changes the document. */
1314
+ "clip.replaceFromSourceMatchFrame": {
1315
+ clips?: Array<number>; /** read by the command beside its listed parameters */
1316
+ item?: number; /** read by the command beside its listed parameters */
1317
+ keepSourceIn?: boolean;
1318
+ };
1319
+ /** From Bin. Replaces the source of the selected or listed `clips` with project `item`, keeping position and length; `keepSourceIn` keeps the old In point instead of the new item's. Params: {"clips":[id]?,"item":id?,"keepSourceIn":bool=false}. Reads the part, selection, mode. Changes the document. */
1320
+ "clip.replaceFromBin": {
1321
+ clips?: Array<number>; /** an id */
1322
+ item?: number;
1323
+ keepSourceIn?: boolean;
1324
+ };
1325
+ /** Restore Captions from Source Clip. Restores embedded captions from source media; always refused, since no embedded caption reader exists. Params: {}. Changes the document. */
1326
+ "clip.restoreCaptionsFromSource": Record<string, never>;
1327
+ /** Update Metadata. Writes the selected file `items`' metadata to XMP sidecar files next to the media. Params: {"items":[id]?}. Acts on `items`. Reads the part, selection. Changes the document. */
1328
+ "clip.updateMetadata": {
1329
+ items?: Array<number>;
1330
+ };
1331
+ /** Generate Audio Waveform. Asks the host to rebuild audio waveform peaks for the selected or listed `items`; changes no project data. Params: {"items":[id]?}. Acts on `items`. Reads the part, selection. */
1332
+ "clip.generateAudioWaveform": {
1333
+ items?: Array<number>;
1334
+ };
1335
+ /** Automate to Sequence. Places the selected project `items` in the active sequence in `ordering` (sort or selection), sequentially or at unnumbered markers, by insert or overwrite, with optional default transitions of `overlapFrames`. Params: {"items":[id]?,"ordering":"sort|selection","placement":"sequentially|unnumberedMarkers","method":"insert|overwrite","overlapFrames":n=30,"stillFrames":n?,"videoTransition":bool=true,"audioTransition":bool=true,"ignoreAudio":bool=false,"ignoreVideo":bool=false}. Acts on `items`. Reads the part, selection, time, active, mode. Changes the document. */
1336
+ "clip.automateToSequence": {
1337
+ audioTransition?: boolean;
1338
+ ignoreAudio?: boolean;
1339
+ ignoreVideo?: boolean;
1340
+ items?: Array<number>;
1341
+ method?: "insert" | "overwrite";
1342
+ ordering?: "sort" | "selection";
1343
+ overlapFrames?: number;
1344
+ placement?: "sequentially" | "unnumberedMarkers";
1345
+ stillFrames?: number;
1346
+ videoTransition?: boolean;
1347
+ };
1348
+ /** Place Clip. Places project `item` on the timeline at `time` (ticks), `frame` or `seconds` on `track` (and `audioTrack`), from `sourceIn` for `duration`; `insert: true` pushes later clips right, false overwrites. `video`/`audio` choose streams. `track: "auto"` / `audioTrack: "auto"` put the picture / sound on the first track with room for it (a new track when none has) instead of overwriting, and answer the track chosen ("V2", "A3"). `snap` ("markers", "beats" or both) starts the clip on the nearest sequence marker or music beat within `toleranceFrames` (3). Answers the new clip ids (and `snapped`). Params: {"item":id,"track":"V1"|id|"A1" (sound only)|"auto"?,"audioTrack":"A1"|id|"auto"?,"time":ticks|"frame":i64|"seconds":f64,"insert":bool,"sourceIn":ticks?,"duration":ticks?,"video":bool=true,"audio":bool=true,"snap":"markers"|"beats"|["markers","beats"]?,"toleranceFrames":i64=3}. Reads the part, time, mode, active. Changes the document. */
1349
+ "timeline.place": {
1350
+ audio?: boolean; /** "A1"|id? */
1351
+ audioTrack?: Json; /** ticks (254016000000 per second) */
1352
+ duration?: number; /** one of several alternative parameters */
1353
+ frame?: number;
1354
+ insert?: boolean; /** an id */
1355
+ item?: number; /** one of several alternative parameters */
1356
+ seconds?: number; /** "markers"|"beats"|["markers","beats"]? */
1357
+ snap?: Json; /** ticks (254016000000 per second) */
1358
+ sourceIn?: number; /** ticks (254016000000 per second); one of several alternative parameters */
1359
+ time?: number; /** the time, as a timecode (one spelling of it) */
1360
+ timecode?: string;
1361
+ toleranceFrames?: number; /** "V1"|id|"A1" (sound only)?; sound only */
1362
+ track?: Json;
1363
+ video?: boolean;
1364
+ };
1365
+ /** Select Clips. Sets the timeline clip selection to `clips`; `add` adds to it, `toggle` flips each clip; linked partners are included unless `linked: false`. Params: {"clips":[id],"add":bool,"toggle":bool,"linked":bool?}. Acts on `clips`. Reads the part, selection, mode. Changes the document. */
1366
+ "timeline.select": {
1367
+ add?: boolean;
1368
+ clips?: Array<number>;
1369
+ linked?: boolean;
1370
+ toggle?: boolean;
1371
+ };
1372
+ /** Move Clips. Moves clips to new tracks and times in one step: `moves` lists {clip, track, time ticks}. `insert: true` pushes clips at the destination right; otherwise it overwrites. Linked partners follow unless `linked: false`. `snap` ("markers", "beats" or both) lands the earliest clip on the nearest sequence marker or music beat within `toleranceFrames` (3) and moves the rest by as much; the answer's `snapped` says {from, to}. Params: {"moves":[{"clip":id,"track":id|"V2","time":ticks}],"insert":bool,"linked":bool?,"snap":"markers"|"beats"|["markers","beats"]?,"toleranceFrames":i64=3}. Reads the part, mode. Changes the document. */
1373
+ "timeline.move": {
1374
+ insert?: boolean;
1375
+ linked?: boolean; /** [{"clip":id,"track":id|"V2","time":ticks}] */
1376
+ moves?: Array<{
1377
+ clip?: number;
1378
+ time?: number;
1379
+ track?: Json;
1380
+ }>; /** "markers"|"beats"|["markers","beats"]? */
1381
+ snap?: Json;
1382
+ toleranceFrames?: number;
1383
+ };
1384
+ /** Trim Edit. Trims `clip`'s in or out `edge` by `delta` ticks or `deltaFrames`: `mode` regular leaves a gap or overlaps; ripple moves later clips to keep the edit closed. `snap` ("markers", "beats" or both) lands the trimmed edge on the nearest sequence marker or music beat within `toleranceFrames` (3). Params: {"clip":id,"edge":"in|out","mode":"regular|ripple","delta":ticks|"deltaFrames":i64,"snap":"markers"|"beats"|["markers","beats"]?,"toleranceFrames":i64=3}. Acts on `clip`. Reads the part, mode. Changes the document. */
1385
+ "timeline.trim": {
1386
+ clip?: number; /** ticks (254016000000 per second); one of several alternative parameters */
1387
+ delta?: number; /** one of several alternative parameters */
1388
+ deltaFrames?: number;
1389
+ edge?: "in" | "out";
1390
+ mode?: "regular" | "ripple"; /** "markers"|"beats"|["markers","beats"]? */
1391
+ snap?: Json;
1392
+ toleranceFrames?: number;
1393
+ };
1394
+ /** Select Edit Point. Selects the `edge` (in|out) of `clip` as an edit point of `kind` trim|ripple|roll; `add` keeps the existing edit points. The first step before trim.nudge or trim.shuttle. Params: {"clip":id,"edge":"in|out","kind":"trim|ripple|roll","add":bool?}. Acts on `clip`. Reads the part, active. Changes the document. */
1395
+ "trim.selectEditPoint": {
1396
+ add?: boolean; /** an id */
1397
+ clip?: number;
1398
+ edge?: "in" | "out";
1399
+ kind?: "trim" | "ripple" | "roll";
1400
+ };
1401
+ /** Select Nearest Edit Point. Selects, on each targeted track (all tracks when none), the edit point nearest the playhead as `kind` rippleIn|rippleOut|roll|trimIn|trimOut. Params: {"kind":"rippleIn|rippleOut|roll|trimIn|trimOut"}. Reads the part, time, active. Changes the document. */
1402
+ "trim.selectNearest": {
1403
+ kind?: "rippleIn" | "rippleOut" | "roll" | "trimIn" | "trimOut";
1404
+ };
1405
+ /** Clear Edit Point Selection. Deselects all edit points and leaves trim mode; changes no clips. Params: {}. Reads the part, mode, active. Changes the document. */
1406
+ "trim.clear": Record<string, never>;
1407
+ /** Toggle Trim Type. Cycles every selected edit point Ripple ? Roll ? Trim. Params: {}. Reads the part, active. Changes the document. */
1408
+ "trim.toggleType": Record<string, never>;
1409
+ /** Trim Backward. Trims every selected edit point one frame earlier, using each point's ripple/roll/trim type. Needs selected edit points; use trim.nudge for any number of frames. Params: {}. Reads the part, mode, active. Changes the document. */
1410
+ "trim.backward": Record<string, never>;
1411
+ /** Trim Forward. Trims every selected edit point one frame later, using each point's ripple/roll/trim type. Needs selected edit points; use trim.nudge for any number of frames. Params: {}. Reads the part, mode, active. Changes the document. */
1412
+ "trim.forward": Record<string, never>;
1413
+ /** Trim Backward Many. Trims every selected edit point earlier by the Large Trim Offset preference (5 frames by default). Needs selected edit points. Params: {}. Reads the part, mode, active. Changes the document. */
1414
+ "trim.backwardMany": Record<string, never>;
1415
+ /** Trim Forward Many. Trims every selected edit point later by the Large Trim Offset preference (5 frames by default). Needs selected edit points. Params: {}. Reads the part, mode, active. Changes the document. */
1416
+ "trim.forwardMany": Record<string, never>;
1417
+ /** Dynamic Trim (Shuttle). Starts or speeds up a dynamic trim of the selected edit points in `direction` (pressing again doubles speed up to 8?, `slow` for slow); `clock` is playback time in seconds. Commit with trim.shuttleStop. Params: {"direction":"forward|reverse","slow":bool?,"clock":seconds}. Reads the part, time, mode, active. Changes the document. */
1418
+ "trim.shuttle": {
1419
+ clock?: number;
1420
+ direction?: "forward" | "reverse";
1421
+ slow?: boolean;
1422
+ };
1423
+ /** Dynamic Trim Stop. Stops a dynamic trim and commits it as one undo step, and stops trim loop playback; `clock` is the playback time in seconds. Params: {"clock":seconds?}. Reads the part, time, mode, active. Changes the document. */
1424
+ "trim.shuttleStop": {
1425
+ clock?: number;
1426
+ };
1427
+ /** Cancel Dynamic Trim. Abandons a dynamic (J/L) trim in progress without committing it; the edit points return to where the trim started. Params: {}. Reads the part, time, mode, active. Changes the document. */
1428
+ "trim.cancelDynamic": Record<string, never>;
1429
+ /** Play Around Edit. Plays from preroll before the first selected edit to postroll after it (loops by default); `clock` is the caller's playback time in seconds, `toggle` stops it if playing. Params: {"clock":seconds,"loop":bool=true,"toggle":bool?}. Reads the part, time, mode, active. Changes the document. */
1430
+ "trim.playAround": {
1431
+ clock?: number;
1432
+ loop?: boolean;
1433
+ toggle?: boolean;
1434
+ };
1435
+ /** Advance Trim Playback. Advances a dynamic trim or Play Around Edit to playback time `clock` (seconds) and answers the trim status; the host calls it while playing. Params: {"clock":seconds}. Reads the part, time, mode, active. */
1436
+ "trim.tick": {
1437
+ clock?: number;
1438
+ };
1439
+ /** Trim Monitor State. Reads the Trim Monitor for the first selected edit point: kind, edge, the outgoing and incoming clips' frames and the trim shift. Answers {active:false} with no edit point. Params: {}. Reads the part, mode, active. */
1440
+ "trim.monitor": Record<string, never>;
1441
+ /** Trim by Frames. Trims every selected edit point by `frames` (sequence frames; negative is earlier), using each point's ripple/roll/trim type. Needs selected edit points. Params: {"frames":i64}. Reads the part, mode, active. Changes the document. */
1442
+ "trim.nudge": {
1443
+ frames?: number;
1444
+ };
1445
+ /** Extend Selected Edit to Playhead. Moves every selected edit point by the distance from the first one to the playhead, keeping each point's trim type. Needs selected edit points. Params: {}. Reads the part, time, mode, active. Changes the document. */
1446
+ "trim.extendToPlayhead": Record<string, never>;
1447
+ /** Ripple Trim Previous Edit to Playhead. Removes the material between the previous edit and the playhead on targeted tracks and closes the gap by moving later clips earlier (Premiere Q). Params: {}. Reads the part, selection, time, mode, active. Changes the document. */
1448
+ "trim.ripplePrevious": Record<string, never>;
1449
+ /** Ripple Trim Next Edit to Playhead. Removes the material between the playhead and the next edit on targeted tracks and closes the gap by moving later clips earlier (Premiere W). Params: {}. Reads the part, selection, time, mode, active. Changes the document. */
1450
+ "trim.rippleNext": Record<string, never>;
1451
+ /** Trim Previous Edit to Playhead. Trims the clip edge at the previous edit on targeted tracks up to the playhead, removing that material and leaving a gap (no ripple). Use trim.ripplePrevious to close the gap. Params: {}. Reads the part, selection, time, mode, active. Changes the document. */
1452
+ "trim.previous": Record<string, never>;
1453
+ /** Trim Next Edit to Playhead. Trims the clip edge at the next edit on targeted tracks back to the playhead, removing that material and leaving a gap (no ripple). Use trim.rippleNext to close the gap. Params: {}. Reads the part, selection, time, mode, active. Changes the document. */
1454
+ "trim.next": Record<string, never>;
1455
+ /** Rolling Edit. Rolling edit between adjacent clips `left` and `right`: moves the cut by `delta` ticks or `deltaFrames`, lengthening one and shortening the other; total duration is unchanged. Params: {"left":id,"right":id,"delta":ticks|"deltaFrames":i64}. Reads the part. Changes the document. */
1456
+ "timeline.roll": {
1457
+ delta?: number; /** one of several alternative parameters */
1458
+ deltaFrames?: number; /** an id */
1459
+ left?: number; /** an id */
1460
+ right?: number;
1461
+ };
1462
+ /** Slip. Slip edit: shifts which part of the source `clip` shows by `delta` ticks or `deltaFrames`, keeping its position and length on the timeline. Params: {"clip":id,"delta":ticks|"deltaFrames":i64}. Acts on `clip`. Reads the part, mode. Changes the document. */
1463
+ "timeline.slip": {
1464
+ clip?: number; /** ticks (254016000000 per second); one of several alternative parameters */
1465
+ delta?: number; /** one of several alternative parameters */
1466
+ deltaFrames?: number;
1467
+ };
1468
+ /** Slide. Slide edit: moves `clip` by `delta` ticks or `deltaFrames` while trimming its neighbours to keep the gap closed; the clip's content and the sequence length don't change. Params: {"clip":id,"delta":ticks|"deltaFrames":i64}. Acts on `clip`. Reads the part, mode. Changes the document. */
1469
+ "timeline.slide": {
1470
+ clip?: number; /** ticks (254016000000 per second); one of several alternative parameters */
1471
+ delta?: number; /** one of several alternative parameters */
1472
+ deltaFrames?: number;
1473
+ };
1474
+ /** Rate Stretch. Drags `clip`'s in or out `edge` by `delta` ticks and changes its speed so the same media fills the new length (Rate Stretch tool). Answers the new speed. Params: {"clip":id,"edge":"in|out","delta":ticks}. Acts on `clip`. Reads the part, mode. Changes the document. */
1475
+ "timeline.rateStretch": {
1476
+ clip?: number; /** ticks (254016000000 per second) */
1477
+ delta?: number;
1478
+ edge?: "in" | "out";
1479
+ };
1480
+ /** Razor. Cuts clips at `time` (ticks), `seconds`, `frame` or `timecode` (default playhead): only `clip` (and linked partners) when given, else every clip on `track`, else all unlocked tracks. Answers `cuts`, the new clip ids (`clips`: the right-hand piece of each cut; the cut clip keeps its id for the left piece), and `pieces` ({left, right} for each cut). Params: {"time":ticks?,"seconds":f64?,"frame":i64?,"timecode":str?,"track":"V1"|id?,"clip":id?}. Acts on `clip`. Reads the part, time, mode. Changes the document. */
1481
+ "timeline.razor": {
1482
+ clip?: number;
1483
+ frame?: number;
1484
+ seconds?: number; /** ticks (254016000000 per second) */
1485
+ time?: number;
1486
+ timecode?: string; /** "V1"|id? */
1487
+ track?: Json;
1488
+ };
1489
+ /** Track Settings. Changes a track's settings: locked, sync lock, enabled (output), muted, solo, name, and for audio volume dB and pan. Params: {"track":"V1"|id,"locked":bool?,"syncLock":bool?,"enabled":bool?,"muted":bool?,"solo":bool?,"name":str?,"volumeDb":f64?,"pan":f64?}. Reads the part. Changes the document. */
1490
+ "timeline.setTrack": {
1491
+ enabled?: boolean;
1492
+ locked?: boolean;
1493
+ muted?: boolean;
1494
+ name?: string;
1495
+ pan?: number;
1496
+ solo?: boolean;
1497
+ syncLock?: boolean; /** "V1"|id */
1498
+ track?: Json;
1499
+ volumeDb?: number;
1500
+ };
1501
+ /** Track Targeting. Turns track targeting (`targeted`, used by paste, match frame and edit navigation) and/or source patching (`sourcePatch`, where source.insert/overwrite land) on or off for `track`. Params: {"track":"V1"|id,"targeted":bool?,"sourcePatch":bool?}. Reads the part, active. Changes the document. */
1502
+ "timeline.setTargeting": {
1503
+ sourcePatch?: boolean;
1504
+ targeted?: boolean; /** "V1"|id */
1505
+ track?: Json;
1506
+ };
1507
+ /** Apply Effect. Adds `effect` (id like gaussian_blur or its name; see effects.list) to the selected or listed `clips`, at the end of each clip's effect stack. Params: {"clips":[id]?,"effect":"gaussian_blur|Gaussian Blur|..."}. Acts on `clips`. Reads the part, selection, time, active, mode. Changes the document. */
1508
+ "effects.apply": {
1509
+ clips?: Array<number>; /** for example gaussian_blur, Gaussian Blur */
1510
+ effect?: string;
1511
+ };
1512
+ /** Remove Effect. Removes the effect at `index` (0-based, as sequence.inspect lists a clip's effects; fixed effects can't be removed) from `clip`. Params: {"clip":id,"index":n}. Acts on `clip`. Reads the part. Changes the document. */
1513
+ "effects.remove": {
1514
+ clip?: number;
1515
+ index?: number;
1516
+ };
1517
+ /** Set Effect Parameter. Sets `param` of `clip`'s `effect` ("motion", "opacity", a name or index) to `value`. With a `time` (sequence ticks; or `frame`, `seconds`, `timecode`) it sets a keyframe there, turning animation on if the parameter was static; without one it keys the playhead when the parameter is animated, else sets the static value. `param` is a parameter id or label, and a choice takes its option's name (any case) or index. `mask` targets a mask's parameter (a mask `path` in frame pixels). Motion's `scale_width` needs `uniform_scale` false (it is refused while Uniform Scale is on). Params: {"clip":id,"effect":"motion"|index,"param":str,"mask":n?,"value":num|[x,y]|"#rrggbb"|bool|path,"time":ticks|"frame":i64|"seconds":f64?,"merge":bool?,"begin":bool?}. Acts on `clip`. Reads the part, time. Changes the document. */
1518
+ "effects.setParam": {
1519
+ begin?: boolean; /** an id */
1520
+ clip?: number; /** "motion"|index */
1521
+ effect?: string; /** one of several alternative parameters */
1522
+ frame?: number;
1523
+ mask?: number;
1524
+ merge?: boolean;
1525
+ param?: string; /** one of several alternative parameters */
1526
+ seconds?: number; /** ticks (254016000000 per second); one of several alternative parameters */
1527
+ time?: number; /** the time, as a timecode (one spelling of it) */
1528
+ timecode?: string; /** num|[x,y]|"#rrggbb"|bool|path */
1529
+ value?: Json;
1530
+ };
1531
+ /** Toggle Animation. Turns keyframe animation of an effect parameter on (a keyframe at `time`, sequence ticks or `frame`/`seconds`, default the playhead) or off (removes its keyframes, keeping the value at that time). Params: {"clip":id,"effect":str|index,"param":str,"mask":n?,"time":ticks|"frame":i64|"seconds":f64?}. Acts on `clip`. Reads the part, time. Changes the document. */
1532
+ "effects.toggleAnimation": {
1533
+ clip?: number; /** str|index */
1534
+ effect?: string; /** one of several alternative parameters */
1535
+ frame?: number;
1536
+ mask?: number;
1537
+ param?: string; /** one of several alternative parameters */
1538
+ seconds?: number; /** ticks (254016000000 per second); one of several alternative parameters */
1539
+ time?: number; /** the time, as a timecode (one spelling of it) */
1540
+ timecode?: string;
1541
+ };
1542
+ /** Toggle Effect. Turns the effect at `index` of `clip` on or off without removing it. Params: {"clip":id,"index":n}. Acts on `clip`. Reads the part. Changes the document. */
1543
+ "effects.toggleEnabled": {
1544
+ clip?: number;
1545
+ index?: number;
1546
+ };
1547
+ /** Reset Effect. Resets every parameter of the effect at `index` of `clip` to its defaults. Params: {"clip":id,"index":n}. Acts on `clip`. Reads the part. Changes the document. */
1548
+ "effects.reset": {
1549
+ clip?: number;
1550
+ index?: number;
1551
+ };
1552
+ /** Add/Remove Keyframe. Adds a keyframe of an effect parameter at `time` (sequence ticks, default playhead) with its current value, or removes it if one is there. `mask` targets a mask's parameter. Params: {"clip":id,"effect":str|index,"param":str,"mask":n?,"time":ticks?}. Acts on `clip`. Reads the part, time. Changes the document. */
1553
+ "effects.addKeyframe": {
1554
+ clip?: number; /** str|index */
1555
+ effect?: string; /** read by the command beside its listed parameters */
1556
+ frame?: number; /** read by the command beside its listed parameters */
1557
+ inInfluence?: number; /** read by the command beside its listed parameters */
1558
+ interpolation?: string;
1559
+ mask?: number; /** read by the command beside its listed parameters */
1560
+ mediaTime?: number; /** read by the command beside its listed parameters */
1561
+ outInfluence?: number;
1562
+ param?: string; /** the time, in seconds (one spelling of it) */
1563
+ seconds?: number; /** ticks (254016000000 per second) */
1564
+ time?: number; /** the time, as a timecode (one spelling of it) */
1565
+ timecode?: string; /** read by the command beside its listed parameters */
1566
+ to?: number; /** read by the command beside its listed parameters */
1567
+ value?: Json;
1568
+ };
1569
+ /** Delete Keyframe. Deletes the keyframe of an effect parameter at `mediaTime` (ticks of the clip's media time, as sequence.inspect lists each keyframe's `mediaTime`). `mask` targets a mask's parameter. Params: {"clip":id,"effect":str|index,"param":str,"mask":n?,"mediaTime":ticks}. Acts on `clip`. Reads the part, time. Changes the document. */
1570
+ "effects.deleteKeyframe": {
1571
+ clip?: number; /** str|index */
1572
+ effect?: string; /** read by the command beside its listed parameters */
1573
+ inInfluence?: number; /** read by the command beside its listed parameters */
1574
+ interpolation?: string;
1575
+ mask?: number; /** ticks (254016000000 per second) */
1576
+ mediaTime?: number; /** read by the command beside its listed parameters */
1577
+ outInfluence?: number;
1578
+ param?: string; /** read by the command beside its listed parameters */
1579
+ to?: number; /** read by the command beside its listed parameters */
1580
+ value?: Json;
1581
+ };
1582
+ /** Move Keyframe. Moves the keyframe of an effect parameter at `mediaTime` to media time `to` (both clip media ticks). `mask` targets a mask's parameter. Params: {"clip":id,"effect":str|index,"param":str,"mask":n?,"mediaTime":ticks,"to":ticks}. Acts on `clip`. Reads the part, time. Changes the document. */
1583
+ "effects.moveKeyframe": {
1584
+ clip?: number; /** str|index */
1585
+ effect?: string; /** read by the command beside its listed parameters */
1586
+ inInfluence?: number; /** read by the command beside its listed parameters */
1587
+ interpolation?: string;
1588
+ mask?: number; /** ticks (254016000000 per second) */
1589
+ mediaTime?: number; /** read by the command beside its listed parameters */
1590
+ outInfluence?: number;
1591
+ param?: string; /** ticks (254016000000 per second) */
1592
+ to?: number; /** read by the command beside its listed parameters */
1593
+ value?: Json;
1594
+ };
1595
+ /** Keyframe Interpolation. Sets the interpolation of the keyframe at `mediaTime`: linear, bezier, autoBezier, continuousBezier, hold, easeIn or easeOut (an unknown name is refused). `mask` targets a mask's parameter. Params: {"clip":id,"effect":str|index,"param":str,"mask":n?,"mediaTime":ticks,"interpolation":"linear|bezier|autoBezier|continuousBezier|hold|easeIn|easeOut"}. Acts on `clip`. Reads the part, time. Changes the document. */
1596
+ "effects.setInterpolation": {
1597
+ clip?: number; /** str|index */
1598
+ effect?: string; /** read by the command beside its listed parameters */
1599
+ frame?: number; /** read by the command beside its listed parameters */
1600
+ inInfluence?: number;
1601
+ interpolation?: "linear" | "bezier" | "autoBezier" | "continuousBezier" | "hold" | "easeIn" | "easeOut";
1602
+ mask?: number; /** ticks (254016000000 per second) */
1603
+ mediaTime?: number; /** read by the command beside its listed parameters */
1604
+ outInfluence?: number;
1605
+ param?: string; /** the time, in seconds (one spelling of it) */
1606
+ seconds?: number; /** read by the command beside its listed parameters */
1607
+ time?: number; /** the time, as a timecode (one spelling of it) */
1608
+ timecode?: string; /** read by the command beside its listed parameters */
1609
+ to?: number; /** read by the command beside its listed parameters */
1610
+ value?: Json;
1611
+ };
1612
+ /** Edit Keyframe. Changes the keyframe at `mediaTime`: its `value` and bezier in/out influence (0?1). `mask` targets a mask's parameter. Params: {"clip":id,"effect":str|index,"param":str,"mask":n?,"mediaTime":ticks,"value":any?,"inInfluence":0..1?,"outInfluence":0..1?}. Acts on `clip`. Reads the part, time. Changes the document. */
1613
+ "effects.setKeyframe": {
1614
+ clip?: number; /** str|index */
1615
+ effect?: string; /** 0 to 1 */
1616
+ inInfluence?: number; /** read by the command beside its listed parameters */
1617
+ interpolation?: string;
1618
+ mask?: number; /** ticks (254016000000 per second) */
1619
+ mediaTime?: number; /** 0 to 1 */
1620
+ outInfluence?: number;
1621
+ param?: string; /** read by the command beside its listed parameters */
1622
+ to?: number;
1623
+ value?: Json;
1624
+ };
1625
+ /** Select Project Items. Sets the Project panel selection to `items`; many project commands act on this selection. Params: {"items":[id]}. Acts on `items`. Changes the document. */
1626
+ "project.select": {
1627
+ items?: Array<number>;
1628
+ };
1629
+ /** Clear. Deletes the listed or selected project `items` (bins with their contents); clips using them are removed from sequences. Answers what was removed. Params: {"items":[id]?}. Acts on `items`. Reads the part, selection, active. Changes the document. */
1630
+ "project.delete": {
1631
+ items?: Array<number>;
1632
+ };
1633
+ /** Move to Bin. Moves the listed or selected project `items` into `bin` (null for the root). Answers how many moved. Params: {"items":[id]?,"bin":binId|null}. Acts on `items`. Reads the selection. Changes the document. */
1634
+ "project.moveToBin": {
1635
+ bin?: number;
1636
+ items?: Array<number>;
1637
+ };
1638
+ /** Set Source In/Out. Sets or clears (null) the source In and Out points of project `item` (default the Source monitor item), in ticks of the item's time. Params: {"item":id,"in":ticks?|null,"out":ticks?|null}. Acts on `item`. Reads the active. Changes the document. */
1639
+ "project.setMarks": {
1640
+ in?: number; /** an id */
1641
+ item?: number; /** ticks?|null */
1642
+ out?: number;
1643
+ };
1644
+ /** List Commands. Lists every command with id, title, menu path, shortcut, parameters and whether it is enabled now. Params: {}. */
1645
+ "command.list": Record<string, never>;
1646
+ /** Inspect Project. Reads the whole project: bins and items with ids, kinds (media, sequence, generators), durations, frame rates and media paths. Read first to find item ids. Params: {}. Reads the part, active. */
1647
+ "project.inspect": Record<string, never>;
1648
+ /** Inspect Sequence. Reads sequence `item` (default active): settings, tracks with their clips (ids, times in ticks, sources, effects), transitions, markers, In/Out and playhead. The main read before editing a timeline. Params: {"item":id?}. Acts on `item`. Reads the part, selection, time. */
1649
+ "sequence.inspect": {
1650
+ item?: number;
1651
+ };
1652
+ /** Inspect Editor State. Reads the editor state: active sequence, playhead, selections (clips, captions, project items, edit points), targeting, In/Out and toggles like snapping and linked selection. Params: {}. */
1653
+ "state.inspect": Record<string, never>;
1654
+ /** List Effects. Lists available effects and transitions (filter by `kind` Video, Audio, VideoTransition, AudioTransition, `folder`, or one `effect` by id or name, the exact id first) with ids; `detail` (implied by `effect`) adds `paramInfo`: each parameter's id, type, default, min / max / unit, choice `options`, and `accepts` (the values it takes, e.g. booleans for an amount, left/right/up/down for a direction). Read to find effect ids and transition `params`. Params: {"kind":"Video"|"Audio"|"VideoTransition"|"AudioTransition"?,"folder":"Video Transitions/Wipe"?,"effect":"push"|"Push"?,"detail":bool?}. */
1655
+ "effects.list": {
1656
+ detail?: boolean;
1657
+ effect?: "push" | "Push"; /** like Video Transitions/Wipe */
1658
+ folder?: string;
1659
+ kind?: "Video" | "Audio" | "VideoTransition" | "AudioTransition";
1660
+ };
1661
+ /** List History. Lists the undo history: each step's label, who made it (person or agent) and which steps can be undone or redone. Params: {}. */
1662
+ "history.list": Record<string, never>;
1663
+ /** Add New Caption Track. Adds a caption track of `format` Subtitle|CEA-608|CEA-708|Teletext (default Subtitle) with `name` and `language` (default en), after the existing caption tracks (C1, C2... keep their tracks). Answers the new track's id and label. Params: {"format":"Subtitle|CEA-608|CEA-708|Teletext","name":str?,"language":str?}. Reads the part. Changes the document. */
1664
+ "captions.newTrack": {
1665
+ format?: "Subtitle" | "CEA-608" | "CEA-708" | "Teletext";
1666
+ language?: string;
1667
+ name?: string;
1668
+ };
1669
+ /** Delete Caption Track. Removes a whole caption track (`track` id or "C1"..., default the first) and all its captions. Params: {"track":id|"C1"}. Reads the part. Changes the document. */
1670
+ "captions.deleteTrack": {
1671
+ track?: Json;
1672
+ };
1673
+ /** Caption Track Settings. Changes a caption track's name, format, language, enabled, locked or sync-lock settings. Params: {"track":id|"C1","name":str?,"format":str?,"language":str?,"enabled":bool?,"locked":bool?,"syncLock":bool?}. Reads the part. Changes the document. */
1674
+ "captions.setTrack": {
1675
+ enabled?: boolean;
1676
+ format?: string;
1677
+ language?: string;
1678
+ locked?: boolean;
1679
+ name?: string;
1680
+ syncLock?: boolean; /** id|"C1" */
1681
+ track?: Json;
1682
+ };
1683
+ /** Caption Track Style. Sets a caption track's look: font, size, color, background, align, anchor, margin (fraction of frame height, 0?0.45), line spacing, outline, and for karaoke captions `highlightColor` and `highlightScale` (0.25?4) of the word being sung; `reset` restores defaults. Applies to every caption on the track. Params: {"track":id|"C1","font":str?,"size":f32?,"color":"#rrggbb[aa]"?,"background":bool?,"backgroundColor":"#rrggbbaa"?,"align":"left|center|right"?,"anchor":"top|middle|bottom"?,"margin":0..0.45 (fraction of frame height)?,"lineSpacing":f32?,"outline":f32?,"outlineColor":str?,"highlightColor":"#rrggbb[aa]" (karaoke word)?,"highlightScale":0.25..4 (karaoke word size)?,"reset":bool?}. Reads the part. Changes the document. */
1684
+ "captions.setStyle": {
1685
+ align?: "left" | "center" | "right";
1686
+ anchor?: "top" | "middle" | "bottom";
1687
+ background?: boolean; /** like #rrggbbaa */
1688
+ backgroundColor?: string; /** like #rrggbb[aa] */
1689
+ color?: string;
1690
+ font?: string; /** like #rrggbb[aa]; karaoke word */
1691
+ highlightColor?: string; /** 0.25 to 4; karaoke word size */
1692
+ highlightScale?: number;
1693
+ lineSpacing?: number; /** 0 to 0.45; fraction of frame height */
1694
+ margin?: number;
1695
+ outline?: number;
1696
+ outlineColor?: string;
1697
+ reset?: boolean;
1698
+ size?: number; /** id|"C1" */
1699
+ track?: Json;
1700
+ };
1701
+ /** Add Caption at Playhead. Adds a caption on a caption track at the playhead (or `time` ticks / `seconds`), `durationSeconds` long (3 by default) with `text`, its In and Out each on the frame that shows their time; creates track C1 if the sequence has none. `words` [{text, start, end} in sequence seconds] makes a karaoke caption spanning the words: each word gets a WebVTT timestamp, Chinese/Japanese/Korean words join without spaces, and burned-in captions draw the word being sung in the track's highlight colour and scale (a pause between words highlights nothing). Inline <b>, <i>, <u> are drawn. Answers the new caption. Params: {"track":id|"C1"?,"text":str?,"words":[{"text":str,"start":seconds,"end":seconds}]? (karaoke; the caption spans them unless seconds/durationSeconds are given),"time":ticks?,"seconds":f64?,"durationSeconds":f64=3}. Reads the part, time. Changes the document. */
1702
+ "captions.add": {
1703
+ durationSeconds?: number; /** the time, as a frame of the sequence (one spelling of it) */
1704
+ frame?: number;
1705
+ seconds?: number;
1706
+ text?: string; /** ticks (254016000000 per second) */
1707
+ time?: number; /** the time, as a timecode (one spelling of it) */
1708
+ timecode?: string; /** id|"C1"? */
1709
+ track?: Json; /** karaoke; the caption spans them unless seconds/durationSeconds are given */
1710
+ words?: Array<{
1711
+ end?: number;
1712
+ start?: number;
1713
+ text?: string;
1714
+ }>;
1715
+ };
1716
+ /** Split Caption. Splits `caption` at `time` (default: the playhead), or every caption under the playhead on unlocked caption tracks when no caption is given. Answers the new captions. Params: {"caption":id?,"time":ticks?}. Reads the part, time. Changes the document. */
1717
+ "captions.split": {
1718
+ caption?: number; /** ticks (254016000000 per second) */
1719
+ time?: number;
1720
+ };
1721
+ /** Merge Captions. Joins consecutive captions on one track into the first: it spans from the first start to the last end, texts joined with line breaks. Answers {caption}. Params: {"captions":[id]?}. Reads the part, selection, time. Changes the document. */
1722
+ "captions.merge": {
1723
+ caption?: number;
1724
+ captions?: Array<number>;
1725
+ };
1726
+ /** Edit Caption Text. Changes the `text` and/or `speaker` (null clears it) of one caption (default: the selected one). Params: {"caption":id?,"text":str?,"speaker":str|null?}. Reads the part, selection, time. Changes the document. */
1727
+ "captions.setText": {
1728
+ caption?: number; /** str|null? */
1729
+ speaker?: Json;
1730
+ text?: string;
1731
+ };
1732
+ /** Set Caption In/Out. Sets a caption's start and/or end, each as ticks (`startTime`), frames, seconds or timecode; default caption is the selected one. Params: {"caption":id?,"startTime":ticks?,"startFrame":i64?,"startSeconds":f64?,"startTimecode":str?,"endTime":ticks?,"endFrame":i64?,"endSeconds":f64?,"endTimecode":str?}. Reads the part, selection, time. Changes the document. */
1733
+ "captions.setTimes": {
1734
+ caption?: number;
1735
+ endFrame?: number;
1736
+ endSeconds?: number; /** ticks (254016000000 per second) */
1737
+ endTime?: number;
1738
+ endTimecode?: string;
1739
+ startFrame?: number;
1740
+ startSeconds?: number; /** ticks (254016000000 per second) */
1741
+ startTime?: number;
1742
+ startTimecode?: string;
1743
+ };
1744
+ /** Trim Caption. Moves the in or out `edge` of one caption by `delta` ticks or `deltaFrames`, without moving neighbours. Use captions.setTimes to set an absolute time. Params: {"caption":id,"edge":"in|out","delta":ticks|"deltaFrames":i64}. Reads the part, selection, time. Changes the document. */
1745
+ "captions.trim": {
1746
+ caption?: number; /** ticks (254016000000 per second); one of several alternative parameters */
1747
+ delta?: number; /** one of several alternative parameters */
1748
+ deltaFrames?: number;
1749
+ edge?: "in" | "out";
1750
+ };
1751
+ /** Move Captions. Shifts `captions` (default: selected) by `delta` ticks or `deltaFrames`, clamped at zero and so they don't overlap captions that stay. Answers {applied} ticks. Params: {"captions":[id]?,"delta":ticks|"deltaFrames":i64}. Reads the part, selection, time. Changes the document. */
1752
+ "captions.move": {
1753
+ caption?: number;
1754
+ captions?: Array<number>; /** ticks (254016000000 per second); one of several alternative parameters */
1755
+ delta?: number; /** one of several alternative parameters */
1756
+ deltaFrames?: number;
1757
+ };
1758
+ /** Delete Captions. Deletes the listed `captions` (default: the caption selection). `ripple: true` also closes the gaps by moving later captions earlier. Answers {deleted}. Params: {"captions":[id]?,"ripple":bool=false}. Reads the part, selection, time. Changes the document. */
1759
+ "captions.delete": {
1760
+ caption?: number;
1761
+ captions?: Array<number>;
1762
+ ripple?: boolean;
1763
+ };
1764
+ /** Select Captions. Selects `captions` by id (ids not in the sequence are ignored); `add: true` adds to the current caption selection. Params: {"captions":[id],"add":bool?}. Reads the part, selection. Changes the document. */
1765
+ "captions.select": {
1766
+ add?: boolean;
1767
+ captions?: Array<number>;
1768
+ };
1769
+ /** Go to Caption. Moves the playhead to the start of `caption` and selects it. Answers {time} in ticks. Params: {"caption":id}. Reads the part, selection, time, mode, active. Changes the document. */
1770
+ "captions.goTo": {
1771
+ caption?: number;
1772
+ };
1773
+ /** Go to Next Caption Segment. Moves the playhead to the start of the next caption on enabled caption tracks and selects it. Answers {time, caption}. Params: {}. Reads the part, time, mode, active. Changes the document. */
1774
+ "captions.next": Record<string, never>;
1775
+ /** Go to Previous Caption Segment. Moves the playhead to the start of the previous caption on enabled caption tracks and selects it. Answers {time, caption}. Params: {}. Reads the part, time, mode, active. Changes the document. */
1776
+ "captions.previous": Record<string, never>;
1777
+ /** Show All Caption Tracks. Enables every caption track of the active sequence. Reverse with captions.hideAll. Params: {}. Reads the part. Changes the document. */
1778
+ "captions.showAll": Record<string, never>;
1779
+ /** Show Active Caption Tracks Only. Enables only `track` (default the first) and disables the other caption tracks, so one language shows. Params: {"track":id|"C1"?}. Reads the part, selection, active. Changes the document. */
1780
+ "captions.showActiveOnly": {
1781
+ track?: Json;
1782
+ };
1783
+ /** Hide All Caption Tracks. Disables every caption track of the active sequence so none shows in the Program monitor or export; the captions stay. Reverse with captions.showAll. Params: {}. Reads the part. Changes the document. */
1784
+ "captions.hideAll": Record<string, never>;
1785
+ /** Import Captions. Reads a caption file at `path` (format detected from content and extension) into a new caption track of the active sequence; `name` names the track. Params: {"path":str,"name":str?}. Reads the part. Changes the document. */
1786
+ "captions.import": {
1787
+ name?: string;
1788
+ path?: Json;
1789
+ };
1790
+ /** Captions. Writes a caption track to a new file at `path`; `format` srt|vtt|scc|mcc|stl|ttml|dfxp defaults from the extension (else SRT); `dropFrame` applies to SCC/MCC timecode. Params: {"path":str,"format":"srt|vtt|scc|mcc|stl|ttml|dfxp"? (default: from the extension),"track":id|"C1"?,"dropFrame":bool=true}. Reads the part. Changes the document. */
1791
+ "captions.export": {
1792
+ dropFrame?: boolean; /** default: from the extension */
1793
+ format?: "srt" | "vtt" | "scc" | "mcc" | "stl" | "ttml" | "dfxp";
1794
+ path?: Json; /** id|"C1"? */
1795
+ track?: Json;
1796
+ };
1797
+ /** List Captions. Lists the caption tracks (or just `track`) with their captions' ids, times in ticks, text and speaker, plus the caption selection. Read before editing captions. Params: {"track":id|"C1"?}. Reads the part, selection. */
1798
+ "captions.list": {
1799
+ track?: Json;
1800
+ };
1801
+ /** Settings Schema. Lists every preference key with its type, default, allowed values and category. Params: {"category":str?}. */
1802
+ "prefs.schema": {
1803
+ category?: string;
1804
+ };
1805
+ /** Media Cache Info. Reads the media cache: folder, size, and file counts (peaks, conformed audio, previews). Params: {}. */
1806
+ "mediaCache.info": Record<string, never>;
1807
+ /** Delete Media Cache Files. Deletes media cache files no longer used by open projects, or `all` of them. Params: {"all":bool?}. Changes the document. */
1808
+ "mediaCache.clean": {
1809
+ all?: boolean;
1810
+ };
1811
+ /** Inspect Audio Track Mixer. Reads the Audio Track Mixer at `time` (default playhead): every strip's volume, pan, mute/solo, mode, output, sends, track effects and automation values. Params: {"time":ticks?}. Reads the part, time, mode. */
1812
+ "mixer.inspect": {
1813
+ time?: number;
1814
+ };
1815
+ /** Track Mixer Settings. Changes a mixer strip's static settings: name, volume dB, pan, mute, solo, record arm, solo safe, automation mode, output routing, input map, channels. Params: {"strip":"A1"|"S1"|"Mix"|id,"name":str?,"volumeDb":f64?,"pan":f64?,"muted":bool?,"solo":bool?,"recordArm":bool?,"soloSafe":bool?,"mode":"Off|Read|Latch|Touch|Write"?,"output":"Mix"|"S1"?,"inputMap":"Stereo|Left|Right|Swap|Mono"?,"channels":"Mono|Stereo|5.1"?}. Reads the part, time, mode. Changes the document. */
1816
+ "mixer.setStrip": {
1817
+ channels?: "Mono" | "Stereo" | "5.1";
1818
+ inputMap?: "Stereo" | "Left" | "Right" | "Swap" | "Mono";
1819
+ mode?: "Off" | "Read" | "Latch" | "Touch" | "Write";
1820
+ muted?: boolean;
1821
+ name?: string; /** destination submix id, S1 ordinal or case-insensitive name; output also accepts Mix */
1822
+ output?: Json;
1823
+ pan?: number;
1824
+ recordArm?: boolean;
1825
+ solo?: boolean;
1826
+ soloSafe?: boolean; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1827
+ strip?: Json; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1828
+ track?: Json;
1829
+ volumeDb?: number;
1830
+ };
1831
+ /** Set Mixer Control. Sets a mixer control (`lane`) on `strip` to `value` once: writes a keyframe at `time` when the lane has automation, else the static value. Use mixer.touch for recorded gestures. Params: {"strip":"A1"|"S1"|"Mix"|id,"lane":"volume|pan|mute|send.<i>.level|fx.<slot>.<param>","value":f64,"time":ticks?}. Reads the part, time, mode. Changes the document. */
1832
+ "mixer.setValue": {
1833
+ lane?: "volume" | "pan" | "mute" | "send.<i>.level" | "fx.<slot>.<param>"; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1834
+ strip?: Json; /** ticks (254016000000 per second) */
1835
+ time?: number; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1836
+ track?: Json;
1837
+ value?: number;
1838
+ };
1839
+ /** Touch Mixer Control. Moves a mixer control during an automation pass: the audio follows at once and the value is recorded at `time` per the strip's automation mode. Params: {"strip":"A1"|"S1"|"Mix"|id,"lane":"volume|pan|mute|send.<i>.level|fx.<slot>.<param>","value":f64,"time":ticks?}. Reads the part, time, mode. */
1840
+ "mixer.touch": {
1841
+ lane?: "volume" | "pan" | "mute" | "send.<i>.level" | "fx.<slot>.<param>"; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1842
+ strip?: Json; /** ticks (254016000000 per second) */
1843
+ time?: number; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1844
+ track?: Json;
1845
+ value?: number;
1846
+ };
1847
+ /** Release Mixer Control. Lets go of a mixer control (`lane`, default volume) on `strip` at `time`; in Touch mode the value ramps back to the existing automation. Params: {"strip":"A1"|"S1"|"Mix"|id,"lane":str?,"time":ticks?}. Reads the part, time, mode. Changes the document. */
1848
+ "mixer.release": {
1849
+ lane?: string; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1850
+ strip?: Json; /** ticks (254016000000 per second) */
1851
+ time?: number; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1852
+ track?: Json;
1853
+ };
1854
+ /** Start Automation Pass. Starts an automation pass at `time` (default playhead); mixer.touch/release gestures are recorded per each strip's mode until mixer.recordStop. Params: {"time":ticks?}. Reads the part, time, mode. */
1855
+ "mixer.recordStart": {
1856
+ time?: number;
1857
+ };
1858
+ /** Write Automation. Ends the automation pass at `time`, thins every recorded gesture into keyframes and writes them as one undo step (Write strips may switch to Touch). Params: {"time":ticks?}. Reads the part, time, mode. Changes the document. */
1859
+ "mixer.recordStop": {
1860
+ time?: number;
1861
+ };
1862
+ /** Audio Clip Mixer Adjust. Sets a clip's audio effect parameter (default Volume ? Level) to `value` at `time` (default playhead); `keyframe: true` writes a keyframe, otherwise the static value. Consecutive calls on the same control are one undo step. Params: {"clip":id,"effect":"volume"|"panner","param":"level"|"balance","value":f64,"keyframe":bool?,"time":ticks?,"begin":bool?}. Acts on `clip`. Reads the part, time. Changes the document. */
1863
+ "clipMixer.set": {
1864
+ begin?: boolean; /** an id */
1865
+ clip?: number;
1866
+ effect?: "volume" | "panner";
1867
+ keyframe?: boolean;
1868
+ param?: "level" | "balance"; /** ticks (254016000000 per second) */
1869
+ time?: number;
1870
+ value?: number;
1871
+ };
1872
+ /** Audio Clip Mixer Automation Mode. Sets the Audio Clip Mixer automation mode of an audio `track`: Off, Read, Latch, Touch or Write. Not undoable; mixer state only. Params: {"track":"A1"|id,"mode":"Off|Read|Latch|Touch|Write"}. Reads the part. */
1873
+ "clipMixer.setMode": {
1874
+ mode?: "Off" | "Read" | "Latch" | "Touch" | "Write"; /** "A1"|id */
1875
+ track?: Json;
1876
+ };
1877
+ /** Touch Clip Mixer Control. Moves an Audio Clip Mixer control (`lane` volume or pan) on `track` to `value` at `time`, recording keyframes on the clip under it per the track's automation mode. Params: {"track":"A1"|id,"lane":"volume|pan","value":f64,"time":ticks?}. Reads the part, time, mode. */
1878
+ "clipMixer.touch": {
1879
+ lane?: "volume" | "pan"; /** ticks (254016000000 per second) */
1880
+ time?: number; /** "A1"|id */
1881
+ track?: Json;
1882
+ value?: number;
1883
+ };
1884
+ /** Release Clip Mixer Control. Lets go of an Audio Clip Mixer fader or pan control on `track` at `time` (default playhead), ending a Latch/Touch automation pass for that lane. Params: {"track":"A1"|id,"lane":"volume|pan","time":ticks?}. Reads the part, time, mode. Changes the document. */
1885
+ "clipMixer.release": {
1886
+ lane?: "volume" | "pan"; /** read by the command beside its listed parameters */
1887
+ param?: string; /** ticks (254016000000 per second) */
1888
+ time?: number; /** "A1"|id */
1889
+ track?: Json;
1890
+ };
1891
+ /** Set Selected as Default Transition. Sets the default video or audio transition used by sequence.applyVideoTransition/applyAudioTransition and default-transition commands. Params: {"effect":str (registered audio or video transition id or display name)}. Reads the mode. Changes the document. */
1892
+ "effects.setDefaultTransition": {
1893
+ effect?: string;
1894
+ };
1895
+ /** Delete Submix Track. Removes submix track `strip` (S1...); tracks and sends that fed it route to the Mix. Params: {"strip":"S1"|id}. Reads the part. Changes the document. */
1896
+ "mixer.deleteSubmix": {
1897
+ strip?: Json; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1898
+ track?: Json;
1899
+ };
1900
+ /** Add Track Effect. Adds a track effect `effect` to a mixer `strip` (A1..., S1..., Mix) at `slot` (default last), pre-fader unless `postFader`. Params: {"strip":"A1"|"S1"|"Mix"|id,"effect":str,"slot":n?,"postFader":bool?}. Reads the part. Changes the document. */
1901
+ "mixer.addInsert": {
1902
+ effect?: string;
1903
+ postFader?: boolean;
1904
+ slot?: number; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1905
+ strip?: Json; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1906
+ track?: Json;
1907
+ };
1908
+ /** Remove Track Effect. Removes the track effect at `slot` (0-based) from a mixer `strip`. Params: {"strip":"A1"|"S1"|"Mix"|id,"slot":n}. Reads the part. Changes the document. */
1909
+ "mixer.removeInsert": {
1910
+ slot?: number; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1911
+ strip?: Json; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1912
+ track?: Json;
1913
+ };
1914
+ /** Track Effect Settings. Changes the track effect at `slot` on a `strip`: `enabled`, pre/post fader, or effect `params` by id. Params: {"strip":"A1"|"S1"|"Mix"|id,"slot":n,"enabled":bool?,"postFader":bool?,"params":{id:value}?}. Reads the part. Changes the document. */
1915
+ "mixer.setInsert": {
1916
+ enabled?: boolean;
1917
+ params?: {
1918
+ id?: Json;
1919
+ };
1920
+ postFader?: boolean;
1921
+ slot?: number; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1922
+ strip?: Json; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1923
+ track?: Json;
1924
+ };
1925
+ /** Add Send. Adds a send from an audio track or submix `strip` to submix `target` at `levelDb`, post-fader unless `preFader`, with `pan`. The Mix has no sends. Params: {"strip":"A1"|"S1"|id,"target":"S1"|id,"levelDb":f64?,"preFader":bool?,"pan":f64?}. Reads the part. Changes the document. */
1926
+ "mixer.addSend": {
1927
+ levelDb?: number;
1928
+ pan?: number;
1929
+ preFader?: boolean; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1930
+ strip?: Json; /** destination submix id, S1 ordinal or case-insensitive name; output also accepts Mix */
1931
+ target?: Json; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1932
+ track?: Json;
1933
+ };
1934
+ /** Send Settings. Changes send `send` (0-based) on a `strip`: level dB, pan, pre/post fader, mute, or retarget to another submix. Params: {"strip":"A1"|"S1"|id,"send":n,"levelDb":f64?,"pan":f64?,"preFader":bool?,"muted":bool?,"target":"S1"?}. Reads the part. Changes the document. */
1935
+ "mixer.setSend": {
1936
+ levelDb?: number;
1937
+ muted?: boolean;
1938
+ pan?: number;
1939
+ preFader?: boolean;
1940
+ send?: number; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1941
+ strip?: Json; /** destination submix id, S1 ordinal or case-insensitive name; output also accepts Mix */
1942
+ target?: Json; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1943
+ track?: Json;
1944
+ };
1945
+ /** Remove Send. Removes send number `send` (0-based) from a mixer `strip`. Params: {"strip":"A1"|"S1"|id,"send":n}. Reads the part. Changes the document. */
1946
+ "mixer.removeSend": {
1947
+ send?: number; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1948
+ strip?: Json; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1949
+ track?: Json;
1950
+ };
1951
+ /** Add Track Keyframe. Adds or replaces an automation keyframe of `value` at `time` (default playhead) on a strip's `lane` (volume dB, pan -1...1, mute, send.i.level, fx.slot.param). Params: {"strip":"A1"|"S1"|"Mix"|id,"lane":str?,"time":ticks?,"value":f64}. Reads the part, time. Changes the document. */
1952
+ "mixer.setKeyframe": {
1953
+ lane?: string; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1954
+ strip?: Json; /** ticks (254016000000 per second) */
1955
+ time?: number; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1956
+ track?: Json;
1957
+ value?: number;
1958
+ };
1959
+ /** Delete Track Keyframe. Deletes the automation keyframe at `time` ticks on a strip's `lane` (default volume). Params: {"strip":"A1"|"S1"|"Mix"|id,"lane":str?,"time":ticks}. Reads the part, time. Changes the document. */
1960
+ "mixer.deleteKeyframe": {
1961
+ lane?: string; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1962
+ strip?: Json; /** ticks (254016000000 per second) */
1963
+ time?: number; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1964
+ track?: Json;
1965
+ };
1966
+ /** Move Track Keyframe. Moves the automation keyframe at `time` on a strip's `lane` to `newTime` and/or changes its `value`. Params: {"strip":"A1"|"S1"|"Mix"|id,"lane":str?,"time":ticks,"newTime":ticks?,"value":f64?}. Reads the part, time. Changes the document. */
1967
+ "mixer.moveKeyframe": {
1968
+ lane?: string; /** the new time, as a frame of the sequence (one spelling of it) */
1969
+ newFrame?: number; /** the new time, in seconds (one spelling of it) */
1970
+ newSeconds?: number; /** ticks (254016000000 per second) */
1971
+ newTime?: number; /** the new time, as a timecode (one spelling of it) */
1972
+ newTimecode?: string; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1973
+ strip?: Json; /** ticks (254016000000 per second) */
1974
+ time?: number; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1975
+ track?: Json;
1976
+ value?: number;
1977
+ };
1978
+ /** Clear Track Keyframes. Deletes every automation keyframe of `lane` (default volume) on a mixer `strip`. Params: {"strip":"A1"|"S1"|"Mix"|id,"lane":str?}. Reads the part, time. Changes the document. */
1979
+ "mixer.clearLane": {
1980
+ lane?: string; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1981
+ strip?: Json; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1982
+ track?: Json;
1983
+ };
1984
+ /** Write Automation Points. Writes a whole automation curve to a strip's `lane` from `points` [[ticks, value]...], thinned to keyframes within `tolerance`, replacing that span; one undo step. Params: {"strip":"A1"|"S1"|"Mix"|id,"lane":str?,"points":[[ticks,value]],"tolerance":f64?}. Reads the part. Changes the document. */
1985
+ "mixer.writeAutomation": {
1986
+ lane?: string; /** [[ticks,value]] */
1987
+ points?: Array<Array<Json>>; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1988
+ strip?: Json;
1989
+ tolerance?: number; /** mixer strip id, A1/S1 ordinal, Mix/master, or case-insensitive strip name */
1990
+ track?: Json;
1991
+ };
1992
+ /** Synchronize. Aligns the selected timeline clips to a `reference` clip by in, out, timecode, a named clip `marker` or audio waveform, plus `offset` frames. Params: {"method":"in|out|timecode|marker|audio","clips":[id]?,"reference":clip?,"track":"V1"|"A1"?,"ignoreHours":bool?,"marker":str?,"offset":frames?}. Acts on `clips`. Reads the part, selection, mode. Changes the document. */
1993
+ "clip.synchronize": {
1994
+ clips?: Array<number>;
1995
+ ignoreHours?: boolean;
1996
+ marker?: string;
1997
+ method?: "in" | "out" | "timecode" | "marker" | "audio"; /** frames */
1998
+ offset?: number; /** clip? */
1999
+ reference?: number;
2000
+ track?: "V1" | "A1";
2001
+ };
2002
+ /** Merge Clips. Merges one video item and audio items, aligned by in, out, timecode, marker or audio, into a new merged project item; `removeVideoAudio` drops the camera audio. Params: {"items":[id]?,"method":"in|out|timecode|marker|audio","name":str?,"removeVideoAudio":bool?,"ignoreHours":bool?,"marker":str?,"offset":frames?}. Acts on `items`. Reads the selection. Changes the document. */
2003
+ "clip.mergeClips": {
2004
+ ignoreHours?: boolean;
2005
+ items?: Array<number>;
2006
+ marker?: string;
2007
+ method?: "in" | "out" | "timecode" | "marker" | "audio";
2008
+ name?: string; /** frames */
2009
+ offset?: number;
2010
+ removeVideoAudio?: boolean;
2011
+ };
2012
+ /** Create Multi-Camera Source Sequence. Builds a multi-camera source sequence from synchronized project `items` (aligned by in, out, timecode, marker or audio), with `audio` mode and camera names from clip, track or metadata. Params: {"items":[id]?,"name":str?,"method":"in|out|timecode|marker|audio","ignoreHours":bool?,"marker":str?,"offset":frames?,"audio":"camera1|all|switch","cameraNames":"clip|track|metadata","processedBin":bool?,"reference":item?}. Acts on `items`. Reads the selection. Changes the document. */
2013
+ "clip.createMulticam": {
2014
+ audio?: "camera1" | "all" | "switch";
2015
+ cameraNames?: "clip" | "track" | "metadata";
2016
+ ignoreHours?: boolean;
2017
+ items?: Array<number>;
2018
+ marker?: string;
2019
+ method?: "in" | "out" | "timecode" | "marker" | "audio";
2020
+ name?: string; /** frames */
2021
+ offset?: number;
2022
+ processedBin?: boolean; /** item? */
2023
+ reference?: number;
2024
+ };
2025
+ /** Enable. Turns multi-camera behaviour of the selected nested clips on or off (`enabled`, toggles when omitted). Params: {"clips":[id]?,"enabled":bool?}. Acts on `clips`. Reads the part, selection, mode. Changes the document. */
2026
+ "clip.multicamEnable": {
2027
+ clips?: Array<number>;
2028
+ enabled?: boolean;
2029
+ };
2030
+ /** Flatten. Replaces the selected multi-camera clips with the clips their active angles show; the result no longer switches angles. Params: {"clips":[id]?}. Acts on `clips`. Reads the part, selection, mode. Changes the document. */
2031
+ "clip.multicamFlatten": {
2032
+ clips?: Array<number>;
2033
+ };
2034
+ /** Switch Multi-Camera Angle. Sets the active angle of the multi-camera clips at `time` (or `clips`) to `camera` (1?16, shown order) or `angle` (0-based) for their whole length; `videoOnly`/`audioOnly` limit it. No edit is added. Params: {"camera":1..16 (shown order)|"angle":0-based,"clips":[id]?,"time":ticks?,"videoOnly":bool?,"audioOnly":bool?}. Acts on `clips`. Reads the part, selection, time, mode, active. Changes the document. */
2035
+ "multicam.switchAngle": {
2036
+ angle?: number;
2037
+ audioOnly?: boolean; /** 1 to 16; shown order; one of several alternative parameters */
2038
+ camera?: number;
2039
+ clips?: Array<number>; /** ticks (254016000000 per second) */
2040
+ time?: number;
2041
+ videoOnly?: boolean;
2042
+ };
2043
+ /** Start Multi-Camera Recording. Starts a multi-camera recording pass at `time` (default playhead): cuts made with multicam.cut until multicam.recordStop become one undo step. Params: {"time":ticks?}. Reads the part, time. */
2044
+ "multicam.recordStart": {
2045
+ time?: number;
2046
+ };
2047
+ /** Cut to Camera. While multi-camera recording, cuts to `camera` (1?16, shown order) or `angle` (0-based) at `time` (default playhead); `videoOnly` leaves audio. Use multicam.switchAngle when not recording. Params: {"camera":1..16|"angle":0-based,"time":ticks?,"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2048
+ "multicam.cut": {
2049
+ angle?: number; /** 1 to 16; one of several alternative parameters */
2050
+ camera?: number; /** ticks (254016000000 per second) */
2051
+ time?: number;
2052
+ videoOnly?: boolean;
2053
+ };
2054
+ /** Stop Multi-Camera Recording. Ends the multi-camera recording pass at `time` and commits its cuts to the multi-camera clip as one undo step. Params: {"time":ticks?}. Reads the part, time, mode. Changes the document. */
2055
+ "multicam.recordStop": {
2056
+ time?: number;
2057
+ };
2058
+ /** Multi-Camera Audio Follows Video. Sets whether switching a multi-camera clip's video angle also switches its linked audio clips (`enabled`, toggles when omitted). Params: {"enabled":bool?}. Reads the mode. Changes the document. */
2059
+ "multicam.audioFollowsVideo": {
2060
+ enabled?: boolean;
2061
+ };
2062
+ /** Edit Cameras. Renames, shows or hides cameras (`cameras` by 0-based `angle`) of a multi-camera source `sequence`, and sets its `audio` mode: camera1, all or switch. Params: {"sequence":id?,"cameras":[{"angle":0-based,"name":str?,"enabled":bool?}]?,"audio":"camera1|all|switch"?}. Reads the part, time, mode, active. Changes the document. */
2063
+ "multicam.editCameras": {
2064
+ audio?: "camera1" | "all" | "switch"; /** [{"angle":0-based,"name":str?,"enabled":bool?}]? */
2065
+ cameras?: Array<{
2066
+ angle?: Json;
2067
+ enabled?: boolean;
2068
+ name?: string;
2069
+ }>; /** an id */
2070
+ sequence?: number;
2071
+ };
2072
+ /** Cut to Camera. Adds an edit at the playhead on the multi-camera clip (and its linked audio when audio follows video) and shows `camera` from there to the clip's end; `videoOnly` leaves the audio angle. Params: {"camera":1..16|"angle":0-based,"time":ticks?,"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2073
+ "multicam.cutToCamera": {
2074
+ angle?: number; /** 1 to 16; one of several alternative parameters */
2075
+ camera?: number; /** ticks (254016000000 per second) */
2076
+ time?: number;
2077
+ videoOnly?: boolean;
2078
+ };
2079
+ /** Multi-Camera Layout. Sets the multi-camera angle grid layout: auto, 2x2, 3x3 or 4x4 (paged when the angles don't fit). Params: {"layout":"auto|2x2|3x3|4x4"}. Reads the mode. Changes the document. */
2080
+ "multicam.gridLayout": {
2081
+ layout?: "auto" | "2x2" | "3x3" | "4x4";
2082
+ };
2083
+ /** Multi-Camera Page. Shows `page` (0-based, or next/prev) of the multi-camera angle grid. Params: {"page":0-based|"next"|"prev"}. Reads the part, time, mode, active. Changes the document. */
2084
+ "multicam.page": {
2085
+ page?: number;
2086
+ };
2087
+ /** Next Multi-Camera Page. Shows the next page of the multi-camera angle grid; number keys pick cameras on the shown page. Params: {}. Reads the part, time, mode, active. Changes the document. */
2088
+ "multicam.nextPage": Record<string, never>;
2089
+ /** Previous Multi-Camera Page. Shows the previous page of the multi-camera angle grid. Params: {}. Reads the part, time, mode, active. Changes the document. */
2090
+ "multicam.prevPage": Record<string, never>;
2091
+ /** Multi-Camera Selection Top Down. Sets whether stacked multi-camera clips switch the topmost clip instead of the lowest (`enabled`, toggles when omitted). Params: {"enabled":bool?}. Reads the mode. Changes the document. */
2092
+ "multicam.selectionTopDown": {
2093
+ enabled?: boolean;
2094
+ };
2095
+ /** Show Multi-Camera Preview Monitor. Sets whether the program shows next to the multi-camera grid (`enabled`); off, the grid fills the monitor. View setting only. Params: {"enabled":bool?}. Reads the mode. Changes the document. */
2096
+ "multicam.showPreviewMonitor": {
2097
+ enabled?: boolean;
2098
+ };
2099
+ /** Auto-Adjust Multi-Camera Playback Quality. Sets whether the multi-camera grid decodes at lower resolution while playing (`enabled`, toggles when omitted). View setting only. Params: {"enabled":bool?}. Reads the mode. Changes the document. */
2100
+ "multicam.autoAdjustQuality": {
2101
+ enabled?: boolean;
2102
+ };
2103
+ /** Transmit Multi-Camera View. Sets whether the multi-camera grid is sent to the transmit device; stored only, there is no transmit output yet. Params: {"enabled":bool?}. Reads the mode. Changes the document. */
2104
+ "multicam.transmitView": {
2105
+ enabled?: boolean;
2106
+ };
2107
+ /** Multi-Camera Grid. Reads the multi-camera grid page at the playhead (or `time`): layout, pages and cells with camera, angle, name and which is active; `cellPixels` picks a decode size. Params: {"time":ticks?,"playing":bool?,"cellPixels":f32?,"playbackScale":f32?}. Reads the part, time, active, mode. */
2108
+ "multicam.grid": {
2109
+ cellPixels?: number;
2110
+ playbackScale?: number;
2111
+ playing?: boolean; /** ticks (254016000000 per second) */
2112
+ time?: number;
2113
+ };
2114
+ /** Inspect Multi-Camera. Reads the multi-camera clip at the playhead (or `time`): its source, cameras with names and angles, the active angle and the recorder state. Params: {"time":ticks?}. Reads the part, time, active, mode. */
2115
+ "multicam.inspect": {
2116
+ time?: number;
2117
+ };
2118
+ /** Select Camera 1. While multi-camera recording, cuts to camera 1 at the playhead; when stopped, switches the multi-camera clip at the playhead to camera 1 without adding an edit. Params: {"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2119
+ "multicam.selectCamera1": {
2120
+ videoOnly?: boolean;
2121
+ };
2122
+ /** Cut to Camera 1. Adds an edit at the playhead on the multi-camera clip and shows camera 1 (on the shown grid page) from there to the clip's end; linked audio follows when audio follows video. Params: {"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2123
+ "multicam.cutToCamera1": {
2124
+ videoOnly?: boolean;
2125
+ };
2126
+ /** Select Camera 2. While multi-camera recording, cuts to camera 2 at the playhead; when stopped, switches the multi-camera clip at the playhead to camera 2 without adding an edit. Params: {"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2127
+ "multicam.selectCamera2": {
2128
+ videoOnly?: boolean;
2129
+ };
2130
+ /** Cut to Camera 2. Adds an edit at the playhead on the multi-camera clip and shows camera 2 (on the shown grid page) from there to the clip's end; linked audio follows when audio follows video. Params: {"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2131
+ "multicam.cutToCamera2": {
2132
+ videoOnly?: boolean;
2133
+ };
2134
+ /** Select Camera 3. While multi-camera recording, cuts to camera 3 at the playhead; when stopped, switches the multi-camera clip at the playhead to camera 3 without adding an edit. Params: {"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2135
+ "multicam.selectCamera3": {
2136
+ videoOnly?: boolean;
2137
+ };
2138
+ /** Cut to Camera 3. Adds an edit at the playhead on the multi-camera clip and shows camera 3 (on the shown grid page) from there to the clip's end; linked audio follows when audio follows video. Params: {"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2139
+ "multicam.cutToCamera3": {
2140
+ videoOnly?: boolean;
2141
+ };
2142
+ /** Select Camera 4. While multi-camera recording, cuts to camera 4 at the playhead; when stopped, switches the multi-camera clip at the playhead to camera 4 without adding an edit. Params: {"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2143
+ "multicam.selectCamera4": {
2144
+ videoOnly?: boolean;
2145
+ };
2146
+ /** Cut to Camera 4. Adds an edit at the playhead on the multi-camera clip and shows camera 4 (on the shown grid page) from there to the clip's end; linked audio follows when audio follows video. Params: {"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2147
+ "multicam.cutToCamera4": {
2148
+ videoOnly?: boolean;
2149
+ };
2150
+ /** Select Camera 5. While multi-camera recording, cuts to camera 5 at the playhead; when stopped, switches the multi-camera clip at the playhead to camera 5 without adding an edit. Params: {"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2151
+ "multicam.selectCamera5": {
2152
+ videoOnly?: boolean;
2153
+ };
2154
+ /** Cut to Camera 5. Adds an edit at the playhead on the multi-camera clip and shows camera 5 (on the shown grid page) from there to the clip's end; linked audio follows when audio follows video. Params: {"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2155
+ "multicam.cutToCamera5": {
2156
+ videoOnly?: boolean;
2157
+ };
2158
+ /** Select Camera 6. While multi-camera recording, cuts to camera 6 at the playhead; when stopped, switches the multi-camera clip at the playhead to camera 6 without adding an edit. Params: {"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2159
+ "multicam.selectCamera6": {
2160
+ videoOnly?: boolean;
2161
+ };
2162
+ /** Cut to Camera 6. Adds an edit at the playhead on the multi-camera clip and shows camera 6 (on the shown grid page) from there to the clip's end; linked audio follows when audio follows video. Params: {"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2163
+ "multicam.cutToCamera6": {
2164
+ videoOnly?: boolean;
2165
+ };
2166
+ /** Select Camera 7. While multi-camera recording, cuts to camera 7 at the playhead; when stopped, switches the multi-camera clip at the playhead to camera 7 without adding an edit. Params: {"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2167
+ "multicam.selectCamera7": {
2168
+ videoOnly?: boolean;
2169
+ };
2170
+ /** Cut to Camera 7. Adds an edit at the playhead on the multi-camera clip and shows camera 7 (on the shown grid page) from there to the clip's end; linked audio follows when audio follows video. Params: {"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2171
+ "multicam.cutToCamera7": {
2172
+ videoOnly?: boolean;
2173
+ };
2174
+ /** Select Camera 8. While multi-camera recording, cuts to camera 8 at the playhead; when stopped, switches the multi-camera clip at the playhead to camera 8 without adding an edit. Params: {"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2175
+ "multicam.selectCamera8": {
2176
+ videoOnly?: boolean;
2177
+ };
2178
+ /** Cut to Camera 8. Adds an edit at the playhead on the multi-camera clip and shows camera 8 (on the shown grid page) from there to the clip's end; linked audio follows when audio follows video. Params: {"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2179
+ "multicam.cutToCamera8": {
2180
+ videoOnly?: boolean;
2181
+ };
2182
+ /** Select Camera 9. While multi-camera recording, cuts to camera 9 at the playhead; when stopped, switches the multi-camera clip at the playhead to camera 9 without adding an edit. Params: {"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2183
+ "multicam.selectCamera9": {
2184
+ videoOnly?: boolean;
2185
+ };
2186
+ /** Cut to Camera 9. Adds an edit at the playhead on the multi-camera clip and shows camera 9 (on the shown grid page) from there to the clip's end; linked audio follows when audio follows video. Params: {"videoOnly":bool?}. Reads the part, selection, time, mode, active. Changes the document. */
2187
+ "multicam.cutToCamera9": {
2188
+ videoOnly?: boolean;
2189
+ };
2190
+ /** Inspect Audio Mixing. Reads the audio mixing settings of the selected or listed audio `clips`: type, repair, clarity, creative, ducking and loudness. Params: {"clips":[id]?}. Acts on `clips`. Reads the part, selection, time, mode. */
2191
+ "audioMixing.inspect": {
2192
+ clips?: Array<number>;
2193
+ };
2194
+ /** Set Audio Type. Sets the audio type of the selected or listed `clips`: dialogue, music, sfx or ambience, which decides the audio mixing controls. Params: {"clips":[id]?,"type":"dialogue|music|sfx|ambience"}. Acts on `clips`. Reads the part, selection, time, mode. Changes the document. */
2195
+ "audioMixing.setType": {
2196
+ clips?: Array<number>;
2197
+ type?: "dialogue" | "music" | "sfx" | "ambience";
2198
+ };
2199
+ /** Clear Audio Type. Clears the audio type of the selected or listed `clips`, removing their audio mixing effects. Params: {"clips":[id]?}. Acts on `clips`. Reads the part, selection, time, mode. Changes the document. */
2200
+ "audioMixing.clearType": {
2201
+ clips?: Array<number>;
2202
+ };
2203
+ /** Audio Mixing Setting. Sets an audio mixing control (`key` like repair.noise.amount, clarity.eqPreset, ducking.reduceDb, volume.levelDb) to `value`, or several `values`, on the selected or listed `clips`. Params: {"clips":[id]?,"key":"repair.noise.on|repair.noise.amount|repair.humHz|clarity.eqPreset|creative.reverbPreset|ducking.reduceDb|volume.levelDb|mute|...","value":any,"values":{key:value}?,"begin":bool?}. Acts on `clips`. Reads the part, selection, time, mode. Changes the document. */
2204
+ "audioMixing.set": {
2205
+ begin?: boolean;
2206
+ clips?: Array<number>; /** for example repair.noise.on, repair.noise.amount, repair.humHz, clarity.eqPreset, creative.reverbPreset, ducking.reduceDb, volume.levelDb, mute */
2207
+ key?: string;
2208
+ value?: Json;
2209
+ values?: {
2210
+ key?: Json;
2211
+ };
2212
+ };
2213
+ /** Apply Sound Preset. Applies audio mixing `preset` to the selected or listed `clips` (for audio `type`). Params: {"clips":[id]?,"preset":str,"type":"dialogue|music|sfx|ambience"?}. Acts on `clips`. Reads the part, selection, time, mode. Changes the document. */
2214
+ "audioMixing.applyPreset": {
2215
+ clips?: Array<number>;
2216
+ preset?: string;
2217
+ type?: "dialogue" | "music" | "sfx" | "ambience";
2218
+ };
2219
+ /** Save Sound Preset. Saves the audio mixing settings of the first selected or listed clip as preset `name`. Params: {"clips":[id]?,"name":str}. Acts on `clips`. Reads the part, selection, time, mode. Changes the document. */
2220
+ "audioMixing.savePreset": {
2221
+ clips?: Array<number>;
2222
+ name?: string;
2223
+ };
2224
+ /** Delete Sound Preset. Deletes saved audio mixing preset `name`. Params: {"name":str,"type":"dialogue|music|sfx|ambience"?}. Reads the mode. Changes the document. */
2225
+ "audioMixing.deletePreset": {
2226
+ name?: string;
2227
+ type?: "dialogue" | "music" | "sfx" | "ambience";
2228
+ };
2229
+ /** Auto-Match Loudness. Sets the clip gain of the selected or listed dialogue `clips` so each measures `target` LUFS (default -23). Params: {"clips":[id]?,"target":lufs?}. Acts on `clips`. Reads the part, selection, time, mode. Changes the document. */
2230
+ "audioMixing.autoMatch": {
2231
+ clips?: Array<number>; /** lufs? */
2232
+ target?: Json;
2233
+ };
2234
+ /** Generate Ducking Keyframes. Writes volume keyframes on the selected music `clips` that duck them under dialogue clips, per their ducking settings. Params: {"clips":[id]?}. Acts on `clips`. Reads the part, selection, mode. Changes the document. */
2235
+ "audioMixing.generateDucking": {
2236
+ clips?: Array<number>;
2237
+ };
2238
+ /** List Colour Spaces. Lists the color space ids that clip.interpretFootage and sequence color settings accept. Params: {}. */
2239
+ "color.spaces": Record<string, never>;
2240
+ /** List Color Presets. Lists color presets (and `.cube` looks) in `folder`. Params: {"folder":str?}. */
2241
+ "color.presets": {
2242
+ folder?: string;
2243
+ };
2244
+ /** Apply Color Preset. Applies color preset `name` to the selected or listed `clips` as a Color effect. Params: {"name":str,"clips":[id]?}. Acts on `clips`. Reads the part, selection. Changes the document. */
2245
+ "color.applyPreset": {
2246
+ clips?: Array<number>;
2247
+ name?: string;
2248
+ };
2249
+ /** Color Preset Thumbnails. Renders thumbnails of color presets (`folder` or `names`) applied to the program frame at the playhead, `width` px wide in `columns`, written as a PNG to `path`; with no sequence open, to a sample picture. Answers `source` (program or sample) and the grid's size. Params: {"folder":str?,"names":[str]?,"width":n=160,"columns":n=4,"path":str?}. Reads the part, time. */
2250
+ "color.presetThumbnails": {
2251
+ columns?: number;
2252
+ folder?: string;
2253
+ names?: Array<string>;
2254
+ path?: Json;
2255
+ width?: number;
2256
+ };
2257
+ /** Media Colour Info. Reads a media `item`'s detected color: primaries, transfer, matrix, range, bit depth and the color space used. Params: {"item":id}. Acts on `item`. */
2258
+ "media.colorInfo": {
2259
+ item?: number;
2260
+ };
2261
+ /** Import LUT. Installs the LUT file at `path` (cube, 3dl...) into the LUT library as `name`. Params: {"path":str,"name":str?}. Changes the document. */
2262
+ "lut.import": {
2263
+ name?: string;
2264
+ path?: Json;
2265
+ };
2266
+ /** List LUTs. Lists the LUTs installed for the Color effect's Input LUT and Creative Look. Params: {}. */
2267
+ "lut.list": Record<string, never>;
2268
+ /** Remove LUT. Uninstalls LUT `id` from the LUT library; clips that use it keep a copy. Params: {"id":str}. Changes the document. */
2269
+ "lut.remove": {
2270
+ id?: string;
2271
+ };
2272
+ /** Export LUT. Writes installed `lut` to a file at `path` in `format` cube or 3dl. Params: {"lut":"lib:<id>"|"builtin:<id>","path":str,"format":"cube"|"3dl"?}. */
2273
+ "lut.export": {
2274
+ format?: "cube" | "3dl";
2275
+ lut?: "lib:<id>" | "builtin:<id>";
2276
+ path?: Json;
2277
+ };
2278
+ /** Set Input LUT. Sets the Input LUT of `clip`'s Color effect to an installed `lut` (lib:/builtin: id) or a .cube file at `path`; "" clears it. Params: {"clip":id?,"lut":"lib:<id>"|"builtin:<id>"|""?,"path":str?}. Acts on `clip`. Reads the part, selection. Changes the document. */
2279
+ "color.setInputLut": {
2280
+ clip?: number;
2281
+ lut?: "lib:<id>" | "builtin:<id>" | "";
2282
+ path?: Json;
2283
+ };
2284
+ /** Set Creative Look. Sets the Creative Look of `clip`'s Color effect to an installed `lut` (lib:/builtin: id) or a file at `path`; "" clears it. Params: {"clip":id?,"lut":"lib:<id>"|"builtin:<id>"|""?,"path":str?}. Acts on `clip`. Reads the part, selection. Changes the document. */
2285
+ "color.setLook": {
2286
+ clip?: number;
2287
+ lut?: "lib:<id>" | "builtin:<id>" | "";
2288
+ path?: Json;
2289
+ };
2290
+ /** Apply Match. Color-matches `clip` (default selected) to the reference frame at `referenceTime`/frame/timecode in the sequence, writing Color effect corrections; `faceDetection` weights skin tones. Params: {"clip":id?,"referenceTime":ticks?|"referenceFrame":n?|"referenceTimecode":str?,"faceDetection":bool=true}. Acts on `clip`. Reads the part, selection, time. Changes the document. */
2291
+ "color.applyMatch": {
2292
+ clip?: number;
2293
+ faceDetection?: boolean; /** one of several alternative parameters */
2294
+ referenceFrame?: number; /** the reference time, in seconds (one spelling of it) */
2295
+ referenceSeconds?: number; /** ticks (254016000000 per second); one of several alternative parameters */
2296
+ referenceTime?: number; /** one of several alternative parameters */
2297
+ referenceTimecode?: string;
2298
+ };
2299
+ /** Toggle Color Section. Turns a Color effect `section` (basic, creative, curves, wheels, hsl, vignette) of `clip` on or off. Params: {"clip":id?,"section":"basic"|"creative"|"curves"|"wheels"|"hsl"|"vignette","on":bool?}. Acts on `clip`. Reads the part, selection. Changes the document. */
2300
+ "color.setSection": {
2301
+ clip?: number;
2302
+ on?: boolean;
2303
+ section?: "basic" | "creative" | "curves" | "wheels" | "hsl" | "vignette";
2304
+ };
2305
+ /** Text. Adds a text layer with `text`, `size` px, font and `position` (point text) or `box` [w,h] (paragraph text) to graphic `clip`, or a new graphic clip `seconds` long at the playhead (`newClip`). Answers the clip and layer. Params: {"text":str="New Text","position":[x,y]? (point text: its alignment point on the first baseline; with `box`: the box's top-left corner),"box":[w,h]? (paragraph text wrapped in a box this size),"clip":id?,"newClip":bool?,"vertical":bool=false,"size":px=100,"font":str?,"fontStyle":str?,"seconds":f64=5,"track":index?,"time":ticks?,"frame":i64?,"timecode":str?}. Acts on `clip`. Reads the part, time, mode. Changes the document. */
2306
+ "graphics.newText": {
2307
+ box?: Array<number>; /** an id */
2308
+ clip?: number;
2309
+ font?: string;
2310
+ fontStyle?: string;
2311
+ frame?: number;
2312
+ newClip?: boolean; /** point text: its alignment point on the first baseline; with `box`: the box's top-left corner */
2313
+ position?: Array<number>;
2314
+ seconds?: number; /** pixels */
2315
+ size?: number;
2316
+ text?: string; /** ticks (254016000000 per second) */
2317
+ time?: number;
2318
+ timecode?: string; /** a position counted from 0 (the first is 0) */
2319
+ track?: number;
2320
+ vertical?: boolean;
2321
+ };
2322
+ /** Shape. Adds a shape layer (`shape` rectangle|ellipse|polygon|path with `points`) to graphic `clip`, or a new graphic clip `seconds` long at the playhead. `position` and the path's `points` are frame pixels; a path without `position` sits at the centre of its points. Params: {"shape":"rectangle|ellipse|polygon|path","position":[x,y]?,"size":[w,h]=[400,200],"points":[[x,y],...]?,"clip":id?,"seconds":f64=5,"track":index?,"time":ticks?,"frame":i64?,"timecode":str?}. Acts on `clip`. Reads the part, time. Changes the document. */
2323
+ "graphics.newShape": {
2324
+ clip?: number;
2325
+ frame?: number;
2326
+ points?: Array<Array<number>>;
2327
+ position?: Array<number>;
2328
+ seconds?: number;
2329
+ shape?: "rectangle" | "ellipse" | "polygon" | "path"; /** default [400,200] */
2330
+ size?: Array<number>; /** ticks (254016000000 per second) */
2331
+ time?: number;
2332
+ timecode?: string; /** a position counted from 0 (the first is 0) */
2333
+ track?: number;
2334
+ };
2335
+ /** Edit Text. Replaces the text of graphic text `layer` (index or name; default selected) in `clip`; `merge` joins it with the previous Edit Text undo step. Params: {"clip":id?,"layer":n|name?,"text":str,"merge":bool? (coalesce with the previous Edit Text undo step)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2336
+ "graphics.setText": {
2337
+ clip?: number; /** n|name? */
2338
+ layer?: Json; /** coalesce with the previous Edit Text undo step */
2339
+ merge?: boolean;
2340
+ text?: string;
2341
+ };
2342
+ /** Set Graphic Properties. Sets properties of graphic `layer` (default selected) in `clip`: `props` like font, size, align, tracking, leading, fill_color, stroke, background, shadow, position, scale, rotation, opacity; keyframed at `time` when animated. Params: {"clip":id?,"layer":n|name?,"props":{"font":"Inter","font_style":"Bold","size":120,"align":"center","tracking":50,"leading":0,"fill_color":"#ffcc00","stroke":true,"stroke_width":6,"background":true,"shadow":true,"position":[x,y],"scale":100,"rotation":0,"opacity":100,...},"time":ticks?}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2343
+ "graphics.set": {
2344
+ clip?: number; /** n|name? */
2345
+ layer?: Json;
2346
+ props?: {
2347
+ align?: string;
2348
+ background?: boolean;
2349
+ fill_color?: string;
2350
+ font?: string;
2351
+ font_style?: string;
2352
+ leading?: number;
2353
+ opacity?: number;
2354
+ position?: Array<number>;
2355
+ rotation?: number;
2356
+ scale?: number;
2357
+ shadow?: boolean;
2358
+ size?: number;
2359
+ stroke?: boolean;
2360
+ stroke_width?: number;
2361
+ tracking?: number;
2362
+ }; /** ticks (254016000000 per second) */
2363
+ time?: number;
2364
+ };
2365
+ /** Text Layer Type. Converts a text layer to `point` text (scales with handles) or `paragraph` text (wraps in a resizable box). Params: {"clip":id?,"layer":n|name?,"type":"point|paragraph" (point: no box, handles scale the text; paragraph: the text wraps in a box that handles resize)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2366
+ "graphics.setTextType": {
2367
+ clip?: number; /** n|name? */
2368
+ layer?: Json; /** point: no box, handles scale the text; paragraph: the text wraps in a box that handles resize */
2369
+ type?: "point" | "paragraph";
2370
+ };
2371
+ /** Select Graphic Layer. Selects graphic `layers` by index in graphic `clip`; `keepSelection` leaves the clip selection as it is. Params: {"clip":id?,"layers":[n],"keepSelection":bool? (leave the selected clips as they are, as upstream's empty Program-monitor click)}. Acts on `clip`. Reads the part, selection, time. Changes the document. */
2372
+ "graphics.selectLayer": {
2373
+ clip?: number; /** leave the selected clips as they are, as upstream's empty Program-monitor click */
2374
+ keepSelection?: boolean;
2375
+ layers?: Array<number>;
2376
+ };
2377
+ /** Delete Graphic Layer. Deletes graphic `layer` (default the selected or frontmost) from graphic `clip`; the clip stays. Params: {"clip":id?,"layer":n?}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2378
+ "graphics.deleteLayer": {
2379
+ clip?: number;
2380
+ layer?: number;
2381
+ };
2382
+ /** Arrange Graphic Layer. Moves a graphic `layer` (default selected) in paint order: front, back, forward, backward, or to an index (0 = bottom). Params: {"clip":id?,"layer":n?,"to":"front|back|forward|backward"|index}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2383
+ "graphics.arrangeLayer": {
2384
+ clip?: number;
2385
+ layer?: number; /** "front|back|forward|backward"|index */
2386
+ to?: Json;
2387
+ };
2388
+ /** Align Layers. Aligns graphic `layers` (default selected) of a graphic clip `left|hcenter|right|top|vcenter|bottom`, relative to the `frame`, their union (`group`) or the selection. Params: {"clip":id?,"layers":[n]?,"align":"left|hcenter|right|top|vcenter|bottom","to":"frame|group|selection"="frame" (frame: each layer; group: the layers' union; one layer always aligns to the frame)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2389
+ "graphics.align": {
2390
+ align?: "left" | "hcenter" | "right" | "top" | "vcenter" | "bottom"; /** an id */
2391
+ clip?: number; /** read by the command beside its listed parameters */
2392
+ layer?: Json;
2393
+ layers?: Array<number>; /** frame: each layer; group: the layers' union; one layer always aligns to the frame */
2394
+ to?: "frame" | "group" | "selection";
2395
+ };
2396
+ /** Distribute Layers. Spaces 3 or more graphic `layers` evenly along `axis` horizontal|vertical: equal centre spacing, or equal gaps with `space: true`. Params: {"clip":id?,"layers":[n] (3 or more)?,"axis":"horizontal|vertical","space":bool=false (equal gaps instead of equal centre spacing)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2397
+ "graphics.distribute": {
2398
+ axis?: "horizontal" | "vertical"; /** an id */
2399
+ clip?: number; /** read by the command beside its listed parameters */
2400
+ layer?: Json; /** 3 or more */
2401
+ layers?: Array<number>; /** equal gaps instead of equal centre spacing */
2402
+ space?: boolean;
2403
+ };
2404
+ /** List Graphic Layers. Lists the layers of graphic `clip` (default targeted) in paint order with index, kind, name, text and properties. Read before editing a graphic. Params: {"clip":id?}. Acts on `clip`. Reads the part, selection, time. */
2405
+ "graphics.list": {
2406
+ clip?: number;
2407
+ };
2408
+ /** List Fonts. Lists the available font families and styles (bundled plus system fonts when `system`). Params: {"system":bool=true (scan the system font folders)}. */
2409
+ "fonts.list": {
2410
+ system?: boolean;
2411
+ };
2412
+ /** Vertical Text. Adds a vertical text layer (top-to-bottom) with `text` and `size` to graphic `clip`, or a new graphic clip at the playhead. Params: {"text":str="New Text","position":[x,y]?,"box":[w,h]?,"clip":id?,"newClip":bool?,"size":px=100,"font":str?,"fontStyle":str?,"seconds":f64=5,"track":index?,"time":ticks?,"frame":i64?,"timecode":str?}. Acts on `clip`. Reads the part, time, mode. Changes the document. */
2413
+ "graphics.newVerticalText": {
2414
+ box?: Array<number>; /** an id */
2415
+ clip?: number;
2416
+ font?: string;
2417
+ fontStyle?: string;
2418
+ frame?: number;
2419
+ newClip?: boolean;
2420
+ position?: Array<number>;
2421
+ seconds?: number; /** pixels */
2422
+ size?: number;
2423
+ text?: string; /** ticks (254016000000 per second) */
2424
+ time?: number;
2425
+ timecode?: string; /** a position counted from 0 (the first is 0) */
2426
+ track?: number;
2427
+ };
2428
+ /** Rectangle. Adds a rectangle shape layer `size` [w,h] (default 400?200) at `position` to graphic `clip`, or a new graphic clip at the playhead. Params: {"position":[x,y]?,"size":[w,h]=[400,200],"clip":id?,"seconds":f64=5,"track":index?,"time":ticks?,"frame":i64?,"timecode":str?}. Acts on `clip`. Reads the part, time. Changes the document. */
2429
+ "graphics.newRectangle": {
2430
+ clip?: number;
2431
+ frame?: number;
2432
+ position?: Array<number>;
2433
+ seconds?: number; /** default [400,200] */
2434
+ size?: Array<number>; /** ticks (254016000000 per second) */
2435
+ time?: number;
2436
+ timecode?: string; /** a position counted from 0 (the first is 0) */
2437
+ track?: number;
2438
+ };
2439
+ /** Ellipse. Adds an ellipse shape layer `size` [w,h] (default 400?200) at `position` to graphic `clip`, or a new graphic clip at the playhead. Params: {"position":[x,y]?,"size":[w,h]=[400,200],"clip":id?,"seconds":f64=5,"track":index?,"time":ticks?,"frame":i64?,"timecode":str?}. Acts on `clip`. Reads the part, time. Changes the document. */
2440
+ "graphics.newEllipse": {
2441
+ clip?: number;
2442
+ frame?: number;
2443
+ position?: Array<number>;
2444
+ seconds?: number; /** default [400,200] */
2445
+ size?: Array<number>; /** ticks (254016000000 per second) */
2446
+ time?: number;
2447
+ timecode?: string; /** a position counted from 0 (the first is 0) */
2448
+ track?: number;
2449
+ };
2450
+ /** Polygon. Adds a polygon shape layer with `sides` (default 6), `size` and `position` to graphic `clip`, or a new graphic clip at the playhead. Params: {"position":[x,y]?,"size":[w,h]=[300,300],"sides":n=6,"clip":id?,"seconds":f64=5,"track":index?,"time":ticks?,"frame":i64?,"timecode":str?}. Acts on `clip`. Reads the part, time, active. Changes the document. */
2451
+ "graphics.newPolygon": {
2452
+ clip?: number;
2453
+ frame?: number;
2454
+ position?: Array<number>;
2455
+ seconds?: number;
2456
+ sides?: number; /** default [300,300] */
2457
+ size?: Array<number>; /** ticks (254016000000 per second) */
2458
+ time?: number;
2459
+ timecode?: string; /** a position counted from 0 (the first is 0) */
2460
+ track?: number;
2461
+ };
2462
+ /** From file. Imports the image or video at `path` and places it as a clip above the clips at the playhead or `time` (on `track`). Params: {"path":str,"time":ticks?,"frame":i64?,"timecode":str?,"track":index?} (imports the image or video and places it above the clips at the playhead). Reads the part, time. Changes the document. */
2463
+ "graphics.newFromFile": {
2464
+ frame?: number;
2465
+ path?: Json; /** the time, in seconds (one spelling of it) */
2466
+ seconds?: number; /** ticks (254016000000 per second) */
2467
+ time?: number;
2468
+ timecode?: string; /** a position counted from 0 (the first is 0) */
2469
+ track?: number;
2470
+ };
2471
+ /** Left. Aligns the left edges of the selected graphic layers to the frame. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2472
+ "graphics.alignFrame.left": {
2473
+ clip?: number; /** default: the selected layers */
2474
+ layers?: Array<number>;
2475
+ };
2476
+ /** Center Horizontally. Aligns the horizontal centres of the selected graphic layers to the frame. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2477
+ "graphics.alignFrame.hcenter": {
2478
+ clip?: number; /** default: the selected layers */
2479
+ layers?: Array<number>;
2480
+ };
2481
+ /** Right. Aligns the right edges of the selected graphic layers to the frame. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2482
+ "graphics.alignFrame.right": {
2483
+ clip?: number; /** default: the selected layers */
2484
+ layers?: Array<number>;
2485
+ };
2486
+ /** Top. Aligns the top edges of the selected graphic layers to the frame. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2487
+ "graphics.alignFrame.top": {
2488
+ clip?: number; /** default: the selected layers */
2489
+ layers?: Array<number>;
2490
+ };
2491
+ /** Center Vertically. Aligns the vertical centres of the selected graphic layers to the frame. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2492
+ "graphics.alignFrame.vcenter": {
2493
+ clip?: number; /** default: the selected layers */
2494
+ layers?: Array<number>;
2495
+ };
2496
+ /** Bottom. Aligns the bottom edges of the selected graphic layers to the frame. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2497
+ "graphics.alignFrame.bottom": {
2498
+ clip?: number; /** default: the selected layers */
2499
+ layers?: Array<number>;
2500
+ };
2501
+ /** Left. Aligns the left edges of the selected graphic layers to their combined bounds. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2502
+ "graphics.alignGroup.left": {
2503
+ clip?: number; /** default: the selected layers */
2504
+ layers?: Array<number>;
2505
+ };
2506
+ /** Center Horizontally. Aligns the horizontal centres of the selected graphic layers to their combined bounds. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2507
+ "graphics.alignGroup.hcenter": {
2508
+ clip?: number; /** default: the selected layers */
2509
+ layers?: Array<number>;
2510
+ };
2511
+ /** Right. Aligns the right edges of the selected graphic layers to their combined bounds. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2512
+ "graphics.alignGroup.right": {
2513
+ clip?: number; /** default: the selected layers */
2514
+ layers?: Array<number>;
2515
+ };
2516
+ /** Top. Aligns the top edges of the selected graphic layers to their combined bounds. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2517
+ "graphics.alignGroup.top": {
2518
+ clip?: number; /** default: the selected layers */
2519
+ layers?: Array<number>;
2520
+ };
2521
+ /** Center Vertically. Aligns the vertical centres of the selected graphic layers to their combined bounds. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2522
+ "graphics.alignGroup.vcenter": {
2523
+ clip?: number; /** default: the selected layers */
2524
+ layers?: Array<number>;
2525
+ };
2526
+ /** Bottom. Aligns the bottom edges of the selected graphic layers to their combined bounds. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2527
+ "graphics.alignGroup.bottom": {
2528
+ clip?: number; /** default: the selected layers */
2529
+ layers?: Array<number>;
2530
+ };
2531
+ /** Left. Aligns the left edges of the selected graphic layers to the selection's bounds. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2532
+ "graphics.alignSelection.left": {
2533
+ clip?: number; /** default: the selected layers */
2534
+ layers?: Array<number>;
2535
+ };
2536
+ /** Center Horizontally. Aligns the horizontal centres of the selected graphic layers to the selection's bounds. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2537
+ "graphics.alignSelection.hcenter": {
2538
+ clip?: number; /** default: the selected layers */
2539
+ layers?: Array<number>;
2540
+ };
2541
+ /** Right. Aligns the right edges of the selected graphic layers to the selection's bounds. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2542
+ "graphics.alignSelection.right": {
2543
+ clip?: number; /** default: the selected layers */
2544
+ layers?: Array<number>;
2545
+ };
2546
+ /** Top. Aligns the top edges of the selected graphic layers to the selection's bounds. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2547
+ "graphics.alignSelection.top": {
2548
+ clip?: number; /** default: the selected layers */
2549
+ layers?: Array<number>;
2550
+ };
2551
+ /** Center Vertically. Aligns the vertical centres of the selected graphic layers to the selection's bounds. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2552
+ "graphics.alignSelection.vcenter": {
2553
+ clip?: number; /** default: the selected layers */
2554
+ layers?: Array<number>;
2555
+ };
2556
+ /** Bottom. Aligns the bottom edges of the selected graphic layers to the selection's bounds. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2557
+ "graphics.alignSelection.bottom": {
2558
+ clip?: number; /** default: the selected layers */
2559
+ layers?: Array<number>;
2560
+ };
2561
+ /** Distribute Vertically. Spaces the selected graphic layers (3 or more) with equal vertical centre spacing. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2562
+ "graphics.distributeVertically": {
2563
+ clip?: number; /** read by the command beside its listed parameters */
2564
+ layer?: Json; /** default: the selected layers */
2565
+ layers?: Array<number>;
2566
+ };
2567
+ /** Distribute Space Vertically. Spaces the selected graphic layers (3 or more) with equal vertical gaps between them. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2568
+ "graphics.distributeSpaceVertically": {
2569
+ clip?: number; /** read by the command beside its listed parameters */
2570
+ layer?: Json; /** default: the selected layers */
2571
+ layers?: Array<number>;
2572
+ };
2573
+ /** Distribute Horizontally. Spaces the selected graphic layers (3 or more) with equal horizontal centre spacing. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2574
+ "graphics.distributeHorizontally": {
2575
+ clip?: number; /** read by the command beside its listed parameters */
2576
+ layer?: Json; /** default: the selected layers */
2577
+ layers?: Array<number>;
2578
+ };
2579
+ /** Distribute Space Horizontally. Spaces the selected graphic layers (3 or more) with equal horizontal gaps between them. Params: {"clip":id?,"layers":[n]? (default: the selected layers)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2580
+ "graphics.distributeSpaceHorizontally": {
2581
+ clip?: number; /** read by the command beside its listed parameters */
2582
+ layer?: Json; /** default: the selected layers */
2583
+ layers?: Array<number>;
2584
+ };
2585
+ /** Bring to Front. Moves the selected graphic layer to the top of the paint order. Params: {"clip":id?,"layer":n?}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2586
+ "graphics.bringToFront": {
2587
+ clip?: number;
2588
+ layer?: number;
2589
+ };
2590
+ /** Bring Forward. Moves the selected graphic layer one step up in paint order. Params: {"clip":id?,"layer":n?}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2591
+ "graphics.bringForward": {
2592
+ clip?: number;
2593
+ layer?: number;
2594
+ };
2595
+ /** Send Backward. Moves the selected graphic layer one step down in paint order. Params: {"clip":id?,"layer":n?}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2596
+ "graphics.sendBackward": {
2597
+ clip?: number;
2598
+ layer?: number;
2599
+ };
2600
+ /** Send to Back. Moves the selected graphic layer to the bottom of the paint order. Params: {"clip":id?,"layer":n?}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2601
+ "graphics.sendToBack": {
2602
+ clip?: number;
2603
+ layer?: number;
2604
+ };
2605
+ /** Select Next Graphic. Selects the next graphic clip in the sequence after the current one. Params: {}. Reads the part, selection, time, mode, active. Changes the document. */
2606
+ "graphics.selectNextGraphic": Record<string, never>;
2607
+ /** Select Previous Graphic. Selects the previous graphic clip in the sequence. Params: {}. Reads the part, selection, time, mode, active. Changes the document. */
2608
+ "graphics.selectPreviousGraphic": Record<string, never>;
2609
+ /** Select Next Layer. Selects the next layer of the targeted graphic clip, cycling. Params: {}. Reads the part, selection, time, active. Changes the document. */
2610
+ "graphics.selectNextLayer": Record<string, never>;
2611
+ /** Select Previous Layer. Selects the previous layer of the targeted graphic clip, cycling. Params: {}. Reads the part, selection, time, active. Changes the document. */
2612
+ "graphics.selectPreviousLayer": Record<string, never>;
2613
+ /** Reset All Parameters. Resets every property of the graphic `layers` (default selected, else all) to defaults. Params: {"clip":id?,"layers":[n]? (default: the selected layers, else all)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2614
+ "graphics.resetAllParameters": {
2615
+ clip?: number; /** default: the selected layers, else all */
2616
+ layers?: Array<number>;
2617
+ };
2618
+ /** Reset Duration. Sets graphic `clip`'s length back to `seconds` (default 5), limited by the next clip on the track. Params: {"clip":id?,"seconds":f64=5 (the default graphic duration; limited by the next clip on the track)}. Acts on `clip`. Reads the part, selection, time. Changes the document. */
2619
+ "graphics.resetDuration": {
2620
+ clip?: number; /** the default graphic duration; limited by the next clip on the track */
2621
+ seconds?: number;
2622
+ };
2623
+ /** List Graphics Templates. Lists built-in and user graphics templates, filtered by `query`, `category` or `source`. Params: {"query":str? (search names, categories, descriptions, tags),"category":str?,"source":"builtin|user"?}. */
2624
+ "graphics.template.list": {
2625
+ category?: string; /** search names, categories, descriptions, tags */
2626
+ query?: string;
2627
+ source?: "builtin" | "user";
2628
+ };
2629
+ /** Apply Graphics Template. Places a graphics template (`template` id, name or path) as a new graphic clip at the playhead or `time` on `track`, setting `values` of its controls. Params: {"template":id|name|path,"values":{control id or name: value}?,"time":ticks?,"frame":i64?,"timecode":str?,"track":index?}. Reads the part, time. Changes the document. */
2630
+ "graphics.template.apply": {
2631
+ frame?: number; /** the time, in seconds (one spelling of it) */
2632
+ seconds?: number; /** id|name|path */
2633
+ template?: string; /** ticks (254016000000 per second) */
2634
+ time?: number;
2635
+ timecode?: string; /** a position counted from 0 (the first is 0) */
2636
+ track?: number;
2637
+ values?: {
2638
+ [key: string]: Json;
2639
+ };
2640
+ };
2641
+ /** Export As Motion Graphics Template. Writes graphic `clip` as a reusable template named `name` exposing the listed `controls` (layer parameters) as editable fields. Params: {"clip":id?,"name":str,"category":str="My Templates","description":str?,"controls":[{"layer":n|name,"param":"text|fill_color|size|font|position|enabled|...","name":str?,"kind":"text|color|slider|checkbox|font|position"?,"min":f64?,"max":f64?,"id":str?}]? (default: each text layer's text),"path":str? (default: the user templates folder),"embedFonts":bool=false,"fontLicense":str?,"author":str?,"license":str?,"tags":[str]?}. Acts on `clip`. Reads the part, selection, time. Changes the document. */
2642
+ "graphics.template.export": {
2643
+ author?: string;
2644
+ category?: string; /** an id */
2645
+ clip?: number; /** [{"layer":n|name,"param":"text|fill_color|size|font|position|enabled|...","name":str?,"kind":"text|color|slider|checkbox|font|position"?,"min":f64?,"max":f64?,"id":str?}]? (default: each text layer's text); default: each text layer's text */
2646
+ controls?: Array<{
2647
+ id?: string;
2648
+ kind?: "text" | "color" | "slider" | "checkbox" | "font" | "position";
2649
+ layer?: Json;
2650
+ max?: number;
2651
+ min?: number;
2652
+ name?: string;
2653
+ param?: string;
2654
+ }>;
2655
+ description?: string;
2656
+ embedFonts?: boolean;
2657
+ fontLicense?: string;
2658
+ license?: string;
2659
+ name?: string; /** default: the user templates folder */
2660
+ path?: Json;
2661
+ tags?: Array<string>;
2662
+ };
2663
+ /** Motion Graphics Template. Writes graphic `clip` as a Motion Graphics Template named `name` in `category`, exposing the listed `controls` (layer parameters) as editable fields. Params: {"clip":id?,"name":str,"category":str="My Templates","description":str?,"controls":[{"layer":n|name,"param":"text|fill_color|size|font|position|enabled|...","name":str?,"kind":"text|color|slider|checkbox|font|position"?,"min":f64?,"max":f64?,"id":str?}]? (default: each text layer's text),"path":str? (default: the user templates folder),"embedFonts":bool=false,"fontLicense":str?,"author":str?,"license":str?,"tags":[str]?}. Acts on `clip`. Reads the part, selection, time. Changes the document. */
2664
+ "file.exportGraphicsTemplate": {
2665
+ author?: string;
2666
+ category?: string; /** an id */
2667
+ clip?: number; /** [{"layer":n|name,"param":"text|fill_color|size|font|position|enabled|...","name":str?,"kind":"text|color|slider|checkbox|font|position"?,"min":f64?,"max":f64?,"id":str?}]? (default: each text layer's text); default: each text layer's text */
2668
+ controls?: Array<{
2669
+ id?: string;
2670
+ kind?: "text" | "color" | "slider" | "checkbox" | "font" | "position";
2671
+ layer?: Json;
2672
+ max?: number;
2673
+ min?: number;
2674
+ name?: string;
2675
+ param?: string;
2676
+ }>;
2677
+ description?: string;
2678
+ embedFonts?: boolean;
2679
+ fontLicense?: string;
2680
+ license?: string;
2681
+ name?: string; /** default: the user templates folder */
2682
+ path?: Json;
2683
+ tags?: Array<string>;
2684
+ };
2685
+ /** Install Motion Graphics Template. Installs a graphics template file (.fcgt) at `path` into the user template library; .mogrt packages are refused. Params: {"path":str (a .fcgt file; Adobe .mogrt files are refused)}. Changes the document. */
2686
+ "graphics.template.install": {
2687
+ path?: Json;
2688
+ };
2689
+ /** Remove Graphics Template. Removes a user graphics template by id or name from the library. Params: {"template":id|name (a user template)}. Changes the document. */
2690
+ "graphics.template.remove": {
2691
+ template?: string;
2692
+ };
2693
+ /** Set Template Property. Sets a template control (`control` id or name to `value`, or several `values`) on graphic `clip`. Params: {"clip":id?,"control":id|name,"value":any} or {"clip":id?,"values":{control: value}}. Acts on `clip`. Reads the part, selection, time. Changes the document. */
2694
+ "graphics.template.set": {
2695
+ clip?: number; /** id|name */
2696
+ control?: Json;
2697
+ value?: Json;
2698
+ };
2699
+ /** List Template Properties. Lists the editable controls of the template on graphic `clip`, with ids, kinds and current values. Params: {"clip":id?}. Acts on `clip`. Reads the part, selection, time. */
2700
+ "graphics.template.controls": {
2701
+ clip?: number;
2702
+ };
2703
+ /** Graphics Template Thumbnail. Renders a thumbnail PNG of graphics `template`, `width` px wide (default 320). Answers base64 PNG and size. Params: {"template":id|name|path,"width":px=320,"path":str? (write a PNG there; else returned as pngBase64)}. */
2704
+ "graphics.template.thumbnail": {
2705
+ path?: Json; /** id|name|path */
2706
+ template?: string; /** pixels */
2707
+ width?: number;
2708
+ };
2709
+ /** Roll/Crawl Options. Makes a graphic clip roll (credits) or crawl left/right with start/end off screen and preroll, ease and postroll frames; `mode: off` stops it. Params: {"clip":id?,"mode":"off|roll|crawlLeft|crawlRight"?,"startOffScreen":bool?,"endOffScreen":bool?,"prerollFrames":n?,"easeInFrames":n?,"easeOutFrames":n?,"postrollFrames":n?,"prerollSeconds":f64?,"easeInSeconds":f64?,"easeOutSeconds":f64?,"postrollSeconds":f64?,"preroll":ticks?,"easeIn":ticks?,"easeOut":ticks?,"postroll":ticks?}. Acts on `clip`. Reads the part, selection, time. Changes the document. */
2710
+ "graphics.setRoll": {
2711
+ clip?: number; /** ticks (254016000000 per second) */
2712
+ easeIn?: number;
2713
+ easeInFrames?: number;
2714
+ easeInSeconds?: number; /** ticks (254016000000 per second) */
2715
+ easeOut?: number;
2716
+ easeOutFrames?: number;
2717
+ easeOutSeconds?: number;
2718
+ endOffScreen?: boolean;
2719
+ mode?: "off" | "roll" | "crawlLeft" | "crawlRight"; /** ticks (254016000000 per second) */
2720
+ postroll?: number;
2721
+ postrollFrames?: number;
2722
+ postrollSeconds?: number; /** ticks (254016000000 per second) */
2723
+ preroll?: number;
2724
+ prerollFrames?: number;
2725
+ prerollSeconds?: number;
2726
+ startOffScreen?: boolean;
2727
+ };
2728
+ /** Responsive Design - Time. Sets a graphic clip's protected intro and outro (`introFrames`/`outroFrames` or seconds) that keep their timing when the clip is trimmed. Params: {"clip":id?,"introFrames":n?,"outroFrames":n? (or introSeconds / outroSeconds, or ticks as intro / outro)}. Acts on `clip`. Reads the part, selection, time. Changes the document. */
2729
+ "graphics.setResponsiveTime": {
2730
+ clip?: number; /** the intro duration, in ticks (one spelling of it) */
2731
+ intro?: number;
2732
+ introFrames?: number; /** the intro duration, in seconds (one spelling of it) */
2733
+ introSeconds?: number; /** the outro duration, in ticks (one spelling of it) */
2734
+ outro?: number; /** or introSeconds / outroSeconds, or ticks as intro / outro */
2735
+ outroFrames?: number; /** the outro duration, in seconds (one spelling of it) */
2736
+ outroSeconds?: number;
2737
+ };
2738
+ /** Responsive Design - Position. Responsive position: pins graphic `layer`'s `edges` to the frame or another layer (`to`), so it follows when that resizes; `to: none` unpins. Params: {"clip":id?,"layer":n|name?,"to":"frame"|"none"|layer index|layer name,"edges":["left","top","right","bottom"]|"all"="all"}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2739
+ "graphics.pin": {
2740
+ clip?: number; /** ["left","top","right","bottom"]|"all"="all"; default "all" */
2741
+ edges?: Json; /** n|name? */
2742
+ layer?: Json; /** "frame"|"none"|layer index|layer name */
2743
+ to?: Json;
2744
+ };
2745
+ /** Character Style. Styles characters `start`?`end` of a text layer: font, size, color, bold, italic, underline, tracking, baseline shift, caps; `clear` removes run styles from the range. Params: {"clip":id?,"layer":n|name?,"start":char=0,"end":char=len,"style":{"font":str,"fontStyle":str,"size":px,"color":"#rrggbb","bold":bool,"italic":bool,"underline":bool,"tracking":n,"baselineShift":px,"caps":"normal|all caps|small caps"},"clear":bool? (remove styles from the range)}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
2746
+ "graphics.setCharStyle": {
2747
+ clear?: boolean; /** an id */
2748
+ clip?: number; /** char=len; default len */
2749
+ end?: number; /** n|name? */
2750
+ layer?: Json; /** char=0; default 0 */
2751
+ start?: number;
2752
+ style?: {
2753
+ baselineShift?: number;
2754
+ bold?: boolean;
2755
+ caps?: "normal" | "all caps" | "small caps";
2756
+ color?: string;
2757
+ font?: string;
2758
+ fontStyle?: string;
2759
+ italic?: boolean;
2760
+ size?: number;
2761
+ tracking?: number;
2762
+ underline?: boolean;
2763
+ };
2764
+ };
2765
+ /** Upgrade Caption to Graphic. Converts `captions` (default selected, else the one under the playhead) into graphic clips with the same text and timing. Params: {"captions":[id]? (default: the selected captions, else the one under the playhead)}. Reads the part, selection, time. Changes the document. */
2766
+ "graphics.upgradeCaption": {
2767
+ captions?: Array<number>;
2768
+ };
2769
+ /** Upgrade to Source Graphic. Turns graphic `clip` into a source graphic project item, so several clips can share and update it. Params: {"clip":id?}. Acts on `clip`. Reads the part, selection, time. Changes the document. */
2770
+ "graphics.upgradeToSourceGraphic": {
2771
+ clip?: number;
2772
+ };
2773
+ /** Replace Fonts in Projects. Replaces font `from` (family, optional style) with `to` in every graphic and caption in the project. Params: {"from":family|{"family","style"?},"to":family|{"family","style"?},"toStyle":str?}. Changes the document. */
2774
+ "file.replaceFonts": {
2775
+ from?: string; /** family|{"family","style"?} */
2776
+ to?: Json;
2777
+ toStyle?: string;
2778
+ };
2779
+ /** List Fonts Used. Lists the font families and styles used by graphics and captions in the project, and whether each is installed. Params: {}. */
2780
+ "graphics.fonts.used": Record<string, never>;
2781
+ /** Register Frontend Commands. Registers host-side (frontend) commands so they can be given keyboard shortcuts; host use only. Params: {"commands":[{"id":str,"label":str,"menu":[str]?,"shortcut":str?}]}. */
2782
+ "shortcuts.registerExternal": {
2783
+ commands?: Array<{
2784
+ id?: string;
2785
+ label?: string;
2786
+ menu?: Array<string>;
2787
+ shortcut?: string;
2788
+ }>;
2789
+ };
2790
+ /** List Keyboard Shortcuts. Lists keyboard shortcuts, filtered by `query`, `panel`, `assigned` and `platform`. Params: {"query":str?,"panel":str?,"assigned":bool?,"platform":"mac|windows|linux"?}. */
2791
+ "shortcuts.list": {
2792
+ assigned?: boolean;
2793
+ panel?: string;
2794
+ platform?: "mac" | "windows" | "linux";
2795
+ query?: string;
2796
+ };
2797
+ /** Get Shortcuts of a Command. Reads the shortcuts assigned to `command` on `platform`. Params: {"command":id,"platform":str?}. */
2798
+ "shortcuts.get": {
2799
+ command?: number;
2800
+ platform?: string;
2801
+ };
2802
+ /** Assign Shortcut. Assigns `keys` (e.g. Cmd+Shift+K) to `command` in `panel`; `add` keeps its existing keys, and conflicting assignments are removed unless `keepConflicts`. Params: {"command":id,"keys":"Cmd+Shift+K","panel":str?,"add":bool?,"keepConflicts":bool?}. Reads the mode. Changes the document. */
2803
+ "shortcuts.set": {
2804
+ add?: boolean; /** an id */
2805
+ command?: number;
2806
+ keepConflicts?: boolean; /** like Cmd+Shift+K */
2807
+ keys?: string;
2808
+ panel?: string;
2809
+ };
2810
+ /** Clear Shortcut. Removes `keys` (or every shortcut) from `command` in `panel`. Params: {"command":id,"keys":str?,"panel":str?}. Reads the mode. Changes the document. */
2811
+ "shortcuts.clear": {
2812
+ command?: number;
2813
+ keys?: string;
2814
+ panel?: string;
2815
+ };
2816
+ /** Undo Shortcut Change. Undoes the last keyboard shortcut change. Params: {}. Reads the mode. Changes the document. */
2817
+ "shortcuts.undo": Record<string, never>;
2818
+ /** Redo Shortcut Change. Redoes the last undone keyboard shortcut change. Params: {}. Reads the mode. Changes the document. */
2819
+ "shortcuts.redo": Record<string, never>;
2820
+ /** Shortcut Conflicts. Lists keys assigned to more than one command in the same panel on `platform`. Params: {"platform":"mac|windows|linux"?}. */
2821
+ "shortcuts.conflicts": {
2822
+ platform?: "mac" | "windows" | "linux";
2823
+ };
2824
+ /** Shortcuts on a Key. Lists the commands on `key` with every modifier combination. Params: {"key":"K","platform":str?}. */
2825
+ "shortcuts.forKey": {
2826
+ key?: string;
2827
+ platform?: string;
2828
+ };
2829
+ /** Resolve Shortcut. Answers which command `keys` would run in `panel` on `platform`. Params: {"keys":str,"panel":str?,"platform":str?}. */
2830
+ "shortcuts.resolve": {
2831
+ keys?: string;
2832
+ panel?: string;
2833
+ platform?: string;
2834
+ };
2835
+ /** Keyboard Shortcut Presets. Lists the keyboard shortcut presets (built-in and saved) and the current one. Params: {}. */
2836
+ "shortcuts.presets": Record<string, never>;
2837
+ /** Load Shortcut Preset. Switches to keyboard shortcut preset `name`. Params: {"name":str}. Reads the mode. Changes the document. */
2838
+ "shortcuts.loadPreset": {
2839
+ name?: string;
2840
+ };
2841
+ /** Save Shortcut Preset As. Saves the current shortcuts as preset `name`. Params: {"name":str}. Reads the mode. Changes the document. */
2842
+ "shortcuts.savePreset": {
2843
+ name?: string;
2844
+ };
2845
+ /** Delete Shortcut Preset. Deletes saved keyboard shortcut preset `name`. Params: {"name":str}. Reads the mode. Changes the document. */
2846
+ "shortcuts.deletePreset": {
2847
+ name?: string;
2848
+ };
2849
+ /** Export Keyboard Shortcuts. Writes the current keyboard shortcuts to a file at `path`. Params: {"path":str}. Reads the mode. Changes the document. */
2850
+ "shortcuts.export": {
2851
+ path?: Json;
2852
+ };
2853
+ /** Import Keyboard Shortcuts. Reads a keyboard shortcut file at `path` as a preset and makes it active unless `activate: false`. Params: {"path":str,"activate":bool=true}. Reads the mode. Changes the document. */
2854
+ "shortcuts.import": {
2855
+ activate?: boolean;
2856
+ path?: Json;
2857
+ };
2858
+ /** Shortcut Audit. Checks the shortcut table for unknown commands, conflicts and invalid keys. Params: {}. */
2859
+ "shortcuts.audit": Record<string, never>;
2860
+ /** Find Missing Media. Lists project items whose media files are missing, with their last known paths. Params: {}. */
2861
+ "media.findMissing": Record<string, never>;
2862
+ /** Media Status. Reads media `item`'s (or every item's) file status: online, offline or missing, proxy attached, path. Params: {"item":id?}. Acts on `item`. */
2863
+ "media.status": {
2864
+ item?: number;
2865
+ };
2866
+ /** Link Media. Opens the Link Media dialog for missing files in the host. Agents relink with media.relink or media.autoRelink instead. Params: {} (opens the Link Media dialog; agents use media.relink / media.autoRelink). */
2867
+ "media.linkMedia": Record<string, never>;
2868
+ /** Relink Media. Links media `item` to the file at `path` (checked to match unless `force`), then relinks other missing items found the same way when `relinkOthers`. Params: {"item":id,"path":str,"force":bool=false,"relinkOthers":bool=true,"alignTimecode":bool=false,"match":{"fileName":bool,"extension":bool,"clipId":bool,"duration":bool,"mediaStart":bool,"metadata":bool}?}. Acts on `item`. Changes the document. */
2869
+ "media.relink": {
2870
+ alignTimecode?: boolean;
2871
+ force?: boolean; /** an id */
2872
+ item?: number;
2873
+ match?: {
2874
+ clipId?: boolean;
2875
+ duration?: boolean;
2876
+ extension?: boolean;
2877
+ fileName?: boolean;
2878
+ mediaStart?: boolean;
2879
+ metadata?: boolean;
2880
+ };
2881
+ path?: Json;
2882
+ relinkOthers?: boolean;
2883
+ };
2884
+ /** Replace Footage. Replaces media `item`'s file with the one at `path` without matching checks; clips using it show the new file. Params: {"item":id,"path":str}. Acts on `item`. Changes the document. */
2885
+ "media.replaceFootage": {
2886
+ alignTimecode?: boolean; /** read by the command beside its listed parameters */
2887
+ force?: boolean; /** an id */
2888
+ item?: number; /** read by the command beside its listed parameters */
2889
+ match?: {
2890
+ alignTimecode?: boolean;
2891
+ clipId?: boolean;
2892
+ duration?: boolean;
2893
+ extension?: boolean;
2894
+ fileName?: boolean;
2895
+ mediaStart?: boolean;
2896
+ metadata?: boolean;
2897
+ relinkOthers?: boolean;
2898
+ };
2899
+ path?: Json; /** read by the command beside its listed parameters */
2900
+ relinkOthers?: boolean;
2901
+ };
2902
+ /** Relink Moved Media. Relinks missing media by remapping a folder prefix (`from` ? `to`) or by searching a `folder` tree for the same file names. Params: {"from":str,"to":str,"match":MatchOptions?,"relinkOthers":bool?,"alignTimecode":bool?}|{"folder":str,"match":MatchOptions?,"relinkOthers":bool?,"alignTimecode":bool?}. Changes the document. */
2903
+ "media.autoRelink": {
2904
+ alignTimecode?: boolean; /** in one of several forms of the parameters */
2905
+ folder?: Json; /** in one of several forms of the parameters */
2906
+ from?: string; /** MatchOptions?; in one of several forms of the parameters */
2907
+ match?: Json; /** in one of several forms of the parameters */
2908
+ relinkOthers?: boolean; /** in one of several forms of the parameters */
2909
+ to?: string;
2910
+ };
2911
+ /** Search for Media. Searches `folder` for files matching missing media (`item` or all) by `exactName`; answers candidates without relinking. Params: {"folder":str,"item":id?,"exactName":bool=true}. Acts on `item`. */
2912
+ "media.search": {
2913
+ alignTimecode?: boolean;
2914
+ exactName?: boolean;
2915
+ folder?: Json; /** an id */
2916
+ item?: number; /** read by the command beside its listed parameters */
2917
+ match?: {
2918
+ alignTimecode?: boolean;
2919
+ clipId?: boolean;
2920
+ duration?: boolean;
2921
+ extension?: boolean;
2922
+ fileName?: boolean;
2923
+ mediaStart?: boolean;
2924
+ metadata?: boolean;
2925
+ relinkOthers?: boolean;
2926
+ }; /** read by the command beside its listed parameters */
2927
+ relinkOthers?: boolean;
2928
+ };
2929
+ /** Make Offline. Makes the selected or listed `items` offline (clips show Media Offline); `deleteFiles` also deletes the files on disk. Params: {"items":[id]?,"deleteFiles":bool=false}. Acts on `items`. Reads the selection. Changes the document. */
2930
+ "media.makeOffline": {
2931
+ deleteFiles?: boolean; /** read by the command beside its listed parameters */
2932
+ item?: number;
2933
+ items?: Array<number>;
2934
+ };
2935
+ /** Import from Media Browser. Imports the Media Browser's selected files, or `paths`; `imageSequence` treats numbered stills as one clip. Params: {"paths":[str]?,"imageSequence":bool?}. Reads the part, active. Changes the document. */
2936
+ "file.importFromMediaBrowser": {
2937
+ imageSequence?: boolean;
2938
+ paths?: Array<Json>;
2939
+ };
2940
+ /** Import. Imports media files at `paths` into the project (into `bin` when given); `imageSequence` treats numbered stills as one clip. Answers the new item ids. Params: {"paths":[str],"bin":binId?,"imageSequence":bool?}. Reads the part. Changes the document. */
2941
+ "file.import": {
2942
+ bin?: number;
2943
+ imageSequence?: boolean; /** read by the command beside its listed parameters */
2944
+ order?: string; /** read by the command beside its listed parameters */
2945
+ path?: Json;
2946
+ paths?: Array<Json>; /** read by the command beside its listed parameters */
2947
+ recursive?: boolean;
2948
+ };
2949
+ /** Import Image Sequence. Imports numbered stills starting at `path` (the first still) as one image-sequence clip, into `bin`. Params: {"path":str,"bin":binId?}. Changes the document. */
2950
+ "file.importImageSequence": {
2951
+ bin?: number;
2952
+ path?: Json;
2953
+ };
2954
+ /** Offline All. Leaves every missing file offline and closes the Link Media dialog. Params: {} (leave every missing file offline and close the Link Media dialog). */
2955
+ "media.offlineAll": Record<string, never>;
2956
+ /** Create Proxies. Creates proxy files for the selected or listed `items` with a `preset` (ProRes or H.264, quarter/half size) in `destination`, attaching them by default; `wait` blocks. Params: {"items":[id]?,"preset":"prores_proxy_quarter|prores_proxy_half|prores_lt_half|h264_quarter|h264_half","destination":str?,"attach":bool=true,"wait":bool=false}. Acts on `items`. Reads the selection. Changes the document. */
2957
+ "media.createProxies": {
2958
+ attach?: boolean;
2959
+ destination?: Json; /** read by the command beside its listed parameters */
2960
+ item?: number;
2961
+ items?: Array<number>;
2962
+ preset?: "prores_proxy_quarter" | "prores_proxy_half" | "prores_lt_half" | "h264_quarter" | "h264_half";
2963
+ wait?: boolean;
2964
+ };
2965
+ /** Attach Proxies. Attaches existing proxy files (`path` or `paths`) to media `item`/`items`; `force` skips the format check. Params: {"item":id,"path":str,"force":bool=false}|{"items":[id],"paths":[str],"force":bool=false}. Acts on `items`. Changes the document. */
2966
+ "media.attachProxies": {
2967
+ force?: boolean; /** an id; in one of several forms of the parameters */
2968
+ item?: number; /** in one of several forms of the parameters */
2969
+ items?: Array<number>; /** in one of several forms of the parameters */
2970
+ path?: Json; /** in one of several forms of the parameters */
2971
+ paths?: Array<Json>;
2972
+ };
2973
+ /** Detach Proxies. Detaches proxies from the selected or listed `items`; the proxy files stay on disk. Params: {"items":[id]?}. Acts on `items`. Reads the selection. Changes the document. */
2974
+ "media.detachProxies": {
2975
+ item?: number;
2976
+ items?: Array<number>;
2977
+ };
2978
+ /** Reconnect Full Resolution Media. Points media `item`'s full-resolution file at `path` while keeping its proxy. Params: {"item":id,"path":str}. Acts on `item`. Changes the document. */
2979
+ "media.reconnectFullRes": {
2980
+ force?: boolean; /** an id */
2981
+ item?: number; /** read by the command beside its listed parameters */
2982
+ match?: {
2983
+ alignTimecode?: boolean;
2984
+ clipId?: boolean;
2985
+ duration?: boolean;
2986
+ extension?: boolean;
2987
+ fileName?: boolean;
2988
+ mediaStart?: boolean;
2989
+ metadata?: boolean;
2990
+ relinkOthers?: boolean;
2991
+ };
2992
+ path?: Json; /** read by the command beside its listed parameters */
2993
+ relinkOthers?: boolean;
2994
+ };
2995
+ /** Toggle Proxies. Switches playback between proxies and full-resolution media (`enabled`, toggles when omitted). Export always uses full resolution. Params: {"enabled":bool?}. */
2996
+ "media.toggleProxies": {
2997
+ enabled?: boolean;
2998
+ };
2999
+ /** Proxy Presets. Lists the proxy presets media.createProxies accepts. Params: {}. */
3000
+ "media.proxyPresets": Record<string, never>;
3001
+ /** File. Reads media file properties of the file at `path` without importing it. Params: {"path":str}. */
3002
+ "file.mediaPropertiesFile": {
3003
+ path?: Json;
3004
+ };
3005
+ /** Selection. Reads media file properties (codec, size, frame rate, streams, duration, timecode) of the selected or listed `items`. Params: {"items":[id]?}. Acts on `items`. Reads the part, selection. */
3006
+ "file.mediaProperties": {
3007
+ items?: Array<number>;
3008
+ };
3009
+ /** General. Changes General project settings: renderer, video and audio time display, capture format, title/action safe margins. Params: {"renderer":"gpu|software"?,"videoDisplay":"timecode|feet35|feet16|frames"?,"audioDisplay":"samples|milliseconds"?,"captureFormat":"DV|HDV"?,"titleSafe":[h,v]?,"actionSafe":[h,v]?}. Changes the document. */
3010
+ "file.projectSettings.general": {
3011
+ actionSafe?: Array<Json>;
3012
+ audioDisplay?: "samples" | "milliseconds";
3013
+ captureFormat?: "DV" | "HDV";
3014
+ renderer?: "gpu" | "software"; /** [h,v]? */
3015
+ titleSafe?: Array<Json>;
3016
+ videoDisplay?: "timecode" | "feet35" | "feet16" | "frames";
3017
+ };
3018
+ /** Scratch Disks. Sets the folders for captured media, video previews, audio previews and auto-saves (null resets to default). Params: {"captured":path|null?,"videoPreviews":path|null?,"audioPreviews":path|null?,"autoSave":path|null?}. Changes the document. */
3019
+ "file.projectSettings.scratchDisks": {
3020
+ audioPreviews?: Json; /** path|null? */
3021
+ autoSave?: Json; /** path|null? */
3022
+ captured?: Json; /** path|null? */
3023
+ videoPreviews?: Json;
3024
+ };
3025
+ /** Ingest Settings. Reads or sets the project's ingest settings: `enabled`, `action` copy|transcode|createProxies|copyAndCreateProxies, `destination` folder and transcode `preset`. Params: {"enabled":bool?,"action":"copy|transcode|createProxies|copyAndCreateProxies"?,"destination":str?,"preset":str?}. Changes the document. */
3026
+ "project.ingestSettings": {
3027
+ action?: "copy" | "transcode" | "createProxies" | "copyAndCreateProxies";
3028
+ destination?: Json;
3029
+ enabled?: boolean;
3030
+ preset?: string;
3031
+ };
3032
+ /** Project Manager. Copies (collect) or trims and transcodes (consolidate) the `sequences` and their media to `destination` as a new project, with `handles` frames; `dryRun` only reports. Long jobs run in the background. Params: {"destination":str,"mode":"collect|consolidate","sequences":[id]?,"excludeUnused":bool=true,"handles":frames=30,"preset":"prores_lt|prores_hq|h264|...","includeProxies":bool,"includePreviews":bool=false,"projectName":str?,"dryRun":bool=false,"overwrite":bool=false,"wait":bool=false}. */
3033
+ "file.projectManager": {
3034
+ destination?: Json;
3035
+ dryRun?: boolean;
3036
+ excludeUnused?: boolean; /** frames */
3037
+ handles?: number;
3038
+ includePreviews?: boolean;
3039
+ includeProxies?: boolean;
3040
+ mode?: "collect" | "consolidate";
3041
+ overwrite?: boolean; /** for example prores_lt, prores_hq, h264 */
3042
+ preset?: string;
3043
+ projectName?: string;
3044
+ sequences?: Array<number>;
3045
+ wait?: boolean;
3046
+ };
3047
+ /** Create Mask. Adds a mask to `clip`'s `effect` (default Opacity): `shape` ellipse, polygon or bezier `path`, with `center`, `size` and `path` points in frame (sequence) pixels, mapped onto the clip through its Motion at the playhead so the mask stays on that part of the picture. Answers its index. Params: {"clip":id?,"effect":index|id?="opacity","shape":"ellipse"|"polygon"|"bezier","path":[[x,y]...]|{vertices}?,"center":[x,y]?,"size":[w,h]?}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
3048
+ "masks.add": {
3049
+ center?: Array<number>; /** an id */
3050
+ clip?: number; /** index|id?="opacity"; default "opacity" */
3051
+ effect?: string; /** [[x,y]...]|{vertices}? */
3052
+ path?: string;
3053
+ shape?: "ellipse" | "polygon" | "bezier";
3054
+ size?: Array<number>;
3055
+ };
3056
+ /** Delete Mask. Deletes mask `mask` (default selected) from an effect of `clip`. Params: {"clip":id?,"effect":index|id?,"mask":n?}. Acts on `clip`. Reads the part, selection, active. Changes the document. */
3057
+ "masks.remove": {
3058
+ clip?: number; /** a position counted from 0 (the first is 0) */
3059
+ effect?: number;
3060
+ mask?: number;
3061
+ };
3062
+ /** Change Mask. Changes a mask: name, inverted, blend `mode`, feather px, opacity %, expansion px, tracking method, or its `path` in frame pixels (keyframed at `time` when animated). Params: {"clip":id?,"effect":index|id?,"mask":n?,"name":str?,"inverted":bool?,"mode":"none|add|subtract|intersect|lighten|darken|difference"?,"trackMethod":"position|positionRotation|positionScaleRotation"?,"feather":px?,"opacity":pct?,"expansion":px?,"path":path?,"time":ticks?,"merge":key?}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
3063
+ "masks.set": {
3064
+ clip?: number; /** a position counted from 0 (the first is 0) */
3065
+ effect?: number; /** pixels */
3066
+ expansion?: number; /** pixels */
3067
+ feather?: number;
3068
+ inverted?: boolean;
3069
+ mask?: number; /** key? */
3070
+ merge?: Json;
3071
+ mode?: "none" | "add" | "subtract" | "intersect" | "lighten" | "darken" | "difference";
3072
+ name?: string; /** pct? */
3073
+ opacity?: number;
3074
+ path?: string; /** ticks (254016000000 per second) */
3075
+ time?: number;
3076
+ trackMethod?: "position" | "positionRotation" | "positionScaleRotation";
3077
+ };
3078
+ /** Move Mask Vertex. Moves vertex `vertex` of a mask (or its in/out bezier `handle`) `to` a point or by `delta` in frame pixels; `breakHandles` unlinks the handles. Params: {"clip":id?,"effect":index|id?,"mask":n?,"vertex":n,"handle":"point"|"in"|"out"?,"to":[x,y]?|"delta":[dx,dy]?,"breakHandles":bool?,"merge":key?}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
3079
+ "masks.moveVertex": {
3080
+ breakHandles?: boolean; /** an id */
3081
+ clip?: number; /** [dx, dy]; one of several alternative parameters */
3082
+ delta?: Array<number>; /** a position counted from 0 (the first is 0) */
3083
+ effect?: number;
3084
+ handle?: "point" | "in" | "out";
3085
+ mask?: number; /** key? */
3086
+ merge?: Json; /** one of several alternative parameters */
3087
+ to?: Array<number>;
3088
+ vertex?: number;
3089
+ };
3090
+ /** Move Mask. Moves a whole mask by `delta` [dx, dy] frame pixels. Params: {"clip":id?,"effect":index|id?,"mask":n?,"delta":[dx,dy],"merge":key?}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
3091
+ "masks.translate": {
3092
+ clip?: number; /** [dx, dy] */
3093
+ delta?: Array<number>; /** a position counted from 0 (the first is 0) */
3094
+ effect?: number;
3095
+ mask?: number; /** key? */
3096
+ merge?: Json;
3097
+ };
3098
+ /** Add Mask Vertex. Inserts a vertex into a mask path `after` vertex n, at point `at` in frame pixels. Params: {"clip":id?,"effect":index|id?,"mask":n?,"after":n,"at":[x,y]}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
3099
+ "masks.addVertex": {
3100
+ after?: number;
3101
+ at?: Array<number>; /** an id */
3102
+ clip?: number; /** a position counted from 0 (the first is 0) */
3103
+ effect?: number;
3104
+ mask?: number;
3105
+ };
3106
+ /** Delete Mask Vertex. Deletes vertex `vertex` from a mask path. Params: {"clip":id?,"effect":index|id?,"mask":n?,"vertex":n}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
3107
+ "masks.removeVertex": {
3108
+ clip?: number; /** a position counted from 0 (the first is 0) */
3109
+ effect?: number;
3110
+ mask?: number;
3111
+ vertex?: number;
3112
+ };
3113
+ /** Track Selected Mask. Tracks a mask through the clip `direction` forward or backward (for `frames`, default to the end), keyframing its path by position, rotation and scale; `wait` blocks. Params: {"clip":id?,"effect":index|id?,"mask":n?,"direction":"forward"|"backward"?,"frames":n?,"method":"position|positionRotation|positionScaleRotation"?,"wait":bool?}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
3114
+ "masks.track": {
3115
+ clip?: number;
3116
+ direction?: "forward" | "backward"; /** a position counted from 0 (the first is 0) */
3117
+ effect?: number;
3118
+ frames?: number;
3119
+ mask?: number;
3120
+ method?: "position" | "positionRotation" | "positionScaleRotation";
3121
+ wait?: boolean;
3122
+ };
3123
+ /** Convert Mask Vertex. Converts a mask vertex between a sharp corner and a smooth bezier point. Params: {"clip":id?,"effect":index|id?,"mask":n?,"vertex":n}. Acts on `clip`. Reads the part, selection, time, active. Changes the document. */
3124
+ "masks.toggleVertexSmooth": {
3125
+ clip?: number; /** a position counted from 0 (the first is 0) */
3126
+ effect?: number;
3127
+ mask?: number;
3128
+ vertex?: number;
3129
+ };
3130
+ /** Select Mask. Selects mask `mask` of `clip`'s `effect` for editing in the Program monitor, or clears it with `none`. Params: {"clip":id,"effect":index|id,"mask":n}|{"none":true}. Acts on `clip`. Reads the part, selection, active. */
3131
+ "masks.select": {
3132
+ clip?: number; /** a position counted from 0 (the first is 0); in one of several forms of the parameters */
3133
+ effect?: number; /** in one of several forms of the parameters */
3134
+ mask?: number; /** in one of several forms of the parameters */
3135
+ none?: boolean;
3136
+ };
3137
+ /** List Masks. Lists the masks of `clip` (or every clip with masks) evaluated at the playhead or `time`: effect, index, shape, path points in frame pixels (where the clip's Motion shows them), feather, opacity, mode. Params: {"clip":id?,"time":ticks?}. Acts on `clip`. Reads the part, time, active. */
3138
+ "masks.list": {
3139
+ clip?: number; /** ticks (254016000000 per second) */
3140
+ time?: number;
3141
+ };
3142
+ /** List Effect Presets. Lists saved effect presets with their effects and keyframe handling. Params: {}. */
3143
+ "presets.list": Record<string, never>;
3144
+ /** Save Preset. Saves `clip`'s effects (`effects` indices, default all) as preset `name`; `keyframes` scale|anchorIn|anchorOut|none decides how keyframes fit other clips. Params: {"clip":id?,"effects":[index]?,"name":str,"description":str?,"keyframes":"scale"|"anchorIn"|"anchorOut"|"none"?}. Acts on `clip`. Reads the part, selection, time, mode. Changes the document. */
3145
+ "presets.save": {
3146
+ clip?: number;
3147
+ description?: string;
3148
+ effects?: Array<number>;
3149
+ keyframes?: "scale" | "anchorIn" | "anchorOut" | "none";
3150
+ name?: string;
3151
+ };
3152
+ /** Apply Preset. Applies effect `preset` to the selected or listed `clips`. Params: {"preset":str,"clips":[id]?}. Acts on `clips`. Reads the part, selection, mode. Changes the document. */
3153
+ "presets.apply": {
3154
+ clips?: Array<number>; /** read by the command beside its listed parameters */
3155
+ name?: string;
3156
+ preset?: string;
3157
+ };
3158
+ /** Delete Preset. Deletes saved effect preset `name`; clips it was applied to keep their effects. Params: {"name":str}. Reads the mode. Changes the document. */
3159
+ "presets.delete": {
3160
+ name?: string;
3161
+ };
3162
+ /** Rename Preset. Renames effect preset `name` to `to`. Params: {"name":str,"to":str}. Reads the mode. Changes the document. */
3163
+ "presets.rename": {
3164
+ name?: string;
3165
+ to?: string;
3166
+ };
3167
+ /** Export Presets. Writes effect presets (`names`, default all) to a preset file at `path`. Params: {"path":str,"names":[str]?}. */
3168
+ "presets.export": {
3169
+ names?: Array<string>;
3170
+ path?: Json;
3171
+ };
3172
+ /** Import Presets. Reads effect presets from the file at `path` into the preset library. Params: {"path":str}. Reads the mode. Changes the document. */
3173
+ "presets.import": {
3174
+ path?: Json;
3175
+ };
3176
+ /** List Export Presets. Lists export presets (built-in and user), filtered by `query`, `category`, `format` or `favorites`. Params: {"query":str?,"category":str?,"format":str?,"favorites":bool?}. */
3177
+ "export.presets.list": {
3178
+ category?: string;
3179
+ favorites?: boolean;
3180
+ format?: string;
3181
+ query?: string;
3182
+ };
3183
+ /** Get Export Preset. Reads export preset `name`'s full settings. Params: {"name":str}. */
3184
+ "export.presets.get": {
3185
+ name?: string;
3186
+ };
3187
+ /** Save Export Preset. Saves a user export preset `name` from another preset (`from`) or `settings` plus overrides; overwrites by default. Params: {"name":str,"from":str?,"category":str?,"description":str?,"overwrite":bool=true,"settings":ExportSettings?,"format":"h264|hevc|prores|dnxhr|apv|mjpeg|mxf-op1a|mxf-opatom|png|tiff|bmp|gif|wav|aiff"?,"width":u32?,"height":u32?,"fps":f64?,"bitrateKbps":u32?,"bitrateMode":"cbr|vbr1Pass|vbr2Pass|quality"?,"maxBitrateKbps":u32?,"keyframeDistance":u32?,"hardwareEncoding":"off|auto"?,"scale":f32?,"audio":bool?,"quality":0..100?,"burnCaptions":bool?,"alpha":bool?,"sdr":bool?,"captionSidecar":"srt|vtt"?,"loudnessLufs":f64?,"proresProfile":"proxy|lt|standard|hq"?,"dnxProfile":"lb|sq|hq|hqx"?,"apvProfile":"422-10|422-12|444-10|444-12"?,"mxfVideoCodec":"dnxhr|proRes|h264"?}. Reads the mode. Changes the document. */
3188
+ "export.presets.save": {
3189
+ alpha?: boolean;
3190
+ apvProfile?: "422-10" | "422-12" | "444-10" | "444-12";
3191
+ audio?: boolean;
3192
+ bitrateKbps?: number;
3193
+ bitrateMode?: "cbr" | "vbr1Pass" | "vbr2Pass" | "quality";
3194
+ burnCaptions?: boolean;
3195
+ captionSidecar?: "srt" | "vtt";
3196
+ category?: string;
3197
+ description?: string;
3198
+ dnxProfile?: "lb" | "sq" | "hq" | "hqx";
3199
+ format?: "h264" | "hevc" | "prores" | "dnxhr" | "apv" | "mjpeg" | "mxf-op1a" | "mxf-opatom" | "png" | "tiff" | "bmp" | "gif" | "wav" | "aiff";
3200
+ fps?: number;
3201
+ from?: string;
3202
+ hardwareEncoding?: "off" | "auto";
3203
+ height?: number;
3204
+ keyframeDistance?: number;
3205
+ loudnessLufs?: number;
3206
+ maxBitrateKbps?: number;
3207
+ mxfVideoCodec?: "dnxhr" | "proRes" | "h264";
3208
+ name?: string;
3209
+ overwrite?: boolean;
3210
+ proresProfile?: "proxy" | "lt" | "standard" | "hq"; /** 0 to 100 */
3211
+ quality?: number;
3212
+ scale?: number;
3213
+ sdr?: boolean; /** ExportSettings? */
3214
+ settings?: Json;
3215
+ width?: number;
3216
+ };
3217
+ /** Delete Export Preset. Deletes user export preset `name`. Params: {"name":str}. Reads the mode. Changes the document. */
3218
+ "export.presets.delete": {
3219
+ name?: string;
3220
+ };
3221
+ /** Favorite Export Preset. Marks export preset `name` as a favorite or not. Params: {"name":str,"favorite":bool?}. Reads the mode. Changes the document. */
3222
+ "export.presets.favorite": {
3223
+ favorite?: boolean;
3224
+ name?: string;
3225
+ };
3226
+ /** Import Export Presets. Reads export presets from the preset file at `path` into the user library. Params: {"path":str}. Reads the mode. Changes the document. */
3227
+ "export.presets.import": {
3228
+ path?: Json;
3229
+ };
3230
+ /** Export Export Presets. Writes user export presets (`names`, default all) to a preset file at `path`. Params: {"path":str,"names":[str]?}. */
3231
+ "export.presets.export": {
3232
+ names?: Array<string>;
3233
+ path?: Json;
3234
+ };
3235
+ /** List Export Formats. Lists the export formats with their codecs, containers and supported options. Params: {}. */
3236
+ "export.formats": Record<string, never>;
3237
+ /** Resolve Export Settings. Answers the full export settings a preset plus overrides would use, and the output path, without exporting. Params: {"preset":str?,"path":str?,"settings":ExportSettings?,"format":"h264|hevc|prores|dnxhr|apv|mjpeg|mxf-op1a|mxf-opatom|png|tiff|bmp|gif|wav|aiff"?,"width":u32?,"height":u32?,"fps":f64?,"bitrateKbps":u32?,"bitrateMode":"cbr|vbr1Pass|vbr2Pass|quality"?,"maxBitrateKbps":u32?,"keyframeDistance":u32?,"hardwareEncoding":"off|auto"?,"scale":f32?,"audio":bool?,"quality":0..100?,"burnCaptions":bool?,"alpha":bool?,"sdr":bool?,"captionSidecar":"srt|vtt"?,"loudnessLufs":f64?,"proresProfile":"proxy|lt|standard|hq"?,"dnxProfile":"lb|sq|hq|hqx"?,"apvProfile":"422-10|422-12|444-10|444-12"?,"mxfVideoCodec":"dnxhr|proRes|h264"?,"sequence":id?,"range":"entire|inOut|workArea|custom"|{mode,start...,end...}?,"startSeconds":f64?,"endSeconds":f64?}. Reads the part, time. */
3238
+ "export.resolve": {
3239
+ alpha?: boolean;
3240
+ apvProfile?: "422-10" | "422-12" | "444-10" | "444-12";
3241
+ audio?: boolean;
3242
+ bitrateKbps?: number;
3243
+ bitrateMode?: "cbr" | "vbr1Pass" | "vbr2Pass" | "quality";
3244
+ burnCaptions?: boolean;
3245
+ captionSidecar?: "srt" | "vtt";
3246
+ dnxProfile?: "lb" | "sq" | "hq" | "hqx"; /** the end time, as a frame of the sequence (one spelling of it) */
3247
+ endFrame?: number;
3248
+ endSeconds?: number; /** the end time, in ticks (one spelling of it) */
3249
+ endTime?: number; /** the end time, as a timecode (one spelling of it) */
3250
+ endTimecode?: string;
3251
+ format?: "h264" | "hevc" | "prores" | "dnxhr" | "apv" | "mjpeg" | "mxf-op1a" | "mxf-opatom" | "png" | "tiff" | "bmp" | "gif" | "wav" | "aiff";
3252
+ fps?: number;
3253
+ hardwareEncoding?: "off" | "auto";
3254
+ height?: number;
3255
+ keyframeDistance?: number;
3256
+ loudnessLufs?: number;
3257
+ maxBitrateKbps?: number;
3258
+ mxfVideoCodec?: "dnxhr" | "proRes" | "h264";
3259
+ path?: Json;
3260
+ preset?: string;
3261
+ proresProfile?: "proxy" | "lt" | "standard" | "hq"; /** 0 to 100 */
3262
+ quality?: number; /** "entire|inOut|workArea|custom"|{mode,start...,end...}? */
3263
+ range?: Json;
3264
+ scale?: number;
3265
+ sdr?: boolean; /** an id */
3266
+ sequence?: number; /** ExportSettings? */
3267
+ settings?: Json; /** the start time, as a frame of the sequence (one spelling of it) */
3268
+ startFrame?: number;
3269
+ startSeconds?: number; /** the start time, in ticks (one spelling of it) */
3270
+ startTime?: number; /** the start time, as a timecode (one spelling of it) */
3271
+ startTimecode?: string;
3272
+ width?: number;
3273
+ };
3274
+ /** Send to Export Queue. Adds an export of the active (or given) sequence with a preset or settings and output path to the export queue; start it with export.queue.start. Params: {"preset":str?,"path":str|dir?,"sequence":id?,"sequences":[id]?,"range":"entire|inOut|workArea|custom"?,"ranges":[range]?,"start":bool?,"wait":bool?,"settings":ExportSettings?,"format":"h264|hevc|prores|dnxhr|apv|mjpeg|mxf-op1a|mxf-opatom|png|tiff|bmp|gif|wav|aiff"?,"width":u32?,"height":u32?,"fps":f64?,"bitrateKbps":u32?,"bitrateMode":"cbr|vbr1Pass|vbr2Pass|quality"?,"maxBitrateKbps":u32?,"keyframeDistance":u32?,"hardwareEncoding":"off|auto"?,"scale":f32?,"audio":bool?,"quality":0..100?,"burnCaptions":bool?,"alpha":bool?,"sdr":bool?,"captionSidecar":"srt|vtt"?,"loudnessLufs":f64?,"proresProfile":"proxy|lt|standard|hq"?,"dnxProfile":"lb|sq|hq|hqx"?,"apvProfile":"422-10|422-12|444-10|444-12"?,"mxfVideoCodec":"dnxhr|proRes|h264"?}. Reads the part, time. Changes the document. */
3275
+ "export.queue.add": {
3276
+ alpha?: boolean;
3277
+ apvProfile?: "422-10" | "422-12" | "444-10" | "444-12";
3278
+ audio?: boolean;
3279
+ bitrateKbps?: number;
3280
+ bitrateMode?: "cbr" | "vbr1Pass" | "vbr2Pass" | "quality";
3281
+ burnCaptions?: boolean;
3282
+ captionSidecar?: "srt" | "vtt";
3283
+ dnxProfile?: "lb" | "sq" | "hq" | "hqx";
3284
+ format?: "h264" | "hevc" | "prores" | "dnxhr" | "apv" | "mjpeg" | "mxf-op1a" | "mxf-opatom" | "png" | "tiff" | "bmp" | "gif" | "wav" | "aiff";
3285
+ fps?: number;
3286
+ hardwareEncoding?: "off" | "auto";
3287
+ height?: number;
3288
+ keyframeDistance?: number;
3289
+ loudnessLufs?: number;
3290
+ maxBitrateKbps?: number;
3291
+ mxfVideoCodec?: "dnxhr" | "proRes" | "h264"; /** str|dir? */
3292
+ path?: Json;
3293
+ preset?: string;
3294
+ proresProfile?: "proxy" | "lt" | "standard" | "hq"; /** 0 to 100 */
3295
+ quality?: number;
3296
+ range?: "entire" | "inOut" | "workArea" | "custom"; /** [range]? */
3297
+ ranges?: Array<Json>;
3298
+ scale?: number;
3299
+ sdr?: boolean; /** an id */
3300
+ sequence?: number;
3301
+ sequences?: Array<number>; /** ExportSettings? */
3302
+ settings?: Json;
3303
+ start?: boolean;
3304
+ wait?: boolean;
3305
+ width?: number;
3306
+ };
3307
+ /** List Export Queue. Lists the export queue: each job's id, sequence, output path, status and progress. Params: {}. */
3308
+ "export.queue.list": Record<string, never>;
3309
+ /** Start Export Queue. Starts encoding the queued exports in order; `wait` blocks until the queue finishes. Params: {"wait":bool=false}. Reads the mode. Changes the document. */
3310
+ "export.queue.start": {
3311
+ wait?: boolean;
3312
+ };
3313
+ /** Stop Export Queue. Pauses the export queue after the current job. Params: {}. Reads the mode. Changes the document. */
3314
+ "export.queue.stop": Record<string, never>;
3315
+ /** Cancel Queued Export. Cancels queued or running export `id` (default the running one). Params: {"id":id?,"wait":bool?}. Reads the mode. Changes the document. */
3316
+ "export.queue.cancel": {
3317
+ id?: number;
3318
+ wait?: boolean;
3319
+ };
3320
+ /** Retry Queued Export. Re-queues failed or cancelled export `id`; `start` starts the queue. Params: {"id":id,"start":bool?,"wait":bool?}. Reads the mode. Changes the document. */
3321
+ "export.queue.retry": {
3322
+ id?: number;
3323
+ start?: boolean;
3324
+ wait?: boolean;
3325
+ };
3326
+ /** Remove Queued Export. Removes export `id` from the queue. Params: {"id":id}. Reads the mode. Changes the document. */
3327
+ "export.queue.remove": {
3328
+ id?: number;
3329
+ };
3330
+ /** Reorder Queued Export. Moves queued export `id` to position `to` or by `by` places. Params: {"id":id,"to":index?,"by":int?}. Reads the mode. Changes the document. */
3331
+ "export.queue.move": {
3332
+ by?: number; /** an id */
3333
+ id?: number; /** a position counted from 0 (the first is 0) */
3334
+ to?: number;
3335
+ };
3336
+ /** Clear Finished Exports. Removes finished exports from the queue (`all` also removes failed and cancelled ones). Params: {"all":bool=false}. Reads the mode. Changes the document. */
3337
+ "export.queue.clear": {
3338
+ all?: boolean;
3339
+ };
3340
+ /** Quick Export. Exports the active sequence immediately with `preset` (default the Quick Export preset) to `path` (default next to the project); `wait` blocks. Params: {"preset":str?,"path":str?,"wait":bool?,"settings":ExportSettings?,"format":"h264|hevc|prores|dnxhr|apv|mjpeg|mxf-op1a|mxf-opatom|png|tiff|bmp|gif|wav|aiff"?,"width":u32?,"height":u32?,"fps":f64?,"bitrateKbps":u32?,"bitrateMode":"cbr|vbr1Pass|vbr2Pass|quality"?,"maxBitrateKbps":u32?,"keyframeDistance":u32?,"hardwareEncoding":"off|auto"?,"scale":f32?,"audio":bool?,"quality":0..100?,"burnCaptions":bool?,"alpha":bool?,"sdr":bool?,"captionSidecar":"srt|vtt"?,"loudnessLufs":f64?,"proresProfile":"proxy|lt|standard|hq"?,"dnxProfile":"lb|sq|hq|hqx"?,"apvProfile":"422-10|422-12|444-10|444-12"?,"mxfVideoCodec":"dnxhr|proRes|h264"?,"sequence":id?,"range":"entire|inOut|workArea|custom"|{mode,start...,end...}?,"startSeconds":f64?,"endSeconds":f64?}. Reads the part, time. Changes the document. */
3341
+ "export.quick": {
3342
+ alpha?: boolean;
3343
+ apvProfile?: "422-10" | "422-12" | "444-10" | "444-12";
3344
+ audio?: boolean;
3345
+ bitrateKbps?: number;
3346
+ bitrateMode?: "cbr" | "vbr1Pass" | "vbr2Pass" | "quality";
3347
+ burnCaptions?: boolean;
3348
+ captionSidecar?: "srt" | "vtt";
3349
+ dnxProfile?: "lb" | "sq" | "hq" | "hqx"; /** the end time, as a frame of the sequence (one spelling of it) */
3350
+ endFrame?: number;
3351
+ endSeconds?: number; /** the end time, in ticks (one spelling of it) */
3352
+ endTime?: number; /** the end time, as a timecode (one spelling of it) */
3353
+ endTimecode?: string;
3354
+ format?: "h264" | "hevc" | "prores" | "dnxhr" | "apv" | "mjpeg" | "mxf-op1a" | "mxf-opatom" | "png" | "tiff" | "bmp" | "gif" | "wav" | "aiff";
3355
+ fps?: number;
3356
+ hardwareEncoding?: "off" | "auto";
3357
+ height?: number;
3358
+ keyframeDistance?: number;
3359
+ loudnessLufs?: number;
3360
+ maxBitrateKbps?: number;
3361
+ mxfVideoCodec?: "dnxhr" | "proRes" | "h264";
3362
+ path?: Json;
3363
+ preset?: string;
3364
+ proresProfile?: "proxy" | "lt" | "standard" | "hq"; /** 0 to 100 */
3365
+ quality?: number; /** "entire|inOut|workArea|custom"|{mode,start...,end...}? */
3366
+ range?: Json;
3367
+ scale?: number;
3368
+ sdr?: boolean; /** an id */
3369
+ sequence?: number; /** ExportSettings? */
3370
+ settings?: Json; /** the start time, as a frame of the sequence (one spelling of it) */
3371
+ startFrame?: number;
3372
+ startSeconds?: number; /** the start time, in ticks (one spelling of it) */
3373
+ startTime?: number; /** the start time, as a timecode (one spelling of it) */
3374
+ startTimecode?: string;
3375
+ wait?: boolean;
3376
+ width?: number;
3377
+ };
3378
+ /** Transcribe. Transcribes the speech of the selected or listed `items` with a local speech `model` in `language` (auto detects), with speaker labels when `diarize`. Params: {"items":[id]?,"model":"whisper-base"?,"language":"en|auto"?,"diarize":bool?,"maxSpeakers":n?}. Acts on `items`. Reads the part, selection. Changes the document. */
3379
+ "transcript.generate": {
3380
+ diarize?: boolean; /** read by the command beside its listed parameters */
3381
+ item?: number;
3382
+ items?: Array<number>;
3383
+ language?: "en" | "auto";
3384
+ maxSpeakers?: number; /** like whisper-base */
3385
+ model?: string;
3386
+ };
3387
+ /** Import Transcript. Stores a transcript for `item` from the given words (text, start/end ticks, speaker) instead of transcribing. Params: {"item":id,"transcript":{"language":str,"speakers":[{"name":str}],"words":[{"text":str,"start":tick,"end":tick,"speaker":n?}]}}. Acts on `item`. Changes the document. */
3388
+ "transcript.set": {
3389
+ item?: number; /** {"language":str,"speakers":[{"name":str}],"words":[{"text":str,"start":tick,"end":tick,"speaker":n?}]} */
3390
+ transcript?: {
3391
+ language?: string;
3392
+ speakers?: Array<{
3393
+ name?: string;
3394
+ }>;
3395
+ words?: Array<{
3396
+ end?: Json;
3397
+ speaker?: number;
3398
+ start?: Json;
3399
+ text?: string;
3400
+ }>;
3401
+ };
3402
+ };
3403
+ /** Delete Transcript. Deletes the transcripts of the selected or listed `items`. Params: {"items":[id]?}. Acts on `items`. Changes the document. */
3404
+ "transcript.delete": {
3405
+ items?: Array<number>;
3406
+ };
3407
+ /** Inspect Transcript. Reads the active sequence's transcript as paragraphs of words with sequence times and speakers; `paragraphGapSeconds` sets where paragraphs break. Params: {"paragraphGapSeconds":f?}. Reads the part, time. */
3408
+ "transcript.inspect": {
3409
+ paragraphGapSeconds?: number;
3410
+ };
3411
+ /** Search Transcript. Finds `query` in the active sequence's transcript and answers the matching words with their sequence times. Params: {"query":str}. Reads the part. */
3412
+ "transcript.search": {
3413
+ query?: string;
3414
+ };
3415
+ /** List Speech Models. Lists the local speech models and whether each is downloaded. Params: {}. */
3416
+ "transcript.models": Record<string, never>;
3417
+ /** Download Speech Model. Downloads speech `model` (default whisper-base) for transcript.generate. Params: {"model":"whisper-base"?}. Changes the document. */
3418
+ "transcript.downloadModel": {
3419
+ model?: string;
3420
+ };
3421
+ /** Mark Selected Text. Sets In and Out around transcript words `from`?`to` (word indices from transcript.inspect). Params: {"from":word,"to":word?}. Reads the part, time, mode, active. Changes the document. */
3422
+ "transcript.select": {
3423
+ from?: number; /** word? */
3424
+ to?: number;
3425
+ };
3426
+ /** Extract Selected Text. Removes the sequence span of transcript words `from`?`to` and closes the gap (text-based ripple delete). Params: {"from":word,"to":word?}. Reads the part, time, mode, active. Changes the document. */
3427
+ "transcript.extract": {
3428
+ from?: number; /** word? */
3429
+ to?: number;
3430
+ };
3431
+ /** Lift Selected Text. Removes the sequence span of transcript words `from`?`to` and leaves a gap. Params: {"from":word,"to":word?}. Reads the part, time, mode, active. Changes the document. */
3432
+ "transcript.lift": {
3433
+ from?: number; /** word? */
3434
+ to?: number;
3435
+ };
3436
+ /** Rename Speaker. Renames a transcript speaker ("Speaker 1" or index) to `name`, in `item`'s transcript or all. Params: {"speaker":"Speaker 1"|index,"name":str,"item":id?}. Acts on `item`. Changes the document. */
3437
+ "transcript.renameSpeaker": {
3438
+ item?: number;
3439
+ name?: string; /** "Speaker 1"|index */
3440
+ speaker?: Json;
3441
+ };
3442
+ /** Remove Pauses. Extracts pauses longer than `minSeconds` from the sequence, keeping `keepSeconds` of each, by ripple delete. Params: {"minSeconds":f?,"keepSeconds":f?}. Reads the part. Changes the document. */
3443
+ "transcript.removePauses": {
3444
+ keepSeconds?: number; /** f? */
3445
+ minSeconds?: number;
3446
+ };
3447
+ /** Remove Filler Words. Extracts filler words (`fillers`, default um, uh...) from the sequence by ripple delete. Params: {"fillers":[str]?}. Reads the part. Changes the document. */
3448
+ "transcript.removeFillers": {
3449
+ fillers?: Array<string>;
3450
+ };
3451
+ /** Create Captions from Transcript. Creates a caption track from the sequence transcript: `maxChars` per line, 1 or 2 `lines`, caption length between `minSeconds` and `maxSeconds`, `gapFrames` between captions. Params: {"maxChars":n?,"lines":1|2?,"minSeconds":f?,"maxSeconds":f?,"gapFrames":n?,"format":str?,"name":str?}. Reads the part. Changes the document. */
3452
+ "transcript.createCaptions": {
3453
+ format?: string;
3454
+ gapFrames?: number;
3455
+ lines?: 1 | 2;
3456
+ maxChars?: number; /** f? */
3457
+ maxSeconds?: number; /** f? */
3458
+ minSeconds?: number;
3459
+ name?: string;
3460
+ };
3461
+ /** List Events. Lists the session's event log (warnings, errors, info) at or above `level`, newer than `since`. Params: {"level":"info|warning|error"?,"since":id?}. */
3462
+ "events.list": {
3463
+ level?: "info" | "warning" | "error"; /** an id */
3464
+ since?: number;
3465
+ };
3466
+ /** Clear All Events. Clears every entry from the session's event log. Params: {}. Changes the document. */
3467
+ "events.clear": Record<string, never>;
3468
+ /** Get Metadata. Reads the metadata fields of project `item` or timeline `clip`'s source (Name, Label, Description, Scene, Shot, Log Note...). Params: {"item":id?,"clip":id?}. Reads the part, selection. */
3469
+ "metadata.get": {
3470
+ clip?: number; /** an id */
3471
+ item?: number;
3472
+ };
3473
+ /** Edit Metadata. Sets metadata `field` to `value` (or several `fields`) on project `item` or `clip`'s source; one undo step. Name renames the item and Label sets its color label. Params: {"item":id?,"clip":id?,"field":"Name|Label|Description|Scene|Shot|Log Note|Comment|Tape Name|Client|Camera Angle|...","value":str} | {"item":id?,"fields":{name:str}}. Reads the part, selection. Changes the document. */
3474
+ "metadata.set": {
3475
+ clip?: number; /** for example Name, Label, Description, Scene, Shot, Log Note, Comment, Tape Name, Client, Camera Angle; in one of several forms of the parameters */
3476
+ field?: string; /** in one of several forms of the parameters */
3477
+ fields?: {
3478
+ name?: string;
3479
+ }; /** an id; in one of several forms of the parameters */
3480
+ item?: number; /** in one of several forms of the parameters */
3481
+ value?: string;
3482
+ };
3483
+ /** Read Scopes. Measures the program frame at the playhead or `time` with scopes (waveform, parade, histogram, vectorscopes), summarised in `columns`, `peaks` and bins. Params: {"scopes":["waveform","parade","histogram","vectorscopeYuv","vectorscopeHls"]?,"waveformType":"rgb|luma|yc|ycNoChroma"?,"paradeType":"rgb|yuv|rgbWhite"?,"colorSpace":"auto|601|709|2100"?,"clamp":bool=true,"columns":n=8,"peaks":n=8,"bins":bool=true,"scale":0.5,"time":ticks?|"frame"|"seconds"|"timecode"}. Reads the part, time. */
3484
+ "scopes.read": {
3485
+ bins?: boolean;
3486
+ clamp?: boolean;
3487
+ colorSpace?: "auto" | "601" | "709" | "2100";
3488
+ columns?: number;
3489
+ paradeType?: "rgb" | "yuv" | "rgbWhite";
3490
+ peaks?: number;
3491
+ scale?: number;
3492
+ scopes?: Array<string>; /** ticks?|"frame"|"seconds"|"timecode" */
3493
+ time?: number;
3494
+ waveformType?: "rgb" | "luma" | "yc" | "ycNoChroma";
3495
+ };
3496
+ /** Enable Remix. Analyses the selected audio `clip` and makes it a remix clip at its current duration, so its length can later be changed with clip.remix. Params: {"clip":id?}. Acts on `clip`. Reads the part, selection. Changes the document. */
3497
+ "clip.remix.enable": {
3498
+ clip?: number;
3499
+ };
3500
+ /** Remix Properties. Without parameters reads a remix clip's settings; with a target duration, `segments` or `variations` re-plans the remix. Params: {"clip":id?,"duration":ticks?,"seconds":f64?,"frame":n?,"timecode":str?,"segments":0..100?,"variations":0..100?}. Acts on `clip`. Reads the part, selection. Changes the document. */
3501
+ "clip.remix.properties": {
3502
+ clip?: number; /** ticks (254016000000 per second) */
3503
+ duration?: number;
3504
+ frame?: number;
3505
+ seconds?: number; /** 0 to 100 */
3506
+ segments?: number; /** the time, in ticks (one spelling of it) */
3507
+ time?: number;
3508
+ timecode?: string; /** 0 to 100 */
3509
+ variations?: number;
3510
+ };
3511
+ /** Revert Remix. Restores a remix `clip` to how it was before remixing. Params: {"clip":id?}. Acts on `clip`. Reads the part, selection. Changes the document. */
3512
+ "clip.remix.revert": {
3513
+ clip?: number;
3514
+ };
3515
+ /** Remix. Remixes an audio `clip` (default selected) to a target length (`duration` ticks, `seconds`, `frame` or `timecode`) by cutting and crossfading its musical segments, enabling remix first if needed. Answers the plan. Params: {"clip":id?,"duration":ticks?,"seconds":f64?,"frame":n?,"timecode":str?,"segments":0..100?,"variations":0..100?}. Acts on `clip`. Reads the part, selection. Changes the document. */
3516
+ "clip.remix": {
3517
+ clip?: number; /** ticks (254016000000 per second) */
3518
+ duration?: number;
3519
+ frame?: number;
3520
+ seconds?: number; /** 0 to 100 */
3521
+ segments?: number; /** the time, in ticks (one spelling of it) */
3522
+ time?: number;
3523
+ timecode?: string; /** 0 to 100 */
3524
+ variations?: number;
3525
+ };
3526
+ /** Detect Beats. Finds the beats of music: an audio `clip` on the timeline (times in the sequence) or a project `item` (times from its start). Answers {bpm, confidence 0?1, beats in seconds, times in ticks, frames}; speech, silence and noise are an error (no beat). `markers: true` also adds a sequence marker (`name`, `color`) on every beat as one undo step, for snapping edits to them. Params: {"clip":id?,"item":id?,"markers":bool=false,"name":str="Beat"?,"color":label?}. Reads the part. Changes the document. */
3527
+ "audio.detectBeats": {
3528
+ clip?: number; /** label? */
3529
+ color?: Json; /** an id */
3530
+ item?: number;
3531
+ markers?: boolean;
3532
+ name?: string;
3533
+ };
3534
+ /** Place Sounds. Places several sounds as one undo step: each of `items` ({item, frame | seconds, gainDb or volume, fadeInFrames/fadeInSeconds, fadeOutFrames/fadeOutSeconds, durationFrames/durationSeconds}) goes on the first audio track with no clip in its span (a new track below the others when none has room), so sounds never overwrite each other. `alignPeak: true` starts the clip at frame ? the sound's peak lag (its loudest sample, from the decoded audio), so a whoosh's or impact's hit lands on the frame; a head before 0 is dropped. Fades are Constant Gain audio transitions on the clip's edges. Answers `placed`: [{clips, audioTrack ("A3"), frame (clip start), peakFrame, peakLagFrames, gainDb}]. Params: {"items":[{"item":id,"frame":i64|"seconds":f64,"gainDb":f64=0|"volume":f64?,"fadeInFrames":f64?|"fadeInSeconds":f64?,"fadeOutFrames":f64?|"fadeOutSeconds":f64?,"durationFrames":f64?|"durationSeconds":f64?,"alignPeak":bool=false}],"tracks":"auto"="auto"}. Reads the part, time. Changes the document. */
3535
+ "timeline.placeMany": {
3536
+ items?: Array<{
3537
+ alignPeak?: boolean;
3538
+ durationFrames?: number;
3539
+ durationSeconds?: number;
3540
+ fadeInFrames?: number;
3541
+ fadeInSeconds?: number;
3542
+ fadeOutFrames?: number;
3543
+ fadeOutSeconds?: number;
3544
+ frame?: number;
3545
+ gainDb?: number;
3546
+ item?: number;
3547
+ seconds?: number;
3548
+ volume?: number;
3549
+ }>; /** like auto */
3550
+ tracks?: string;
3551
+ };
3552
+ /** Sound Phrase. Builds a stock sound phrase at `frame` (or `seconds`) from sound items the caller imported, as one undo step, each sound peak-aligned (its loudest sample on the frame) on the first free audio track: `closing` = items.riser starting at the frame (0.5), items.impact peaking `impactAfterFrames` (35) later at 0.55 (keep it the loudest sound, at most three such hits a film), items.sparkle `sparkleAfterFrames` (25) after the impact at 0.3; `titleIn` = items.swoosh 0.4; `sceneIn` = items.transition 0.4; `click` = items.click 0.6; `hitRun` = `count` (6) hits alternating items.hit / items.hitAlt, volume stepping 0.40 ? 0.25, spacing from `spacingFrames` (5) to `endSpacingFrames`; hits closer than 3 frames blur, so items.swoosh plays once over the run instead. `gainOffsetDb` shifts every gain. Answers `placed` as timeline.placeMany. Params: {"preset":"closing"|"titleIn"|"sceneIn"|"click"|"hitRun","frame":i64|"seconds":f64,"items":{"riser":id,"impact":id,"sparkle":id?}|{"swoosh":id}|{"transition":id}|{"click":id}|{"hit":id,"hitAlt":id?,"swoosh":id?},"count":i64=6 (hitRun),"spacingFrames":f64=5 (hitRun),"endSpacingFrames":f64? (hitRun),"impactAfterFrames":f64=35 (closing),"sparkleAfterFrames":f64=25 (closing),"gainOffsetDb":f64=0}. Reads the part, time. Changes the document. */
3553
+ "sound.phrase": {
3554
+ count?: number; /** hitRun */
3555
+ endSpacingFrames?: number; /** one of several alternative parameters */
3556
+ frame?: number;
3557
+ gainOffsetDb?: number; /** closing */
3558
+ impactAfterFrames?: number;
3559
+ items?: {
3560
+ click?: number;
3561
+ hit?: number;
3562
+ hitAlt?: number;
3563
+ impact?: number;
3564
+ riser?: number;
3565
+ sparkle?: number;
3566
+ swoosh?: number;
3567
+ transition?: number;
3568
+ };
3569
+ preset?: "closing" | "titleIn" | "sceneIn" | "click" | "hitRun"; /** one of several alternative parameters */
3570
+ seconds?: number; /** hitRun */
3571
+ spacingFrames?: number; /** closing */
3572
+ sparkleAfterFrames?: number; /** the time, in ticks (one spelling of it) */
3573
+ time?: number; /** the time, as a timecode (one spelling of it) */
3574
+ timecode?: string;
3575
+ };
3576
+ /** Beat Cut Transitions. Cuts picture on the beat as one undo step: puts a video transition centred on every cut between two clips that lies within `toleranceFrames` (1) of a beat of the sequence's music (or of a sequence marker when no audio clip has a beat; `onBeat: false` takes every cut), or only on the cuts into `clips`, or at the `at` frames (taken as given). `effect` is whip, flash, push, crossZoom, cut (no transition, sound only) or any video transition id, or a list used in turn; `frames` sets the length (whip 8, flash 6, push 10, crossZoom 10); `params` are transition parameters, each effect taking the ones it has (booleans for amounts such as motion_blur, left/right/up/down for direction). `sfx` (a sound item or a list used in turn) drops a whoosh or impact peak-aligned to each cut at `sfxGainDb` (?6.9 dB, ?0.45) on a free audio track. Answers `cuts` [{frame, track, effect, transition, frames, sfx}] and `skipped` cuts with the reason. Params: {"clips":[id]? (cuts into these clips)|"at":[frame]? (cuts at these frames),"effect":"whip"|"flash"|"push"|"crossZoom"|"cut"|id|[names, used in turn]="whip","frames":i64? (whip 8, flash 6, push 10, crossZoom 10),"params":{param:value}?,"sfx":id|[id, used in turn]?,"sfxGainDb":f64=-6.9|"sfxVolume":f64?,"toleranceFrames":i64=1,"onBeat":bool=true}. Acts on `clips`. Reads the part. Changes the document. */
3577
+ "transition.beatCut": {
3578
+ at?: Array<number>; /** cuts into these clips; one of several alternative parameters */
3579
+ clips?: Array<number>; /** "whip"|"flash"|"push"|"crossZoom"|"cut"|id|[names, used in turn]="whip"; default "whip" */
3580
+ effect?: Json; /** whip 8, flash 6, push 10, crossZoom 10 */
3581
+ frames?: number;
3582
+ onBeat?: boolean;
3583
+ params?: {
3584
+ param?: Json;
3585
+ }; /** project sound item id, or ids used in turn */
3586
+ sfx?: Json; /** one of several alternative parameters */
3587
+ sfxGainDb?: number; /** one of several alternative parameters */
3588
+ sfxVolume?: number;
3589
+ toleranceFrames?: number;
3590
+ };
3591
+ /** Music Bed. Lays music under the film as one undo step: an audio `clip`, or a project `item` placed from `frame`/`seconds` (0) to the end of the picture on the first free audio track. Sets clip gain `gainDb` (?9.4, ?0.34 linear; or `volume`) and Constant Gain fades of `fadeInSeconds` (1) and `fadeOutSeconds` (1.7); `duck` {against: dialogue (or sfx, ambience, a list), reduceDb, sensitivity, fadeSeconds} makes it Music, sets its ducking and generates the ducking keyframes. Answers {clips, audioTrack, gainDb, frames [start, end], ducking regions}. Params: {"clip":id?|"item":id? (placed from frame/seconds, default 0, to the end of the picture),"frame":i64?|"seconds":f64?,"gainDb":f64=-9.4|"volume":f64?,"fadeInSeconds":f64=1,"fadeOutSeconds":f64=1.7,"duck":{"against":"dialogue"|"sfx"|...|[types]="dialogue","reduceDb":f64=-15,"sensitivity":0..10?,"fadeSeconds":f64?}?}. Reads the part, time, mode. Changes the document. */
3592
+ "audio.bed": {
3593
+ clip?: number; /** {"against":"dialogue"|"sfx"|...|[types]="dialogue","reduceDb":f64=-15,"sensitivity":0..10?,"fadeSeconds":f64?}? */
3594
+ duck?: {
3595
+ against?: Json;
3596
+ fadeSeconds?: number;
3597
+ reduceDb?: number;
3598
+ sensitivity?: number;
3599
+ };
3600
+ fadeInSeconds?: number;
3601
+ fadeOutSeconds?: number; /** one of several alternative parameters */
3602
+ frame?: number; /** one of several alternative parameters */
3603
+ gainDb?: number; /** an id; placed from frame/seconds, default 0, to the end of the picture; one of several alternative parameters */
3604
+ item?: number; /** one of several alternative parameters */
3605
+ seconds?: number; /** the time, in ticks (one spelling of it) */
3606
+ time?: number; /** the time, as a timecode (one spelling of it) */
3607
+ timecode?: string; /** one of several alternative parameters */
3608
+ volume?: number;
3609
+ };
3610
+ /** Voice-Over Record Settings. Reads or changes the Voice-Over Record Settings preferences: source device, input channel, take `name`, countdown cues, pre-roll and post-roll seconds (0?60). Answers the settings and the input devices. Params: {"source":str?,"inputChannel":n?,"name":str?,"countdownSoundCues":bool?,"prerollSeconds":f64?,"postrollSeconds":f64?}. Reads the mode. Changes the document. */
3611
+ "audio.voiceover.settings": {
3612
+ countdownSoundCues?: boolean;
3613
+ inputChannel?: number;
3614
+ name?: string; /** the postroll duration, in ticks (one spelling of it) */
3615
+ postroll?: number; /** the postroll duration, in frames (one spelling of it) */
3616
+ postrollFrames?: number;
3617
+ postrollSeconds?: number; /** the preroll duration, in ticks (one spelling of it) */
3618
+ preroll?: number; /** the preroll duration, in frames (one spelling of it) */
3619
+ prerollFrames?: number;
3620
+ prerollSeconds?: number;
3621
+ source?: string;
3622
+ };
3623
+ /** Start Voice-over Recording. Arms and starts a voice-over take at the playhead or `time` (the sequence In point when In/Out are set), on `track` or the record-armed/targeted audio track; `preroll` overrides the pre-roll. Answers the record, capture and punch-out times. Params: {"track":"A1"|id?,"time":ticks?,"preroll":seconds?}. Reads the part, time, active. Changes the document. */
3624
+ "audio.voiceover.start": {
3625
+ preroll?: number; /** the preroll duration, in frames (one spelling of it) */
3626
+ prerollFrames?: number; /** the preroll duration, in seconds (one spelling of it) */
3627
+ prerollSeconds?: number; /** ticks (254016000000 per second) */
3628
+ time?: number; /** "A1"|id? */
3629
+ track?: Json;
3630
+ };
3631
+ /** Sync Voice-over Capture. Tells the recorder that host playback actually started at `time`, so capture restarts there and the take lands sample-accurately. Call after audio.voiceover.start once playback runs. Params: {"time":ticks?}. Reads the part, time. Changes the document. */
3632
+ "audio.voiceover.sync": {
3633
+ time?: number;
3634
+ };
3635
+ /** Stop Voice-over Recording. Stops the voice-over take and, as one undo step, writes it to `<Name> n.wav` (in `dir` or the captured-media folder), imports it and places it on the record track at the record point. `discard: true` drops the take instead. Params: {"time":ticks?,"dir":str?,"discard":bool?}. Reads the part, time. Changes the document. */
3636
+ "audio.voiceover.stop": {
3637
+ dir?: Json;
3638
+ discard?: boolean; /** ticks (254016000000 per second) */
3639
+ time?: number;
3640
+ };
3641
+ /** Go to Next Edit Point on Any Track. Moves the playhead to the next edit point on any track, regardless of track targeting. Params: {}. Reads the part, time, mode, active. Changes the document. */
3642
+ "playhead.nextEditAnyTrack": Record<string, never>;
3643
+ /** Go to Previous Edit Point on Any Track. Moves the playhead to the previous edit point on any track, regardless of track targeting. Params: {}. Reads the part, time, mode, active. Changes the document. */
3644
+ "playhead.prevEditAnyTrack": Record<string, never>;
3645
+ /** Go to Selected Clip Start. Moves the playhead to the first frame of the selected clips. Needs a clip selection. Answers {time}. Params: {}. Reads the part, selection, time, mode, active. Changes the document. */
3646
+ "playhead.selectedClipStart": Record<string, never>;
3647
+ /** Go to Selected Clip End. Moves the playhead to the last frame of the selected clips (the frame before their out edge). Needs a clip selection. Answers {time}. Params: {}. Reads the part, selection, time, mode, active. Changes the document. */
3648
+ "playhead.selectedClipEnd": Record<string, never>;
3649
+ /** Reveal Nested Sequence. Opens the nested sequence of the selected (or topmost targeted) nested clip with its playhead on the matching frame. Params: {}. Reads the part, selection, time, mode, active. Changes the document. */
3650
+ "sequence.revealNested": Record<string, never>;
3651
+ /** Select Clip at Playhead. Selects the clips under the playhead on the targeted tracks. Params: {}. Reads the part, selection, time, mode, active. Changes the document. */
3652
+ "timeline.selectClipAtPlayhead": Record<string, never>;
3653
+ /** Select Next Clip. Selects the clip after each selected clip on its track; with nothing selected, the clips at the playhead on targeted tracks. Params: {}. Reads the part, selection, time, mode, active. Changes the document. */
3654
+ "timeline.selectNextClip": Record<string, never>;
3655
+ /** Select Previous Clip. Selects the clip before each selected clip on its track; with nothing selected, the clips at the playhead on targeted tracks. Params: {}. Reads the part, selection, time, mode, active. Changes the document. */
3656
+ "timeline.selectPrevClip": Record<string, never>;
3657
+ /** Extend Previous Edit To Playhead. On each targeted, unlocked track, moves the nearest edit before the playhead forward to the playhead: a cut between clips rolls, an edge beside a gap trims; nothing ripples. Params: {}. Reads the part, time, active. Changes the document. */
3658
+ "trim.extendPreviousEdit": Record<string, never>;
3659
+ /** Extend Next Edit To Playhead. On each targeted, unlocked track, moves the nearest edit after the playhead back to the playhead: a cut between clips rolls, an edge beside a gap trims; nothing ripples. Params: {}. Reads the part, time, active. Changes the document. */
3660
+ "trim.extendNextEdit": Record<string, never>;
3661
+ /** Nudge Clip Selection Left One Frame. Moves the selected clips (with linked partners) one frame earlier, overwriting what they land on. Params: {}. Reads the part, selection, mode. Changes the document. */
3662
+ "timeline.nudgeLeft": Record<string, never>;
3663
+ /** Nudge Clip Selection Right One Frame. Moves the selected clips (with linked partners) one frame later, overwriting what they land on. Params: {}. Reads the part, selection, mode. Changes the document. */
3664
+ "timeline.nudgeRight": Record<string, never>;
3665
+ /** Nudge Clip Selection Left Five Frames. Moves the selected clips (with linked partners) five frames earlier, overwriting what they land on. Params: {}. Reads the part, selection, mode. Changes the document. */
3666
+ "timeline.nudgeLeft5": Record<string, never>;
3667
+ /** Nudge Clip Selection Right Five Frames. Moves the selected clips (with linked partners) five frames later, overwriting what they land on. Params: {}. Reads the part, selection, mode. Changes the document. */
3668
+ "timeline.nudgeRight5": Record<string, never>;
3669
+ /** Nudge Clip Selection Up. Moves the selected clips (with linked partners) one track up as displayed (video to V(n+1), audio to A(n-1)), overwriting there. Params: {}. Reads the part, selection. Changes the document. */
3670
+ "timeline.nudgeUp": Record<string, never>;
3671
+ /** Nudge Clip Selection Down. Moves the selected clips (with linked partners) one track down as displayed (video to V(n-1), audio to A(n+1)), overwriting there. Params: {}. Reads the part, selection. Changes the document. */
3672
+ "timeline.nudgeDown": Record<string, never>;
3673
+ /** Slip Clip Selection Left One Frame. Slips the selected clips' content one frame (shows later source frames) without moving them. Params: {}. Reads the part, selection, mode. Changes the document. */
3674
+ "timeline.slipLeft": Record<string, never>;
3675
+ /** Slip Clip Selection Right One Frame. Slips the selected clips' content one frame back (earlier source frames) without moving them. Params: {}. Reads the part, selection, mode. Changes the document. */
3676
+ "timeline.slipRight": Record<string, never>;
3677
+ /** Slip Clip Selection Left Five Frames. Slips the selected clips' content five frames (later source frames) without moving them. Params: {}. Reads the part, selection, mode. Changes the document. */
3678
+ "timeline.slipLeft5": Record<string, never>;
3679
+ /** Slip Clip Selection Right Five Frames. Slips the selected clips' content five frames back (earlier source frames) without moving them. Params: {}. Reads the part, selection, mode. Changes the document. */
3680
+ "timeline.slipRight5": Record<string, never>;
3681
+ /** Slide Clip Selection Left One Frame. Slides the selected clips one frame earlier, trimming their neighbours (Slide tool). Params: {}. Reads the part, selection, mode. Changes the document. */
3682
+ "timeline.slideLeft": Record<string, never>;
3683
+ /** Slide Clip Selection Right One Frame. Slides the selected clips one frame later, trimming their neighbours. Params: {}. Reads the part, selection, mode. Changes the document. */
3684
+ "timeline.slideRight": Record<string, never>;
3685
+ /** Slide Clip Selection Left Five Frames. Slides the selected clips five frames earlier, trimming their neighbours. Params: {}. Reads the part, selection, mode. Changes the document. */
3686
+ "timeline.slideLeft5": Record<string, never>;
3687
+ /** Slide Clip Selection Right Five Frames. Slides the selected clips five frames later, trimming their neighbours. Params: {}. Reads the part, selection, mode. Changes the document. */
3688
+ "timeline.slideRight5": Record<string, never>;
3689
+ /** Toggle All Video Targets. Targets all video tracks, or untargets them all if they already are. Params: {}. Reads the part, active. Changes the document. */
3690
+ "timeline.toggleAllVideoTargets": Record<string, never>;
3691
+ /** Toggle All Audio Targets. Targets all audio tracks, or untargets them all if they already are. Params: {}. Reads the part, active. Changes the document. */
3692
+ "timeline.toggleAllAudioTargets": Record<string, never>;
3693
+ /** Toggle All Source Video. Turns source patching on for all video tracks, or off if it already is. Params: {}. Reads the part, active. Changes the document. */
3694
+ "timeline.toggleAllSourceVideo": Record<string, never>;
3695
+ /** Toggle All Source Audio. Turns source patching on for all audio tracks, or off if it already is. Params: {}. Reads the part, active. Changes the document. */
3696
+ "timeline.toggleAllSourceAudio": Record<string, never>;
3697
+ /** Move All Video Targets Up. Moves every video track target up by one track. Params: {}. Reads the part, active. Changes the document. */
3698
+ "timeline.moveVideoTargetsUp": Record<string, never>;
3699
+ /** Move All Video Targets Down. Moves every video track target down by one track. Params: {}. Reads the part, active. Changes the document. */
3700
+ "timeline.moveVideoTargetsDown": Record<string, never>;
3701
+ /** Move All Audio Targets Up. Moves every audio track target up by one track. Params: {}. Reads the part, active. Changes the document. */
3702
+ "timeline.moveAudioTargetsUp": Record<string, never>;
3703
+ /** Move All Audio Targets Down. Moves every audio track target down by one track. Params: {}. Reads the part, active. Changes the document. */
3704
+ "timeline.moveAudioTargetsDown": Record<string, never>;
3705
+ /** Toggle Mute for All Targeted Audio Tracks. Toggles mute on every targeted audio track. Params: {}. Reads the part, active. Changes the document. */
3706
+ "timeline.toggleMuteTargetedAudio": Record<string, never>;
3707
+ /** Toggle Solo for All Targeted Audio Tracks. Toggles solo on every targeted audio track. Params: {}. Reads the part, active. Changes the document. */
3708
+ "timeline.toggleSoloTargetedAudio": Record<string, never>;
3709
+ /** Toggle Track Output for All Targeted Video Tracks. Toggles track output (visibility) of every targeted video track. Params: {}. Reads the part, active. Changes the document. */
3710
+ "timeline.toggleOutputTargetedVideo": Record<string, never>;
3711
+ /** Increase Clip Volume. Raises the Volume level of the selected audio clips by 1 dB. Params: {}. Reads the part, selection, mode. Changes the document. */
3712
+ "clip.volumeUp": Record<string, never>;
3713
+ /** Decrease Clip Volume. Lowers the Volume level of the selected audio clips by 1 dB. Params: {}. Reads the part, selection, mode. Changes the document. */
3714
+ "clip.volumeDown": Record<string, never>;
3715
+ /** Increase Clip Volume Many. Raises the Volume level of the selected audio clips by the Large Volume Adjustment preference. Params: {}. Reads the part, selection, mode. Changes the document. */
3716
+ "clip.volumeUpMany": Record<string, never>;
3717
+ /** Decrease Clip Volume Many. Lowers the Volume level of the selected audio clips by the Large Volume Adjustment preference. Params: {}. Reads the part, selection, mode. Changes the document. */
3718
+ "clip.volumeDownMany": Record<string, never>;
3719
+ /** Nudge Volume +1dB. Raises the Volume level of the selected audio clips by 1 dB (keyframed levels shift as a whole). Params: {}. Reads the part, selection, mode. Changes the document. */
3720
+ "clip.nudgeVolumeUp1": Record<string, never>;
3721
+ /** Nudge Volume +3dB. Raises the Volume level of the selected audio clips by 3 dB (keyframed levels shift as a whole). Params: {}. Reads the part, selection, mode. Changes the document. */
3722
+ "clip.nudgeVolumeUp3": Record<string, never>;
3723
+ /** Nudge Volume -1dB. Lowers the Volume level of the selected audio clips by 1 dB (keyframed levels shift as a whole). Params: {}. Reads the part, selection, mode. Changes the document. */
3724
+ "clip.nudgeVolumeDown1": Record<string, never>;
3725
+ /** Nudge Volume -3dB. Lowers the Volume level of the selected audio clips by 3 dB (keyframed levels shift as a whole). Params: {}. Reads the part, selection, mode. Changes the document. */
3726
+ "clip.nudgeVolumeDown3": Record<string, never>;
3727
+ /** Toggle Audio During Scrubbing. Turns audio during scrubbing on or off (the audio.scrubAudio preference). Answers {scrubAudio}. Params: {}. Reads the mode. Changes the document. */
3728
+ "audio.toggleScrubbing": Record<string, never>;
3729
+ /** Increase Font Size by One Unit. Increases the font size of the selected text layers by 1 px. Params: {}. Reads the part, selection, time, active. Changes the document. */
3730
+ "graphics.fontSizeUp": Record<string, never>;
3731
+ /** Decrease Font Size by One Unit. Decreases the font size of the selected text layers by 1 px. Params: {}. Reads the part, selection, time, active. Changes the document. */
3732
+ "graphics.fontSizeDown": Record<string, never>;
3733
+ /** Increase Font Size by Five Units. Increases the font size of the selected text layers by 5 px. Params: {}. Reads the part, selection, time, active. Changes the document. */
3734
+ "graphics.fontSizeUp5": Record<string, never>;
3735
+ /** Decrease Font Size by Five Units. Decreases the font size of the selected text layers by 5 px. Params: {}. Reads the part, selection, time, active. Changes the document. */
3736
+ "graphics.fontSizeDown5": Record<string, never>;
3737
+ /** Increase Leading by One Unit. Increases line spacing (leading) of the selected text layers by 1. Params: {}. Reads the part, selection, time, active. Changes the document. */
3738
+ "graphics.leadingUp": Record<string, never>;
3739
+ /** Decrease Leading by One Unit. Decreases line spacing (leading) of the selected text layers by 1. Params: {}. Reads the part, selection, time, active. Changes the document. */
3740
+ "graphics.leadingDown": Record<string, never>;
3741
+ /** Increase Leading by Five Units. Increases line spacing (leading) of the selected text layers by 5. Params: {}. Reads the part, selection, time, active. Changes the document. */
3742
+ "graphics.leadingUp5": Record<string, never>;
3743
+ /** Decrease Leading by Five Units. Decreases line spacing (leading) of the selected text layers by 5. Params: {}. Reads the part, selection, time, active. Changes the document. */
3744
+ "graphics.leadingDown5": Record<string, never>;
3745
+ /** Left align text. Left-aligns the text of the selected graphic text layers. Params: {}. Reads the part, selection, time, active. Changes the document. */
3746
+ "graphics.alignTextLeft": Record<string, never>;
3747
+ /** Center align text. Center-aligns the text of the selected graphic text layers. Params: {}. Reads the part, selection, time, active. Changes the document. */
3748
+ "graphics.alignTextCenter": Record<string, never>;
3749
+ /** Right align text. Right-aligns the text of the selected graphic text layers. Params: {}. Reads the part, selection, time, active. Changes the document. */
3750
+ "graphics.alignTextRight": Record<string, never>;
3751
+ /** Nudge Selected Object to left by one. Moves the selected graphic layers (or the selected video clips' Motion position) left 1 px. Params: {}. Reads the part, selection, time, active. Changes the document. */
3752
+ "graphics.nudgeLeft": Record<string, never>;
3753
+ /** Nudge Selected Object to right by one. Moves the selected graphic layers (or the selected video clips' Motion position) right 1 px. Params: {}. Reads the part, selection, time, active. Changes the document. */
3754
+ "graphics.nudgeRight": Record<string, never>;
3755
+ /** Nudge Selected Object up by one. Moves the selected graphic layers (or the selected video clips' Motion position) up 1 px. Params: {}. Reads the part, selection, time, active. Changes the document. */
3756
+ "graphics.nudgeUp": Record<string, never>;
3757
+ /** Nudge Selected Object down by one. Moves the selected graphic layers (or the selected video clips' Motion position) down 1 px. Params: {}. Reads the part, selection, time, active. Changes the document. */
3758
+ "graphics.nudgeDown": Record<string, never>;
3759
+ /** Nudge Selected Object to left by five. Moves the selected graphic layers (or the selected video clips' Motion position) left 5 px. Params: {}. Reads the part, selection, time, active. Changes the document. */
3760
+ "graphics.nudgeLeft5": Record<string, never>;
3761
+ /** Nudge Selected Object to right by five. Moves the selected graphic layers (or the selected video clips' Motion position) right 5 px. Params: {}. Reads the part, selection, time, active. Changes the document. */
3762
+ "graphics.nudgeRight5": Record<string, never>;
3763
+ /** Nudge Selected Object up by five. Moves the selected graphic layers (or the selected video clips' Motion position) up 5 px. Params: {}. Reads the part, selection, time, active. Changes the document. */
3764
+ "graphics.nudgeUp5": Record<string, never>;
3765
+ /** Nudge Selected Object down by five. Moves the selected graphic layers (or the selected video clips' Motion position) down 5 px. Params: {}. Reads the part, selection, time, active. Changes the document. */
3766
+ "graphics.nudgeDown5": Record<string, never>;
3767
+ /** Export Frame. Writes one frame to an image file at `path` (`format` png|jpeg|tiff|bmp, `depth` 8 or 16) from the program (or Source monitor with target "source") at `time`; `import` adds it to the project. Params: {"path":str?,"format":"png|jpeg|tiff|bmp"?,"depth":8|16?,"import":bool?,"target":"source|program"?,"item":id?,"sequence":id?,"time":ticks?}. Acts on `item`. Reads the part, time, active. Changes the document. */
3768
+ "file.exportFrame": {
3769
+ depth?: 8 | 16;
3770
+ format?: "png" | "jpeg" | "tiff" | "bmp";
3771
+ import?: boolean; /** an id */
3772
+ item?: number;
3773
+ path?: Json; /** an id */
3774
+ sequence?: number;
3775
+ target?: "source" | "program"; /** ticks (254016000000 per second) */
3776
+ time?: number;
3777
+ };
3778
+ /** Set Poster Frame. Sets a project `item`'s poster (thumbnail) frame to `time` or its Source playhead. Params: {"item":id?,"time":ticks?}. Acts on `item`. Reads the part, selection, time, active. Changes the document. */
3779
+ "clip.setPosterFrame": {
3780
+ item?: number; /** ticks (254016000000 per second) */
3781
+ time?: number;
3782
+ };
3783
+ /** Clear Poster Frame. Clears the poster frame of a project `item` (default selected), so its thumbnail returns to the first frame. Params: {"item":id?}. Acts on `item`. Reads the selection, active. Changes the document. */
3784
+ "clip.clearPosterFrame": {
3785
+ item?: number;
3786
+ };
3787
+ /** Toggle Target Video 1. Toggles track targeting of video track V1. Params: {}. Reads the part, active. Changes the document. */
3788
+ "timeline.toggleTargetV1": Record<string, never>;
3789
+ /** Toggle Target Video 2. Toggles track targeting of video track V2. Params: {}. Reads the part, active. Changes the document. */
3790
+ "timeline.toggleTargetV2": Record<string, never>;
3791
+ /** Toggle Target Video 3. Toggles track targeting of video track V3. Params: {}. Reads the part, active. Changes the document. */
3792
+ "timeline.toggleTargetV3": Record<string, never>;
3793
+ /** Toggle Target Video 4. Toggles track targeting of video track V4. Params: {}. Reads the part, active. Changes the document. */
3794
+ "timeline.toggleTargetV4": Record<string, never>;
3795
+ /** Toggle Target Video 5. Toggles track targeting of video track V5. Params: {}. Reads the part, active. Changes the document. */
3796
+ "timeline.toggleTargetV5": Record<string, never>;
3797
+ /** Toggle Target Video 6. Toggles track targeting of video track V6. Params: {}. Reads the part, active. Changes the document. */
3798
+ "timeline.toggleTargetV6": Record<string, never>;
3799
+ /** Toggle Target Video 7. Toggles track targeting of video track V7. Params: {}. Reads the part, active. Changes the document. */
3800
+ "timeline.toggleTargetV7": Record<string, never>;
3801
+ /** Toggle Target Video 8. Toggles track targeting of video track V8. Params: {}. Reads the part, active. Changes the document. */
3802
+ "timeline.toggleTargetV8": Record<string, never>;
3803
+ /** Toggle Target Audio 1. Toggles track targeting of audio track A1. Params: {}. Reads the part, active. Changes the document. */
3804
+ "timeline.toggleTargetA1": Record<string, never>;
3805
+ /** Toggle Target Audio 2. Toggles track targeting of audio track A2. Params: {}. Reads the part, active. Changes the document. */
3806
+ "timeline.toggleTargetA2": Record<string, never>;
3807
+ /** Toggle Target Audio 3. Toggles track targeting of audio track A3. Params: {}. Reads the part, active. Changes the document. */
3808
+ "timeline.toggleTargetA3": Record<string, never>;
3809
+ /** Toggle Target Audio 4. Toggles track targeting of audio track A4. Params: {}. Reads the part, active. Changes the document. */
3810
+ "timeline.toggleTargetA4": Record<string, never>;
3811
+ /** Toggle Target Audio 5. Toggles track targeting of audio track A5. Params: {}. Reads the part, active. Changes the document. */
3812
+ "timeline.toggleTargetA5": Record<string, never>;
3813
+ /** Toggle Target Audio 6. Toggles track targeting of audio track A6. Params: {}. Reads the part, active. Changes the document. */
3814
+ "timeline.toggleTargetA6": Record<string, never>;
3815
+ /** Toggle Target Audio 7. Toggles track targeting of audio track A7. Params: {}. Reads the part, active. Changes the document. */
3816
+ "timeline.toggleTargetA7": Record<string, never>;
3817
+ /** Toggle Target Audio 8. Toggles track targeting of audio track A8. Params: {}. Reads the part, active. Changes the document. */
3818
+ "timeline.toggleTargetA8": Record<string, never>;
3819
+ /** Project Panel View. Reads the Project panel view: list/icon/freeform, icon and font size, preview area, thumbnails, the shown columns and every available column. Params: {}. */
3820
+ "project.view.get": Record<string, never>;
3821
+ /** Set Project Panel View. Sets the Project panel view: `view` list|icon|freeform, icon size, font size, preview area, thumbnails and hover scrub. Params: {"view":"list|icon|freeform"?,"iconSize":f32?,"fontSize":"small|medium|large|extraLarge"?,"previewArea":bool?,"thumbnails":bool?,"thumbnailsShowEffects":bool?,"hoverScrub":bool?,"thumbnailControlsAllDevices":bool?,"iconSort":column|{"column":str,"descending":bool}?}. Reads the mode. Changes the document. */
3822
+ "project.view.set": {
3823
+ fontSize?: "small" | "medium" | "large" | "extraLarge";
3824
+ hoverScrub?: boolean;
3825
+ iconSize?: number; /** column|{"column":str,"descending":bool}? */
3826
+ iconSort?: Json;
3827
+ previewArea?: boolean;
3828
+ thumbnailControlsAllDevices?: boolean;
3829
+ thumbnails?: boolean;
3830
+ thumbnailsShowEffects?: boolean;
3831
+ view?: "list" | "icon" | "freeform";
3832
+ };
3833
+ /** List Project Columns. Lists every Project panel column (built-ins plus metadata fields found on items) and whether each is shown, in display order with widths. Params: {}. */
3834
+ "project.columns.list": Record<string, never>;
3835
+ /** Metadata Display. Sets which Project panel columns show and in what order: `columns` is a list of names or {name, width}. Params: {"columns":[name|{"name":str,"width":f32}]}. Reads the mode. Changes the document. */
3836
+ "project.columns.set": {
3837
+ columns?: Array<Json>;
3838
+ };
3839
+ /** Resize Column. Sets the width of one Project panel `column` to `width` pixels. View setting only. Params: {"column":str,"width":f32}. Reads the mode. Changes the document. */
3840
+ "project.columns.resize": {
3841
+ column?: string;
3842
+ width?: number;
3843
+ };
3844
+ /** Sort Project Items. Sorts the Project panel List view by `column` (`descending` reverses). View setting only. Params: {"column":str,"descending":bool?}. Reads the mode. Changes the document. */
3845
+ "project.sort": {
3846
+ column?: string;
3847
+ descending?: boolean;
3848
+ };
3849
+ /** List Project Panel Rows. Lists the rows the Project panel shows for `bin` (default root; `recursive` for sub-bins), sorted, with each shown column's text. Params: {"bin":binId?,"recursive":bool?,"order":"icon"?}. */
3850
+ "project.items": {
3851
+ bin?: number; /** like icon */
3852
+ order?: string;
3853
+ recursive?: boolean;
3854
+ };
3855
+ /** List View Presets. Lists the saved Project panel view presets (slots 1?10) and the current one. Params: {}. */
3856
+ "project.viewPreset.list": Record<string, never>;
3857
+ /** Save Current View Preset. Saves the current Project panel view over the current preset (or `slot`) with `name`. Params: {"slot":1..10?,"name":str?}. Reads the mode. Changes the document. */
3858
+ "project.viewPreset.save": {
3859
+ name?: string; /** 1 to 10 */
3860
+ slot?: number;
3861
+ };
3862
+ /** Save As New View Preset. Saves the current Project panel view as a new preset in `slot` (default the first free) named `name`. Params: {"name":str?,"slot":1..10?}. Reads the mode. Changes the document. */
3863
+ "project.viewPreset.saveAs": {
3864
+ name?: string; /** 1 to 10 */
3865
+ slot?: number;
3866
+ };
3867
+ /** Restore View Preset. Applies the Project panel view preset in `slot` (1?10). Params: {"slot":1..10}. Reads the mode. Changes the document. */
3868
+ "project.viewPreset.restore": {
3869
+ slot?: number;
3870
+ };
3871
+ /** Rename View Preset. Renames the Project panel view preset in `slot` to `name`. Params: {"slot":1..10,"name":str}. Reads the mode. Changes the document. */
3872
+ "project.viewPreset.rename": {
3873
+ name?: string; /** 1 to 10 */
3874
+ slot?: number;
3875
+ };
3876
+ /** Delete View Preset. Deletes the Project panel view preset in `slot` (1?10). Params: {"slot":1..10}. Reads the mode. Changes the document. */
3877
+ "project.viewPreset.delete": {
3878
+ slot?: number;
3879
+ };
3880
+ /** Freeform Layout. Reads the Freeform card positions and sizes of `bin`'s items (auto-placed ones included) for a panel `width`. Params: {"bin":binId?,"width":f32?}. */
3881
+ "project.freeform.layout": {
3882
+ bin?: number;
3883
+ width?: number;
3884
+ };
3885
+ /** Move Clip Cards. Moves Freeform clip cards: the listed or selected `items` to (`x`, `y`), or per-item positions; `snap` aligns to the grid. Undoable. Params: {"items":[id]?,"x":f32,"y":f32,"snap":bool?,"width":f32?} | {"positions":{"<id>":[x,y]},"width":f32?}. Acts on `items`. Reads the selection, mode. Changes the document. */
3886
+ "project.freeform.move": {
3887
+ items?: Array<number>; /** in one of several forms of the parameters */
3888
+ positions?: {
3889
+ [key: string]: Json;
3890
+ }; /** in one of several forms of the parameters */
3891
+ snap?: boolean; /** in one of several forms of the parameters */
3892
+ width?: number; /** in one of several forms of the parameters */
3893
+ x?: number; /** in one of several forms of the parameters */
3894
+ y?: number;
3895
+ };
3896
+ /** Clip Size. Sets the card size of the listed or selected `items` in Freeform view. Params: {"items":[id]?,"size":f32?,"step":1|-1?,"width":f32?}. Acts on `items`. Reads the selection, mode. Changes the document. */
3897
+ "project.freeform.resize": {
3898
+ items?: Array<number>;
3899
+ size?: number;
3900
+ step?: 1 | -1;
3901
+ width?: number;
3902
+ };
3903
+ /** Align to Grid. Snaps the clip cards of `bin` (default root) in Freeform view to a `grid` of the given spacing; undoable. Params: {"bin":binId?,"grid":f32?,"width":f32?}. Reads the mode. Changes the document. */
3904
+ "project.freeform.alignToGrid": {
3905
+ bin?: number;
3906
+ grid?: number;
3907
+ width?: number;
3908
+ };
3909
+ /** Reset to Grid. Resets `bin`'s Freeform cards to the default grid layout, dropping manual positions. Params: {"bin":binId?,"width":f32?}. Reads the mode. Changes the document. */
3910
+ "project.freeform.reset": {
3911
+ bin?: number;
3912
+ width?: number;
3913
+ };
3914
+ /** Stack Clips. Groups the listed or selected `items` into one stack in Freeform view. Params: {"items":[id]?,"width":f32?}. Acts on `items`. Reads the selection, mode. Changes the document. */
3915
+ "project.freeform.stack": {
3916
+ item?: number;
3917
+ items?: Array<number>;
3918
+ width?: number;
3919
+ };
3920
+ /** Unstack Clips. Splits the stack holding the listed or selected `items` back into separate cards. Params: {"items":[id]?,"width":f32?}. Acts on `items`. Reads the selection, mode. Changes the document. */
3921
+ "project.freeform.unstack": {
3922
+ item?: number;
3923
+ items?: Array<number>;
3924
+ width?: number;
3925
+ };
3926
+ /** Save Arrangement. Saves the current Freeform card positions of `bin` as arrangement `name`. Params: {"name":str,"bin":binId?,"width":f32?}. Reads the mode. Changes the document. */
3927
+ "project.freeform.saveArrangement": {
3928
+ bin?: number;
3929
+ name?: string;
3930
+ width?: number;
3931
+ };
3932
+ /** Restore Arrangement. Restores the saved Freeform arrangement `name` of `bin`, moving the cards back. Params: {"name":str,"bin":binId?,"width":f32?}. Changes the document. */
3933
+ "project.freeform.restoreArrangement": {
3934
+ bin?: number;
3935
+ name?: string;
3936
+ width?: number;
3937
+ };
3938
+ /** Delete Arrangement. Deletes the saved Freeform arrangement `name` of `bin`. Params: {"name":str,"bin":binId?}. Changes the document. */
3939
+ "project.freeform.deleteArrangement": {
3940
+ bin?: number;
3941
+ name?: string;
3942
+ };
3943
+ /** List Arrangements. Lists the saved Freeform arrangements of `bin` (default root). Params: {"bin":binId?}. */
3944
+ "project.freeform.arrangements": {
3945
+ bin?: number;
3946
+ };
3947
+ /** Freeform View Options. Sets Freeform view options: grid spacing, snapping, showing names and durations, card size. Params: {"grid":f32?,"snap":bool?,"showNames":bool?,"showDurations":bool?,"cardSize":f32?}. Reads the mode. Changes the document. */
3948
+ "project.freeform.options": {
3949
+ cardSize?: number;
3950
+ grid?: number;
3951
+ showDurations?: boolean;
3952
+ showNames?: boolean;
3953
+ snap?: boolean;
3954
+ };
3955
+ /** Rename Bin. Renames bin `bin` to `name`. Params: {"bin":binId,"name":str}. Changes the document. */
3956
+ "project.renameBin": {
3957
+ bin?: number;
3958
+ name?: string;
3959
+ };
3960
+ /** Select All Project Items. Selects every item in the project. Answers {selected}. Params: {}. Reads the selection. Changes the document. */
3961
+ "project.selectAll": Record<string, never>;
3962
+ /** Deselect All Project Items. Clears the Project panel selection. Params: {}. Changes the document. */
3963
+ "project.deselectAll": Record<string, never>;
3964
+ /** Media Browser Locations. Lists the Media Browser's locations: volumes, favorites and recent folders. Params: {}. */
3965
+ "mediaBrowser.roots": Record<string, never>;
3966
+ /** List Directory. Lists the entries of a folder (default the current one) filtered by the Media Browser file types. Params: {"path":str?,"fileTypes":str?}. */
3967
+ "mediaBrowser.list": {
3968
+ fileTypes?: string;
3969
+ path?: Json;
3970
+ };
3971
+ /** Go to Directory. Goes to a folder in the Media Browser, or `back`, `forward` or `up`. Params: {"path":str} | {"back":true} | {"forward":true} | {"up":true}. Reads the mode, active. Changes the document. */
3972
+ "mediaBrowser.navigate": {
3973
+ back?: boolean; /** in one of several forms of the parameters */
3974
+ forward?: boolean; /** in one of several forms of the parameters */
3975
+ path?: Json; /** in one of several forms of the parameters */
3976
+ up?: boolean;
3977
+ };
3978
+ /** Select Files. Sets the Media Browser's selected files, which mediaBrowser.import and Import from Media Browser use. Params: {"paths":[str]}. Reads the mode, active. Changes the document. */
3979
+ "mediaBrowser.select": {
3980
+ paths?: Array<Json>;
3981
+ };
3982
+ /** Add to Favorites. Adds a folder to, or removes it from, the Media Browser favorites. Params: {"path":str?,"remove":bool?}. Reads the mode, active. Changes the document. */
3983
+ "mediaBrowser.favorite": {
3984
+ path?: Json;
3985
+ remove?: boolean;
3986
+ };
3987
+ /** Clear Recent Directories. Clears the Media Browser's recent folders. Params: {}. Reads the mode. Changes the document. */
3988
+ "mediaBrowser.clearRecent": Record<string, never>;
3989
+ /** Media Browser Settings. Sets Media Browser options: shown `fileTypes`, list or thumbnail `view`, columns, import numbered stills as image sequences, hover scrub, thumbnail size. Params: {"fileTypes":"all|video|audio|image|project|caption|<ext>"?,"view":"list|thumbnails"?,"columns":[str]?,"importAsImageSequence":bool?,"hoverScrub":bool?,"thumbnailSize":f32?}. Reads the mode. Changes the document. */
3990
+ "mediaBrowser.settings": {
3991
+ columns?: Array<string>;
3992
+ fileTypes?: "all" | "video" | "audio" | "image" | "project" | "caption" | "<ext>";
3993
+ hoverScrub?: boolean;
3994
+ importAsImageSequence?: boolean;
3995
+ thumbnailSize?: number;
3996
+ view?: "list" | "thumbnails";
3997
+ };
3998
+ /** Import. Imports the Media Browser's selected files (or `paths`) into the project, applying the project's ingest settings. Params: {"paths":[str]?,"bin":binId?,"imageSequence":bool?}. Reads the part, active, mode. Changes the document. */
3999
+ "mediaBrowser.import": {
4000
+ bin?: number;
4001
+ imageSequence?: boolean; /** read by the command beside its listed parameters */
4002
+ path?: Json;
4003
+ paths?: Array<Json>;
4004
+ };
4005
+ /** Open In Source Monitor. Opens the Media Browser's selected file (or `path`) in the Source monitor without importing it. Params: {"path":str?}. Reads the part, active. Changes the document. */
4006
+ "mediaBrowser.openInSource": {
4007
+ path?: Json; /** read by the command beside its listed parameters */
4008
+ paths?: Array<Json>;
4009
+ };
4010
+ /** Media File Properties. Reads a file's media properties (frame rate, duration, video and audio streams) at `path`, cached. Params: {"path":str}. */
4011
+ "mediaBrowser.probe": {
4012
+ path?: Json;
4013
+ };
4014
+ /** Set Time Interpolation. Sets how the selected or listed `clips` render changed speed: `mode` frameSampling, frameBlending or opticalFlow. Params: {"clips":[id]?,"mode":"frameSampling|frameBlending|opticalFlow"}. Acts on `clips`. Reads the part. Changes the document. */
4015
+ "clip.setTimeInterpolation": {
4016
+ clip?: number;
4017
+ clips?: Array<number>;
4018
+ mode?: "frameSampling" | "frameBlending" | "opticalFlow";
4019
+ };
4020
+ /** Search Bin Contents. Lists the items search bin `bin` currently matches. Params: {"bin":id}. */
4021
+ "project.searchBinItems": {
4022
+ bin?: number;
4023
+ };
4024
+ /** List Search Bins. Lists the project's search bins with their queries and live contents. Params: {}. */
4025
+ "project.searchBins": Record<string, never>;
4026
+ /** Edit Search Bin. Changes search bin `bin`: its name and the query (`column`, `operator`, `text`, or `rows` with `matchAll`, `caseSensitive`). Params: {"bin":id,"name":str?,"column":str?,"operator":str?,"text":str?,"rows":[..]?,"matchAll":bool?,"caseSensitive":bool?}. Changes the document. */
4027
+ "project.editSearchBin": {
4028
+ bin?: number;
4029
+ caseSensitive?: boolean;
4030
+ column?: string;
4031
+ matchAll?: boolean;
4032
+ name?: string;
4033
+ operator?: string; /** [..]? */
4034
+ rows?: Array<Json>;
4035
+ text?: string;
4036
+ };
4037
+ /** Delete Search Bin. Deletes search bin `bin`; the items it matched stay in the project. Params: {"bin":id}. Changes the document. */
4038
+ "project.deleteSearchBin": {
4039
+ bin?: number;
4040
+ };
4041
+ /** List Project Templates. Lists the saved project templates. Params: {}. */
4042
+ "file.templates": Record<string, never>;
4043
+ /** New Project from Template. Creates a new project from `template` (a saved template name or path) named `name`. Params: {"template":name|path,"name":str?}. Reads the part. Changes the document. */
4044
+ "file.newProjectFromTemplate": {
4045
+ force?: boolean;
4046
+ name?: string;
4047
+ template?: string;
4048
+ };
4049
+ /** System Compatibility Report. Reads what this build supports: OS, CPU, decoders, containers and export formats. Params: {}. */
4050
+ "help.systemReport": Record<string, never>;
4051
+ /** Render Preview. Renders what the Program monitor shows of a sequence at a time, as a PNG, without moving the playhead or opening the sequence: `target.time` (seconds from the sequence's start) for one frame, or `target.range` [from, to] with `target.frames` (2 to 12) for a contact sheet of frames laid out in a grid, each labelled with its time. `target.sequence` names the sequence by its item id; without it, the project's main sequence (the only one no other sequence holds). Without a target it answers a contact sheet of the whole sequence. Changes nothing. Params: {target?: {time?: seconds, sequence?: item id, range?: [from, to] seconds, frames?: 2-12, path?: "sequence:<id>[/clip:<id>]"}, scale?: >0-2 (default 1), maxSize?: 16-4096 (default 1024)} ? {png (base64), mimeType, width, height, scale, sequence, frames: [{time, frame, label}], columns, rows}. */
4052
+ "file.render": {
4053
+ maxSize?: number; /** Picture pixels per sequence pixel, above 0 and at most 2 (default 1). A contact sheet's frames are each drawn at this scale. Reduced so the picture fits `maxSize`. */
4054
+ scale?: number; /** What to show. `time` alone shows one frame; `range` with `frames` a contact sheet; neither, the whole sequence as a contact sheet. */
4055
+ target?: {
4056
+ frames?: number;
4057
+ path?: string;
4058
+ range?: Array<number>;
4059
+ sequence?: number;
4060
+ time?: number;
4061
+ };
4062
+ };
4063
+ }
4064
+ /** A Film file opened with `openDocument<Project, FilmCommands>`. */
4065
+ export type FilmDocument = ModelDocument<Project, FilmCommands>;
4066
+ export type FilmContext = RequestContext<Project, FilmCommands>;
4067
+ export {};