afterpresets 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +2 -2
- package/runtime/docs/cep/host-after-effects.md +57 -0
- package/runtime/docs/cep/host-premiere.md +84 -0
- package/runtime/docs/{host.md → cep/host.md} +34 -16
- package/runtime/docs/{README.md → common/README.md} +9 -7
- package/runtime/docs/{assets.md → common/assets.md} +16 -2
- package/runtime/docs/{licensing.md → common/licensing.md} +1 -1
- package/runtime/docs/{panels.md → common/panels.md} +5 -5
- package/runtime/docs/{storage.md → common/storage.md} +5 -5
- package/runtime/docs/{updates.md → common/updates.md} +1 -1
- package/runtime/package.json +1 -1
- package/runtime/src/host.js +1 -1
- package/runtime/src/updates.js +1 -1
- package/src/build/build.js +7 -7
- package/src/build/html.js +1 -1
- package/src/build/jsx.js +2 -2
- package/src/build/runtime.js +3 -3
- package/src/check/check.js +3 -3
- package/src/check/types.js +2 -2
- package/src/cli.js +5 -5
- package/src/commands/add.js +8 -3
- package/src/commands/check.js +3 -3
- package/src/commands/dev.js +2 -2
- package/src/commands/docs.js +1 -1
- package/src/commands/init.js +12 -3
- package/src/config.js +1 -1
- package/src/dev/cep-link.js +1 -1
- package/src/dev/debug-file.js +5 -5
- package/src/mcp/extendscript.js +9 -7
- package/src/mcp/panels.js +1 -1
- package/src/mcp/server.js +2 -2
- package/src/mcp/tools/host.js +1 -1
- package/src/mcp/tools/panel.js +4 -4
- package/src/mcp/tools/project.js +15 -15
- package/src/project/add-panel.js +1 -1
- package/src/project/docs.js +3 -1
- package/src/project/manifest.js +3 -2
- package/src/project/project.js +2 -2
- package/src/project/template.js +4 -1
- package/src/prompt.js +1 -1
- package/src/release/installers.js +4 -4
- package/src/release/package.js +1 -1
- package/src/release/publish.js +1 -1
- package/src/targets.js +1 -0
- package/src/user-config.js +2 -2
- package/template/{AGENTS.md → cep/AGENTS.md} +23 -22
- package/template/{README.md → cep/README.md} +9 -9
- package/template/{docs → cep/docs}/initial_setup.md +4 -4
- package/template/{src → cep/src}/features/home/home.html +4 -4
- package/template/{src → cep/src}/features/home/home.js +10 -11
- package/template/{src → cep/src}/shared/lib/host-theme.js +3 -3
- package/template/{src → cep/src}/shared/lib/view.js +1 -1
- package/template/{src → cep/src}/shared/ui/tokens.css +1 -1
- package/template/hosts/aeft/AGENTS.host.md +10 -0
- package/template/hosts/aeft/jsx/aeft/home.jsx +16 -0
- package/template/hosts/ppro/AGENTS.host.md +15 -0
- package/template/hosts/ppro/jsx/ppro/home.jsx +20 -0
- package/vendor/afterpresets-additions/AfterEffects.d.ts +291 -0
- package/vendor/afterpresets-additions/Premiere.d.ts +179 -0
- package/vendor/types-for-adobe/Premiere/24.0/index.d.ts +2567 -0
- package/vendor/types-for-adobe/README.md +8 -4
- package/template/jsx/home.jsx +0 -17
- /package/runtime/docs/{boot.md → common/boot.md} +0 -0
- /package/template/{.mcp.json → cep/.mcp.json} +0 -0
- /package/template/{gitignore → cep/gitignore} +0 -0
- /package/template/{package.json → cep/package.json} +0 -0
- /package/template/{src → cep/src}/features/home/home.css +0 -0
- /package/template/{src → cep/src}/features/license-screen/license-screen.css +0 -0
- /package/template/{src → cep/src}/features/license-screen/license-screen.html +0 -0
- /package/template/{src → cep/src}/features/license-screen/license-screen.js +0 -0
- /package/template/{src → cep/src}/features/update-screen/update-screen.css +0 -0
- /package/template/{src → cep/src}/features/update-screen/update-screen.html +0 -0
- /package/template/{src → cep/src}/features/update-screen/update-screen.js +0 -0
- /package/template/{src → cep/src}/panels/main/index.html +0 -0
- /package/template/{src → cep/src}/panels/main/main.js +0 -0
- /package/template/{src → cep/src}/shared/lib/dom.js +0 -0
- /package/template/{src → cep/src}/shared/lib/markdown.js +0 -0
- /package/template/{src → cep/src}/shared/ui/base.css +0 -0
- /package/template/{src → cep/src}/shared/ui/button.css +0 -0
- /package/template/{src → cep/src}/shared/ui/card.css +0 -0
- /package/template/{src → cep/src}/shared/ui/field.css +0 -0
- /package/template/{src → cep/src}/shared/ui/index.css +0 -0
|
@@ -0,0 +1,2567 @@
|
|
|
1
|
+
/// <reference path="../../shared/global.d.ts" />
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* TypeScript definitions for Premiere Pro's ExtendScript API would not have happened
|
|
5
|
+
* without the efforts of Eric Robinson and Pravdomil Toman. If you find these definitions
|
|
6
|
+
* useful, it's thanks to them. If you find problems with them, they're mine.
|
|
7
|
+
*
|
|
8
|
+
* -bbb
|
|
9
|
+
* 4/15/19
|
|
10
|
+
*
|
|
11
|
+
*/
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* 0 = false,
|
|
15
|
+
* 1 = true
|
|
16
|
+
*/
|
|
17
|
+
|
|
18
|
+
type NumericalBool = 0 | 1
|
|
19
|
+
type MediaType = "Video" | "Audio" | "any"
|
|
20
|
+
type SampleRateOption = 48000 | 96000
|
|
21
|
+
type BitsPerSampleOption = 16 | 24
|
|
22
|
+
type SDKEventType = "warning" | "info" | "error"
|
|
23
|
+
|
|
24
|
+
declare enum WorkAreaType {
|
|
25
|
+
ENCODE_ENTIRE = 0,
|
|
26
|
+
ENCODE_IN_TO_OUT = 1,
|
|
27
|
+
ENCODE_WORK_AREA = 2,
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
declare enum TIME_FORMAT {
|
|
31
|
+
TIMEDISPLAY_24Timecode = 100,
|
|
32
|
+
TIMEDISPLAY_25Timecode = 101,
|
|
33
|
+
TIMEDISPLAY_2997DropTimecode = 102,
|
|
34
|
+
TIMEDISPLAY_2997NonDropTimecode = 103,
|
|
35
|
+
TIMEDISPLAY_30Timecode = 104,
|
|
36
|
+
TIMEDISPLAY_50Timecode = 105,
|
|
37
|
+
TIMEDISPLAY_5994DropTimecode = 106,
|
|
38
|
+
TIMEDISPLAY_5994NonDropTimecode = 107,
|
|
39
|
+
TIMEDISPLAY_60Timecode = 108,
|
|
40
|
+
TIMEDISPLAY_Frames = 109,
|
|
41
|
+
TIMEDISPLAY_23976Timecode = 110,
|
|
42
|
+
TIMEDISPLAY_16mmFeetFrames = 111,
|
|
43
|
+
TIMEDISPLAY_35mmFeetFrames = 112,
|
|
44
|
+
TIMEDISPLAY_48Timecode = 113,
|
|
45
|
+
TIMEDISPLAY_AudioSamplesTimecode = 200,
|
|
46
|
+
TIMEDISPLAY_AudioMsTimecode = 201,
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
interface $ {
|
|
50
|
+
_PPP_: any
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
/**
|
|
54
|
+
* Structure containing sequence settings.
|
|
55
|
+
*/
|
|
56
|
+
declare class SequenceSettings {
|
|
57
|
+
audioChannelCount: number
|
|
58
|
+
audioChannelType: number
|
|
59
|
+
audioDisplayFormat: number
|
|
60
|
+
audioSampleRate: Time
|
|
61
|
+
compositeLinearColor: boolean
|
|
62
|
+
editingMode: String
|
|
63
|
+
maximumBitDepth: boolean
|
|
64
|
+
maximumRenderQuality: boolean
|
|
65
|
+
previewCode: String
|
|
66
|
+
previewFileFormat: String
|
|
67
|
+
previewFrameHeight: number
|
|
68
|
+
previewFrameWidth: number
|
|
69
|
+
videoDisplayFormat: number
|
|
70
|
+
videoFieldType: number
|
|
71
|
+
videoFrameRate: Time
|
|
72
|
+
videoFrameHeight: number
|
|
73
|
+
videoFrameWidth: number
|
|
74
|
+
videoPixelAspectRatio: string
|
|
75
|
+
vrHorzCapturedView: number
|
|
76
|
+
vrLayout: number
|
|
77
|
+
vrProjection: number
|
|
78
|
+
vrVertCapturedView: number
|
|
79
|
+
workingColorSpaceList: Array<any>
|
|
80
|
+
workingColorSpace: String
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* A sequence.
|
|
85
|
+
*/
|
|
86
|
+
declare class Sequence {
|
|
87
|
+
/**
|
|
88
|
+
* Subtitle (Default)
|
|
89
|
+
*/
|
|
90
|
+
static readonly CAPTION_FORMAT_SUBTITLE: number
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* CEA-608
|
|
94
|
+
*/
|
|
95
|
+
static readonly CAPTION_FORMAT_608: number
|
|
96
|
+
|
|
97
|
+
/**
|
|
98
|
+
* CEA-708
|
|
99
|
+
*/
|
|
100
|
+
static readonly CAPTION_FORMAT_708: number
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* Teletext
|
|
104
|
+
*/
|
|
105
|
+
static readonly CAPTION_FORMAT_TELETEXT: number
|
|
106
|
+
|
|
107
|
+
/**
|
|
108
|
+
* EBU Subtitle
|
|
109
|
+
*/
|
|
110
|
+
static readonly CAPTION_FORMAT_OPEN_EBU: number
|
|
111
|
+
|
|
112
|
+
/**
|
|
113
|
+
* OP-42
|
|
114
|
+
*/
|
|
115
|
+
static readonly CAPTION_FORMAT_OP42: number
|
|
116
|
+
|
|
117
|
+
/**
|
|
118
|
+
* OP-47
|
|
119
|
+
*/
|
|
120
|
+
static readonly CAPTION_FORMAT_OP47: number
|
|
121
|
+
|
|
122
|
+
/**
|
|
123
|
+
*
|
|
124
|
+
*/
|
|
125
|
+
sequenceSettings: SequenceSettings
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* A collection of the sequence's audio tracks.
|
|
129
|
+
*/
|
|
130
|
+
readonly audioTracks: TrackCollection
|
|
131
|
+
|
|
132
|
+
/**
|
|
133
|
+
* Timecode (as a string) of the end of the sequence.
|
|
134
|
+
*/
|
|
135
|
+
readonly end: string
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* Width
|
|
139
|
+
*/
|
|
140
|
+
readonly frameSizeHorizontal: number
|
|
141
|
+
|
|
142
|
+
/**
|
|
143
|
+
* Height
|
|
144
|
+
*/
|
|
145
|
+
readonly frameSizeVertical: number
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* Sequence ID
|
|
149
|
+
*/
|
|
150
|
+
readonly id: number
|
|
151
|
+
|
|
152
|
+
/**
|
|
153
|
+
* The sequence's markers.
|
|
154
|
+
*/
|
|
155
|
+
readonly markers: MarkerCollection
|
|
156
|
+
|
|
157
|
+
/**
|
|
158
|
+
* The available colorspaces
|
|
159
|
+
*/
|
|
160
|
+
readonly workingColorSpaceList: Array<any>
|
|
161
|
+
|
|
162
|
+
/**
|
|
163
|
+
* The color space in use by the sequence
|
|
164
|
+
*/
|
|
165
|
+
workingColorSpace: string
|
|
166
|
+
|
|
167
|
+
/**
|
|
168
|
+
* Name (writable).
|
|
169
|
+
*/
|
|
170
|
+
name: string
|
|
171
|
+
|
|
172
|
+
/**
|
|
173
|
+
*
|
|
174
|
+
*/
|
|
175
|
+
videoDisplayFormat: number
|
|
176
|
+
|
|
177
|
+
/**
|
|
178
|
+
* The `projectItem` corresponding to the sequence.
|
|
179
|
+
*/
|
|
180
|
+
readonly projectItem: ProjectItem
|
|
181
|
+
|
|
182
|
+
/**
|
|
183
|
+
* Permanent ID of the sequence, within its project.
|
|
184
|
+
*/
|
|
185
|
+
readonly sequenceID: string
|
|
186
|
+
|
|
187
|
+
/**
|
|
188
|
+
*
|
|
189
|
+
*/
|
|
190
|
+
readonly timebase: string
|
|
191
|
+
|
|
192
|
+
/**
|
|
193
|
+
*
|
|
194
|
+
*/
|
|
195
|
+
readonly videoTracks: TrackCollection
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* The starting timecode of the first frame of the sequence, as a string.
|
|
199
|
+
*/
|
|
200
|
+
readonly zeroPoint: string
|
|
201
|
+
|
|
202
|
+
/**
|
|
203
|
+
* Adds a new metadata key to the sequence, and sets its value.
|
|
204
|
+
* @param propertyID Name of new property
|
|
205
|
+
* @param propertyValue Value of new property
|
|
206
|
+
*/
|
|
207
|
+
attachCustomProperty(propertyID: string, propertyValue: string): void
|
|
208
|
+
|
|
209
|
+
/**
|
|
210
|
+
*
|
|
211
|
+
*/
|
|
212
|
+
bind(eventName: string, function_: any): void
|
|
213
|
+
|
|
214
|
+
/**
|
|
215
|
+
* Clones a sequence.
|
|
216
|
+
* @returns the clone Sequence.
|
|
217
|
+
*/
|
|
218
|
+
clone(): Sequence
|
|
219
|
+
|
|
220
|
+
/**
|
|
221
|
+
* Creates a caption track in the active sequence using caption data from a project item.
|
|
222
|
+
* @param projectItem A captions source clip (e.g. .srt)
|
|
223
|
+
* @param startAtTime Offset in seconds from start of sequence
|
|
224
|
+
* @param captionsFormat (Optional, defaults to subtitle) Caption format of the new track (see table below).
|
|
225
|
+
*/
|
|
226
|
+
createCaptionTrack(projectItem: ProjectItem, startAtTime: number, captionFormat: number): Sequence
|
|
227
|
+
|
|
228
|
+
/**
|
|
229
|
+
* Creates a new sequence from the source sequence's in and out points.
|
|
230
|
+
* @param ignoreMapping If True the current selection, not track targeting, will determine
|
|
231
|
+
* the clips to include in the new sequence.
|
|
232
|
+
*
|
|
233
|
+
* If there is no selection, track targeting determines which clips are included in the new sequence.
|
|
234
|
+
*/
|
|
235
|
+
createSubsequence(ignoreMapping: Boolean): Sequence
|
|
236
|
+
|
|
237
|
+
/**
|
|
238
|
+
* Exports a new FCP XML file representing this sequence.
|
|
239
|
+
* @param exportPath The full file path (with file name) to create.
|
|
240
|
+
* @param suppressUI Optional; quiets any warnings or errors encountered during export.
|
|
241
|
+
*/
|
|
242
|
+
exportAsFinalCutProXML(exportPath: string, suppressUI?: number): boolean
|
|
243
|
+
|
|
244
|
+
/**
|
|
245
|
+
* Premiere Pro exports the sequence immediately.
|
|
246
|
+
* @param outputFilePath The output file path (with name).
|
|
247
|
+
* @param presetPath The .epr file to use.
|
|
248
|
+
* @param workAreaType Optional work area specifier.
|
|
249
|
+
*/
|
|
250
|
+
exportAsMediaDirect(
|
|
251
|
+
outputFilePath: string,
|
|
252
|
+
presetPath: string,
|
|
253
|
+
workAreaType?: WorkAreaType,
|
|
254
|
+
): string
|
|
255
|
+
|
|
256
|
+
/**
|
|
257
|
+
* Exports the sequence (and its constituent media) as a new PPro project.
|
|
258
|
+
* @param path Output file path, including file name.
|
|
259
|
+
*/
|
|
260
|
+
exportAsProject(exportPath: string): void
|
|
261
|
+
|
|
262
|
+
/**
|
|
263
|
+
* Retrieves the file extension associated with a given output preset (.epr file).
|
|
264
|
+
* @param presetFilePath full path to .epr file
|
|
265
|
+
*/
|
|
266
|
+
getExportFileExtension(presetFilePath: string): string
|
|
267
|
+
|
|
268
|
+
/**
|
|
269
|
+
* Retrieves the sequence's in point, as a timecode string.
|
|
270
|
+
*/
|
|
271
|
+
getInPoint(): string
|
|
272
|
+
|
|
273
|
+
/**
|
|
274
|
+
* Retrieves the sequence's out point, as a timecode string.
|
|
275
|
+
*/
|
|
276
|
+
getOutPoint(): string
|
|
277
|
+
|
|
278
|
+
/**
|
|
279
|
+
* Retrieves the sequence's in point, as a `Time` object.
|
|
280
|
+
*/
|
|
281
|
+
getInPointAsTime(): Time
|
|
282
|
+
|
|
283
|
+
/**
|
|
284
|
+
* Retrieves the sequence's out point, as a `Time` object.
|
|
285
|
+
*/
|
|
286
|
+
getOutPointAsTime(): Time
|
|
287
|
+
|
|
288
|
+
/**
|
|
289
|
+
* Retrieves the current player position, as a `Time` object.
|
|
290
|
+
*/
|
|
291
|
+
getPlayerPosition(): Time
|
|
292
|
+
|
|
293
|
+
/**
|
|
294
|
+
* Sets the in point of the sequence.
|
|
295
|
+
* @param seconds Time of in point.
|
|
296
|
+
*/
|
|
297
|
+
setInPoint(seconds: number): void
|
|
298
|
+
|
|
299
|
+
/**
|
|
300
|
+
* Sets the out point of the sequence.
|
|
301
|
+
* @param seconds Time of out point.
|
|
302
|
+
*/
|
|
303
|
+
setOutPoint(seconds: number): void
|
|
304
|
+
|
|
305
|
+
/**
|
|
306
|
+
* Sets the current player position.
|
|
307
|
+
* @param pos The new position, as a string, representing ticks.
|
|
308
|
+
*/
|
|
309
|
+
setPlayerPosition(pos: string): void
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
*
|
|
313
|
+
*/
|
|
314
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
315
|
+
|
|
316
|
+
/**
|
|
317
|
+
* Sets the timecode of the first frame of the sequence.
|
|
318
|
+
* @param newStartTime The new starting time, in `ticks`.
|
|
319
|
+
*/
|
|
320
|
+
setZeroPoint(newStartTime: string): void
|
|
321
|
+
|
|
322
|
+
/**
|
|
323
|
+
* Links the currently-selected `trackItems` together, if possible.
|
|
324
|
+
* @returns `True` if successful.
|
|
325
|
+
*/
|
|
326
|
+
linkSelection(): boolean
|
|
327
|
+
|
|
328
|
+
/**
|
|
329
|
+
* Unlinks the currently-selected `trackItems`, if possible.
|
|
330
|
+
* @returns `True` if successful.
|
|
331
|
+
*/
|
|
332
|
+
unlinkSelection(): boolean
|
|
333
|
+
|
|
334
|
+
/**
|
|
335
|
+
* Imports a Motion Graphics Template (.mogrt) into the sequence
|
|
336
|
+
* @param pathToMOGRT Complete path to .mogrt
|
|
337
|
+
* @param timeInTicks Time (in ticks) at which to insert
|
|
338
|
+
* @param videoTrackOffset The offset from first video track to targeted track
|
|
339
|
+
* @param audioTrackOffset The offset from first audio track to targeted track
|
|
340
|
+
* @returns newly-created `trackItem` representing the .mogrt
|
|
341
|
+
*/
|
|
342
|
+
importMGT(
|
|
343
|
+
pathToMOGRT: String,
|
|
344
|
+
timeInTicks: String,
|
|
345
|
+
videoTrackOffset: number,
|
|
346
|
+
audioTrackOffset: number,
|
|
347
|
+
): TrackItem
|
|
348
|
+
|
|
349
|
+
/**
|
|
350
|
+
* Returns `true` if work area is enabled.
|
|
351
|
+
*/
|
|
352
|
+
isWorkAreaEnabled(): Boolean
|
|
353
|
+
|
|
354
|
+
/**
|
|
355
|
+
* Sets the enabled state of the seqeuence work area.
|
|
356
|
+
* @param enableState The desired state
|
|
357
|
+
*/
|
|
358
|
+
setWorkAreaEnabled(enableState: Boolean): void
|
|
359
|
+
|
|
360
|
+
/**
|
|
361
|
+
* Returns the work area in point, in seconds.
|
|
362
|
+
*/
|
|
363
|
+
getWorkAreaInPoint(): number
|
|
364
|
+
|
|
365
|
+
/**
|
|
366
|
+
* Specify the work area in point, in seconds.
|
|
367
|
+
* @param timeInSeconds new in point time.
|
|
368
|
+
*/
|
|
369
|
+
setWorkAreaInPoint(timeInSeconds: number): void
|
|
370
|
+
|
|
371
|
+
/**
|
|
372
|
+
* Returns the work area out point, in seconds.
|
|
373
|
+
*/
|
|
374
|
+
getWorkAreaOutPoint(): number
|
|
375
|
+
|
|
376
|
+
/**
|
|
377
|
+
* Specify the work area out point, in seconds.
|
|
378
|
+
* @param timeInSeconds new out point time.
|
|
379
|
+
*/
|
|
380
|
+
setWorkAreaOutPoint(timeInSeconds: number): void
|
|
381
|
+
|
|
382
|
+
/**
|
|
383
|
+
* @returns the work area in point, as a `Time` object.
|
|
384
|
+
*/
|
|
385
|
+
getWorkAreaInPointAsTime(): Time
|
|
386
|
+
|
|
387
|
+
/**
|
|
388
|
+
* Specify the work area in point, as `Time`.
|
|
389
|
+
*/
|
|
390
|
+
setWorkAreaInPointAsTime(outPoint: Time): void
|
|
391
|
+
|
|
392
|
+
/**
|
|
393
|
+
* @returns the work area out point, as a `Time` object.
|
|
394
|
+
*/
|
|
395
|
+
getWorkAreaOutPointAsTime(): Time
|
|
396
|
+
|
|
397
|
+
/**
|
|
398
|
+
* Specify the work area out point, as `Time`.
|
|
399
|
+
*/
|
|
400
|
+
setWorkAreaOutPointAsTime(outPoint: Time): void
|
|
401
|
+
|
|
402
|
+
/**
|
|
403
|
+
* Inserts a clip (`trackItem`) into the sequence.
|
|
404
|
+
* @param projectItem The project item to insert.
|
|
405
|
+
* @param time Time at which to insert.
|
|
406
|
+
* @param vidTrackOffset The offset from the first video track to targeted track
|
|
407
|
+
* @param audTrackOffset The offset from the first audio track to targeted track
|
|
408
|
+
*/
|
|
409
|
+
insertClip(
|
|
410
|
+
projectItem: ProjectItem,
|
|
411
|
+
time: Time,
|
|
412
|
+
vidTrackOffset: number,
|
|
413
|
+
audTrackOffset: number,
|
|
414
|
+
): TrackItem
|
|
415
|
+
|
|
416
|
+
/**
|
|
417
|
+
* @returns currently-selected clips, as an `Array` of `trackItems`
|
|
418
|
+
*/
|
|
419
|
+
getSelection(): Array<TrackItem>
|
|
420
|
+
|
|
421
|
+
/**
|
|
422
|
+
* Returns the current sequence settings.
|
|
423
|
+
* @returns SequenceSettings
|
|
424
|
+
*/
|
|
425
|
+
getSettings(): SequenceSettings
|
|
426
|
+
|
|
427
|
+
/**
|
|
428
|
+
* Specifies the sequence settings to use.
|
|
429
|
+
* @param newSettings New settings
|
|
430
|
+
*/
|
|
431
|
+
setSettings(newSettings: SequenceSettings): void
|
|
432
|
+
|
|
433
|
+
/**
|
|
434
|
+
* @returns true if effect analysis is complete
|
|
435
|
+
*/
|
|
436
|
+
|
|
437
|
+
isDoneAnalyzingForVideoEffects(): Boolean
|
|
438
|
+
|
|
439
|
+
/**
|
|
440
|
+
*
|
|
441
|
+
* @param numerator Numerator of desired frame aspect ratio
|
|
442
|
+
* @param denominator Denominator of desired frame aspect ratio
|
|
443
|
+
* @param motionPreset Either "default", "faster" or "slower"
|
|
444
|
+
* @param sequenceName Name for created sequence
|
|
445
|
+
* @param nest Use nested sequences?
|
|
446
|
+
*/
|
|
447
|
+
|
|
448
|
+
autoReframeSequence(
|
|
449
|
+
numerator: Number,
|
|
450
|
+
denominator: Number,
|
|
451
|
+
motionPreset: String,
|
|
452
|
+
sequenceName: String,
|
|
453
|
+
nest: Boolean,
|
|
454
|
+
): Sequence
|
|
455
|
+
|
|
456
|
+
/**
|
|
457
|
+
*
|
|
458
|
+
* @param action Either 'ApplyCuts' or 'CreateMarkers'
|
|
459
|
+
* @param applyCutsToLinkedAudio Operate on linked audio too?
|
|
460
|
+
* @param sensitivity 'LowSensitivity', 'MediumSensitivity', or 'HighSensitivity'
|
|
461
|
+
*/
|
|
462
|
+
performCutDetectionOnSelection(
|
|
463
|
+
action: String,
|
|
464
|
+
applyCutsToLinkedAudio: Boolean,
|
|
465
|
+
sensitivity: String,
|
|
466
|
+
): void
|
|
467
|
+
/**
|
|
468
|
+
*
|
|
469
|
+
*/
|
|
470
|
+
unbind(eventName: string): void
|
|
471
|
+
}
|
|
472
|
+
|
|
473
|
+
/**
|
|
474
|
+
* Structure containing all available options for the `ProjectManager`.
|
|
475
|
+
*/
|
|
476
|
+
declare class ProjectManagerOptions {
|
|
477
|
+
/**
|
|
478
|
+
* Transfer mode setting: Copy source media
|
|
479
|
+
*/
|
|
480
|
+
readonly CLIP_TRANSFER_COPY: string
|
|
481
|
+
|
|
482
|
+
/**
|
|
483
|
+
* Transfer mode setting: Transcode source media
|
|
484
|
+
*/
|
|
485
|
+
readonly CLIP_TRANSFER_TRANSCODE: string
|
|
486
|
+
|
|
487
|
+
/**
|
|
488
|
+
* Transcode mode setting: Transcode source media to a specific preset
|
|
489
|
+
*/
|
|
490
|
+
readonly CLIP_TRANSCODE_MATCH_PRESET: string
|
|
491
|
+
|
|
492
|
+
/**
|
|
493
|
+
* Transcode mode setting: Transcode source media to match clips
|
|
494
|
+
*/
|
|
495
|
+
readonly CLIP_TRANSCODE_MATCH_CLIPS: string
|
|
496
|
+
|
|
497
|
+
/**
|
|
498
|
+
* Transcode mode setting: Transcode source media to match sequence settings
|
|
499
|
+
*/
|
|
500
|
+
readonly CLIP_TRANSCODE_MATCH_SEQUENCE: string
|
|
501
|
+
|
|
502
|
+
/**
|
|
503
|
+
* Which transcode option to use; will be one of these:
|
|
504
|
+
* `CLIP_TRANSCODE_MATCH_PRESET`
|
|
505
|
+
* `CLIP_TRANSCODE_MATCH_CLIPS`
|
|
506
|
+
* `CLIP_TRANSCODE_MATCH_SEQUENCE`
|
|
507
|
+
*/
|
|
508
|
+
clipTranscoderOption: string
|
|
509
|
+
|
|
510
|
+
/**
|
|
511
|
+
* Which transfer option to use; will be one of these:
|
|
512
|
+
* `CLIP_TRANSFER_COPY`
|
|
513
|
+
* `CLIP_TRANSFER_TRANSCODE`
|
|
514
|
+
*/
|
|
515
|
+
clipTransferOption: string
|
|
516
|
+
|
|
517
|
+
/**
|
|
518
|
+
* If `true`, projectItems not used in a sequence are not transferred
|
|
519
|
+
*/
|
|
520
|
+
excludeUnused: boolean
|
|
521
|
+
|
|
522
|
+
/**
|
|
523
|
+
* The number of 'handle' frames to provide, before and after the in/out points of clips in the sequence.
|
|
524
|
+
*/
|
|
525
|
+
handleFrameCount: number
|
|
526
|
+
|
|
527
|
+
/**
|
|
528
|
+
* If `true`, preview files will also be transferred.
|
|
529
|
+
*/
|
|
530
|
+
includePreviews: boolean
|
|
531
|
+
|
|
532
|
+
/**
|
|
533
|
+
* If `true`, conformed audio files will also be transferred.
|
|
534
|
+
*/
|
|
535
|
+
includeConformedAudio: boolean
|
|
536
|
+
|
|
537
|
+
/**
|
|
538
|
+
* If `true`, media files will be renamed to match clip names.
|
|
539
|
+
*/
|
|
540
|
+
renameMedia: boolean
|
|
541
|
+
|
|
542
|
+
/**
|
|
543
|
+
* The containing directory for the consolidation/transfer.
|
|
544
|
+
*/
|
|
545
|
+
destinationPath: String
|
|
546
|
+
|
|
547
|
+
/**
|
|
548
|
+
* If `true`, all sequences in the project will be transferred.
|
|
549
|
+
*/
|
|
550
|
+
includeAllSequences: boolean
|
|
551
|
+
|
|
552
|
+
/**
|
|
553
|
+
* An `Array` of all sequences affected by the transfer.
|
|
554
|
+
*/
|
|
555
|
+
affectedSequences: Array<Sequence>
|
|
556
|
+
|
|
557
|
+
/**
|
|
558
|
+
* Path the the encoder preset (.epr file) to be used.
|
|
559
|
+
*/
|
|
560
|
+
encoderPresetFilePath: String
|
|
561
|
+
|
|
562
|
+
/**
|
|
563
|
+
* If `true`, image sequences will be transcoded.
|
|
564
|
+
*/
|
|
565
|
+
convertImageSequencesToClips: boolean
|
|
566
|
+
|
|
567
|
+
/**
|
|
568
|
+
* If `true`, synthetic importer clips will be transcoded.
|
|
569
|
+
*/
|
|
570
|
+
convertSyntheticsToClips: boolean
|
|
571
|
+
|
|
572
|
+
/**
|
|
573
|
+
* If `true`, After Effects compositions will be transcoded.
|
|
574
|
+
*/
|
|
575
|
+
convertAECompsToClips: boolean
|
|
576
|
+
|
|
577
|
+
/**
|
|
578
|
+
* If `true`, source media will be copied not transcoded, if transcoding would have resulted in loss of alpha information.
|
|
579
|
+
*/
|
|
580
|
+
copyToPreventAlphaLoss: boolean
|
|
581
|
+
}
|
|
582
|
+
|
|
583
|
+
declare class ProjectManager {
|
|
584
|
+
/**
|
|
585
|
+
* An array of strings describing errors encountered.
|
|
586
|
+
*/
|
|
587
|
+
errors: Array<Error>
|
|
588
|
+
|
|
589
|
+
/**
|
|
590
|
+
* The `ProjectManagerOptions` structure.
|
|
591
|
+
*/
|
|
592
|
+
options: ProjectManagerOptions
|
|
593
|
+
|
|
594
|
+
/**
|
|
595
|
+
* Perform the consolidation and transfer.
|
|
596
|
+
* @param project the `Project` to consolidate.
|
|
597
|
+
*/
|
|
598
|
+
process(project: Project): number
|
|
599
|
+
|
|
600
|
+
/**
|
|
601
|
+
*
|
|
602
|
+
*/
|
|
603
|
+
unbind(eventName: string): void
|
|
604
|
+
}
|
|
605
|
+
|
|
606
|
+
/**
|
|
607
|
+
*
|
|
608
|
+
*/
|
|
609
|
+
declare class SequenceCollection {
|
|
610
|
+
/**
|
|
611
|
+
*
|
|
612
|
+
*/
|
|
613
|
+
readonly numSequences: number
|
|
614
|
+
|
|
615
|
+
/**
|
|
616
|
+
*
|
|
617
|
+
*/
|
|
618
|
+
bind(eventName: string, function_: any): void
|
|
619
|
+
|
|
620
|
+
/**
|
|
621
|
+
*
|
|
622
|
+
*/
|
|
623
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
624
|
+
|
|
625
|
+
/**
|
|
626
|
+
*
|
|
627
|
+
*/
|
|
628
|
+
unbind(eventName: string): void
|
|
629
|
+
|
|
630
|
+
/**
|
|
631
|
+
*
|
|
632
|
+
*/
|
|
633
|
+
[index: number]: Sequence
|
|
634
|
+
}
|
|
635
|
+
|
|
636
|
+
/**
|
|
637
|
+
*
|
|
638
|
+
*/
|
|
639
|
+
declare class Metadata {
|
|
640
|
+
/**
|
|
641
|
+
*
|
|
642
|
+
*/
|
|
643
|
+
readonly getMetadata: string
|
|
644
|
+
|
|
645
|
+
/**
|
|
646
|
+
*
|
|
647
|
+
*/
|
|
648
|
+
addMarker(): void
|
|
649
|
+
|
|
650
|
+
/**
|
|
651
|
+
*
|
|
652
|
+
*/
|
|
653
|
+
bind(eventName: string, function_: any): void
|
|
654
|
+
|
|
655
|
+
/**
|
|
656
|
+
*
|
|
657
|
+
*/
|
|
658
|
+
deleteMarker(): void
|
|
659
|
+
|
|
660
|
+
/**
|
|
661
|
+
*
|
|
662
|
+
*/
|
|
663
|
+
setMarkerData(): void
|
|
664
|
+
|
|
665
|
+
/**
|
|
666
|
+
*
|
|
667
|
+
*/
|
|
668
|
+
setMetadataValue(): void
|
|
669
|
+
|
|
670
|
+
/**
|
|
671
|
+
*
|
|
672
|
+
*/
|
|
673
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
674
|
+
|
|
675
|
+
/**
|
|
676
|
+
*
|
|
677
|
+
*/
|
|
678
|
+
unbind(eventName: string): void
|
|
679
|
+
|
|
680
|
+
/**
|
|
681
|
+
*
|
|
682
|
+
*/
|
|
683
|
+
updateMarker(): void
|
|
684
|
+
}
|
|
685
|
+
|
|
686
|
+
/**
|
|
687
|
+
*
|
|
688
|
+
*/
|
|
689
|
+
declare class Anywhere {
|
|
690
|
+
/**
|
|
691
|
+
*
|
|
692
|
+
*/
|
|
693
|
+
bind(eventName: string, function_: any): void
|
|
694
|
+
|
|
695
|
+
/**
|
|
696
|
+
*
|
|
697
|
+
*/
|
|
698
|
+
getAuthenticationToken(): string
|
|
699
|
+
|
|
700
|
+
/**
|
|
701
|
+
*
|
|
702
|
+
*/
|
|
703
|
+
getCurrentEditingSessionActiveSequenceURL(): string
|
|
704
|
+
|
|
705
|
+
/**
|
|
706
|
+
*
|
|
707
|
+
*/
|
|
708
|
+
getCurrentEditingSessionSelectionURL(): string
|
|
709
|
+
|
|
710
|
+
/**
|
|
711
|
+
*
|
|
712
|
+
*/
|
|
713
|
+
getCurrentEditingSessionURL(): string
|
|
714
|
+
|
|
715
|
+
/**
|
|
716
|
+
*
|
|
717
|
+
*/
|
|
718
|
+
isProductionOpen(): boolean
|
|
719
|
+
|
|
720
|
+
/**
|
|
721
|
+
*
|
|
722
|
+
*/
|
|
723
|
+
listProductions(): RemoteProductionCollection
|
|
724
|
+
|
|
725
|
+
/**
|
|
726
|
+
*
|
|
727
|
+
*/
|
|
728
|
+
openProduction(inProductionURL: string): boolean
|
|
729
|
+
|
|
730
|
+
/**
|
|
731
|
+
*
|
|
732
|
+
*/
|
|
733
|
+
setAuthenticationToken(inAuthToken: string, inEmail: string): boolean
|
|
734
|
+
|
|
735
|
+
/**
|
|
736
|
+
*
|
|
737
|
+
*/
|
|
738
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
739
|
+
|
|
740
|
+
/**
|
|
741
|
+
*
|
|
742
|
+
*/
|
|
743
|
+
unbind(eventName: string): void
|
|
744
|
+
}
|
|
745
|
+
|
|
746
|
+
/**
|
|
747
|
+
*
|
|
748
|
+
*/
|
|
749
|
+
declare class CsxsResourceCentral {
|
|
750
|
+
/**
|
|
751
|
+
*
|
|
752
|
+
*/
|
|
753
|
+
bind(eventName: string, function_: any): void
|
|
754
|
+
|
|
755
|
+
/**
|
|
756
|
+
*
|
|
757
|
+
*/
|
|
758
|
+
getBrightness(): string
|
|
759
|
+
|
|
760
|
+
/**
|
|
761
|
+
*
|
|
762
|
+
*/
|
|
763
|
+
openURL(urlString: string): void
|
|
764
|
+
|
|
765
|
+
/**
|
|
766
|
+
*
|
|
767
|
+
*/
|
|
768
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
769
|
+
|
|
770
|
+
/**
|
|
771
|
+
*
|
|
772
|
+
*/
|
|
773
|
+
unbind(eventName: string): void
|
|
774
|
+
|
|
775
|
+
/**
|
|
776
|
+
*
|
|
777
|
+
*/
|
|
778
|
+
validateClient(token: string): boolean
|
|
779
|
+
}
|
|
780
|
+
|
|
781
|
+
/**
|
|
782
|
+
*
|
|
783
|
+
*/
|
|
784
|
+
declare class SourceMonitor {
|
|
785
|
+
/**
|
|
786
|
+
*
|
|
787
|
+
*/
|
|
788
|
+
bind(eventName: string, function_: any): void
|
|
789
|
+
|
|
790
|
+
/**
|
|
791
|
+
*
|
|
792
|
+
*/
|
|
793
|
+
closeAllClips(): void
|
|
794
|
+
|
|
795
|
+
/**
|
|
796
|
+
*
|
|
797
|
+
*/
|
|
798
|
+
closeClip(): void
|
|
799
|
+
|
|
800
|
+
/**
|
|
801
|
+
*
|
|
802
|
+
*/
|
|
803
|
+
openFilePath(filePath: string): boolean
|
|
804
|
+
|
|
805
|
+
/**
|
|
806
|
+
*
|
|
807
|
+
*/
|
|
808
|
+
play(speed?: number): void
|
|
809
|
+
|
|
810
|
+
/**
|
|
811
|
+
*
|
|
812
|
+
*/
|
|
813
|
+
getProjectItem(): ProjectItem | undefined
|
|
814
|
+
|
|
815
|
+
/**
|
|
816
|
+
*
|
|
817
|
+
*/
|
|
818
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
819
|
+
|
|
820
|
+
/**
|
|
821
|
+
*
|
|
822
|
+
*/
|
|
823
|
+
unbind(eventName: string): void
|
|
824
|
+
|
|
825
|
+
/**
|
|
826
|
+
*
|
|
827
|
+
*/
|
|
828
|
+
getPosition(): Time
|
|
829
|
+
|
|
830
|
+
/**
|
|
831
|
+
*
|
|
832
|
+
*/
|
|
833
|
+
openProjectItem(itemToOpen: ProjectItem): void
|
|
834
|
+
}
|
|
835
|
+
|
|
836
|
+
/**
|
|
837
|
+
*
|
|
838
|
+
*/
|
|
839
|
+
declare class Time {
|
|
840
|
+
/**
|
|
841
|
+
*
|
|
842
|
+
*/
|
|
843
|
+
seconds: number
|
|
844
|
+
|
|
845
|
+
/**
|
|
846
|
+
*
|
|
847
|
+
*/
|
|
848
|
+
ticks: string
|
|
849
|
+
|
|
850
|
+
/**
|
|
851
|
+
*
|
|
852
|
+
*/
|
|
853
|
+
bind(eventName: string, function_: any): void
|
|
854
|
+
|
|
855
|
+
/**
|
|
856
|
+
*
|
|
857
|
+
*/
|
|
858
|
+
getFormatted(Time: Time, timeFormat: TIME_FORMAT): String
|
|
859
|
+
|
|
860
|
+
/**
|
|
861
|
+
*
|
|
862
|
+
*/
|
|
863
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
864
|
+
|
|
865
|
+
/**
|
|
866
|
+
*
|
|
867
|
+
*/
|
|
868
|
+
unbind(eventName: string): void
|
|
869
|
+
}
|
|
870
|
+
|
|
871
|
+
/**
|
|
872
|
+
*
|
|
873
|
+
*/
|
|
874
|
+
declare class ProjectItemType {
|
|
875
|
+
/**
|
|
876
|
+
*
|
|
877
|
+
*/
|
|
878
|
+
static readonly BIN: number
|
|
879
|
+
|
|
880
|
+
/**
|
|
881
|
+
*
|
|
882
|
+
*/
|
|
883
|
+
static readonly CLIP: number
|
|
884
|
+
|
|
885
|
+
/**
|
|
886
|
+
*
|
|
887
|
+
*/
|
|
888
|
+
static readonly FILE: number
|
|
889
|
+
|
|
890
|
+
/**
|
|
891
|
+
*
|
|
892
|
+
*/
|
|
893
|
+
static readonly ROOT: number
|
|
894
|
+
|
|
895
|
+
/**
|
|
896
|
+
*
|
|
897
|
+
*/
|
|
898
|
+
bind(eventName: string, function_: any): void
|
|
899
|
+
|
|
900
|
+
/**
|
|
901
|
+
*
|
|
902
|
+
*/
|
|
903
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
904
|
+
|
|
905
|
+
/**
|
|
906
|
+
*
|
|
907
|
+
*/
|
|
908
|
+
unbind(eventName: string): void
|
|
909
|
+
}
|
|
910
|
+
|
|
911
|
+
/**
|
|
912
|
+
*
|
|
913
|
+
*/
|
|
914
|
+
declare class Project {
|
|
915
|
+
/**
|
|
916
|
+
*f
|
|
917
|
+
*/
|
|
918
|
+
activeSequence: Sequence
|
|
919
|
+
|
|
920
|
+
/**
|
|
921
|
+
*
|
|
922
|
+
*/
|
|
923
|
+
readonly documentID: string
|
|
924
|
+
|
|
925
|
+
/**
|
|
926
|
+
*
|
|
927
|
+
*/
|
|
928
|
+
readonly name: string
|
|
929
|
+
|
|
930
|
+
/**
|
|
931
|
+
* Warning: in MacOS Ventura, fetching the project path can throw an error during shutdown
|
|
932
|
+
* Bug ID: DVAPR-4242199
|
|
933
|
+
*
|
|
934
|
+
* Workaround: put any path checks in a try/catch block if checking may coincide with shutdown
|
|
935
|
+
*/
|
|
936
|
+
readonly path: string
|
|
937
|
+
|
|
938
|
+
/**
|
|
939
|
+
*
|
|
940
|
+
*/
|
|
941
|
+
readonly rootItem: ProjectItem
|
|
942
|
+
|
|
943
|
+
/**
|
|
944
|
+
*
|
|
945
|
+
*/
|
|
946
|
+
readonly sequences: SequenceCollection
|
|
947
|
+
|
|
948
|
+
/**
|
|
949
|
+
*
|
|
950
|
+
*/
|
|
951
|
+
addPropertyToProjectMetadataSchema(name: string, label: string, type: number): boolean
|
|
952
|
+
|
|
953
|
+
/**
|
|
954
|
+
*
|
|
955
|
+
*/
|
|
956
|
+
bind(eventName: string, function_: any): void
|
|
957
|
+
|
|
958
|
+
/**
|
|
959
|
+
*
|
|
960
|
+
*/
|
|
961
|
+
closeDocument(): boolean
|
|
962
|
+
|
|
963
|
+
/**
|
|
964
|
+
*
|
|
965
|
+
*/
|
|
966
|
+
createNewSequence(sequenceName: string, placeholderID: string): Sequence
|
|
967
|
+
|
|
968
|
+
/**
|
|
969
|
+
*
|
|
970
|
+
*/
|
|
971
|
+
deleteAsset(): void
|
|
972
|
+
|
|
973
|
+
/**
|
|
974
|
+
*
|
|
975
|
+
*/
|
|
976
|
+
deleteSequence(sequence: Sequence): boolean
|
|
977
|
+
|
|
978
|
+
/**
|
|
979
|
+
*
|
|
980
|
+
*/
|
|
981
|
+
exportAAF(
|
|
982
|
+
sequence: Sequence,
|
|
983
|
+
filePath: string,
|
|
984
|
+
mixDownVideo: number,
|
|
985
|
+
explodeToMono: number,
|
|
986
|
+
sampleRate: number,
|
|
987
|
+
bitsPerSample: number,
|
|
988
|
+
embedAudio: number,
|
|
989
|
+
audioFileFormat: number,
|
|
990
|
+
trimSources: number,
|
|
991
|
+
handleFrames: number,
|
|
992
|
+
): number
|
|
993
|
+
|
|
994
|
+
/**
|
|
995
|
+
*
|
|
996
|
+
*/
|
|
997
|
+
exportFinalCutProXML(exportPath: string, suppressUI: number): boolean
|
|
998
|
+
|
|
999
|
+
/**
|
|
1000
|
+
*
|
|
1001
|
+
*/
|
|
1002
|
+
consolidateDuplicates(): void
|
|
1003
|
+
|
|
1004
|
+
/**
|
|
1005
|
+
*
|
|
1006
|
+
*/
|
|
1007
|
+
exportOMF(
|
|
1008
|
+
sequence: Sequence,
|
|
1009
|
+
filePath: string,
|
|
1010
|
+
OMFTitle: string,
|
|
1011
|
+
sampleRate: number,
|
|
1012
|
+
bitsPerSample: number,
|
|
1013
|
+
audioEncapsulated: number,
|
|
1014
|
+
audioFileFormat: number,
|
|
1015
|
+
trimAudioFiles: number,
|
|
1016
|
+
handleFrames: number,
|
|
1017
|
+
includePan: number,
|
|
1018
|
+
): number
|
|
1019
|
+
|
|
1020
|
+
/**
|
|
1021
|
+
*
|
|
1022
|
+
*/
|
|
1023
|
+
exportTimeline(exportControllerName: string): number
|
|
1024
|
+
|
|
1025
|
+
/**
|
|
1026
|
+
*
|
|
1027
|
+
*/
|
|
1028
|
+
getInsertionBin(): ProjectItem
|
|
1029
|
+
|
|
1030
|
+
/**
|
|
1031
|
+
*
|
|
1032
|
+
*/
|
|
1033
|
+
getProjectPanelMetadata(): string
|
|
1034
|
+
|
|
1035
|
+
/**
|
|
1036
|
+
*
|
|
1037
|
+
*/
|
|
1038
|
+
importAEComps(aepPath: String, compsToImport: Array<any>, projectBin: ProjectItem): boolean
|
|
1039
|
+
|
|
1040
|
+
/**
|
|
1041
|
+
*
|
|
1042
|
+
*/
|
|
1043
|
+
importAllAEComps(arg1: any, compsToImport: Array<any>, projectBin: ProjectItem): boolean
|
|
1044
|
+
|
|
1045
|
+
/**
|
|
1046
|
+
* Imports files into the project.
|
|
1047
|
+
* @param arrayOfFilePathsToImport An array of paths to files to import
|
|
1048
|
+
* @param suppressUI optional; if true, suppress any warnings, translation reports, or errors.
|
|
1049
|
+
* @param projectBin optional; if present, the bin into which to import the new media.
|
|
1050
|
+
* @param importAsNumberedStill optiona; if present, interprets the file paths as a series of numbered stills.
|
|
1051
|
+
*/
|
|
1052
|
+
importFiles(
|
|
1053
|
+
arrayOfFilePathsToImport: string[],
|
|
1054
|
+
suppressUI?: boolean,
|
|
1055
|
+
projectBin?: ProjectItem,
|
|
1056
|
+
importAsNumberedStill?: boolean,
|
|
1057
|
+
): boolean
|
|
1058
|
+
|
|
1059
|
+
/**
|
|
1060
|
+
* Imports sequences from a project.
|
|
1061
|
+
* @param projectPath Path to project from which to import sequences.
|
|
1062
|
+
* @param sequences An array of sequence IDs to import, from the project.
|
|
1063
|
+
*/
|
|
1064
|
+
importSequences(projectPath: String, sequencesToImport: Array<string>): boolean
|
|
1065
|
+
|
|
1066
|
+
/**
|
|
1067
|
+
*
|
|
1068
|
+
*/
|
|
1069
|
+
openSequence(sequenceID: string): boolean
|
|
1070
|
+
|
|
1071
|
+
/**
|
|
1072
|
+
*
|
|
1073
|
+
*/
|
|
1074
|
+
pauseGrowing(pausedOrNot: number): boolean
|
|
1075
|
+
|
|
1076
|
+
/**
|
|
1077
|
+
*
|
|
1078
|
+
*/
|
|
1079
|
+
placeAsset(arg1: any): boolean
|
|
1080
|
+
|
|
1081
|
+
/**
|
|
1082
|
+
*
|
|
1083
|
+
*/
|
|
1084
|
+
save(): void
|
|
1085
|
+
|
|
1086
|
+
/**
|
|
1087
|
+
*
|
|
1088
|
+
*/
|
|
1089
|
+
saveAs(saveAsPath: string): boolean
|
|
1090
|
+
|
|
1091
|
+
/**
|
|
1092
|
+
*
|
|
1093
|
+
*/
|
|
1094
|
+
setProjectPanelMetadata(newMetadata: string): void
|
|
1095
|
+
|
|
1096
|
+
/**
|
|
1097
|
+
*
|
|
1098
|
+
* @param newSequenceName Name for newly-created sequence
|
|
1099
|
+
* @param projectItems Array of project items to be added to sequence
|
|
1100
|
+
* @param targetBin Bin in which new sequence should be created
|
|
1101
|
+
*/
|
|
1102
|
+
|
|
1103
|
+
createNewSequenceFromClips(
|
|
1104
|
+
newSequenceName: string,
|
|
1105
|
+
projectItems: Array<ProjectItem>,
|
|
1106
|
+
targetBin: ProjectItem,
|
|
1107
|
+
): Sequence
|
|
1108
|
+
|
|
1109
|
+
/**
|
|
1110
|
+
*
|
|
1111
|
+
*/
|
|
1112
|
+
getSupportedGraphicsWhiteLuminances(): Array<any>
|
|
1113
|
+
|
|
1114
|
+
/**
|
|
1115
|
+
*
|
|
1116
|
+
*/
|
|
1117
|
+
getGraphicsWhiteLuminance(): number
|
|
1118
|
+
|
|
1119
|
+
/**
|
|
1120
|
+
*
|
|
1121
|
+
* @param newGWL
|
|
1122
|
+
*/
|
|
1123
|
+
setGraphicsWhiteLuminance(newGWL: number): boolean
|
|
1124
|
+
|
|
1125
|
+
/**
|
|
1126
|
+
*
|
|
1127
|
+
* @param width Integer
|
|
1128
|
+
* @param height Integer
|
|
1129
|
+
* @param timeBase A timebase for a new project item
|
|
1130
|
+
* @param pixelAspectNumerator Integer Pixel aspect ration numerator
|
|
1131
|
+
* @param pixelAspectDenominator Integer Pixel aspect ration denominator
|
|
1132
|
+
* @param audioSampleRate Audio sample rate
|
|
1133
|
+
* @param name String Name for a new project item
|
|
1134
|
+
*/
|
|
1135
|
+
newBarsAndTone(
|
|
1136
|
+
width: number,
|
|
1137
|
+
height: number,
|
|
1138
|
+
timeBase: number,
|
|
1139
|
+
pixelAspectNumerator: number,
|
|
1140
|
+
pixelAspectDenominator: number,
|
|
1141
|
+
audioSampleRate: number,
|
|
1142
|
+
name: string,
|
|
1143
|
+
): boolean
|
|
1144
|
+
|
|
1145
|
+
/**
|
|
1146
|
+
*
|
|
1147
|
+
*/
|
|
1148
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
1149
|
+
|
|
1150
|
+
/**
|
|
1151
|
+
*
|
|
1152
|
+
*/
|
|
1153
|
+
unbind(eventName: string): void
|
|
1154
|
+
}
|
|
1155
|
+
|
|
1156
|
+
/**
|
|
1157
|
+
*
|
|
1158
|
+
*/
|
|
1159
|
+
declare class Track {
|
|
1160
|
+
/**
|
|
1161
|
+
*
|
|
1162
|
+
*/
|
|
1163
|
+
name: String
|
|
1164
|
+
|
|
1165
|
+
/**
|
|
1166
|
+
*
|
|
1167
|
+
*/
|
|
1168
|
+
readonly clips: TrackItemCollection
|
|
1169
|
+
|
|
1170
|
+
/**
|
|
1171
|
+
*
|
|
1172
|
+
*/
|
|
1173
|
+
readonly id: number
|
|
1174
|
+
|
|
1175
|
+
/**
|
|
1176
|
+
*
|
|
1177
|
+
*/
|
|
1178
|
+
readonly mediaType: string
|
|
1179
|
+
|
|
1180
|
+
/**
|
|
1181
|
+
*
|
|
1182
|
+
*/
|
|
1183
|
+
readonly transitions: TrackItemCollection
|
|
1184
|
+
|
|
1185
|
+
/**
|
|
1186
|
+
*
|
|
1187
|
+
*/
|
|
1188
|
+
bind(eventName: string, function_: any): void
|
|
1189
|
+
|
|
1190
|
+
/**
|
|
1191
|
+
* Inserts a clip relative to the time of the last item on that track
|
|
1192
|
+
*/
|
|
1193
|
+
insertClip(clipProjectItem: ProjectItem, time: number): boolean
|
|
1194
|
+
|
|
1195
|
+
/**
|
|
1196
|
+
*
|
|
1197
|
+
*/
|
|
1198
|
+
isMuted(): boolean
|
|
1199
|
+
|
|
1200
|
+
/**
|
|
1201
|
+
*
|
|
1202
|
+
*/
|
|
1203
|
+
isLocked(): boolean
|
|
1204
|
+
|
|
1205
|
+
/**
|
|
1206
|
+
* Overwrites a clip at an absolute time on a track
|
|
1207
|
+
*/
|
|
1208
|
+
overwriteClip(clipProjectItem: ProjectItem, time: number | Time): boolean
|
|
1209
|
+
|
|
1210
|
+
/**
|
|
1211
|
+
*
|
|
1212
|
+
*/
|
|
1213
|
+
setMute(arg1?: number): void
|
|
1214
|
+
|
|
1215
|
+
/**
|
|
1216
|
+
*
|
|
1217
|
+
*/
|
|
1218
|
+
setLocked(arg1?: number): void
|
|
1219
|
+
|
|
1220
|
+
/**
|
|
1221
|
+
*
|
|
1222
|
+
*/
|
|
1223
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
1224
|
+
|
|
1225
|
+
/**
|
|
1226
|
+
*
|
|
1227
|
+
*/
|
|
1228
|
+
isTargeted(): boolean
|
|
1229
|
+
|
|
1230
|
+
/**
|
|
1231
|
+
*
|
|
1232
|
+
*/
|
|
1233
|
+
setTargeted(isTargeted: boolean, shouldBroadcast: boolean): boolean
|
|
1234
|
+
|
|
1235
|
+
/**
|
|
1236
|
+
*
|
|
1237
|
+
*/
|
|
1238
|
+
unbind(eventName: string): void
|
|
1239
|
+
}
|
|
1240
|
+
|
|
1241
|
+
/**
|
|
1242
|
+
*
|
|
1243
|
+
*/
|
|
1244
|
+
|
|
1245
|
+
declare class ComponentCollection {
|
|
1246
|
+
/**Number of items
|
|
1247
|
+
*
|
|
1248
|
+
*/
|
|
1249
|
+
readonly numItems: number
|
|
1250
|
+
/**Number of items
|
|
1251
|
+
*
|
|
1252
|
+
*/
|
|
1253
|
+
readonly length: number;
|
|
1254
|
+
|
|
1255
|
+
/**
|
|
1256
|
+
*
|
|
1257
|
+
*/
|
|
1258
|
+
[index: number]: Component
|
|
1259
|
+
}
|
|
1260
|
+
declare class Component {
|
|
1261
|
+
/**
|
|
1262
|
+
*
|
|
1263
|
+
*/
|
|
1264
|
+
readonly displayName: string
|
|
1265
|
+
/**
|
|
1266
|
+
*
|
|
1267
|
+
*/
|
|
1268
|
+
readonly matchName: string
|
|
1269
|
+
/**
|
|
1270
|
+
*
|
|
1271
|
+
*/
|
|
1272
|
+
readonly properties: ComponentParamCollection
|
|
1273
|
+
}
|
|
1274
|
+
declare class TrackItem {
|
|
1275
|
+
/**
|
|
1276
|
+
*
|
|
1277
|
+
*/
|
|
1278
|
+
readonly components: any
|
|
1279
|
+
|
|
1280
|
+
/**
|
|
1281
|
+
*
|
|
1282
|
+
*/
|
|
1283
|
+
readonly duration: Time
|
|
1284
|
+
|
|
1285
|
+
/**
|
|
1286
|
+
*
|
|
1287
|
+
*/
|
|
1288
|
+
readonly nodeId: string
|
|
1289
|
+
|
|
1290
|
+
/**
|
|
1291
|
+
*
|
|
1292
|
+
*/
|
|
1293
|
+
end: Time
|
|
1294
|
+
|
|
1295
|
+
/**
|
|
1296
|
+
*
|
|
1297
|
+
*/
|
|
1298
|
+
inPoint: Time
|
|
1299
|
+
|
|
1300
|
+
/**
|
|
1301
|
+
*
|
|
1302
|
+
*/
|
|
1303
|
+
outPoint: Time
|
|
1304
|
+
|
|
1305
|
+
/**
|
|
1306
|
+
*
|
|
1307
|
+
*/
|
|
1308
|
+
readonly mediaType: string
|
|
1309
|
+
|
|
1310
|
+
/**
|
|
1311
|
+
*
|
|
1312
|
+
*/
|
|
1313
|
+
name: string
|
|
1314
|
+
|
|
1315
|
+
/**
|
|
1316
|
+
* @version 22.0
|
|
1317
|
+
*/
|
|
1318
|
+
disabled: boolean
|
|
1319
|
+
|
|
1320
|
+
/**
|
|
1321
|
+
* @version 22.0
|
|
1322
|
+
*/
|
|
1323
|
+
readonly parentTrackIndex: number
|
|
1324
|
+
|
|
1325
|
+
/**
|
|
1326
|
+
*
|
|
1327
|
+
*/
|
|
1328
|
+
projectItem: ProjectItem
|
|
1329
|
+
|
|
1330
|
+
/**
|
|
1331
|
+
*
|
|
1332
|
+
*/
|
|
1333
|
+
start: Time
|
|
1334
|
+
|
|
1335
|
+
/**
|
|
1336
|
+
*
|
|
1337
|
+
*/
|
|
1338
|
+
readonly type: number
|
|
1339
|
+
|
|
1340
|
+
/**
|
|
1341
|
+
*
|
|
1342
|
+
*/
|
|
1343
|
+
bind(eventName: string, function_: any): void
|
|
1344
|
+
|
|
1345
|
+
/**
|
|
1346
|
+
*
|
|
1347
|
+
*/
|
|
1348
|
+
getLinkedItems(): TrackItemCollection
|
|
1349
|
+
|
|
1350
|
+
/**
|
|
1351
|
+
*
|
|
1352
|
+
*/
|
|
1353
|
+
isSelected(): boolean
|
|
1354
|
+
|
|
1355
|
+
/**
|
|
1356
|
+
*
|
|
1357
|
+
*/
|
|
1358
|
+
isSpeedReversed(): 0 | 1
|
|
1359
|
+
|
|
1360
|
+
/**
|
|
1361
|
+
*
|
|
1362
|
+
*/
|
|
1363
|
+
setSelected(isSelected: boolean, updateUI?: boolean): void
|
|
1364
|
+
|
|
1365
|
+
/**
|
|
1366
|
+
*
|
|
1367
|
+
*/
|
|
1368
|
+
isAdjustmentLayer(): boolean
|
|
1369
|
+
|
|
1370
|
+
/**
|
|
1371
|
+
*
|
|
1372
|
+
*/
|
|
1373
|
+
remove(rippleEdit: boolean, alignToVideo: boolean): boolean
|
|
1374
|
+
|
|
1375
|
+
/**
|
|
1376
|
+
*
|
|
1377
|
+
*/
|
|
1378
|
+
getSpeed(): number
|
|
1379
|
+
|
|
1380
|
+
/**
|
|
1381
|
+
*
|
|
1382
|
+
*/
|
|
1383
|
+
getMGTComponent(): Component
|
|
1384
|
+
|
|
1385
|
+
/**
|
|
1386
|
+
*
|
|
1387
|
+
*/
|
|
1388
|
+
getColorSpace(): String
|
|
1389
|
+
|
|
1390
|
+
/**
|
|
1391
|
+
*
|
|
1392
|
+
*/
|
|
1393
|
+
move(seconds: number): boolean
|
|
1394
|
+
|
|
1395
|
+
/**
|
|
1396
|
+
*
|
|
1397
|
+
*/
|
|
1398
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
1399
|
+
|
|
1400
|
+
/**
|
|
1401
|
+
*
|
|
1402
|
+
*/
|
|
1403
|
+
unbind(eventName: string): void
|
|
1404
|
+
}
|
|
1405
|
+
|
|
1406
|
+
/**
|
|
1407
|
+
*
|
|
1408
|
+
*/
|
|
1409
|
+
declare class ProjectItem {
|
|
1410
|
+
/**
|
|
1411
|
+
*
|
|
1412
|
+
*/
|
|
1413
|
+
readonly children: ProjectItemCollection
|
|
1414
|
+
|
|
1415
|
+
/**
|
|
1416
|
+
*
|
|
1417
|
+
*/
|
|
1418
|
+
name: string
|
|
1419
|
+
|
|
1420
|
+
/**
|
|
1421
|
+
*
|
|
1422
|
+
*/
|
|
1423
|
+
readonly nodeId: string
|
|
1424
|
+
|
|
1425
|
+
/**
|
|
1426
|
+
*
|
|
1427
|
+
*/
|
|
1428
|
+
readonly treePath: string
|
|
1429
|
+
|
|
1430
|
+
/**
|
|
1431
|
+
*
|
|
1432
|
+
*/
|
|
1433
|
+
readonly type: number
|
|
1434
|
+
|
|
1435
|
+
/**
|
|
1436
|
+
*
|
|
1437
|
+
*/
|
|
1438
|
+
timeDisplayFormat: number
|
|
1439
|
+
|
|
1440
|
+
/**
|
|
1441
|
+
*
|
|
1442
|
+
*/
|
|
1443
|
+
videoComponents: () => ComponentCollection | undefined
|
|
1444
|
+
|
|
1445
|
+
/**
|
|
1446
|
+
*
|
|
1447
|
+
*/
|
|
1448
|
+
attachProxy(mediaPath: string, isHiRes: number): boolean
|
|
1449
|
+
|
|
1450
|
+
/**
|
|
1451
|
+
*
|
|
1452
|
+
*/
|
|
1453
|
+
detachProxy(): boolean
|
|
1454
|
+
|
|
1455
|
+
/**
|
|
1456
|
+
*
|
|
1457
|
+
*/
|
|
1458
|
+
bind(eventName: string, function_: any): void
|
|
1459
|
+
|
|
1460
|
+
/**
|
|
1461
|
+
*
|
|
1462
|
+
*/
|
|
1463
|
+
canChangeMediaPath(): boolean
|
|
1464
|
+
|
|
1465
|
+
/**
|
|
1466
|
+
*
|
|
1467
|
+
*/
|
|
1468
|
+
canProxy(): boolean
|
|
1469
|
+
|
|
1470
|
+
/**
|
|
1471
|
+
*
|
|
1472
|
+
*/
|
|
1473
|
+
changeMediaPath(mediaPath: string, suppressWarnings: boolean): boolean
|
|
1474
|
+
|
|
1475
|
+
/**
|
|
1476
|
+
*
|
|
1477
|
+
*/
|
|
1478
|
+
createBin(name: string): ProjectItem
|
|
1479
|
+
|
|
1480
|
+
/**
|
|
1481
|
+
*
|
|
1482
|
+
*/
|
|
1483
|
+
createSmartBin(name: string, query: string): void
|
|
1484
|
+
|
|
1485
|
+
/**
|
|
1486
|
+
* Returns whether the projectItem represents a sequence.
|
|
1487
|
+
@returns true, if projectItem is a sequence.
|
|
1488
|
+
*/
|
|
1489
|
+
isSequence(): boolean
|
|
1490
|
+
|
|
1491
|
+
/**
|
|
1492
|
+
*
|
|
1493
|
+
*/
|
|
1494
|
+
createSubClip(
|
|
1495
|
+
name: string,
|
|
1496
|
+
startTime: object,
|
|
1497
|
+
endTime: object,
|
|
1498
|
+
hasHardBoundaries: number,
|
|
1499
|
+
takeVideo?: number,
|
|
1500
|
+
takeAudio?: number,
|
|
1501
|
+
): ProjectItem
|
|
1502
|
+
|
|
1503
|
+
/**
|
|
1504
|
+
*
|
|
1505
|
+
*/
|
|
1506
|
+
deleteBin(): void
|
|
1507
|
+
|
|
1508
|
+
/**
|
|
1509
|
+
*
|
|
1510
|
+
*/
|
|
1511
|
+
findItemsMatchingMediaPath(matchString: string, ignoreSubclips?: number): void
|
|
1512
|
+
|
|
1513
|
+
/**
|
|
1514
|
+
*
|
|
1515
|
+
*/
|
|
1516
|
+
getColorLabel(): number
|
|
1517
|
+
|
|
1518
|
+
/**
|
|
1519
|
+
*
|
|
1520
|
+
*/
|
|
1521
|
+
getMarkers(): MarkerCollection
|
|
1522
|
+
|
|
1523
|
+
/**
|
|
1524
|
+
*
|
|
1525
|
+
*/
|
|
1526
|
+
getMediaPath(): string
|
|
1527
|
+
|
|
1528
|
+
/**
|
|
1529
|
+
*
|
|
1530
|
+
*/
|
|
1531
|
+
getProjectMetadata(): string
|
|
1532
|
+
|
|
1533
|
+
/**
|
|
1534
|
+
*
|
|
1535
|
+
*/
|
|
1536
|
+
getProxyPath(): string
|
|
1537
|
+
|
|
1538
|
+
/**
|
|
1539
|
+
*
|
|
1540
|
+
*/
|
|
1541
|
+
getXMPMetadata(): string
|
|
1542
|
+
|
|
1543
|
+
/**
|
|
1544
|
+
*
|
|
1545
|
+
*/
|
|
1546
|
+
hasProxy(): boolean
|
|
1547
|
+
|
|
1548
|
+
/**
|
|
1549
|
+
*
|
|
1550
|
+
*/
|
|
1551
|
+
moveBin(destination: ProjectItem): void
|
|
1552
|
+
|
|
1553
|
+
/**
|
|
1554
|
+
*
|
|
1555
|
+
*/
|
|
1556
|
+
refreshMedia(): string
|
|
1557
|
+
|
|
1558
|
+
/**
|
|
1559
|
+
*
|
|
1560
|
+
*/
|
|
1561
|
+
renameBin(name: string): boolean
|
|
1562
|
+
|
|
1563
|
+
/**
|
|
1564
|
+
*
|
|
1565
|
+
*/
|
|
1566
|
+
select(): void
|
|
1567
|
+
|
|
1568
|
+
/**
|
|
1569
|
+
*
|
|
1570
|
+
*/
|
|
1571
|
+
setColorLabel(newColor: number): void
|
|
1572
|
+
|
|
1573
|
+
/**
|
|
1574
|
+
*
|
|
1575
|
+
*/
|
|
1576
|
+
setOverridePixelAspectRatio(numerator: number, denominator: number): boolean
|
|
1577
|
+
|
|
1578
|
+
/**
|
|
1579
|
+
*
|
|
1580
|
+
*/
|
|
1581
|
+
setOverrideFrameRate(newFrameRate: number): boolean
|
|
1582
|
+
|
|
1583
|
+
/**
|
|
1584
|
+
*
|
|
1585
|
+
*/
|
|
1586
|
+
setProjectMetadata(buffer: String, keysToBeUpdated: Array<any>): void
|
|
1587
|
+
|
|
1588
|
+
/**
|
|
1589
|
+
*
|
|
1590
|
+
*/
|
|
1591
|
+
setScaleToFrameSize(): void
|
|
1592
|
+
|
|
1593
|
+
/**
|
|
1594
|
+
*
|
|
1595
|
+
*/
|
|
1596
|
+
setStartTime(seconds: number): void
|
|
1597
|
+
|
|
1598
|
+
/**
|
|
1599
|
+
* Sets the in point of the clip.
|
|
1600
|
+
* @param seconds Time of in point.
|
|
1601
|
+
*/
|
|
1602
|
+
setInPoint(seconds: Time | number | string, p2: number): void
|
|
1603
|
+
|
|
1604
|
+
/**
|
|
1605
|
+
* Sets the out point of the clip.
|
|
1606
|
+
* @param seconds Time of out point.
|
|
1607
|
+
*/
|
|
1608
|
+
setOutPoint(seconds: Time | number | string, p2: number): void
|
|
1609
|
+
|
|
1610
|
+
/**
|
|
1611
|
+
* Clears the in point of the clip.
|
|
1612
|
+
*/
|
|
1613
|
+
clearInPoint(): boolean
|
|
1614
|
+
|
|
1615
|
+
/**
|
|
1616
|
+
* Clears the out point of the clip.
|
|
1617
|
+
*/
|
|
1618
|
+
clearOutPoint(): boolean
|
|
1619
|
+
|
|
1620
|
+
/**
|
|
1621
|
+
*
|
|
1622
|
+
*/
|
|
1623
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
1624
|
+
|
|
1625
|
+
/**
|
|
1626
|
+
*
|
|
1627
|
+
*/
|
|
1628
|
+
setXMPMetadata(buffer: String): boolean
|
|
1629
|
+
|
|
1630
|
+
/**
|
|
1631
|
+
*
|
|
1632
|
+
*/
|
|
1633
|
+
startTime(): Time
|
|
1634
|
+
|
|
1635
|
+
/**
|
|
1636
|
+
*
|
|
1637
|
+
* @param newColorSpace value must be available via sequence.workingColorSpaceList
|
|
1638
|
+
*/
|
|
1639
|
+
setOverrideColorSpace(newColorSpace: String): void
|
|
1640
|
+
|
|
1641
|
+
/**
|
|
1642
|
+
*
|
|
1643
|
+
*/
|
|
1644
|
+
getColorSpace(): String
|
|
1645
|
+
|
|
1646
|
+
/**
|
|
1647
|
+
*
|
|
1648
|
+
*/
|
|
1649
|
+
isMultiCamClip(): boolean
|
|
1650
|
+
|
|
1651
|
+
/**
|
|
1652
|
+
*
|
|
1653
|
+
*/
|
|
1654
|
+
isMergedClip(): boolean
|
|
1655
|
+
|
|
1656
|
+
/**
|
|
1657
|
+
*
|
|
1658
|
+
*/
|
|
1659
|
+
getInPoint(): Time
|
|
1660
|
+
|
|
1661
|
+
/**
|
|
1662
|
+
*
|
|
1663
|
+
*/
|
|
1664
|
+
getOutPoint(): Time
|
|
1665
|
+
|
|
1666
|
+
/**
|
|
1667
|
+
*
|
|
1668
|
+
*/
|
|
1669
|
+
unbind(eventName: string): void
|
|
1670
|
+
}
|
|
1671
|
+
|
|
1672
|
+
/**
|
|
1673
|
+
*
|
|
1674
|
+
*/
|
|
1675
|
+
declare class ProjectCollection {
|
|
1676
|
+
/**
|
|
1677
|
+
*
|
|
1678
|
+
*/
|
|
1679
|
+
readonly numProjects: number
|
|
1680
|
+
|
|
1681
|
+
/**
|
|
1682
|
+
*
|
|
1683
|
+
*/
|
|
1684
|
+
bind(eventName: string, function_: any): void
|
|
1685
|
+
|
|
1686
|
+
/**
|
|
1687
|
+
*
|
|
1688
|
+
*/
|
|
1689
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
1690
|
+
|
|
1691
|
+
/**
|
|
1692
|
+
*
|
|
1693
|
+
*/
|
|
1694
|
+
unbind(eventName: string): void
|
|
1695
|
+
|
|
1696
|
+
/**
|
|
1697
|
+
*
|
|
1698
|
+
*/
|
|
1699
|
+
[index: number]: Project
|
|
1700
|
+
}
|
|
1701
|
+
|
|
1702
|
+
/**
|
|
1703
|
+
*
|
|
1704
|
+
*/
|
|
1705
|
+
declare class ProjectItemCollection {
|
|
1706
|
+
/**
|
|
1707
|
+
*
|
|
1708
|
+
*/
|
|
1709
|
+
readonly numItems: number
|
|
1710
|
+
|
|
1711
|
+
/**
|
|
1712
|
+
*
|
|
1713
|
+
*/
|
|
1714
|
+
bind(eventName: string, function_: any): void
|
|
1715
|
+
|
|
1716
|
+
/**
|
|
1717
|
+
*
|
|
1718
|
+
*/
|
|
1719
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
1720
|
+
|
|
1721
|
+
/**
|
|
1722
|
+
*
|
|
1723
|
+
*/
|
|
1724
|
+
unbind(eventName: string): void
|
|
1725
|
+
|
|
1726
|
+
/**
|
|
1727
|
+
*
|
|
1728
|
+
*/
|
|
1729
|
+
[index: number]: ProjectItem
|
|
1730
|
+
}
|
|
1731
|
+
|
|
1732
|
+
/**
|
|
1733
|
+
*
|
|
1734
|
+
*/
|
|
1735
|
+
declare class TrackCollection {
|
|
1736
|
+
/**
|
|
1737
|
+
*
|
|
1738
|
+
*/
|
|
1739
|
+
readonly numTracks: number
|
|
1740
|
+
|
|
1741
|
+
/**
|
|
1742
|
+
*
|
|
1743
|
+
*/
|
|
1744
|
+
bind(eventName: string, function_: any): void
|
|
1745
|
+
|
|
1746
|
+
/**
|
|
1747
|
+
*
|
|
1748
|
+
*/
|
|
1749
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
1750
|
+
|
|
1751
|
+
/**
|
|
1752
|
+
*
|
|
1753
|
+
*/
|
|
1754
|
+
unbind(eventName: string): void
|
|
1755
|
+
|
|
1756
|
+
/**
|
|
1757
|
+
*
|
|
1758
|
+
*/
|
|
1759
|
+
[index: number]: Track
|
|
1760
|
+
}
|
|
1761
|
+
|
|
1762
|
+
/**
|
|
1763
|
+
*
|
|
1764
|
+
*/
|
|
1765
|
+
declare class TrackItemCollection {
|
|
1766
|
+
/**Number of items
|
|
1767
|
+
*
|
|
1768
|
+
*/
|
|
1769
|
+
readonly numItems: number
|
|
1770
|
+
|
|
1771
|
+
/**
|
|
1772
|
+
*
|
|
1773
|
+
*/
|
|
1774
|
+
bind(eventName: string, function_: any): void
|
|
1775
|
+
|
|
1776
|
+
/**
|
|
1777
|
+
*
|
|
1778
|
+
*/
|
|
1779
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
1780
|
+
|
|
1781
|
+
/**
|
|
1782
|
+
*
|
|
1783
|
+
*/
|
|
1784
|
+
unbind(eventName: string): void
|
|
1785
|
+
|
|
1786
|
+
/**
|
|
1787
|
+
*
|
|
1788
|
+
*/
|
|
1789
|
+
[index: number]: TrackItem
|
|
1790
|
+
}
|
|
1791
|
+
|
|
1792
|
+
/**
|
|
1793
|
+
*
|
|
1794
|
+
*/
|
|
1795
|
+
declare class ScratchDiskType {
|
|
1796
|
+
/**
|
|
1797
|
+
*
|
|
1798
|
+
*/
|
|
1799
|
+
static readonly FirstAudioCaptureFolder: string
|
|
1800
|
+
|
|
1801
|
+
/**
|
|
1802
|
+
*
|
|
1803
|
+
*/
|
|
1804
|
+
static readonly FirstAudioPreviewFolder: string
|
|
1805
|
+
|
|
1806
|
+
/**
|
|
1807
|
+
*
|
|
1808
|
+
*/
|
|
1809
|
+
static readonly FirstAutoSaveFolder: string
|
|
1810
|
+
|
|
1811
|
+
/**
|
|
1812
|
+
*
|
|
1813
|
+
*/
|
|
1814
|
+
static readonly FirstCClibrariesFolder: string
|
|
1815
|
+
|
|
1816
|
+
/**
|
|
1817
|
+
*
|
|
1818
|
+
*/
|
|
1819
|
+
static readonly FirstCapsuleMediaFolder: string
|
|
1820
|
+
|
|
1821
|
+
/**
|
|
1822
|
+
*
|
|
1823
|
+
*/
|
|
1824
|
+
static readonly FirstVideoCaptureFolder: string
|
|
1825
|
+
|
|
1826
|
+
/**
|
|
1827
|
+
*
|
|
1828
|
+
*/
|
|
1829
|
+
static readonly FirstVideoPreviewFolder: string
|
|
1830
|
+
|
|
1831
|
+
/**
|
|
1832
|
+
*
|
|
1833
|
+
*/
|
|
1834
|
+
bind(eventName: string, function_: any): void
|
|
1835
|
+
|
|
1836
|
+
/**
|
|
1837
|
+
*
|
|
1838
|
+
*/
|
|
1839
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
1840
|
+
|
|
1841
|
+
/**
|
|
1842
|
+
*
|
|
1843
|
+
*/
|
|
1844
|
+
unbind(eventName: string): void
|
|
1845
|
+
}
|
|
1846
|
+
|
|
1847
|
+
/**
|
|
1848
|
+
*
|
|
1849
|
+
*/
|
|
1850
|
+
declare class Csxs {
|
|
1851
|
+
/**
|
|
1852
|
+
*
|
|
1853
|
+
*/
|
|
1854
|
+
readonly resourceCentral: CsxsResourceCentral
|
|
1855
|
+
|
|
1856
|
+
/**
|
|
1857
|
+
*
|
|
1858
|
+
*/
|
|
1859
|
+
bind(eventName: string, function_: any): void
|
|
1860
|
+
|
|
1861
|
+
/**
|
|
1862
|
+
*
|
|
1863
|
+
*/
|
|
1864
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
1865
|
+
|
|
1866
|
+
/**
|
|
1867
|
+
*
|
|
1868
|
+
*/
|
|
1869
|
+
unbind(eventName: string): void
|
|
1870
|
+
}
|
|
1871
|
+
|
|
1872
|
+
/**
|
|
1873
|
+
*
|
|
1874
|
+
*/
|
|
1875
|
+
declare class RemoteProductionCollection {
|
|
1876
|
+
/**
|
|
1877
|
+
*
|
|
1878
|
+
*/
|
|
1879
|
+
readonly numProductions: number
|
|
1880
|
+
|
|
1881
|
+
/**
|
|
1882
|
+
*
|
|
1883
|
+
*/
|
|
1884
|
+
bind(eventName: string, function_: any): void
|
|
1885
|
+
|
|
1886
|
+
/**
|
|
1887
|
+
*
|
|
1888
|
+
*/
|
|
1889
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
1890
|
+
|
|
1891
|
+
/**
|
|
1892
|
+
*
|
|
1893
|
+
*/
|
|
1894
|
+
unbind(eventName: string): void
|
|
1895
|
+
}
|
|
1896
|
+
|
|
1897
|
+
/**
|
|
1898
|
+
*
|
|
1899
|
+
*/
|
|
1900
|
+
declare class RemoteProduction {
|
|
1901
|
+
/**
|
|
1902
|
+
*
|
|
1903
|
+
*/
|
|
1904
|
+
readonly description: string
|
|
1905
|
+
|
|
1906
|
+
/**
|
|
1907
|
+
*
|
|
1908
|
+
*/
|
|
1909
|
+
readonly name: string
|
|
1910
|
+
|
|
1911
|
+
/**
|
|
1912
|
+
*
|
|
1913
|
+
*/
|
|
1914
|
+
readonly url: string
|
|
1915
|
+
|
|
1916
|
+
/**
|
|
1917
|
+
*
|
|
1918
|
+
*/
|
|
1919
|
+
bind(eventName: string, function_: any): void
|
|
1920
|
+
|
|
1921
|
+
/**
|
|
1922
|
+
*
|
|
1923
|
+
*/
|
|
1924
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
1925
|
+
|
|
1926
|
+
/**
|
|
1927
|
+
*
|
|
1928
|
+
*/
|
|
1929
|
+
unbind(eventName: string): void
|
|
1930
|
+
}
|
|
1931
|
+
|
|
1932
|
+
type EncoderEvent =
|
|
1933
|
+
| "onEncoderJobCanceled"
|
|
1934
|
+
| "onEncoderJobQueued"
|
|
1935
|
+
| "onEncoderJobComplete"
|
|
1936
|
+
| "onEncoderJobError"
|
|
1937
|
+
| "onEncoderJobProgress"
|
|
1938
|
+
| "onEncoderLaunched"
|
|
1939
|
+
|
|
1940
|
+
/**
|
|
1941
|
+
*
|
|
1942
|
+
*/
|
|
1943
|
+
declare class Encoder {
|
|
1944
|
+
/**
|
|
1945
|
+
*
|
|
1946
|
+
*/
|
|
1947
|
+
readonly ENCODE_ENTIRE: number
|
|
1948
|
+
|
|
1949
|
+
/**
|
|
1950
|
+
*
|
|
1951
|
+
*/
|
|
1952
|
+
readonly ENCODE_IN_TO_OUT: number
|
|
1953
|
+
|
|
1954
|
+
/**
|
|
1955
|
+
*
|
|
1956
|
+
*/
|
|
1957
|
+
readonly ENCODE_WORKAREA: number
|
|
1958
|
+
|
|
1959
|
+
/**
|
|
1960
|
+
*
|
|
1961
|
+
*/
|
|
1962
|
+
bind(eventName: EncoderEvent, function_: any): void
|
|
1963
|
+
|
|
1964
|
+
/**
|
|
1965
|
+
*
|
|
1966
|
+
*/
|
|
1967
|
+
encodeFile(
|
|
1968
|
+
inputFilePath: string,
|
|
1969
|
+
outputFilePath: string,
|
|
1970
|
+
presetPath: string,
|
|
1971
|
+
removeOnCompletion?: number,
|
|
1972
|
+
startTime?: object,
|
|
1973
|
+
stopTime?: object,
|
|
1974
|
+
): string
|
|
1975
|
+
|
|
1976
|
+
/**
|
|
1977
|
+
*
|
|
1978
|
+
*/
|
|
1979
|
+
encodeProjectItem(
|
|
1980
|
+
projectItem: ProjectItem,
|
|
1981
|
+
outputFilePath: string,
|
|
1982
|
+
presetPath: string,
|
|
1983
|
+
WorkAreaType?: number,
|
|
1984
|
+
removeOnCompletion?: number,
|
|
1985
|
+
): string
|
|
1986
|
+
|
|
1987
|
+
/**
|
|
1988
|
+
*
|
|
1989
|
+
*/
|
|
1990
|
+
encodeSequence(
|
|
1991
|
+
sequence: Sequence,
|
|
1992
|
+
outputFilePath: string,
|
|
1993
|
+
presetPath: string,
|
|
1994
|
+
WorkAreaType?: number,
|
|
1995
|
+
removeOnCompletion?: number,
|
|
1996
|
+
): string
|
|
1997
|
+
|
|
1998
|
+
/**
|
|
1999
|
+
*
|
|
2000
|
+
*/
|
|
2001
|
+
getExporters(): Array<any>
|
|
2002
|
+
/**
|
|
2003
|
+
*
|
|
2004
|
+
*/
|
|
2005
|
+
launchEncoder(): boolean
|
|
2006
|
+
|
|
2007
|
+
/**
|
|
2008
|
+
*
|
|
2009
|
+
*/
|
|
2010
|
+
setEmbeddedXMPEnabled(enable: number): void
|
|
2011
|
+
|
|
2012
|
+
/**
|
|
2013
|
+
*
|
|
2014
|
+
*/
|
|
2015
|
+
setSidecarXMPEnabled(enable: number): void
|
|
2016
|
+
|
|
2017
|
+
/**
|
|
2018
|
+
*
|
|
2019
|
+
*/
|
|
2020
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
2021
|
+
|
|
2022
|
+
/**
|
|
2023
|
+
*
|
|
2024
|
+
*/
|
|
2025
|
+
startBatch(): boolean
|
|
2026
|
+
|
|
2027
|
+
/**
|
|
2028
|
+
*
|
|
2029
|
+
*/
|
|
2030
|
+
lastExportMediaFolder(): String
|
|
2031
|
+
|
|
2032
|
+
/**
|
|
2033
|
+
*
|
|
2034
|
+
*/
|
|
2035
|
+
unbind(eventName: string): void
|
|
2036
|
+
}
|
|
2037
|
+
|
|
2038
|
+
/**
|
|
2039
|
+
*
|
|
2040
|
+
*/
|
|
2041
|
+
declare class ComponentParamCollection {
|
|
2042
|
+
/** Number of items */
|
|
2043
|
+
readonly numItems: number
|
|
2044
|
+
|
|
2045
|
+
/** Number of items */
|
|
2046
|
+
readonly length: number
|
|
2047
|
+
|
|
2048
|
+
bind(eventName: string, function_: any): void
|
|
2049
|
+
clearProperty(propertyKey: string): void
|
|
2050
|
+
doesPropertyExist(propertyKey: string): boolean
|
|
2051
|
+
getProperty(propertyKey: string): any
|
|
2052
|
+
isPropertyReadOnly(propertyKey: string): boolean
|
|
2053
|
+
setProperty(
|
|
2054
|
+
propertyKey: string,
|
|
2055
|
+
propertyValue: any,
|
|
2056
|
+
permanenceValue: number,
|
|
2057
|
+
allowCreateNewProperty: boolean,
|
|
2058
|
+
): void
|
|
2059
|
+
|
|
2060
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
2061
|
+
unbind(eventName: string): void
|
|
2062
|
+
[index: number]: ComponentParam
|
|
2063
|
+
getParamForDisplayName(paramName: string): ComponentParam | null
|
|
2064
|
+
}
|
|
2065
|
+
|
|
2066
|
+
declare class ComponentParam {
|
|
2067
|
+
readonly displayName: string
|
|
2068
|
+
addKey(): boolean
|
|
2069
|
+
areKeyframesSupported(): boolean
|
|
2070
|
+
findNearestKey(): object
|
|
2071
|
+
findNextKey(): object
|
|
2072
|
+
findPreviousKey(): object
|
|
2073
|
+
getColorValue(): any[]
|
|
2074
|
+
getKeys(): any[]
|
|
2075
|
+
getValue(): any
|
|
2076
|
+
getValueAtKey(time: Time): any
|
|
2077
|
+
getValueAtTime(): any
|
|
2078
|
+
isEmpty(): boolean
|
|
2079
|
+
isTimeVarying(): boolean
|
|
2080
|
+
keyExistsAtTime(): boolean
|
|
2081
|
+
removeKey(): boolean
|
|
2082
|
+
removeKeyRange(start: Time, end: Time): boolean
|
|
2083
|
+
setColorValue(p0: number, p1: number, p2: number, p3: number, p4: boolean): boolean
|
|
2084
|
+
setInterpolationTypeAtKey(): boolean
|
|
2085
|
+
setTimeVarying(setTimeVarying: boolean, p1?: boolean): boolean
|
|
2086
|
+
setValue(value: any, updateUI?: boolean | number): boolean
|
|
2087
|
+
setValueAtKey(time: Time, value: any, updateUI?: boolean | number): boolean
|
|
2088
|
+
}
|
|
2089
|
+
/**
|
|
2090
|
+
*
|
|
2091
|
+
*/
|
|
2092
|
+
declare class PrProduction {
|
|
2093
|
+
/**
|
|
2094
|
+
*
|
|
2095
|
+
*/
|
|
2096
|
+
name: string
|
|
2097
|
+
|
|
2098
|
+
/**
|
|
2099
|
+
*
|
|
2100
|
+
*/
|
|
2101
|
+
projects: ProjectCollection
|
|
2102
|
+
|
|
2103
|
+
/**
|
|
2104
|
+
*
|
|
2105
|
+
*/
|
|
2106
|
+
close(): void
|
|
2107
|
+
|
|
2108
|
+
/**
|
|
2109
|
+
*
|
|
2110
|
+
*/
|
|
2111
|
+
getLocked(project: Project): Boolean
|
|
2112
|
+
|
|
2113
|
+
/**
|
|
2114
|
+
*
|
|
2115
|
+
*/
|
|
2116
|
+
setLocked(project: Project, newLockState: Boolean): void
|
|
2117
|
+
|
|
2118
|
+
/**
|
|
2119
|
+
*
|
|
2120
|
+
*/
|
|
2121
|
+
moveToTrash(projectPath: String, suppressUI: Boolean, saveProject: Boolean): Boolean
|
|
2122
|
+
}
|
|
2123
|
+
|
|
2124
|
+
type ApplicationEvent =
|
|
2125
|
+
| "onSourceClipSelectedInProjectPanel"
|
|
2126
|
+
| "onSequenceActivated"
|
|
2127
|
+
| "onActiveSequenceChanged"
|
|
2128
|
+
| "onActiveSequenceSelectionChanged"
|
|
2129
|
+
| "onActiveSequenceTrackItemAdded"
|
|
2130
|
+
| "onActiveSequenceTrackItemRemoved"
|
|
2131
|
+
| "onActiveSequenceStructureChanged"
|
|
2132
|
+
| "onProjectChanged"
|
|
2133
|
+
| "onProjectEndDrop"
|
|
2134
|
+
|
|
2135
|
+
/**
|
|
2136
|
+
*
|
|
2137
|
+
*/
|
|
2138
|
+
declare class Application {
|
|
2139
|
+
/**
|
|
2140
|
+
*
|
|
2141
|
+
*/
|
|
2142
|
+
readonly anywhere: Anywhere
|
|
2143
|
+
|
|
2144
|
+
/**
|
|
2145
|
+
*
|
|
2146
|
+
*/
|
|
2147
|
+
readonly build: string
|
|
2148
|
+
|
|
2149
|
+
/**
|
|
2150
|
+
*
|
|
2151
|
+
*/
|
|
2152
|
+
readonly csxs: Csxs
|
|
2153
|
+
|
|
2154
|
+
/**
|
|
2155
|
+
*
|
|
2156
|
+
*/
|
|
2157
|
+
readonly encoder: Encoder
|
|
2158
|
+
|
|
2159
|
+
/**
|
|
2160
|
+
*
|
|
2161
|
+
*/
|
|
2162
|
+
readonly projectManager: ProjectManager
|
|
2163
|
+
|
|
2164
|
+
/**
|
|
2165
|
+
*
|
|
2166
|
+
*/
|
|
2167
|
+
readonly getAppPrefPath: string
|
|
2168
|
+
|
|
2169
|
+
/**
|
|
2170
|
+
*
|
|
2171
|
+
*/
|
|
2172
|
+
readonly getAppSystemPrefPath: string
|
|
2173
|
+
|
|
2174
|
+
/**
|
|
2175
|
+
*
|
|
2176
|
+
*/
|
|
2177
|
+
readonly getPProPrefPath: string
|
|
2178
|
+
|
|
2179
|
+
/**
|
|
2180
|
+
*
|
|
2181
|
+
*/
|
|
2182
|
+
readonly getPProSystemPrefPath: string
|
|
2183
|
+
|
|
2184
|
+
/**
|
|
2185
|
+
*
|
|
2186
|
+
*/
|
|
2187
|
+
readonly metadata: Metadata
|
|
2188
|
+
|
|
2189
|
+
/**
|
|
2190
|
+
* This is the current active project.
|
|
2191
|
+
*/
|
|
2192
|
+
project: Project
|
|
2193
|
+
|
|
2194
|
+
/**
|
|
2195
|
+
*
|
|
2196
|
+
*/
|
|
2197
|
+
readonly projects: ProjectCollection
|
|
2198
|
+
|
|
2199
|
+
/**
|
|
2200
|
+
*
|
|
2201
|
+
*/
|
|
2202
|
+
readonly properties: ComponentParamCollection
|
|
2203
|
+
|
|
2204
|
+
/**
|
|
2205
|
+
*
|
|
2206
|
+
*/
|
|
2207
|
+
readonly sourceMonitor: SourceMonitor
|
|
2208
|
+
|
|
2209
|
+
/**
|
|
2210
|
+
*
|
|
2211
|
+
*/
|
|
2212
|
+
readonly userGuid: string
|
|
2213
|
+
|
|
2214
|
+
/**
|
|
2215
|
+
*
|
|
2216
|
+
*/
|
|
2217
|
+
readonly version: string
|
|
2218
|
+
|
|
2219
|
+
/**
|
|
2220
|
+
*
|
|
2221
|
+
*/
|
|
2222
|
+
bind(eventName: ApplicationEvent, function_: Function): void
|
|
2223
|
+
|
|
2224
|
+
/**
|
|
2225
|
+
* Notifies App that Preferences have changed
|
|
2226
|
+
* Only valid argument currently is 'BE::PreferencesScratchDisksChanged'
|
|
2227
|
+
*/
|
|
2228
|
+
broadcastPrefsChanged(preferencesThatChanged: string): boolean
|
|
2229
|
+
|
|
2230
|
+
/**
|
|
2231
|
+
*
|
|
2232
|
+
*/
|
|
2233
|
+
getEnableProxies(): number
|
|
2234
|
+
|
|
2235
|
+
/**
|
|
2236
|
+
* Checks whether file specified is a doc
|
|
2237
|
+
* @param filePath This is the path to be checked
|
|
2238
|
+
* @returns true if the document at that path is openable as a PPro project
|
|
2239
|
+
*/
|
|
2240
|
+
isDocument(filePath: string): boolean
|
|
2241
|
+
|
|
2242
|
+
/**
|
|
2243
|
+
*
|
|
2244
|
+
*/
|
|
2245
|
+
isDocumentOpen(): boolean
|
|
2246
|
+
|
|
2247
|
+
/**
|
|
2248
|
+
*
|
|
2249
|
+
*/
|
|
2250
|
+
openDocument(
|
|
2251
|
+
filePath: string,
|
|
2252
|
+
bypassConversionDialog?: boolean,
|
|
2253
|
+
bypassLocateFile?: boolean,
|
|
2254
|
+
bypassWarningDialog?: boolean,
|
|
2255
|
+
hideFromMRUList?: boolean,
|
|
2256
|
+
): boolean
|
|
2257
|
+
|
|
2258
|
+
/**
|
|
2259
|
+
* @param newValueForTranscodeOnIngest
|
|
2260
|
+
* @returns the newly-set state for whether or not PPro transcodes files upon ingest.
|
|
2261
|
+
*/
|
|
2262
|
+
setEnableTranscodeOnIngest(newValueForTranscodeOnIngest: boolean): void
|
|
2263
|
+
|
|
2264
|
+
/**
|
|
2265
|
+
*
|
|
2266
|
+
*/
|
|
2267
|
+
openFCPXML(): boolean
|
|
2268
|
+
|
|
2269
|
+
/**
|
|
2270
|
+
*
|
|
2271
|
+
*/
|
|
2272
|
+
quit(): void
|
|
2273
|
+
|
|
2274
|
+
/**
|
|
2275
|
+
*
|
|
2276
|
+
*/
|
|
2277
|
+
setEnableProxies(enable: number): boolean
|
|
2278
|
+
|
|
2279
|
+
/**
|
|
2280
|
+
*
|
|
2281
|
+
*/
|
|
2282
|
+
setExtensionPersistent(extensionID: string, state?: number): void
|
|
2283
|
+
|
|
2284
|
+
/**
|
|
2285
|
+
*
|
|
2286
|
+
*/
|
|
2287
|
+
setSDKEventMessage(value: string, eventType: string): boolean
|
|
2288
|
+
|
|
2289
|
+
/**
|
|
2290
|
+
*
|
|
2291
|
+
*/
|
|
2292
|
+
setScratchDiskPath(value: string, type: string): boolean
|
|
2293
|
+
|
|
2294
|
+
/**
|
|
2295
|
+
*
|
|
2296
|
+
*/
|
|
2297
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
2298
|
+
|
|
2299
|
+
/**
|
|
2300
|
+
*
|
|
2301
|
+
*/
|
|
2302
|
+
getProjectViewIDs(): Array<string>
|
|
2303
|
+
|
|
2304
|
+
/**
|
|
2305
|
+
*
|
|
2306
|
+
*/
|
|
2307
|
+
getProjectFromViewID(viewID: String): Project
|
|
2308
|
+
|
|
2309
|
+
/**
|
|
2310
|
+
*
|
|
2311
|
+
*/
|
|
2312
|
+
showCursor(enable: boolean): void
|
|
2313
|
+
|
|
2314
|
+
/**
|
|
2315
|
+
*
|
|
2316
|
+
*/
|
|
2317
|
+
getProjectViewSelection(viewID: String): Array<ProjectItem>
|
|
2318
|
+
|
|
2319
|
+
/**
|
|
2320
|
+
*
|
|
2321
|
+
*/
|
|
2322
|
+
setProjectViewSelection(projectItems: Array<ProjectItem>, viewID: String): void
|
|
2323
|
+
|
|
2324
|
+
/**
|
|
2325
|
+
*
|
|
2326
|
+
*/
|
|
2327
|
+
onItemAddedToProjectSuccess: undefined
|
|
2328
|
+
|
|
2329
|
+
/**
|
|
2330
|
+
* @returns an array of the names of all available workspaces.
|
|
2331
|
+
*/
|
|
2332
|
+
getWorkspaces(): Array<string>
|
|
2333
|
+
|
|
2334
|
+
/**
|
|
2335
|
+
* @param workspaceName Name of workspace to use
|
|
2336
|
+
* @returns true if successful
|
|
2337
|
+
*/
|
|
2338
|
+
setWorkspace(workspaceName: string): void
|
|
2339
|
+
|
|
2340
|
+
/**
|
|
2341
|
+
*
|
|
2342
|
+
* @param eventName event to which to subscribe
|
|
2343
|
+
* @param function_ function to be called
|
|
2344
|
+
*/
|
|
2345
|
+
addEventListener(eventName: string, function_: any): void
|
|
2346
|
+
|
|
2347
|
+
/**
|
|
2348
|
+
*
|
|
2349
|
+
*/
|
|
2350
|
+
trace(message: string): void
|
|
2351
|
+
|
|
2352
|
+
/**
|
|
2353
|
+
*
|
|
2354
|
+
*/
|
|
2355
|
+
unbind(eventName: string): void
|
|
2356
|
+
|
|
2357
|
+
/**
|
|
2358
|
+
*
|
|
2359
|
+
*/
|
|
2360
|
+
enableQE(): void
|
|
2361
|
+
|
|
2362
|
+
/**
|
|
2363
|
+
*
|
|
2364
|
+
*/
|
|
2365
|
+
newProject(projectName: string): boolean
|
|
2366
|
+
|
|
2367
|
+
/**
|
|
2368
|
+
*
|
|
2369
|
+
*/
|
|
2370
|
+
production: PrProduction
|
|
2371
|
+
|
|
2372
|
+
/**
|
|
2373
|
+
*
|
|
2374
|
+
*/
|
|
2375
|
+
openPrProduction(path: string): PrProduction
|
|
2376
|
+
}
|
|
2377
|
+
|
|
2378
|
+
/**
|
|
2379
|
+
*
|
|
2380
|
+
*/
|
|
2381
|
+
declare class MarkerCollection {
|
|
2382
|
+
/**
|
|
2383
|
+
*
|
|
2384
|
+
*/
|
|
2385
|
+
readonly numMarkers: number
|
|
2386
|
+
|
|
2387
|
+
/**
|
|
2388
|
+
*
|
|
2389
|
+
*/
|
|
2390
|
+
bind(eventName: string, function_: any): void
|
|
2391
|
+
|
|
2392
|
+
/**
|
|
2393
|
+
*
|
|
2394
|
+
*/
|
|
2395
|
+
createMarker(start: number, name: string, duration: number, comments: string): Marker
|
|
2396
|
+
|
|
2397
|
+
/**
|
|
2398
|
+
*
|
|
2399
|
+
*/
|
|
2400
|
+
deleteMarker(marker: Marker): void
|
|
2401
|
+
|
|
2402
|
+
/**
|
|
2403
|
+
*
|
|
2404
|
+
*/
|
|
2405
|
+
getFirstMarker(): Marker
|
|
2406
|
+
|
|
2407
|
+
/**
|
|
2408
|
+
*
|
|
2409
|
+
*/
|
|
2410
|
+
getLastMarker(): Marker
|
|
2411
|
+
|
|
2412
|
+
/**
|
|
2413
|
+
*
|
|
2414
|
+
*/
|
|
2415
|
+
getNextMarker(marker: Marker): Marker
|
|
2416
|
+
|
|
2417
|
+
/**
|
|
2418
|
+
*
|
|
2419
|
+
*/
|
|
2420
|
+
getPrevMarker(marker: Marker): Marker
|
|
2421
|
+
|
|
2422
|
+
/**
|
|
2423
|
+
*
|
|
2424
|
+
*/
|
|
2425
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
2426
|
+
|
|
2427
|
+
/**
|
|
2428
|
+
*
|
|
2429
|
+
*/
|
|
2430
|
+
unbind(eventName: string): void
|
|
2431
|
+
|
|
2432
|
+
/**
|
|
2433
|
+
*
|
|
2434
|
+
*/
|
|
2435
|
+
[index: number]: Marker
|
|
2436
|
+
}
|
|
2437
|
+
|
|
2438
|
+
/**
|
|
2439
|
+
*
|
|
2440
|
+
*/
|
|
2441
|
+
declare class Marker {
|
|
2442
|
+
/**
|
|
2443
|
+
*
|
|
2444
|
+
*/
|
|
2445
|
+
comments: string
|
|
2446
|
+
|
|
2447
|
+
/**
|
|
2448
|
+
*
|
|
2449
|
+
*/
|
|
2450
|
+
end: Time
|
|
2451
|
+
|
|
2452
|
+
/**
|
|
2453
|
+
*
|
|
2454
|
+
*/
|
|
2455
|
+
readonly guid: string
|
|
2456
|
+
|
|
2457
|
+
/**
|
|
2458
|
+
*
|
|
2459
|
+
*/
|
|
2460
|
+
name: string
|
|
2461
|
+
|
|
2462
|
+
/**
|
|
2463
|
+
*
|
|
2464
|
+
*/
|
|
2465
|
+
start: Time
|
|
2466
|
+
|
|
2467
|
+
/**
|
|
2468
|
+
*
|
|
2469
|
+
*/
|
|
2470
|
+
type: string
|
|
2471
|
+
|
|
2472
|
+
/**
|
|
2473
|
+
*
|
|
2474
|
+
*/
|
|
2475
|
+
bind(eventName: string, function_: any): void
|
|
2476
|
+
|
|
2477
|
+
/**
|
|
2478
|
+
*
|
|
2479
|
+
*/
|
|
2480
|
+
getWebLinkFrameTarget(): string
|
|
2481
|
+
|
|
2482
|
+
/**
|
|
2483
|
+
*
|
|
2484
|
+
*/
|
|
2485
|
+
getWebLinkURL(): string
|
|
2486
|
+
|
|
2487
|
+
/**
|
|
2488
|
+
*
|
|
2489
|
+
*/
|
|
2490
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
2491
|
+
|
|
2492
|
+
/**
|
|
2493
|
+
*
|
|
2494
|
+
*/
|
|
2495
|
+
setTypeAsChapter(): void
|
|
2496
|
+
|
|
2497
|
+
/**
|
|
2498
|
+
*
|
|
2499
|
+
*/
|
|
2500
|
+
setTypeAsComment(): void
|
|
2501
|
+
|
|
2502
|
+
/**
|
|
2503
|
+
*
|
|
2504
|
+
*/
|
|
2505
|
+
setTypeAsSegmentation(): void
|
|
2506
|
+
|
|
2507
|
+
/**
|
|
2508
|
+
*
|
|
2509
|
+
*/
|
|
2510
|
+
setTypeAsWebLink(url: string, frameTarget: string): void
|
|
2511
|
+
|
|
2512
|
+
/**
|
|
2513
|
+
*
|
|
2514
|
+
*/
|
|
2515
|
+
getColorByIndex(): number
|
|
2516
|
+
|
|
2517
|
+
/**
|
|
2518
|
+
*
|
|
2519
|
+
*/
|
|
2520
|
+
setColorByIndex(index: number): void
|
|
2521
|
+
|
|
2522
|
+
/**
|
|
2523
|
+
*
|
|
2524
|
+
*/
|
|
2525
|
+
unbind(eventName: string): void
|
|
2526
|
+
}
|
|
2527
|
+
|
|
2528
|
+
/**
|
|
2529
|
+
*
|
|
2530
|
+
*/
|
|
2531
|
+
declare class Document {
|
|
2532
|
+
/**
|
|
2533
|
+
*
|
|
2534
|
+
*/
|
|
2535
|
+
bind(eventName: string, function_: any): void
|
|
2536
|
+
|
|
2537
|
+
/**
|
|
2538
|
+
*
|
|
2539
|
+
*/
|
|
2540
|
+
getFilePath(): string
|
|
2541
|
+
|
|
2542
|
+
/**
|
|
2543
|
+
*
|
|
2544
|
+
*/
|
|
2545
|
+
importFiles(arg1: any): boolean
|
|
2546
|
+
|
|
2547
|
+
/**
|
|
2548
|
+
*
|
|
2549
|
+
*/
|
|
2550
|
+
setTimeout(eventName: string, function_: any, milliseconds: number): void
|
|
2551
|
+
|
|
2552
|
+
/**
|
|
2553
|
+
*
|
|
2554
|
+
*/
|
|
2555
|
+
unbind(eventName: string): void
|
|
2556
|
+
}
|
|
2557
|
+
|
|
2558
|
+
declare const document: Document
|
|
2559
|
+
|
|
2560
|
+
interface SystemCompatibilityReport {
|
|
2561
|
+
/**
|
|
2562
|
+
* @param fullOutputPath The path and filename at which to write the report.
|
|
2563
|
+
*/
|
|
2564
|
+
CreateReport(fullOutputPath: string): void
|
|
2565
|
+
}
|
|
2566
|
+
|
|
2567
|
+
declare const SystemCompatibilityReport: SystemCompatibilityReport
|