├── .gitignore
├── resources
└── gif.gif
├── illustratordemo.png
├── .prettierrc
├── .travis.yml
├── tsconfig.json
├── shared
├── tsconfig.json
├── PlugPlugExternalObject.ts
└── global.d.ts
├── Audition
├── 2017
│ └── tsconfig.json
├── 2018
│ └── tsconfig.json
└── 2015.2
│ └── tsconfig.json
├── Premiere
├── 2018
│ ├── tsconfig.json
│ └── index.d.ts
├── 2019
│ └── index.d.ts
└── 2020
│ └── index.d.ts
├── AfterEffects
└── 2018
│ ├── tsconfig.json
│ └── index.d.ts
├── Illustrator
└── 2015.3
│ └── tsconfig.json
├── Photoshop
└── 2015.5
│ └── tsconfig.json
├── InDesign
├── 2018
│ └── tsconfig.json
└── 2015.3
│ └── tsconfig.json
├── package.json
├── src
└── test.ts
└── README.md
/.gitignore:
--------------------------------------------------------------------------------
1 | /node_modules
2 |
--------------------------------------------------------------------------------
/resources/gif.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ten-A/Types-for-Adobe/HEAD/resources/gif.gif
--------------------------------------------------------------------------------
/ illustratordemo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ten-A/Types-for-Adobe/HEAD/ illustratordemo.png
--------------------------------------------------------------------------------
/.prettierrc:
--------------------------------------------------------------------------------
1 | {
2 | "semi": false,
3 | "trailingComma": "all",
4 | "printWidth": 100
5 | }
6 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: node_js
2 | node_js: node
3 | cache:
4 | directories:
5 | - node_modules
6 | notifications:
7 | email: false
8 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "module": "commonjs",
4 | "target": "es6",
5 | "strict": true
6 | },
7 | "exclude": ["node_modules"]
8 | }
9 |
--------------------------------------------------------------------------------
/shared/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "module": "none",
4 | "strict": true,
5 | "noLib": true,
6 | "typeRoots": []
7 | },
8 | "exclude": ["node_modules"]
9 | }
10 |
--------------------------------------------------------------------------------
/Audition/2015.2/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "module": "none",
4 | "strict": true,
5 | "noLib": true,
6 | "typeRoots": []
7 | },
8 | "exclude": ["node_modules"]
9 | }
10 |
--------------------------------------------------------------------------------
/Audition/2017/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "module": "none",
4 | "strict": true,
5 | "noLib": true,
6 | "typeRoots": []
7 | },
8 | "exclude": ["node_modules"]
9 | }
10 |
--------------------------------------------------------------------------------
/Audition/2018/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "module": "none",
4 | "strict": true,
5 | "noLib": true,
6 | "typeRoots": []
7 | },
8 | "exclude": ["node_modules"]
9 | }
10 |
--------------------------------------------------------------------------------
/Premiere/2018/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "module": "none",
4 | "strict": true,
5 | "noLib": true,
6 | "typeRoots": []
7 | },
8 | "exclude": ["node_modules"]
9 | }
10 |
--------------------------------------------------------------------------------
/AfterEffects/2018/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "module": "none",
4 | "strict": true,
5 | "noLib": true,
6 | "typeRoots": []
7 | },
8 | "exclude": ["node_modules"]
9 | }
10 |
--------------------------------------------------------------------------------
/Illustrator/2015.3/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "module": "none",
4 | "strict": true,
5 | "noLib": true,
6 | "typeRoots": []
7 | },
8 | "exclude": ["node_modules"]
9 | }
10 |
--------------------------------------------------------------------------------
/Photoshop/2015.5/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "module": "none",
4 | "strict": true,
5 | "noLib": true,
6 | "typeRoots": []
7 | },
8 | "exclude": ["node_modules"]
9 | }
10 |
--------------------------------------------------------------------------------
/InDesign/2015.3/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "module": "none",
4 | "strict": true,
5 | "noLib": true,
6 | "typeRoots": []
7 | },
8 | "exclude": [
9 | "node_modules"
10 | ]
11 | }
12 |
--------------------------------------------------------------------------------
/InDesign/2018/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "module": "none",
4 | "strict": true,
5 | "noLib": true,
6 | "typeRoots": []
7 | },
8 | "exclude": [
9 | "node_modules"
10 | ]
11 | }
12 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "types-for-adobe",
3 | "version": "1.4.1",
4 | "productName": "TypeScript types for Adobe Products",
5 | "description": "TypeScript types for Adobe Audition, Illustrator, InDesign, Photoshop, AfterEffects, Premiere, ScriptUI",
6 | "keywords": [
7 | "adobe"
8 | ],
9 | "files": [
10 | "AfterEffects",
11 | "Audition",
12 | "InDesign",
13 | "Illustrator",
14 | "Photoshop",
15 | "Premiere",
16 | "shared"
17 | ],
18 | "repository": {
19 | "type": "git",
20 | "url": "https://github.com/ten-A/types-for-adobe.git"
21 | },
22 | "scripts": {
23 | "pretest": "npm i typescript ts-node glob @types/glob",
24 | "test": "ts-node src/test"
25 | },
26 | "license": "MIT"
27 | }
28 |
--------------------------------------------------------------------------------
/src/test.ts:
--------------------------------------------------------------------------------
1 | import * as child_process from "child_process"
2 | import { IOptions, sync as glob } from "glob"
3 | import { promisify } from "util"
4 | const execFile = promisify(child_process.execFile)
5 |
6 | main()
7 |
8 | async function main() {
9 | try {
10 | const options: IOptions = { ignore: "node_modules/**" }
11 | const files = glob("*/**/tsconfig.json", options)
12 |
13 | for (const file of files) {
14 | const dir = file.replace("/tsconfig.json", "")
15 | await execFile("tsc", ["-p", ".", "--pretty", "--noEmit"], { cwd: dir })
16 | console.log("OK " + dir)
17 | }
18 |
19 | console.log("Tests passed.")
20 | process.exit(0)
21 | } catch (e) {
22 | console.log(e.stdout)
23 | process.exit(1)
24 | }
25 | }
26 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 | Repository for declaration files generated by [extendscript-xml-to-typescript converter](https://github.com/pravdomil/extendscript-xml-to-typescript).
3 |
4 |
5 |
6 | ## Prerequisites
7 |
8 | Install [Node.js](https://nodejs.org/en/download/) and [TypeScript](https://www.typescriptlang.org/#download-links) and git.
9 |
10 | ## Your first script for eg. Adobe Illustrator
11 |
12 | ```bash
13 | # create new folder
14 | mkdir my-script
15 | cd my-script
16 |
17 | # install types-for-adobe
18 | npm init -y
19 | npm install ten-A/types-for-adobe
20 |
21 | # create tsconfig.json
22 | printf '{"compilerOptions":{"module":"none","noLib":true}}' > tsconfig.json
23 |
24 | # create index.ts and change reference types to Adobe product you're targeting
25 | printf '/// \nalert(String(app));\n' > index.ts
26 |
27 | # compile typescript files
28 | tsc
29 |
30 | # open Adobe Illustrator -> File -> Scripts -> Other Script -> and open index.js
31 | ```
32 |
33 | ## More typings
34 |
35 | - [Adobe's offical typings](https://github.com/Adobe-CEP/Samples/tree/master/TypeScript/typings)
36 | - [BrightShadow/CSInterface-TS](https://github.com/BrightShadow/CSInterface-TS)
37 | - [Premiere](http://ppro.aenhancers.com)
38 |
39 |
40 | Thanks to [pravdomil](https://github.com/pravdomil).
41 |
42 |
43 |
--------------------------------------------------------------------------------
/shared/PlugPlugExternalObject.ts:
--------------------------------------------------------------------------------
1 | ///
2 |
3 | interface ExternalObjectConstructor {
4 | readonly prototype: ExternalObject
5 |
6 | /**
7 | * Creates a new ExternalObject object.
8 | */
9 | new (lib: string): ExternalObject
10 | (lib: string): ExternalObject
11 | }
12 | declare const ExternalObject: ExternalObjectConstructor
13 |
14 | interface ExternalObject {
15 | /**
16 | * Set to true to write status information to standard output (the
17 | * JavaScript Console in the ExtendScript Toolkit). Set to false to turn
18 | * logging off. Default is false.
19 | */
20 | log: boolean
21 |
22 | /**
23 | * A set of alternate paths in which to search for the shared library files, a
24 | * single string with multiple path specifications delimited by semicolons
25 | * (;). Paths can be absolute or relative to the Folder.startup location.
26 | */
27 | searchFolders: string
28 |
29 | /**
30 | * The version of the library, as returned by ESGetVersion()
31 | */
32 | version: number
33 |
34 | /**
35 | * Reports whether a compiled C/C++ library can be found, but does not load it. If logging is on, the
36 | * paths searched are reported to the JavaScript Console in the ExtendScript Toolkit.
37 | * Returns true if the library is found, false otherwise.
38 | * @param spec The file specification for the compiled library, with or without path information.
39 | */
40 | search(spec: string): boolean
41 |
42 | /**
43 | * Explicitly shuts down the ExternalObject dynamic library wrapped by this instance.
44 | * It can be helpful to force a shutdown of the external library if termination of external libraries during
45 | * the shutdown of the hosting application does not occur in the correct order.
46 | */
47 | terminate(): undefined
48 | }
49 |
50 | interface CSXSEventConstructor {
51 | readonly prototype: CSXSEvent
52 |
53 | /**
54 | * Creates a new CSXSEvent object.
55 | */
56 | new (type?: string, scope?: string, data?: string): CSXSEvent
57 | (type?: string, scope?: string, data?: string): CSXSEvent
58 | }
59 | declare const CSXSEvent: CSXSEventConstructor
60 |
61 | interface CSXSEvent {
62 | /**
63 | * Retrieves the unique identifier of the application from which this event was dispatched.
64 | */
65 | readonly appId: string
66 |
67 | /**
68 | * Retrieves or sets the payload of this event.
69 | */
70 | data: string
71 |
72 | /**
73 | * Retrieves the unique identifier of the extension from which this event was dispatched.
74 | */
75 | readonly extensionId: string
76 |
77 | /**
78 | * Retrieves the scope of this event.
79 | */
80 | scope: string
81 |
82 | /**
83 | * Retrieves the type of this event.
84 | */
85 | type: string
86 |
87 | /**
88 | * Dispatch the event
89 | */
90 | dispatch(): void
91 | }
92 |
--------------------------------------------------------------------------------
/shared/global.d.ts:
--------------------------------------------------------------------------------
1 | ///
2 |
3 | /**
4 | * The global BridgeTalk object.
5 | */
6 | declare var BridgeTalk: any
7 |
8 | /**
9 | * The Infinity global property is a predefined variable with the value for infinity.
10 | */
11 | declare var Infinity: number
12 |
13 | /**
14 | * The NaN global property is a predefined variable with the value NaN (Not-a-Number), as specified by the IEEE-754 standard.
15 | */
16 | declare var NaN: number
17 |
18 | /**
19 | * The application object
20 | */
21 | declare var app: Application
22 | declare interface Application {}
23 |
24 | /**
25 | * Displays an alert box
26 | * @param message The text to display
27 | * @param title The title of the alert; ignored on the Macintosh
28 | * @param errorIcon Display an Error icon; ignored on the Macintosh
29 | */
30 | declare function alert(message: string, title?: string, errorIcon?: boolean): void
31 |
32 | /**
33 | * Displays an alert box with Yes and No buttons; returns true for Yes
34 | * @param message The text to display
35 | * @param noAsDefault Set to true to set the No button as the default button
36 | * @param title The title of the alert; ignored on the Macintosh
37 | */
38 | declare function confirm(message: string, noAsDefault?: boolean, title?: string): boolean
39 |
40 | /**
41 | * Decodes a string created with encodeURI().
42 | * @param uri The text to decode.
43 | */
44 | declare function decodeURI(uri: string): string
45 |
46 | /**
47 | * Decodes a string created with encodeURIComponent().
48 | * @param uri The text to decode.
49 | */
50 | declare function decodeURIComponent(uri: string): string
51 |
52 | /**
53 | * Encodes a string after RFC2396.
54 | * Create an UTF-8 ASCII encoded version of this string. The string is converted into UTF-8. Every non-alphanumeric character is encoded as a percent escape
55 | * character of the form %xx, where xx is the hex value of the character. After the conversion to UTF-8 encoding and escaping, it is guaranteed that the string does not contain characters codes greater than 127. The list of characters not to be encoded is -_.!~*'();/?:@&=+$,#. The method returns false on errors.
56 | * @param text The text to encode.
57 | */
58 | declare function encodeURI(text: string): string
59 |
60 | /**
61 | * Encodes a string after RFC2396.
62 | * Create an UTF-8 ASCII encoded version of this string. The string is converted into UTF-8. Every non-alphanumeric character is encoded as a percent escape
63 | * character of the form %xx, where xx is the hex value of the character. After the conversion to UTF-8 encoding and escaping, it is guaranteed that the string does not contain characters codes greater than 127. The list of characters not to be encoded is -_.!~*'(). The method returns false on errors.
64 | * @param text The text to encode.
65 | */
66 | declare function encodeURIComponent(text: string): string
67 |
68 | /**
69 | * Creates a URL-encoded string from aString.
70 | * In the new string, characters of aString that require URL encoding are replaced with the format %xx, where xx is the hexadecimal value of the character code in the Unicode character set.This format is used to transmit information appended to a URL during, for example, execution of the GET method.Use the unescape() global function to translate the string back into its original format. Returns a string which is aString URL-encoded.
71 | * @param aString The string to be encoded.
72 | */
73 | declare function escape(aString: string): string
74 |
75 | /**
76 | * Evaluates its argument as a JavaScript script, and returns the result of evaluation.
77 | * You can pass the result of an object's toSource() method to reconstruct that object.
78 | * @param stringExpression The string to evaluate.
79 | */
80 | declare function eval(stringExpression: string): any
81 |
82 | /**
83 | * Evaluates an expression and reports whether the result is a finite number.
84 | * Returns true if the expression is a finite number, false otherwise. False if the value is infinity or negative infinity.
85 | * @param expression Any valid JavaScript expression.
86 | */
87 | declare function isFinite(expression: number): boolean
88 |
89 | /**
90 | * Evaluates an expression and reports whether the result is "Not-a-Number" (NaN).
91 | * Returns true if the result of evaluation is not a number (NaN), false if the value is a number.
92 | * @param expression Any valid JavaScript expression.
93 | */
94 | declare function isNaN(expression: number): boolean
95 |
96 | /**
97 | * Returns true if the supplied string is a valid XML name.
98 | * @param name The XML name to test.
99 | */
100 | declare function isXMLName(name: string): boolean
101 |
102 | /**
103 | * Localizes a ZString-encoded string and merges additional arguments into the string.
104 | * @param what The string to localize. A ZString-encoded string that can contain placeholder for additional arguments in the form %1 to %n.
105 | * @param arguments Optional argument(s) to be merged into the string. There may be more than one argument.
106 | */
107 | declare function localize(what: string, ...arguments: any[]): string
108 |
109 | /**
110 | * Extracts a floating-point number from a string.
111 | * Parses a string to find the first set of characters that can be converted to a floating point number, and returns that number, or NaN if it does not encounter characters that it can converted to a number.The function supports exponential notation.
112 | * @param text The string from which to extract a floating point number.
113 | */
114 | declare function parseFloat(text: string): number
115 |
116 | /**
117 | * Extracts an integer from a string.
118 | * Parses a string to find the first set of characters, in a specified base, that can be converted to an integer, and returns that integer, or NaN if it does not encounter characters that it can convert to a number.
119 | * @param text The string from which to extract an integer.
120 | * @param base The base of the string to parse (from base 2 to base 36). If not supplied, base is determined by the format of string.
121 | */
122 | declare function parseInt(text: string, base?: number): number
123 |
124 | /**
125 | * Displays a dialog allowing the user to enter text
126 | * Returns null if the user cancelled the dialog, the text otherwise
127 | * @param prompt The text to display
128 | * @param default_ The default text to preset the edit field with
129 | * @param title The title of the dialog;
130 | */
131 | declare function prompt(prompt: string, default_?: string, title?: string): string
132 |
133 | /**
134 | * Defines the default XML namespace.
135 | * This is a replacement function for the standard JavaScript statement set default xml namespace.
136 | * @param namespace The namespace to use. Omit this parameter to return to the empty namespace. This is either a Namespace object or a string.
137 | */
138 | declare function setDefaultXMLNamespace(namespace: Namespace): void
139 |
140 | /**
141 | * Translates URL-encoded string into a regular string, and returns that string.
142 | * Use the escape() global function to URL-encode strings.
143 | * @param stringExpression The URL-encoded string to convert.
144 | */
145 | declare function unescape(stringExpression: string): string
146 |
147 | /**
148 | * Creates a source code representation of the supplied argument, and returns it as a string.
149 | * @param what The object to uneval.
150 | */
151 | declare function uneval(what: any): string
152 |
--------------------------------------------------------------------------------
/Premiere/2018/index.d.ts:
--------------------------------------------------------------------------------
1 | ///
2 | ///
3 |
4 | /**
5 | *
6 | */
7 | declare class Sequence {
8 | /**
9 | *
10 | */
11 | readonly audioTracks: TrackCollection
12 |
13 | /**
14 | *
15 | */
16 | readonly end: string
17 |
18 | /**
19 | *
20 | */
21 | readonly frameSizeHorizontal: number
22 |
23 | /**
24 | *
25 | */
26 | readonly frameSizeVertical: number
27 |
28 | /**
29 | *
30 | */
31 | readonly id: number
32 |
33 | /**
34 | *
35 | */
36 | readonly markers: MarkerCollection
37 |
38 | /**
39 | *
40 | */
41 | name: string
42 |
43 | /**
44 | *
45 | */
46 | readonly projectItem: ProjectItem
47 |
48 | /**
49 | *
50 | */
51 | readonly sequenceID: string
52 |
53 | /**
54 | *
55 | */
56 | readonly timebase: string
57 |
58 | /**
59 | *
60 | */
61 | readonly videoTracks: TrackCollection
62 |
63 | /**
64 | *
65 | */
66 | readonly zeroPoint: string
67 |
68 | /**
69 | *
70 | */
71 | attachCustomProperty(propertyID: string, propertyValue: string): void
72 |
73 | /**
74 | *
75 | */
76 | bind(eventName: string, function_: any): void
77 |
78 | /**
79 | *
80 | */
81 | clone(): void
82 |
83 | /**
84 | *
85 | */
86 | exportAsFinalCutProXML(exportPath: string, suppressUI: number): boolean
87 |
88 | /**
89 | *
90 | */
91 | exportAsMediaDirect(outputFilePath: string, presetPath: string, workAreaType?: number): string
92 |
93 | /**
94 | *
95 | */
96 | exportAsProject(exportPath: string): void
97 |
98 | /**
99 | *
100 | */
101 | getExportFileExtension(presetFilePath: string): string
102 |
103 | /**
104 | *
105 | */
106 | getInPoint(): string
107 |
108 | /**
109 | *
110 | */
111 | getOutPoint(): string
112 |
113 | /**
114 | *
115 | */
116 | getPlayerPosition(): Time
117 |
118 | /**
119 | *
120 | */
121 | setInPoint(seconds: number): void
122 |
123 | /**
124 | *
125 | */
126 | setOutPoint(seconds: number): void
127 |
128 | /**
129 | *
130 | */
131 | setPlayerPosition(pos: string): void
132 |
133 | /**
134 | *
135 | */
136 | setTimeout(eventName: string, function_: any, milliseconds: number): void
137 |
138 | /**
139 | *
140 | */
141 | setZeroPoint(ticks: string): void
142 |
143 | /**
144 | *
145 | */
146 | unbind(eventName: string): void
147 | }
148 |
149 | /**
150 | *
151 | */
152 | declare class SequenceCollection {
153 | /**
154 | *
155 | */
156 | readonly numSequences: number
157 |
158 | /**
159 | *
160 | */
161 | bind(eventName: string, function_: any): void
162 |
163 | /**
164 | *
165 | */
166 | setTimeout(eventName: string, function_: any, milliseconds: number): void
167 |
168 | /**
169 | *
170 | */
171 | unbind(eventName: string): void
172 | }
173 |
174 | /**
175 | *
176 | */
177 | declare class Metadata {
178 | /**
179 | *
180 | */
181 | readonly getMetadata: string
182 |
183 | /**
184 | *
185 | */
186 | addMarker(): void
187 |
188 | /**
189 | *
190 | */
191 | bind(eventName: string, function_: any): void
192 |
193 | /**
194 | *
195 | */
196 | deleteMarker(): void
197 |
198 | /**
199 | *
200 | */
201 | setMarkerData(): void
202 |
203 | /**
204 | *
205 | */
206 | setMetadataValue(): void
207 |
208 | /**
209 | *
210 | */
211 | setTimeout(eventName: string, function_: any, milliseconds: number): void
212 |
213 | /**
214 | *
215 | */
216 | unbind(eventName: string): void
217 |
218 | /**
219 | *
220 | */
221 | updateMarker(): void
222 | }
223 |
224 | /**
225 | *
226 | */
227 | declare class Anywhere {
228 | /**
229 | *
230 | */
231 | bind(eventName: string, function_: any): void
232 |
233 | /**
234 | *
235 | */
236 | getAuthenticationToken(): string
237 |
238 | /**
239 | *
240 | */
241 | getCurrentEditingSessionActiveSequenceURL(): string
242 |
243 | /**
244 | *
245 | */
246 | getCurrentEditingSessionSelectionURL(): string
247 |
248 | /**
249 | *
250 | */
251 | getCurrentEditingSessionURL(): string
252 |
253 | /**
254 | *
255 | */
256 | isProductionOpen(): boolean
257 |
258 | /**
259 | *
260 | */
261 | listProductions(): RemoteProductionCollection
262 |
263 | /**
264 | *
265 | */
266 | openProduction(inProductionURL: string): boolean
267 |
268 | /**
269 | *
270 | */
271 | setAuthenticationToken(inAuthToken: string, inEmail: string): boolean
272 |
273 | /**
274 | *
275 | */
276 | setTimeout(eventName: string, function_: any, milliseconds: number): void
277 |
278 | /**
279 | *
280 | */
281 | unbind(eventName: string): void
282 | }
283 |
284 | /**
285 | *
286 | */
287 | declare class CsxsResourceCentral {
288 | /**
289 | *
290 | */
291 | bind(eventName: string, function_: any): void
292 |
293 | /**
294 | *
295 | */
296 | getBrightness(): string
297 |
298 | /**
299 | *
300 | */
301 | openURL(urlString: string): void
302 |
303 | /**
304 | *
305 | */
306 | setTimeout(eventName: string, function_: any, milliseconds: number): void
307 |
308 | /**
309 | *
310 | */
311 | unbind(eventName: string): void
312 |
313 | /**
314 | *
315 | */
316 | validateClient(token: string): boolean
317 | }
318 |
319 | /**
320 | *
321 | */
322 | declare class SourceMonitor {
323 | /**
324 | *
325 | */
326 | bind(eventName: string, function_: any): void
327 |
328 | /**
329 | *
330 | */
331 | closeAllClips(): void
332 |
333 | /**
334 | *
335 | */
336 | closeClip(): void
337 |
338 | /**
339 | *
340 | */
341 | openFilePath(filePath: string): boolean
342 |
343 | /**
344 | *
345 | */
346 | play(speed?: number): void
347 |
348 | /**
349 | *
350 | */
351 | setTimeout(eventName: string, function_: any, milliseconds: number): void
352 |
353 | /**
354 | *
355 | */
356 | unbind(eventName: string): void
357 | }
358 |
359 | /**
360 | *
361 | */
362 | declare class Time {
363 | /**
364 | *
365 | */
366 | seconds: number
367 |
368 | /**
369 | *
370 | */
371 | ticks: string
372 |
373 | /**
374 | *
375 | */
376 | bind(eventName: string, function_: any): void
377 |
378 | /**
379 | *
380 | */
381 | setTimeout(eventName: string, function_: any, milliseconds: number): void
382 |
383 | /**
384 | *
385 | */
386 | unbind(eventName: string): void
387 | }
388 |
389 | /**
390 | *
391 | */
392 | declare class ProjectItemType {
393 | /**
394 | *
395 | */
396 | readonly BIN: number
397 |
398 | /**
399 | *
400 | */
401 | readonly CLIP: number
402 |
403 | /**
404 | *
405 | */
406 | readonly FILE: number
407 |
408 | /**
409 | *
410 | */
411 | readonly ROOT: number
412 |
413 | /**
414 | *
415 | */
416 | bind(eventName: string, function_: any): void
417 |
418 | /**
419 | *
420 | */
421 | setTimeout(eventName: string, function_: any, milliseconds: number): void
422 |
423 | /**
424 | *
425 | */
426 | unbind(eventName: string): void
427 | }
428 |
429 | /**
430 | *
431 | */
432 | declare class Project {
433 | /**
434 | *
435 | */
436 | activeSequence: Sequence
437 |
438 | /**
439 | *
440 | */
441 | readonly documentID: string
442 |
443 | /**
444 | *
445 | */
446 | readonly name: string
447 |
448 | /**
449 | *
450 | */
451 | readonly path: string
452 |
453 | /**
454 | *
455 | */
456 | readonly rootItem: ProjectItem
457 |
458 | /**
459 | *
460 | */
461 | readonly sequences: SequenceCollection
462 |
463 | /**
464 | *
465 | */
466 | addPropertyToProjectMetadataSchema(name: string, label: string, type: number): boolean
467 |
468 | /**
469 | *
470 | */
471 | bind(eventName: string, function_: any): void
472 |
473 | /**
474 | *
475 | */
476 | closeDocument(): boolean
477 |
478 | /**
479 | *
480 | */
481 | createNewSequence(sequenceName: string, placeholderID: string): void
482 |
483 | /**
484 | *
485 | */
486 | deleteAsset(): void
487 |
488 | /**
489 | *
490 | */
491 | deleteSequence(sequence: Sequence): boolean
492 |
493 | /**
494 | *
495 | */
496 | exportAAF(
497 | sequence: Sequence,
498 | filePath: string,
499 | mixDownVideo: number,
500 | explodeToMono: number,
501 | sampleRate: number,
502 | bitsPerSample: number,
503 | embedAudio: number,
504 | audioFileFormat: number,
505 | trimSources: number,
506 | handleFrames: number,
507 | ): number
508 |
509 | /**
510 | *
511 | */
512 | exportFinalCutProXML(exportPath: string, suppressUI: number): boolean
513 |
514 | /**
515 | *
516 | */
517 | exportOMF(
518 | sequence: Sequence,
519 | filePath: string,
520 | OMFTitle: string,
521 | sampleRate: number,
522 | bitsPerSample: number,
523 | audioEncapsulated: number,
524 | audioFileFormat: number,
525 | trimAudioFiles: number,
526 | handleFrames: number,
527 | includePan: number,
528 | ): number
529 |
530 | /**
531 | *
532 | */
533 | exportTimeline(exportControllerName: string): number
534 |
535 | /**
536 | *
537 | */
538 | getInsertionBin(): ProjectItem
539 |
540 | /**
541 | *
542 | */
543 | getProjectPanelMetadata(): void
544 |
545 | /**
546 | *
547 | */
548 | importAEComps(arg1: any): boolean
549 |
550 | /**
551 | *
552 | */
553 | importAllAEComps(arg1: any): boolean
554 |
555 | /**
556 | *
557 | */
558 | importFiles(arrayOfFilePathsToImport: string[], suppressUI: boolean, projectBin: string, importAsNumberedStill: boolean): boolean
559 |
560 | /**
561 | *
562 | */
563 | importSequences(arg1: any): boolean
564 |
565 | /**
566 | *
567 | */
568 | openSequence(sequenceID: string): boolean
569 |
570 | /**
571 | *
572 | */
573 | pauseGrowing(pausedOrNot: number): boolean
574 |
575 | /**
576 | *
577 | */
578 | placeAsset(arg1: any): boolean
579 |
580 | /**
581 | *
582 | */
583 | save(): void
584 |
585 | /**
586 | *
587 | */
588 | saveAs(saveAsPath: string): boolean
589 |
590 | /**
591 | *
592 | */
593 | setProjectPanelMetadata(): void
594 |
595 | /**
596 | *
597 | */
598 | setTimeout(eventName: string, function_: any, milliseconds: number): void
599 |
600 | /**
601 | *
602 | */
603 | unbind(eventName: string): void
604 | }
605 |
606 | /**
607 | *
608 | */
609 | declare class Track {
610 | /**
611 | *
612 | */
613 | readonly clips: TrackItemCollection
614 |
615 | /**
616 | *
617 | */
618 | readonly id: number
619 |
620 | /**
621 | *
622 | */
623 | readonly mediaType: string
624 |
625 | /**
626 | *
627 | */
628 | readonly transitions: TrackItemCollection
629 |
630 | /**
631 | *
632 | */
633 | bind(eventName: string, function_: any): void
634 |
635 | /**
636 | *
637 | */
638 | insertClip(clipProjectItem: ProjectItem, time: number): void
639 |
640 | /**
641 | *
642 | */
643 | isMuted(): boolean
644 |
645 | /**
646 | *
647 | */
648 | overwriteClip(clipProjectItem: ProjectItem, time: number): void
649 |
650 | /**
651 | *
652 | */
653 | setMute(arg1?: number): void
654 |
655 | /**
656 | *
657 | */
658 | setTimeout(eventName: string, function_: any, milliseconds: number): void
659 |
660 | /**
661 | *
662 | */
663 | unbind(eventName: string): void
664 | }
665 |
666 | /**
667 | *
668 | */
669 | declare class TrackItem {
670 | /**
671 | *
672 | */
673 | readonly components: any
674 |
675 | /**
676 | *
677 | */
678 | readonly duration: Time
679 |
680 | /**
681 | *
682 | */
683 | readonly end: Time
684 |
685 | /**
686 | *
687 | */
688 | readonly inPoint: Time
689 |
690 | /**
691 | *
692 | */
693 | readonly mediaType: string
694 |
695 | /**
696 | *
697 | */
698 | name: string
699 |
700 | /**
701 | *
702 | */
703 | readonly outPoint: Time
704 |
705 | /**
706 | *
707 | */
708 | projectItem: ProjectItem
709 |
710 | /**
711 | *
712 | */
713 | readonly start: Time
714 |
715 | /**
716 | *
717 | */
718 | readonly type: number
719 |
720 | /**
721 | *
722 | */
723 | bind(eventName: string, function_: any): void
724 |
725 | /**
726 | *
727 | */
728 | getLinkedItems(): TrackItemCollection
729 |
730 | /**
731 | *
732 | */
733 | isSelected(): boolean
734 |
735 | /**
736 | *
737 | */
738 | setSelected(isSelected: number, updateUI?: number): void
739 |
740 | /**
741 | *
742 | */
743 | setTimeout(eventName: string, function_: any, milliseconds: number): void
744 |
745 | /**
746 | *
747 | */
748 | unbind(eventName: string): void
749 | }
750 |
751 | /**
752 | *
753 | */
754 | declare class ProjectItem {
755 | /**
756 | *
757 | */
758 | readonly children: ProjectItemCollection
759 |
760 | /**
761 | *
762 | */
763 | name: string
764 |
765 | /**
766 | *
767 | */
768 | readonly nodeId: string
769 |
770 | /**
771 | *
772 | */
773 | readonly treePath: string
774 |
775 | /**
776 | *
777 | */
778 | readonly type: number
779 |
780 | /**
781 | *
782 | */
783 | readonly videoComponents: any
784 |
785 | /**
786 | *
787 | */
788 | attachProxy(mediaPath: string, isHiRes: number): boolean
789 |
790 | /**
791 | *
792 | */
793 | bind(eventName: string, function_: any): void
794 |
795 | /**
796 | *
797 | */
798 | canChangeMediaPath(): boolean
799 |
800 | /**
801 | *
802 | */
803 | canProxy(): boolean
804 |
805 | /**
806 | *
807 | */
808 | changeMediaPath(mediaPath: string): boolean
809 |
810 | /**
811 | *
812 | */
813 | createBin(name: string): void
814 |
815 | /**
816 | *
817 | */
818 | createSmartBin(name: string, query: string): void
819 |
820 | /**
821 | *
822 | */
823 | createSubClip(
824 | name: string,
825 | startTime: object,
826 | endTime: object,
827 | hasHardBoundaries: number,
828 | takeVideo?: number,
829 | takeAudio?: number,
830 | ): ProjectItem
831 |
832 | /**
833 | *
834 | */
835 | deleteBin(): void
836 |
837 | /**
838 | *
839 | */
840 | findItemsMatchingMediaPath(matchString: string, ignoreSubclips?: number): void
841 |
842 | /**
843 | *
844 | */
845 | getColorLabel(): number
846 |
847 | /**
848 | *
849 | */
850 | getMarkers(): MarkerCollection
851 |
852 | /**
853 | *
854 | */
855 | getMediaPath(): string
856 |
857 | /**
858 | *
859 | */
860 | getProjectMetadata(): string
861 |
862 | /**
863 | *
864 | */
865 | getProxyPath(): string
866 |
867 | /**
868 | *
869 | */
870 | getXMPMetadata(): string
871 |
872 | /**
873 | *
874 | */
875 | hasProxy(): boolean
876 |
877 | /**
878 | *
879 | */
880 | moveBin(destination: ProjectItem): void
881 |
882 | /**
883 | *
884 | */
885 | refreshMedia(): string
886 |
887 | /**
888 | *
889 | */
890 | renameBin(name: string): boolean
891 |
892 | /**
893 | *
894 | */
895 | select(): void
896 |
897 | /**
898 | *
899 | */
900 | setColorLabel(): void
901 |
902 | /**
903 | *
904 | */
905 | setOverridePixelAspectRatio(numerator: number, denominator: number): boolean
906 |
907 | /**
908 | *
909 | */
910 | setProjectMetadata(buffer: string): void
911 |
912 | /**
913 | *
914 | */
915 | setScaleToFrameSize(): void
916 |
917 | /**
918 | *
919 | */
920 | setStartTime(arg1: object): void
921 |
922 | /**
923 | *
924 | */
925 | setTimeout(eventName: string, function_: any, milliseconds: number): void
926 |
927 | /**
928 | *
929 | */
930 | setXMPMetadata(buffer: string): boolean
931 |
932 | /**
933 | *
934 | */
935 | startTime(): Time
936 |
937 | /**
938 | *
939 | */
940 | unbind(eventName: string): void
941 | }
942 |
943 | /**
944 | *
945 | */
946 | declare class ProjectCollection {
947 | /**
948 | *
949 | */
950 | readonly numProjects: number
951 |
952 | /**
953 | *
954 | */
955 | bind(eventName: string, function_: any): void
956 |
957 | /**
958 | *
959 | */
960 | setTimeout(eventName: string, function_: any, milliseconds: number): void
961 |
962 | /**
963 | *
964 | */
965 | unbind(eventName: string): void
966 | }
967 |
968 | /**
969 | *
970 | */
971 | declare class ProjectItemCollection {
972 | /**
973 | *
974 | */
975 | readonly numItems: number
976 |
977 | /**
978 | *
979 | */
980 | bind(eventName: string, function_: any): void
981 |
982 | /**
983 | *
984 | */
985 | setTimeout(eventName: string, function_: any, milliseconds: number): void
986 |
987 | /**
988 | *
989 | */
990 | unbind(eventName: string): void
991 |
992 | /**
993 | *
994 | */
995 | [index: number]: ProjectItem
996 | }
997 |
998 | /**
999 | *
1000 | */
1001 | declare class TrackCollection {
1002 | /**
1003 | *
1004 | */
1005 | readonly numTracks: number
1006 |
1007 | /**
1008 | *
1009 | */
1010 | bind(eventName: string, function_: any): void
1011 |
1012 | /**
1013 | *
1014 | */
1015 | setTimeout(eventName: string, function_: any, milliseconds: number): void
1016 |
1017 | /**
1018 | *
1019 | */
1020 | unbind(eventName: string): void
1021 |
1022 | /**
1023 | *
1024 | */
1025 | [index: number]: Track
1026 | }
1027 |
1028 | /**
1029 | *
1030 | */
1031 | declare class TrackItemCollection {
1032 | /**
1033 | *
1034 | */
1035 | readonly numItems: number
1036 |
1037 | /**
1038 | *
1039 | */
1040 | bind(eventName: string, function_: any): void
1041 |
1042 | /**
1043 | *
1044 | */
1045 | setTimeout(eventName: string, function_: any, milliseconds: number): void
1046 |
1047 | /**
1048 | *
1049 | */
1050 | unbind(eventName: string): void
1051 |
1052 | /**
1053 | *
1054 | */
1055 | [index: number]: TrackItem
1056 | }
1057 |
1058 | /**
1059 | *
1060 | */
1061 | declare class ScratchDiskType {
1062 | /**
1063 | *
1064 | */
1065 | readonly FirstAudioCaptureFolder: string
1066 |
1067 | /**
1068 | *
1069 | */
1070 | readonly FirstAudioPreviewFolder: string
1071 |
1072 | /**
1073 | *
1074 | */
1075 | readonly FirstAutoSaveFolder: string
1076 |
1077 | /**
1078 | *
1079 | */
1080 | readonly FirstCClibrariesFolder: string
1081 |
1082 | /**
1083 | *
1084 | */
1085 | readonly FirstCapsuleMediaFolder: string
1086 |
1087 | /**
1088 | *
1089 | */
1090 | readonly FirstVideoCaptureFolder: string
1091 |
1092 | /**
1093 | *
1094 | */
1095 | readonly FirstVideoPreviewFolder: string
1096 |
1097 | /**
1098 | *
1099 | */
1100 | bind(eventName: string, function_: any): void
1101 |
1102 | /**
1103 | *
1104 | */
1105 | setTimeout(eventName: string, function_: any, milliseconds: number): void
1106 |
1107 | /**
1108 | *
1109 | */
1110 | unbind(eventName: string): void
1111 | }
1112 |
1113 | /**
1114 | *
1115 | */
1116 | declare class Csxs {
1117 | /**
1118 | *
1119 | */
1120 | readonly resourceCentral: CsxsResourceCentral
1121 |
1122 | /**
1123 | *
1124 | */
1125 | bind(eventName: string, function_: any): void
1126 |
1127 | /**
1128 | *
1129 | */
1130 | setTimeout(eventName: string, function_: any, milliseconds: number): void
1131 |
1132 | /**
1133 | *
1134 | */
1135 | unbind(eventName: string): void
1136 | }
1137 |
1138 | /**
1139 | *
1140 | */
1141 | declare class RemoteProductionCollection {
1142 | /**
1143 | *
1144 | */
1145 | readonly numProductions: number
1146 |
1147 | /**
1148 | *
1149 | */
1150 | bind(eventName: string, function_: any): void
1151 |
1152 | /**
1153 | *
1154 | */
1155 | setTimeout(eventName: string, function_: any, milliseconds: number): void
1156 |
1157 | /**
1158 | *
1159 | */
1160 | unbind(eventName: string): void
1161 | }
1162 |
1163 | /**
1164 | *
1165 | */
1166 | declare class RemoteProduction {
1167 | /**
1168 | *
1169 | */
1170 | readonly description: string
1171 |
1172 | /**
1173 | *
1174 | */
1175 | readonly name: string
1176 |
1177 | /**
1178 | *
1179 | */
1180 | readonly url: string
1181 |
1182 | /**
1183 | *
1184 | */
1185 | bind(eventName: string, function_: any): void
1186 |
1187 | /**
1188 | *
1189 | */
1190 | setTimeout(eventName: string, function_: any, milliseconds: number): void
1191 |
1192 | /**
1193 | *
1194 | */
1195 | unbind(eventName: string): void
1196 | }
1197 |
1198 | /**
1199 | *
1200 | */
1201 | declare class Encoder {
1202 | /**
1203 | *
1204 | */
1205 | readonly ENCODE_ENTIRE: number
1206 |
1207 | /**
1208 | *
1209 | */
1210 | readonly ENCODE_IN_TO_OUT: number
1211 |
1212 | /**
1213 | *
1214 | */
1215 | readonly ENCODE_WORKAREA: number
1216 |
1217 | /**
1218 | *
1219 | */
1220 | bind(eventName: string, function_: any): void
1221 |
1222 | /**
1223 | *
1224 | */
1225 | encodeFile(
1226 | inputFilePath: string,
1227 | outputFilePath: string,
1228 | presetPath: string,
1229 | removeOnCompletion?: number,
1230 | startTime?: object,
1231 | stopTime?: object,
1232 | ): string
1233 |
1234 | /**
1235 | *
1236 | */
1237 | encodeProjectItem(
1238 | projectItem: ProjectItem,
1239 | outputFilePath: string,
1240 | presetPath: string,
1241 | WorkAreaType?: number,
1242 | removeOnCompletion?: number,
1243 | ): string
1244 |
1245 | /**
1246 | *
1247 | */
1248 | encodeSequence(
1249 | sequence: Sequence,
1250 | outputFilePath: string,
1251 | presetPath: string,
1252 | WorkAreaType?: number,
1253 | removeOnCompletion?: number,
1254 | ): string
1255 |
1256 | /**
1257 | *
1258 | */
1259 | launchEncoder(): boolean
1260 |
1261 | /**
1262 | *
1263 | */
1264 | setEmbeddedXMPEnabled(enable: number): void
1265 |
1266 | /**
1267 | *
1268 | */
1269 | setSidecarXMPEnabled(enable: number): void
1270 |
1271 | /**
1272 | *
1273 | */
1274 | setTimeout(eventName: string, function_: any, milliseconds: number): void
1275 |
1276 | /**
1277 | *
1278 | */
1279 | startBatch(): boolean
1280 |
1281 | /**
1282 | *
1283 | */
1284 | unbind(eventName: string): void
1285 | }
1286 |
1287 | /**
1288 | *
1289 | */
1290 | declare class Properties {
1291 | /**
1292 | *
1293 | */
1294 | bind(eventName: string, function_: any): void
1295 |
1296 | /**
1297 | *
1298 | */
1299 | clearProperty(propertyKey: string): void
1300 |
1301 | /**
1302 | *
1303 | */
1304 | doesPropertyExist(propertyKey: string): boolean
1305 |
1306 | /**
1307 | *
1308 | */
1309 | getProperty(propertyKey: string): void
1310 |
1311 | /**
1312 | *
1313 | */
1314 | isPropertyReadOnly(propertyKey: string): boolean
1315 |
1316 | /**
1317 | *
1318 | */
1319 | setProperty(propertyKey: string): void
1320 |
1321 | /**
1322 | *
1323 | */
1324 | setTimeout(eventName: string, function_: any, milliseconds: number): void
1325 |
1326 | /**
1327 | *
1328 | */
1329 | unbind(eventName: string): void
1330 | }
1331 |
1332 | /**
1333 | *
1334 | */
1335 | declare class Application {
1336 | /**
1337 | *
1338 | */
1339 | readonly anywhere: Anywhere
1340 |
1341 | /**
1342 | *
1343 | */
1344 | readonly build: string
1345 |
1346 | /**
1347 | *
1348 | */
1349 | readonly csxs: Csxs
1350 |
1351 | /**
1352 | *
1353 | */
1354 | readonly encoder: Encoder
1355 |
1356 | /**
1357 | *
1358 | */
1359 | readonly getAppPrefPath: string
1360 |
1361 | /**
1362 | *
1363 | */
1364 | readonly getAppSystemPrefPath: string
1365 |
1366 | /**
1367 | *
1368 | */
1369 | readonly getPProPrefPath: string
1370 |
1371 | /**
1372 | *
1373 | */
1374 | readonly getPProSystemPrefPath: string
1375 |
1376 | /**
1377 | *
1378 | */
1379 | readonly metadata: Metadata
1380 |
1381 | /**
1382 | *
1383 | */
1384 | project: Project
1385 |
1386 | /**
1387 | *
1388 | */
1389 | readonly projects: ProjectCollection
1390 |
1391 | /**
1392 | *
1393 | */
1394 | readonly properties: Properties
1395 |
1396 | /**
1397 | *
1398 | */
1399 | readonly sourceMonitor: SourceMonitor
1400 |
1401 | /**
1402 | *
1403 | */
1404 | readonly userGuid: string
1405 |
1406 | /**
1407 | *
1408 | */
1409 | readonly version: string
1410 |
1411 | /**
1412 | *
1413 | */
1414 | bind(eventName: string, function_: any): void
1415 |
1416 | /**
1417 | *
1418 | */
1419 | broadcastPrefsChanged(preferencesThatChanged: string): boolean
1420 |
1421 | /**
1422 | *
1423 | */
1424 | getEnableProxies(): number
1425 |
1426 | /**
1427 | *
1428 | */
1429 | isDocument(filePath: string): boolean
1430 |
1431 | /**
1432 | *
1433 | */
1434 | isDocumentOpen(): boolean
1435 |
1436 | /**
1437 | *
1438 | */
1439 | openDocument(): boolean
1440 |
1441 | /**
1442 | *
1443 | */
1444 | openFCPXML(): boolean
1445 |
1446 | /**
1447 | *
1448 | */
1449 | quit(): void
1450 |
1451 | /**
1452 | *
1453 | */
1454 | setEnableProxies(enable: number): boolean
1455 |
1456 | /**
1457 | *
1458 | */
1459 | setExtensionPersistent(extensionID: string, state?: number): void
1460 |
1461 | /**
1462 | *
1463 | */
1464 | setSDKEventMessage(value: string, eventType: string): boolean
1465 |
1466 | /**
1467 | *
1468 | */
1469 | setScratchDiskPath(value: string, type: string): boolean
1470 |
1471 | /**
1472 | *
1473 | */
1474 | setTimeout(eventName: string, function_: any, milliseconds: number): void
1475 |
1476 | /**
1477 | *
1478 | */
1479 | showCursor(enable: boolean): void
1480 |
1481 | /**
1482 | *
1483 | */
1484 | trace(message: string): void
1485 |
1486 | /**
1487 | *
1488 | */
1489 | unbind(eventName: string): void
1490 |
1491 | /**
1492 | *
1493 | */
1494 | enableQE(): void
1495 | }
1496 |
1497 | /**
1498 | *
1499 | */
1500 | declare class MarkerCollection {
1501 | /**
1502 | *
1503 | */
1504 | readonly numMarkers: number
1505 |
1506 | /**
1507 | *
1508 | */
1509 | bind(eventName: string, function_: any): void
1510 |
1511 | /**
1512 | *
1513 | */
1514 | createMarker(time: number): Marker
1515 |
1516 | /**
1517 | *
1518 | */
1519 | deleteMarker(marker: Marker): void
1520 |
1521 | /**
1522 | *
1523 | */
1524 | getFirstMarker(): Marker
1525 |
1526 | /**
1527 | *
1528 | */
1529 | getLastMarker(): Marker
1530 |
1531 | /**
1532 | *
1533 | */
1534 | getNextMarker(marker: Marker): Marker
1535 |
1536 | /**
1537 | *
1538 | */
1539 | getPrevMarker(marker: Marker): Marker
1540 |
1541 | /**
1542 | *
1543 | */
1544 | setTimeout(eventName: string, function_: any, milliseconds: number): void
1545 |
1546 | /**
1547 | *
1548 | */
1549 | unbind(eventName: string): void
1550 | }
1551 |
1552 | /**
1553 | *
1554 | */
1555 | declare class Marker {
1556 | /**
1557 | *
1558 | */
1559 | comments: string
1560 |
1561 | /**
1562 | *
1563 | */
1564 | end: Time
1565 |
1566 | /**
1567 | *
1568 | */
1569 | readonly guid: string
1570 |
1571 | /**
1572 | *
1573 | */
1574 | name: string
1575 |
1576 | /**
1577 | *
1578 | */
1579 | start: Time
1580 |
1581 | /**
1582 | *
1583 | */
1584 | type: string
1585 |
1586 | /**
1587 | *
1588 | */
1589 | bind(eventName: string, function_: any): void
1590 |
1591 | /**
1592 | *
1593 | */
1594 | getWebLinkFrameTarget(): string
1595 |
1596 | /**
1597 | *
1598 | */
1599 | getWebLinkURL(): string
1600 |
1601 | /**
1602 | *
1603 | */
1604 | setTimeout(eventName: string, function_: any, milliseconds: number): void
1605 |
1606 | /**
1607 | *
1608 | */
1609 | setTypeAsChapter(): void
1610 |
1611 | /**
1612 | *
1613 | */
1614 | setTypeAsComment(): void
1615 |
1616 | /**
1617 | *
1618 | */
1619 | setTypeAsSegmentation(): void
1620 |
1621 | /**
1622 | *
1623 | */
1624 | setTypeAsWebLink(url: string, frameTarget: string): void
1625 |
1626 | /**
1627 | *
1628 | */
1629 | unbind(eventName: string): void
1630 | }
1631 |
1632 | /**
1633 | *
1634 | */
1635 | declare class Document {
1636 | /**
1637 | *
1638 | */
1639 | bind(eventName: string, function_: any): void
1640 |
1641 | /**
1642 | *
1643 | */
1644 | getFilePath(): string
1645 |
1646 | /**
1647 | *
1648 | */
1649 | importFiles(arg1: any): boolean
1650 |
1651 | /**
1652 | *
1653 | */
1654 | setTimeout(eventName: string, function_: any, milliseconds: number): void
1655 |
1656 | /**
1657 | *
1658 | */
1659 | unbind(eventName: string): void
1660 | }
1661 |
1662 | /**
1663 | * In order to use qe please call app.enableQE() first.
1664 | */
1665 | declare const qe: undefined | any
1666 |
--------------------------------------------------------------------------------
/Premiere/2019/index.d.ts:
--------------------------------------------------------------------------------
1 | /**
2 | *
3 | */
4 | declare class Exporter {
5 | /**
6 | *
7 | */
8 | classID: number;
9 |
10 | /**
11 | *
12 | */
13 | fileType: number;
14 |
15 | /**
16 | *
17 | */
18 | name: string;
19 |
20 | /**
21 | *
22 | */
23 | bind(eventName: string, function_: any): void;
24 |
25 | /**
26 | *
27 | */
28 | getPresets(): void;
29 |
30 | /**
31 | *
32 | */
33 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
34 |
35 | /**
36 | *
37 | */
38 | unbind(eventName: string): void;
39 |
40 | }
41 |
42 | /**
43 | *
44 | */
45 | declare class Sequence {
46 | /**
47 | *
48 | */
49 | audioDisplayFormat: number;
50 |
51 | /**
52 | *
53 | */
54 | audioTracks: TrackCollection;
55 |
56 | /**
57 | *
58 | */
59 | end: string;
60 |
61 | /**
62 | *
63 | */
64 | frameSizeHorizontal: number;
65 |
66 | /**
67 | *
68 | */
69 | frameSizeVertical: number;
70 |
71 | /**
72 | *
73 | */
74 | id: number;
75 |
76 | /**
77 | *
78 | */
79 | markers: MarkerCollection;
80 |
81 | /**
82 | *
83 | */
84 | name: string;
85 |
86 | /**
87 | *
88 | */
89 | projectItem: ProjectItem;
90 |
91 | /**
92 | *
93 | */
94 | sequenceID: string;
95 |
96 | /**
97 | *
98 | */
99 | timebase: string;
100 |
101 | /**
102 | *
103 | */
104 | videoDisplayFormat: number;
105 |
106 | /**
107 | *
108 | */
109 | videoTracks: TrackCollection;
110 |
111 | /**
112 | *
113 | */
114 | zeroPoint: string;
115 |
116 | /**
117 | *
118 | */
119 | attachCustomProperty(propertyID: string, propertyValue: string): void;
120 |
121 | /**
122 | *
123 | */
124 | bind(eventName: string, function_: any): void;
125 |
126 | /**
127 | *
128 | */
129 | clone(): void;
130 |
131 | /**
132 | *
133 | */
134 | close(): void;
135 |
136 | /**
137 | *
138 | */
139 | createSubsequence(ignoreTrackTargeting?: boolean): Sequence;
140 |
141 | /**
142 | *
143 | */
144 | exportAsFinalCutProXML(exportPath: string, suppressUI: number): boolean;
145 |
146 | /**
147 | *
148 | */
149 | exportAsMediaDirect(outputFilePath: string, presetPath: string, workAreaType?: number): string;
150 |
151 | /**
152 | *
153 | */
154 | exportAsProject(exportPath: string): void;
155 |
156 | /**
157 | *
158 | */
159 | getExportFileExtension(presetFilePath: string): string;
160 |
161 | /**
162 | *
163 | */
164 | getInPoint(): string;
165 |
166 | /**
167 | *
168 | */
169 | getInPointAsTime(): Time;
170 |
171 | /**
172 | *
173 | */
174 | getOutPoint(): string;
175 |
176 | /**
177 | *
178 | */
179 | getOutPointAsTime(): Time;
180 |
181 | /**
182 | *
183 | */
184 | getPlayerPosition(): Time;
185 |
186 | /**
187 | *
188 | */
189 | getSelection(): void;
190 |
191 | /**
192 | *
193 | */
194 | getSettings(): SequenceSettings;
195 |
196 | /**
197 | *
198 | */
199 | getWorkAreaInPoint(): string;
200 |
201 | /**
202 | *
203 | */
204 | getWorkAreaInPointAsTime(): Time;
205 |
206 | /**
207 | *
208 | */
209 | getWorkAreaOutPoint(): string;
210 |
211 | /**
212 | *
213 | */
214 | getWorkAreaOutPointAsTime(): Time;
215 |
216 | /**
217 | *
218 | */
219 | importMGT(path: string, time: object, videoTrackIndex: number, audioTrackIndex: number): TrackItem;
220 |
221 | /**
222 | *
223 | */
224 | importMGTFromLibrary(libraryName: string, mgtName: string, time: object, videoTrackIndex: number, audioTrackIndex: number): TrackItem;
225 |
226 | /**
227 | *
228 | */
229 | insertClip(clipProjectItem: ProjectItem, time: object, videoTrackIndex: number, audioTrackIndex: number): void;
230 |
231 | /**
232 | *
233 | */
234 | isWorkAreaEnabled(): boolean;
235 |
236 | /**
237 | *
238 | */
239 | linkSelection(): boolean;
240 |
241 | /**
242 | *
243 | */
244 | overwriteClip(clipProjectItem: ProjectItem, time: object, videoTrackIndex: number, audioTrackIndex: number): void;
245 |
246 | /**
247 | *
248 | */
249 | setInPoint(time: object): void;
250 |
251 | /**
252 | *
253 | */
254 | setOutPoint(time: object): void;
255 |
256 | /**
257 | *
258 | */
259 | setPlayerPosition(pos: string): void;
260 |
261 | /**
262 | *
263 | */
264 | setSelection(): void;
265 |
266 | /**
267 | *
268 | */
269 | setSettings(settings: SequenceSettings): void;
270 |
271 | /**
272 | *
273 | */
274 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
275 |
276 | /**
277 | *
278 | */
279 | setWorkAreaEnabled(specifiedState?: number): boolean;
280 |
281 | /**
282 | *
283 | */
284 | setWorkAreaInPoint(time: object): void;
285 |
286 | /**
287 | *
288 | */
289 | setWorkAreaOutPoint(time: object): void;
290 |
291 | /**
292 | *
293 | */
294 | setZeroPoint(ticks: string): void;
295 |
296 | /**
297 | *
298 | */
299 | unbind(eventName: string): void;
300 |
301 | /**
302 | *
303 | */
304 | unlinkSelection(): boolean;
305 |
306 | }
307 |
308 | /**
309 | *
310 | */
311 | declare class SequenceCollection {
312 | /**
313 | *
314 | */
315 | numSequences: number;
316 |
317 | /**
318 | *
319 | */
320 | bind(eventName: string, function_: any): void;
321 |
322 | /**
323 | *
324 | */
325 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
326 |
327 | /**
328 | *
329 | */
330 | unbind(eventName: string): void;
331 |
332 | }
333 |
334 | /**
335 | *
336 | */
337 | declare class Metadata {
338 | /**
339 | *
340 | */
341 | getMetadata: string;
342 |
343 | /**
344 | *
345 | */
346 | addMarker(): void;
347 |
348 | /**
349 | *
350 | */
351 | bind(eventName: string, function_: any): void;
352 |
353 | /**
354 | *
355 | */
356 | deleteMarker(): void;
357 |
358 | /**
359 | *
360 | */
361 | setMarkerData(): void;
362 |
363 | /**
364 | *
365 | */
366 | setMetadataValue(): void;
367 |
368 | /**
369 | *
370 | */
371 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
372 |
373 | /**
374 | *
375 | */
376 | unbind(eventName: string): void;
377 |
378 | /**
379 | *
380 | */
381 | updateMarker(): void;
382 |
383 | }
384 |
385 | /**
386 | *
387 | */
388 | declare class Anywhere {
389 | /**
390 | *
391 | */
392 | bind(eventName: string, function_: any): void;
393 |
394 | /**
395 | *
396 | */
397 | getAuthenticationToken(): string;
398 |
399 | /**
400 | *
401 | */
402 | getCurrentEditingSessionActiveSequenceURL(): string;
403 |
404 | /**
405 | *
406 | */
407 | getCurrentEditingSessionSelectionURL(): string;
408 |
409 | /**
410 | *
411 | */
412 | getCurrentEditingSessionURL(): string;
413 |
414 | /**
415 | *
416 | */
417 | isProductionOpen(): boolean;
418 |
419 | /**
420 | *
421 | */
422 | listProductions(): RemoteProductionCollection;
423 |
424 | /**
425 | *
426 | */
427 | openProduction(inProductionURL: string): boolean;
428 |
429 | /**
430 | *
431 | */
432 | openTeamProjectSnapshot(inTeamProjectSnapshotPath: string): boolean;
433 |
434 | /**
435 | *
436 | */
437 | setAuthenticationToken(inAuthToken: string, inEmail: string): boolean;
438 |
439 | /**
440 | *
441 | */
442 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
443 |
444 | /**
445 | *
446 | */
447 | unbind(eventName: string): void;
448 |
449 | }
450 |
451 | /**
452 | *
453 | */
454 | declare class SourceMonitor {
455 | /**
456 | *
457 | */
458 | bind(eventName: string, function_: any): void;
459 |
460 | /**
461 | *
462 | */
463 | closeAllClips(): void;
464 |
465 | /**
466 | *
467 | */
468 | closeClip(): void;
469 |
470 | /**
471 | *
472 | */
473 | getPosition(): Time;
474 |
475 | /**
476 | *
477 | */
478 | openFilePath(filePath: string): boolean;
479 |
480 | /**
481 | *
482 | */
483 | openProjectItem(projectItem: ProjectItem): boolean;
484 |
485 | /**
486 | *
487 | */
488 | play(speed?: number): void;
489 |
490 | /**
491 | *
492 | */
493 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
494 |
495 | /**
496 | *
497 | */
498 | unbind(eventName: string): void;
499 |
500 | }
501 |
502 | /**
503 | *
504 | */
505 | declare class Time {
506 | /**
507 | *
508 | */
509 | seconds: number;
510 |
511 | /**
512 | *
513 | */
514 | ticks: string;
515 |
516 | /**
517 | *
518 | */
519 | bind(eventName: string, function_: any): void;
520 |
521 | /**
522 | *
523 | */
524 | getFormatted(time: object, timeDisplay: number): string;
525 |
526 | /**
527 | *
528 | */
529 | setSecondsAsFraction(numerator: number, denominator: number): void;
530 |
531 | /**
532 | *
533 | */
534 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
535 |
536 | /**
537 | *
538 | */
539 | unbind(eventName: string): void;
540 |
541 | }
542 |
543 | /**
544 | *
545 | */
546 | declare class TrackItemCollection {
547 | /**
548 | *
549 | */
550 | numItems: number;
551 |
552 | /**
553 | *
554 | */
555 | bind(eventName: string, function_: any): void;
556 |
557 | /**
558 | *
559 | */
560 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
561 |
562 | /**
563 | *
564 | */
565 | unbind(eventName: string): void;
566 |
567 | }
568 |
569 | /**
570 | *
571 | */
572 | declare class Track {
573 | /**
574 | *
575 | */
576 | clips: TrackItemCollection;
577 |
578 | /**
579 | *
580 | */
581 | id: number;
582 |
583 | /**
584 | *
585 | */
586 | mediaType: string;
587 |
588 | /**
589 | *
590 | */
591 | name: string;
592 |
593 | /**
594 | *
595 | */
596 | transitions: TrackItemCollection;
597 |
598 | /**
599 | *
600 | */
601 | bind(eventName: string, function_: any): void;
602 |
603 | /**
604 | *
605 | */
606 | insertClip(clipProjectItem: ProjectItem, time: object): void;
607 |
608 | /**
609 | *
610 | */
611 | isLocked(): boolean;
612 |
613 | /**
614 | *
615 | */
616 | isMuted(): boolean;
617 |
618 | /**
619 | *
620 | */
621 | isTargeted(): boolean;
622 |
623 | /**
624 | *
625 | */
626 | overwriteClip(clipProjectItem: ProjectItem, time: object): void;
627 |
628 | /**
629 | *
630 | */
631 | setLocked(arg1?: number): void;
632 |
633 | /**
634 | *
635 | */
636 | setMute(arg1?: number): void;
637 |
638 | /**
639 | *
640 | */
641 | setTargeted(isTargeted: boolean, shouldBroadcast?: boolean): void;
642 |
643 | /**
644 | *
645 | */
646 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
647 |
648 | /**
649 | *
650 | */
651 | unbind(eventName: string): void;
652 |
653 | }
654 |
655 | /**
656 | *
657 | */
658 | declare class TrackItem {
659 | /**
660 | *
661 | */
662 | components: ComponentCollection;
663 |
664 | /**
665 | *
666 | */
667 | duration: Time;
668 |
669 | /**
670 | *
671 | */
672 | end: Time;
673 |
674 | /**
675 | *
676 | */
677 | inPoint: Time;
678 |
679 | /**
680 | *
681 | */
682 | matchName: string;
683 |
684 | /**
685 | *
686 | */
687 | mediaType: string;
688 |
689 | /**
690 | *
691 | */
692 | name: string;
693 |
694 | /**
695 | *
696 | */
697 | nodeId: string;
698 |
699 | /**
700 | *
701 | */
702 | outPoint: Time;
703 |
704 | /**
705 | *
706 | */
707 | projectItem: ProjectItem;
708 |
709 | /**
710 | *
711 | */
712 | start: Time;
713 |
714 | /**
715 | *
716 | */
717 | type: number;
718 |
719 | /**
720 | *
721 | */
722 | bind(eventName: string, function_: any): void;
723 |
724 | /**
725 | *
726 | */
727 | getLinkedItems(): TrackItemCollection;
728 |
729 | /**
730 | *
731 | */
732 | getMGTComponent(): Component;
733 |
734 | /**
735 | *
736 | */
737 | getMatchName(): string;
738 |
739 | /**
740 | *
741 | */
742 | getSpeed(): number;
743 |
744 | /**
745 | *
746 | */
747 | isAdjustmentLayer(): boolean;
748 |
749 | /**
750 | *
751 | */
752 | isMGT(): boolean;
753 |
754 | /**
755 | *
756 | */
757 | isSelected(): boolean;
758 |
759 | /**
760 | *
761 | */
762 | isSpeedReversed(): boolean;
763 |
764 | /**
765 | *
766 | */
767 | remove(inRipple: boolean, inAlignToVideo?: boolean): boolean;
768 |
769 | /**
770 | *
771 | */
772 | setSelected(isSelected: number, updateUI?: number): void;
773 |
774 | /**
775 | *
776 | */
777 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
778 |
779 | /**
780 | *
781 | */
782 | unbind(eventName: string): void;
783 |
784 | }
785 |
786 | /**
787 | *
788 | */
789 | declare class Project {
790 | /**
791 | *
792 | */
793 | activeSequence: Sequence;
794 |
795 | /**
796 | *
797 | */
798 | cloudProjectLocalID: string;
799 |
800 | /**
801 | *
802 | */
803 | documentID: string;
804 |
805 | /**
806 | *
807 | */
808 | isCloudProject: boolean;
809 |
810 | /**
811 | *
812 | */
813 | name: string;
814 |
815 | /**
816 | *
817 | */
818 | path: string;
819 |
820 | /**
821 | *
822 | */
823 | rootItem: ProjectItem;
824 |
825 | /**
826 | *
827 | */
828 | sequences: SequenceCollection;
829 |
830 | /**
831 | *
832 | */
833 | addPropertyToProjectMetadataSchema(name: string, label: string, type: number): boolean;
834 |
835 | /**
836 | *
837 | */
838 | bind(eventName: string, function_: any): void;
839 |
840 | /**
841 | *
842 | */
843 | closeDocument(): boolean;
844 |
845 | /**
846 | *
847 | */
848 | consolidateDuplicates(): void;
849 |
850 | /**
851 | *
852 | */
853 | createNewSequence(sequenceName: string, placeholderID: string): void;
854 |
855 | /**
856 | *
857 | */
858 | deleteSequence(sequence: Sequence): boolean;
859 |
860 | /**
861 | *
862 | */
863 | exportAAF(sequence: Sequence, filePath: string, mixDownVideo: number, explodeToMono: number, sampleRate: number, bitsPerSample: number, embedAudio: number, audioFileFormat: number, trimSources: number, handleFrames: number): number;
864 |
865 | /**
866 | *
867 | */
868 | exportFinalCutProXML(exportPath: string, suppressUI: number): boolean;
869 |
870 | /**
871 | *
872 | */
873 | exportOMF(sequence: Sequence, filePath: string, OMFTitle: string, sampleRate: number, bitsPerSample: number, audioEncapsulated: number, audioFileFormat: number, trimAudioFiles: number, handleFrames: number, includePan: number): number;
874 |
875 | /**
876 | *
877 | */
878 | exportTimeline(exportControllerName: string): number;
879 |
880 | /**
881 | *
882 | */
883 | getInsertionBin(): ProjectItem;
884 |
885 | /**
886 | *
887 | */
888 | getProjectPanelMetadata(): void;
889 |
890 | /**
891 | *
892 | */
893 | importAEComps(arg1: any): boolean;
894 |
895 | /**
896 | *
897 | */
898 | importAllAEComps(arg1: any): boolean;
899 |
900 | /**
901 | *
902 | */
903 | importFiles(arg1: any): boolean;
904 |
905 | /**
906 | *
907 | */
908 | importSequences(arg1: any): boolean;
909 |
910 | /**
911 | *
912 | */
913 | openSequence(sequenceID: string): boolean;
914 |
915 | /**
916 | *
917 | */
918 | pauseGrowing(pausedOrNot: number): boolean;
919 |
920 | /**
921 | *
922 | */
923 | placeAsset(arg1: any): boolean;
924 |
925 | /**
926 | *
927 | */
928 | save(): void;
929 |
930 | /**
931 | *
932 | */
933 | saveAs(saveAsPath: string): boolean;
934 |
935 | /**
936 | *
937 | */
938 | setEnableTranscodeOnIngest(inEnable: boolean): boolean;
939 |
940 | /**
941 | *
942 | */
943 | setProjectPanelMetadata(): void;
944 |
945 | /**
946 | *
947 | */
948 | setScratchDiskPath(value: string, type: string): void;
949 |
950 | /**
951 | *
952 | */
953 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
954 |
955 | /**
956 | *
957 | */
958 | unbind(eventName: string): void;
959 |
960 | }
961 |
962 | /**
963 | *
964 | */
965 | declare class ProjectItemType {
966 | /**
967 | *
968 | */
969 | BIN: number;
970 |
971 | /**
972 | *
973 | */
974 | CLIP: number;
975 |
976 | /**
977 | *
978 | */
979 | FILE: number;
980 |
981 | /**
982 | *
983 | */
984 | ROOT: number;
985 |
986 | /**
987 | *
988 | */
989 | bind(eventName: string, function_: any): void;
990 |
991 | /**
992 | *
993 | */
994 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
995 |
996 | /**
997 | *
998 | */
999 | unbind(eventName: string): void;
1000 |
1001 | }
1002 |
1003 | /**
1004 | *
1005 | */
1006 | declare class ProjectItem {
1007 | /**
1008 | *
1009 | */
1010 | children: ProjectItemCollection;
1011 |
1012 | /**
1013 | *
1014 | */
1015 | name: string;
1016 |
1017 | /**
1018 | *
1019 | */
1020 | nodeId: string;
1021 |
1022 | /**
1023 | *
1024 | */
1025 | treePath: string;
1026 |
1027 | /**
1028 | *
1029 | */
1030 | type: number;
1031 |
1032 | /**
1033 | *
1034 | */
1035 | videoComponents: ComponentCollection;
1036 |
1037 | /**
1038 | *
1039 | */
1040 | attachProxy(mediaPath: string, isHiRes: number): boolean;
1041 |
1042 | /**
1043 | *
1044 | */
1045 | bind(eventName: string, function_: any): void;
1046 |
1047 | /**
1048 | *
1049 | */
1050 | canChangeMediaPath(): boolean;
1051 |
1052 | /**
1053 | *
1054 | */
1055 | canProxy(): boolean;
1056 |
1057 | /**
1058 | *
1059 | */
1060 | changeMediaPath(mediaPath: string, overrideChecks?: boolean): boolean;
1061 |
1062 | /**
1063 | *
1064 | */
1065 | clearInPoint(mediaType?: number): void;
1066 |
1067 | /**
1068 | *
1069 | */
1070 | clearOutPoint(mediaType?: number): void;
1071 |
1072 | /**
1073 | *
1074 | */
1075 | createBin(name: string): void;
1076 |
1077 | /**
1078 | *
1079 | */
1080 | createSmartBin(name: string, query: string): void;
1081 |
1082 | /**
1083 | *
1084 | */
1085 | createSubClip(name: string, startTime: object, endTime: object, hasHardBoundaries: number, takeVideo?: number, takeAudio?: number): ProjectItem;
1086 |
1087 | /**
1088 | *
1089 | */
1090 | deleteBin(): void;
1091 |
1092 | /**
1093 | *
1094 | */
1095 | findItemsMatchingMediaPath(matchString: string, ignoreSubclips?: number): void;
1096 |
1097 | /**
1098 | *
1099 | */
1100 | getColorLabel(): number;
1101 |
1102 | /**
1103 | *
1104 | */
1105 | getFootageInterpretation(): FootageInterpretation;
1106 |
1107 | /**
1108 | *
1109 | */
1110 | getInPoint(mediaType?: number): Time;
1111 |
1112 | /**
1113 | *
1114 | */
1115 | getMarkers(): MarkerCollection;
1116 |
1117 | /**
1118 | *
1119 | */
1120 | getMediaPath(): string;
1121 |
1122 | /**
1123 | *
1124 | */
1125 | getOutPoint(mediaType?: number): Time;
1126 |
1127 | /**
1128 | *
1129 | */
1130 | getProjectMetadata(): string;
1131 |
1132 | /**
1133 | *
1134 | */
1135 | getProxyPath(): string;
1136 |
1137 | /**
1138 | *
1139 | */
1140 | getXMPMetadata(): string;
1141 |
1142 | /**
1143 | *
1144 | */
1145 | hasProxy(): boolean;
1146 |
1147 | /**
1148 | *
1149 | */
1150 | isAdjustmentLayer(): boolean;
1151 |
1152 | /**
1153 | *
1154 | */
1155 | isOffline(): boolean;
1156 |
1157 | /**
1158 | *
1159 | */
1160 | isReference(): boolean;
1161 |
1162 | /**
1163 | *
1164 | */
1165 | isSequence(): boolean;
1166 |
1167 | /**
1168 | *
1169 | */
1170 | moveBin(destination: ProjectItem): void;
1171 |
1172 | /**
1173 | *
1174 | */
1175 | refreshMedia(): string;
1176 |
1177 | /**
1178 | *
1179 | */
1180 | renameBin(name: string): boolean;
1181 |
1182 | /**
1183 | *
1184 | */
1185 | saveProjectSnapshot(): boolean;
1186 |
1187 | /**
1188 | *
1189 | */
1190 | select(): void;
1191 |
1192 | /**
1193 | *
1194 | */
1195 | setColorLabel(): void;
1196 |
1197 | /**
1198 | *
1199 | */
1200 | setFootageInterpretation(interpretFootage: FootageInterpretation): boolean;
1201 |
1202 | /**
1203 | *
1204 | */
1205 | setInPoint(arg1: object, mediaType?: number): void;
1206 |
1207 | /**
1208 | *
1209 | */
1210 | setOffline(): boolean;
1211 |
1212 | /**
1213 | *
1214 | */
1215 | setOutPoint(arg1: object, mediaType?: number): void;
1216 |
1217 | /**
1218 | *
1219 | */
1220 | setOverrideFrameRate(frameRate: number): boolean;
1221 |
1222 | /**
1223 | *
1224 | */
1225 | setOverridePixelAspectRatio(numerator: number, denominator: number): boolean;
1226 |
1227 | /**
1228 | *
1229 | */
1230 | setProjectMetadata(buffer: string): void;
1231 |
1232 | /**
1233 | *
1234 | */
1235 | setScaleToFrameSize(): void;
1236 |
1237 | /**
1238 | *
1239 | */
1240 | setStartTime(arg1: object): void;
1241 |
1242 | /**
1243 | *
1244 | */
1245 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1246 |
1247 | /**
1248 | *
1249 | */
1250 | setXMPMetadata(buffer: string): boolean;
1251 |
1252 | /**
1253 | *
1254 | */
1255 | startTime(): Time;
1256 |
1257 | /**
1258 | *
1259 | */
1260 | unbind(eventName: string): void;
1261 |
1262 | }
1263 |
1264 | /**
1265 | *
1266 | */
1267 | declare class ProjectCollection {
1268 | /**
1269 | *
1270 | */
1271 | numProjects: number;
1272 |
1273 | /**
1274 | *
1275 | */
1276 | bind(eventName: string, function_: any): void;
1277 |
1278 | /**
1279 | *
1280 | */
1281 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1282 |
1283 | /**
1284 | *
1285 | */
1286 | unbind(eventName: string): void;
1287 |
1288 | }
1289 |
1290 | /**
1291 | *
1292 | */
1293 | declare class ProjectItemCollection {
1294 | /**
1295 | *
1296 | */
1297 | numItems: number;
1298 |
1299 | /**
1300 | *
1301 | */
1302 | bind(eventName: string, function_: any): void;
1303 |
1304 | /**
1305 | *
1306 | */
1307 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1308 |
1309 | /**
1310 | *
1311 | */
1312 | unbind(eventName: string): void;
1313 |
1314 | }
1315 |
1316 | /**
1317 | *
1318 | */
1319 | declare class TrackCollection {
1320 | /**
1321 | *
1322 | */
1323 | numTracks: number;
1324 |
1325 | /**
1326 | *
1327 | */
1328 | bind(eventName: string, function_: any): void;
1329 |
1330 | /**
1331 | *
1332 | */
1333 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1334 |
1335 | /**
1336 | *
1337 | */
1338 | unbind(eventName: string): void;
1339 |
1340 | }
1341 |
1342 | /**
1343 | *
1344 | */
1345 | declare class ScratchDiskType {
1346 | /**
1347 | *
1348 | */
1349 | FirstAudioCaptureFolder: string;
1350 |
1351 | /**
1352 | *
1353 | */
1354 | FirstAudioPreviewFolder: string;
1355 |
1356 | /**
1357 | *
1358 | */
1359 | FirstAutoSaveFolder: string;
1360 |
1361 | /**
1362 | *
1363 | */
1364 | FirstCClibrariesFolder: string;
1365 |
1366 | /**
1367 | *
1368 | */
1369 | FirstCapsuleMediaFolder: string;
1370 |
1371 | /**
1372 | *
1373 | */
1374 | FirstVideoCaptureFolder: string;
1375 |
1376 | /**
1377 | *
1378 | */
1379 | FirstVideoPreviewFolder: string;
1380 |
1381 | /**
1382 | *
1383 | */
1384 | bind(eventName: string, function_: any): void;
1385 |
1386 | /**
1387 | *
1388 | */
1389 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1390 |
1391 | /**
1392 | *
1393 | */
1394 | unbind(eventName: string): void;
1395 |
1396 | }
1397 |
1398 | /**
1399 | *
1400 | */
1401 | declare class RemoteProductionCollection {
1402 | /**
1403 | *
1404 | */
1405 | numProductions: number;
1406 |
1407 | /**
1408 | *
1409 | */
1410 | bind(eventName: string, function_: any): void;
1411 |
1412 | /**
1413 | *
1414 | */
1415 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1416 |
1417 | /**
1418 | *
1419 | */
1420 | unbind(eventName: string): void;
1421 |
1422 | }
1423 |
1424 | /**
1425 | *
1426 | */
1427 | declare class RemoteProduction {
1428 | /**
1429 | *
1430 | */
1431 | description: string;
1432 |
1433 | /**
1434 | *
1435 | */
1436 | name: string;
1437 |
1438 | /**
1439 | *
1440 | */
1441 | url: string;
1442 |
1443 | /**
1444 | *
1445 | */
1446 | bind(eventName: string, function_: any): void;
1447 |
1448 | /**
1449 | *
1450 | */
1451 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1452 |
1453 | /**
1454 | *
1455 | */
1456 | unbind(eventName: string): void;
1457 |
1458 | }
1459 |
1460 | /**
1461 | *
1462 | */
1463 | declare class EncoderPreset {
1464 | /**
1465 | *
1466 | */
1467 | matchName: string;
1468 |
1469 | /**
1470 | *
1471 | */
1472 | name: string;
1473 |
1474 | /**
1475 | *
1476 | */
1477 | bind(eventName: string, function_: any): void;
1478 |
1479 | /**
1480 | *
1481 | */
1482 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1483 |
1484 | /**
1485 | *
1486 | */
1487 | unbind(eventName: string): void;
1488 |
1489 | /**
1490 | *
1491 | */
1492 | writeToFile(outputFilePath: string): boolean;
1493 |
1494 | }
1495 |
1496 | /**
1497 | *
1498 | */
1499 | declare class Encoder {
1500 | /**
1501 | *
1502 | */
1503 | ENCODE_ENTIRE: number;
1504 |
1505 | /**
1506 | *
1507 | */
1508 | ENCODE_IN_TO_OUT: number;
1509 |
1510 | /**
1511 | *
1512 | */
1513 | ENCODE_WORKAREA: number;
1514 |
1515 | /**
1516 | *
1517 | */
1518 | bind(eventName: string, function_: any): void;
1519 |
1520 | /**
1521 | *
1522 | */
1523 | encodeFile(inputFilePath: string, outputFilePath: string, presetPath: string, removeOnCompletion?: number, startTime?: object, stopTime?: object): string;
1524 |
1525 | /**
1526 | *
1527 | */
1528 | encodeProjectItem(projectItem: ProjectItem, outputFilePath: string, presetPath: string, WorkAreaType?: number, removeOnCompletion?: number): string;
1529 |
1530 | /**
1531 | *
1532 | */
1533 | encodeSequence(sequence: Sequence, outputFilePath: string, presetPath: string, WorkAreaType?: number, removeOnCompletion?: number): string;
1534 |
1535 | /**
1536 | *
1537 | */
1538 | getExporters(): void;
1539 |
1540 | /**
1541 | *
1542 | */
1543 | launchEncoder(): boolean;
1544 |
1545 | /**
1546 | *
1547 | */
1548 | setEmbeddedXMPEnabled(enable: number): void;
1549 |
1550 | /**
1551 | *
1552 | */
1553 | setSidecarXMPEnabled(enable: number): void;
1554 |
1555 | /**
1556 | *
1557 | */
1558 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1559 |
1560 | /**
1561 | *
1562 | */
1563 | startBatch(): boolean;
1564 |
1565 | /**
1566 | *
1567 | */
1568 | unbind(eventName: string): void;
1569 |
1570 | }
1571 |
1572 | /**
1573 | *
1574 | */
1575 | declare class Properties {
1576 | /**
1577 | *
1578 | */
1579 | bind(eventName: string, function_: any): void;
1580 |
1581 | /**
1582 | *
1583 | */
1584 | clearProperty(propertyKey: string): void;
1585 |
1586 | /**
1587 | *
1588 | */
1589 | doesPropertyExist(propertyKey: string): boolean;
1590 |
1591 | /**
1592 | *
1593 | */
1594 | getProperty(propertyKey: string): void;
1595 |
1596 | /**
1597 | *
1598 | */
1599 | isPropertyReadOnly(propertyKey: string): boolean;
1600 |
1601 | /**
1602 | *
1603 | */
1604 | setProperty(propertyKey: string): void;
1605 |
1606 | /**
1607 | *
1608 | */
1609 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1610 |
1611 | /**
1612 | *
1613 | */
1614 | unbind(eventName: string): void;
1615 |
1616 | }
1617 |
1618 | /**
1619 | *
1620 | */
1621 | declare class App {
1622 | /**
1623 | *
1624 | */
1625 | anywhere: Anywhere;
1626 |
1627 | /**
1628 | *
1629 | */
1630 | build: string;
1631 |
1632 | /**
1633 | *
1634 | */
1635 | encoder: Encoder;
1636 |
1637 | /**
1638 | *
1639 | */
1640 | getAppPrefPath: string;
1641 |
1642 | /**
1643 | *
1644 | */
1645 | getAppSystemPrefPath: string;
1646 |
1647 | /**
1648 | *
1649 | */
1650 | getPProPrefPath: string;
1651 |
1652 | /**
1653 | *
1654 | */
1655 | getPProSystemPrefPath: string;
1656 |
1657 | /**
1658 | *
1659 | */
1660 | metadata: Metadata;
1661 |
1662 | /**
1663 | *
1664 | */
1665 | path: string;
1666 |
1667 | /**
1668 | *
1669 | */
1670 | project: Project;
1671 |
1672 | /**
1673 | *
1674 | */
1675 | projectManager: ProjectManager;
1676 |
1677 | /**
1678 | *
1679 | */
1680 | projects: ProjectCollection;
1681 |
1682 | /**
1683 | *
1684 | */
1685 | properties: Properties;
1686 |
1687 | /**
1688 | *
1689 | */
1690 | sourceMonitor: SourceMonitor;
1691 |
1692 | /**
1693 | *
1694 | */
1695 | userGuid: string;
1696 |
1697 | /**
1698 | *
1699 | */
1700 | version: string;
1701 |
1702 | /**
1703 | *
1704 | */
1705 | bind(eventName: string, function_: any): void;
1706 |
1707 | /**
1708 | *
1709 | */
1710 | broadcastPrefsChanged(preferencesThatChanged: string): boolean;
1711 |
1712 | /**
1713 | *
1714 | */
1715 | getConstant(name: string): number;
1716 |
1717 | /**
1718 | *
1719 | */
1720 | getEnableProxies(): number;
1721 |
1722 | /**
1723 | *
1724 | */
1725 | getProjectFromViewID(viewID: string): Project;
1726 |
1727 | /**
1728 | *
1729 | */
1730 | getProjectViewIDs(): void;
1731 |
1732 | /**
1733 | *
1734 | */
1735 | getProjectViewSelection(viewID: string): void;
1736 |
1737 | /**
1738 | *
1739 | */
1740 | getWorkspaces(): void;
1741 |
1742 | /**
1743 | *
1744 | */
1745 | isDocument(filePath: string): boolean;
1746 |
1747 | /**
1748 | *
1749 | */
1750 | isDocumentOpen(): boolean;
1751 |
1752 | /**
1753 | *
1754 | */
1755 | openDocument(): boolean;
1756 |
1757 | /**
1758 | *
1759 | */
1760 | openFCPXML(): boolean;
1761 |
1762 | /**
1763 | *
1764 | */
1765 | quit(): void;
1766 |
1767 | /**
1768 | *
1769 | */
1770 | refresh(): void;
1771 |
1772 | /**
1773 | *
1774 | */
1775 | setEnableProxies(enable: number): boolean;
1776 |
1777 | /**
1778 | *
1779 | */
1780 | setEnableTranscodeOnIngest(inEnable: boolean): void;
1781 |
1782 | /**
1783 | *
1784 | */
1785 | setExtensionPersistent(extensionID: string, state?: number): void;
1786 |
1787 | /**
1788 | *
1789 | */
1790 | setProjectViewSelection(viewID: string): void;
1791 |
1792 | /**
1793 | *
1794 | */
1795 | setSDKEventMessage(value: string, eventType: string): boolean;
1796 |
1797 | /**
1798 | *
1799 | */
1800 | setScratchDiskPath(value: string, type: string): void;
1801 |
1802 | /**
1803 | *
1804 | */
1805 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1806 |
1807 | /**
1808 | *
1809 | */
1810 | setWorkspace(workspace: string): boolean;
1811 |
1812 | /**
1813 | *
1814 | */
1815 | showCursor(enable: boolean): void;
1816 |
1817 | /**
1818 | *
1819 | */
1820 | trace(message: string): void;
1821 |
1822 | /**
1823 | *
1824 | */
1825 | unbind(eventName: string): void;
1826 |
1827 | /**
1828 | *
1829 | */
1830 | write(arg1: any): void;
1831 |
1832 | }
1833 |
1834 | /**
1835 | *
1836 | */
1837 | declare class MarkerCollection {
1838 | /**
1839 | *
1840 | */
1841 | numMarkers: number;
1842 |
1843 | /**
1844 | *
1845 | */
1846 | bind(eventName: string, function_: any): void;
1847 |
1848 | /**
1849 | *
1850 | */
1851 | createMarker(time: number): Marker;
1852 |
1853 | /**
1854 | *
1855 | */
1856 | deleteMarker(marker: Marker): void;
1857 |
1858 | /**
1859 | *
1860 | */
1861 | getFirstMarker(): Marker;
1862 |
1863 | /**
1864 | *
1865 | */
1866 | getLastMarker(): Marker;
1867 |
1868 | /**
1869 | *
1870 | */
1871 | getNextMarker(marker: Marker): Marker;
1872 |
1873 | /**
1874 | *
1875 | */
1876 | getPrevMarker(marker: Marker): Marker;
1877 |
1878 | /**
1879 | *
1880 | */
1881 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1882 |
1883 | /**
1884 | *
1885 | */
1886 | unbind(eventName: string): void;
1887 |
1888 | }
1889 |
1890 | /**
1891 | *
1892 | */
1893 | declare class Marker {
1894 | /**
1895 | *
1896 | */
1897 | comments: string;
1898 |
1899 | /**
1900 | *
1901 | */
1902 | end: Time;
1903 |
1904 | /**
1905 | *
1906 | */
1907 | guid: string;
1908 |
1909 | /**
1910 | *
1911 | */
1912 | name: string;
1913 |
1914 | /**
1915 | *
1916 | */
1917 | start: Time;
1918 |
1919 | /**
1920 | *
1921 | */
1922 | type: string;
1923 |
1924 | /**
1925 | *
1926 | */
1927 | bind(eventName: string, function_: any): void;
1928 |
1929 | /**
1930 | *
1931 | */
1932 | getColorByIndex(): number;
1933 |
1934 | /**
1935 | *
1936 | */
1937 | getWebLinkFrameTarget(): string;
1938 |
1939 | /**
1940 | *
1941 | */
1942 | getWebLinkURL(): string;
1943 |
1944 | /**
1945 | *
1946 | */
1947 | setColorByIndex(arg1: number): void;
1948 |
1949 | /**
1950 | *
1951 | */
1952 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1953 |
1954 | /**
1955 | *
1956 | */
1957 | setTypeAsChapter(): void;
1958 |
1959 | /**
1960 | *
1961 | */
1962 | setTypeAsComment(): void;
1963 |
1964 | /**
1965 | *
1966 | */
1967 | setTypeAsSegmentation(): void;
1968 |
1969 | /**
1970 | *
1971 | */
1972 | setTypeAsWebLink(url: string, frameTarget: string): void;
1973 |
1974 | /**
1975 | *
1976 | */
1977 | unbind(eventName: string): void;
1978 |
1979 | }
1980 |
1981 | /**
1982 | *
1983 | */
1984 | declare class Document {
1985 | /**
1986 | *
1987 | */
1988 | bind(eventName: string, function_: any): void;
1989 |
1990 | /**
1991 | *
1992 | */
1993 | getFilePath(): string;
1994 |
1995 | /**
1996 | *
1997 | */
1998 | importFiles(arg1: any): boolean;
1999 |
2000 | /**
2001 | *
2002 | */
2003 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
2004 |
2005 | /**
2006 | *
2007 | */
2008 | unbind(eventName: string): void;
2009 |
2010 | }
2011 |
2012 |
--------------------------------------------------------------------------------
/Premiere/2020/index.d.ts:
--------------------------------------------------------------------------------
1 | /**
2 | *
3 | */
4 | declare class Exporter {
5 | /**
6 | *
7 | */
8 | readonly classID: number;
9 |
10 | /**
11 | *
12 | */
13 | readonly fileType: number;
14 |
15 | /**
16 | *
17 | */
18 | readonly name: string;
19 |
20 | /**
21 | *
22 | */
23 | bind(eventName: string, function_: any): void;
24 |
25 | /**
26 | *
27 | */
28 | getPresets(): void;
29 |
30 | /**
31 | *
32 | */
33 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
34 |
35 | /**
36 | *
37 | */
38 | unbind(eventName: string): void;
39 |
40 | }
41 |
42 | /**
43 | *
44 | */
45 | declare class Sequence {
46 | /**
47 | *
48 | */
49 | audioDisplayFormat: number;
50 |
51 | /**
52 | *
53 | */
54 | readonly audioTracks: TrackCollection;
55 |
56 | /**
57 | *
58 | */
59 | readonly end: string;
60 |
61 | /**
62 | *
63 | */
64 | readonly frameSizeHorizontal: number;
65 |
66 | /**
67 | *
68 | */
69 | readonly frameSizeVertical: number;
70 |
71 | /**
72 | *
73 | */
74 | readonly id: number;
75 |
76 | /**
77 | *
78 | */
79 | readonly markers: MarkerCollection;
80 |
81 | /**
82 | *
83 | */
84 | name: string;
85 |
86 | /**
87 | *
88 | */
89 | readonly projectItem: ProjectItem;
90 |
91 | /**
92 | *
93 | */
94 | readonly sequenceID: string;
95 |
96 | /**
97 | *
98 | */
99 | readonly timebase: string;
100 |
101 | /**
102 | *
103 | */
104 | videoDisplayFormat: number;
105 |
106 | /**
107 | *
108 | */
109 | readonly videoTracks: TrackCollection;
110 |
111 | /**
112 | *
113 | */
114 | readonly zeroPoint: string;
115 |
116 | /**
117 | *
118 | */
119 | attachCustomProperty(propertyID: string, propertyValue: string): void;
120 |
121 | /**
122 | *
123 | */
124 | bind(eventName: string, function_: any): void;
125 |
126 | /**
127 | *
128 | */
129 | clone(): void;
130 |
131 | /**
132 | *
133 | */
134 | close(): void;
135 |
136 | /**
137 | *
138 | */
139 | createSubsequence(ignoreTrackTargeting?: boolean): Sequence;
140 |
141 | /**
142 | *
143 | */
144 | exportAsFinalCutProXML(exportPath: string, suppressUI: number): boolean;
145 |
146 | /**
147 | *
148 | */
149 | exportAsMediaDirect(outputFilePath: string, presetPath: string, workAreaType?: number): string;
150 |
151 | /**
152 | *
153 | */
154 | exportAsProject(exportPath: string): void;
155 |
156 | /**
157 | *
158 | */
159 | getExportFileExtension(presetFilePath: string): string;
160 |
161 | /**
162 | *
163 | */
164 | getInPoint(): string;
165 |
166 | /**
167 | *
168 | */
169 | getInPointAsTime(): Time;
170 |
171 | /**
172 | *
173 | */
174 | getOutPoint(): string;
175 |
176 | /**
177 | *
178 | */
179 | getOutPointAsTime(): Time;
180 |
181 | /**
182 | *
183 | */
184 | getPlayerPosition(): Time;
185 |
186 | /**
187 | *
188 | */
189 | getSelection(): void;
190 |
191 | /**
192 | *
193 | */
194 | getSettings(): SequenceSettings;
195 |
196 | /**
197 | *
198 | */
199 | getWorkAreaInPoint(): string;
200 |
201 | /**
202 | *
203 | */
204 | getWorkAreaInPointAsTime(): Time;
205 |
206 | /**
207 | *
208 | */
209 | getWorkAreaOutPoint(): string;
210 |
211 | /**
212 | *
213 | */
214 | getWorkAreaOutPointAsTime(): Time;
215 |
216 | /**
217 | *
218 | */
219 | importMGT(path: string, time: object, videoTrackIndex: number, audioTrackIndex: number): TrackItem;
220 |
221 | /**
222 | *
223 | */
224 | importMGTFromLibrary(libraryName: string, mgtName: string, time: object, videoTrackIndex: number, audioTrackIndex: number): TrackItem;
225 |
226 | /**
227 | *
228 | */
229 | insertClip(clipProjectItem: ProjectItem, time: object, videoTrackIndex: number, audioTrackIndex: number): void;
230 |
231 | /**
232 | *
233 | */
234 | isWorkAreaEnabled(): boolean;
235 |
236 | /**
237 | *
238 | */
239 | linkSelection(): boolean;
240 |
241 | /**
242 | *
243 | */
244 | overwriteClip(clipProjectItem: ProjectItem, time: object, videoTrackIndex: number, audioTrackIndex: number): void;
245 |
246 | /**
247 | *
248 | */
249 | setInPoint(time: object): void;
250 |
251 | /**
252 | *
253 | */
254 | setOutPoint(time: object): void;
255 |
256 | /**
257 | *
258 | */
259 | setPlayerPosition(pos: string): void;
260 |
261 | /**
262 | *
263 | */
264 | setSelection(): void;
265 |
266 | /**
267 | *
268 | */
269 | setSettings(settings: SequenceSettings): void;
270 |
271 | /**
272 | *
273 | */
274 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
275 |
276 | /**
277 | *
278 | */
279 | setWorkAreaEnabled(specifiedState?: number): boolean;
280 |
281 | /**
282 | *
283 | */
284 | setWorkAreaInPoint(time: object): void;
285 |
286 | /**
287 | *
288 | */
289 | setWorkAreaOutPoint(time: object): void;
290 |
291 | /**
292 | *
293 | */
294 | setZeroPoint(ticks: string): void;
295 |
296 | /**
297 | *
298 | */
299 | unbind(eventName: string): void;
300 |
301 | /**
302 | *
303 | */
304 | unlinkSelection(): boolean;
305 |
306 | }
307 |
308 | /**
309 | *
310 | */
311 | declare class SequenceCollection {
312 | /**
313 | *
314 | */
315 | readonly numSequences: number;
316 |
317 | /**
318 | *
319 | */
320 | bind(eventName: string, function_: any): void;
321 |
322 | /**
323 | *
324 | */
325 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
326 |
327 | /**
328 | *
329 | */
330 | unbind(eventName: string): void;
331 |
332 | }
333 |
334 | /**
335 | *
336 | */
337 | declare class Metadata {
338 | /**
339 | *
340 | */
341 | readonly getMetadata: string;
342 |
343 | /**
344 | *
345 | */
346 | addMarker(): void;
347 |
348 | /**
349 | *
350 | */
351 | bind(eventName: string, function_: any): void;
352 |
353 | /**
354 | *
355 | */
356 | deleteMarker(): void;
357 |
358 | /**
359 | *
360 | */
361 | setMarkerData(): void;
362 |
363 | /**
364 | *
365 | */
366 | setMetadataValue(): void;
367 |
368 | /**
369 | *
370 | */
371 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
372 |
373 | /**
374 | *
375 | */
376 | unbind(eventName: string): void;
377 |
378 | /**
379 | *
380 | */
381 | updateMarker(): void;
382 |
383 | }
384 |
385 | /**
386 | *
387 | */
388 | declare class Anywhere {
389 | /**
390 | *
391 | */
392 | bind(eventName: string, function_: any): void;
393 |
394 | /**
395 | *
396 | */
397 | getAuthenticationToken(): string;
398 |
399 | /**
400 | *
401 | */
402 | getCurrentEditingSessionActiveSequenceURL(): string;
403 |
404 | /**
405 | *
406 | */
407 | getCurrentEditingSessionSelectionURL(): string;
408 |
409 | /**
410 | *
411 | */
412 | getCurrentEditingSessionURL(): string;
413 |
414 | /**
415 | *
416 | */
417 | isProductionOpen(): boolean;
418 |
419 | /**
420 | *
421 | */
422 | listProductions(): RemoteProductionCollection;
423 |
424 | /**
425 | *
426 | */
427 | openProduction(inProductionURL: string): boolean;
428 |
429 | /**
430 | *
431 | */
432 | openTeamProjectSnapshot(inTeamProjectSnapshotPath: string): boolean;
433 |
434 | /**
435 | *
436 | */
437 | setAuthenticationToken(inAuthToken: string, inEmail: string): boolean;
438 |
439 | /**
440 | *
441 | */
442 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
443 |
444 | /**
445 | *
446 | */
447 | unbind(eventName: string): void;
448 |
449 | }
450 |
451 | /**
452 | *
453 | */
454 | declare class SourceMonitor {
455 | /**
456 | *
457 | */
458 | bind(eventName: string, function_: any): void;
459 |
460 | /**
461 | *
462 | */
463 | closeAllClips(): void;
464 |
465 | /**
466 | *
467 | */
468 | closeClip(): void;
469 |
470 | /**
471 | *
472 | */
473 | getPosition(): Time;
474 |
475 | /**
476 | *
477 | */
478 | getProjectItem(): ProjectItem;
479 |
480 | /**
481 | *
482 | */
483 | openFilePath(filePath: string): boolean;
484 |
485 | /**
486 | *
487 | */
488 | openProjectItem(projectItem: ProjectItem): boolean;
489 |
490 | /**
491 | *
492 | */
493 | play(speed?: number): void;
494 |
495 | /**
496 | *
497 | */
498 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
499 |
500 | /**
501 | *
502 | */
503 | unbind(eventName: string): void;
504 |
505 | }
506 |
507 | /**
508 | *
509 | */
510 | declare class Time {
511 | /**
512 | *
513 | */
514 | seconds: number;
515 |
516 | /**
517 | *
518 | */
519 | ticks: string;
520 |
521 | /**
522 | *
523 | */
524 | bind(eventName: string, function_: any): void;
525 |
526 | /**
527 | *
528 | */
529 | getFormatted(time: object, timeDisplay: number): string;
530 |
531 | /**
532 | *
533 | */
534 | setSecondsAsFraction(numerator: number, denominator: number): void;
535 |
536 | /**
537 | *
538 | */
539 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
540 |
541 | /**
542 | *
543 | */
544 | unbind(eventName: string): void;
545 |
546 | }
547 |
548 | /**
549 | *
550 | */
551 | declare class TrackItemCollection {
552 | /**
553 | *
554 | */
555 | readonly numItems: number;
556 |
557 | /**
558 | *
559 | */
560 | bind(eventName: string, function_: any): void;
561 |
562 | /**
563 | *
564 | */
565 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
566 |
567 | /**
568 | *
569 | */
570 | unbind(eventName: string): void;
571 |
572 | }
573 |
574 | /**
575 | *
576 | */
577 | declare class Track {
578 | /**
579 | *
580 | */
581 | readonly clips: TrackItemCollection;
582 |
583 | /**
584 | *
585 | */
586 | readonly id: number;
587 |
588 | /**
589 | *
590 | */
591 | readonly mediaType: string;
592 |
593 | /**
594 | *
595 | */
596 | name: string;
597 |
598 | /**
599 | *
600 | */
601 | readonly transitions: TrackItemCollection;
602 |
603 | /**
604 | *
605 | */
606 | bind(eventName: string, function_: any): void;
607 |
608 | /**
609 | *
610 | */
611 | insertClip(clipProjectItem: ProjectItem, time: object): void;
612 |
613 | /**
614 | *
615 | */
616 | isLocked(): boolean;
617 |
618 | /**
619 | *
620 | */
621 | isMuted(): boolean;
622 |
623 | /**
624 | *
625 | */
626 | isTargeted(): boolean;
627 |
628 | /**
629 | *
630 | */
631 | overwriteClip(clipProjectItem: ProjectItem, time: object): void;
632 |
633 | /**
634 | *
635 | */
636 | setLocked(arg1?: number): void;
637 |
638 | /**
639 | *
640 | */
641 | setMute(arg1?: number): void;
642 |
643 | /**
644 | *
645 | */
646 | setTargeted(isTargeted: boolean, shouldBroadcast?: boolean): void;
647 |
648 | /**
649 | *
650 | */
651 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
652 |
653 | /**
654 | *
655 | */
656 | unbind(eventName: string): void;
657 |
658 | }
659 |
660 | /**
661 | *
662 | */
663 | declare class TrackItem {
664 | /**
665 | *
666 | */
667 | readonly components: ComponentCollection;
668 |
669 | /**
670 | *
671 | */
672 | readonly duration: Time;
673 |
674 | /**
675 | *
676 | */
677 | end: Time;
678 |
679 | /**
680 | *
681 | */
682 | inPoint: Time;
683 |
684 | /**
685 | *
686 | */
687 | readonly matchName: string;
688 |
689 | /**
690 | *
691 | */
692 | readonly mediaType: string;
693 |
694 | /**
695 | *
696 | */
697 | name: string;
698 |
699 | /**
700 | *
701 | */
702 | readonly nodeId: string;
703 |
704 | /**
705 | *
706 | */
707 | outPoint: Time;
708 |
709 | /**
710 | *
711 | */
712 | projectItem: ProjectItem;
713 |
714 | /**
715 | *
716 | */
717 | start: Time;
718 |
719 | /**
720 | *
721 | */
722 | readonly type: number;
723 |
724 | /**
725 | *
726 | */
727 | bind(eventName: string, function_: any): void;
728 |
729 | /**
730 | *
731 | */
732 | getLinkedItems(): TrackItemCollection;
733 |
734 | /**
735 | *
736 | */
737 | getMGTComponent(): Component;
738 |
739 | /**
740 | *
741 | */
742 | getMatchName(): string;
743 |
744 | /**
745 | *
746 | */
747 | getSpeed(): number;
748 |
749 | /**
750 | *
751 | */
752 | isAdjustmentLayer(): boolean;
753 |
754 | /**
755 | *
756 | */
757 | isMGT(): boolean;
758 |
759 | /**
760 | *
761 | */
762 | isSelected(): boolean;
763 |
764 | /**
765 | *
766 | */
767 | isSpeedReversed(): boolean;
768 |
769 | /**
770 | *
771 | */
772 | remove(inRipple: boolean, inAlignToVideo?: boolean): boolean;
773 |
774 | /**
775 | *
776 | */
777 | setSelected(isSelected: number, updateUI?: number): void;
778 |
779 | /**
780 | *
781 | */
782 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
783 |
784 | /**
785 | *
786 | */
787 | unbind(eventName: string): void;
788 |
789 | }
790 |
791 | /**
792 | *
793 | */
794 | declare class Project {
795 | /**
796 | *
797 | */
798 | activeSequence: Sequence;
799 |
800 | /**
801 | *
802 | */
803 | readonly cloudProjectLocalID: string;
804 |
805 | /**
806 | *
807 | */
808 | readonly documentID: string;
809 |
810 | /**
811 | *
812 | */
813 | readonly isCloudProject: boolean;
814 |
815 | /**
816 | *
817 | */
818 | readonly name: string;
819 |
820 | /**
821 | *
822 | */
823 | readonly path: string;
824 |
825 | /**
826 | *
827 | */
828 | readonly rootItem: ProjectItem;
829 |
830 | /**
831 | *
832 | */
833 | readonly sequences: SequenceCollection;
834 |
835 | /**
836 | *
837 | */
838 | addPropertyToProjectMetadataSchema(name: string, label: string, type: number): boolean;
839 |
840 | /**
841 | *
842 | */
843 | bind(eventName: string, function_: any): void;
844 |
845 | /**
846 | *
847 | */
848 | closeDocument(): boolean;
849 |
850 | /**
851 | *
852 | */
853 | consolidateDuplicates(): void;
854 |
855 | /**
856 | *
857 | */
858 | createNewSequence(sequenceName: string, placeholderID: string): void;
859 |
860 | /**
861 | *
862 | */
863 | deleteSequence(sequence: Sequence): boolean;
864 |
865 | /**
866 | *
867 | */
868 | exportAAF(sequence: Sequence, filePath: string, mixDownVideo: number, explodeToMono: number, sampleRate: number, bitsPerSample: number, embedAudio: number, audioFileFormat: number, trimSources: number, handleFrames: number): number;
869 |
870 | /**
871 | *
872 | */
873 | exportFinalCutProXML(exportPath: string, suppressUI: number): boolean;
874 |
875 | /**
876 | *
877 | */
878 | exportOMF(sequence: Sequence, filePath: string, OMFTitle: string, sampleRate: number, bitsPerSample: number, audioEncapsulated: number, audioFileFormat: number, trimAudioFiles: number, handleFrames: number, includePan: number): number;
879 |
880 | /**
881 | *
882 | */
883 | exportTimeline(exportControllerName: string): number;
884 |
885 | /**
886 | *
887 | */
888 | getInsertionBin(): ProjectItem;
889 |
890 | /**
891 | *
892 | */
893 | getProjectPanelMetadata(): void;
894 |
895 | /**
896 | *
897 | */
898 | importAEComps(arg1: any): boolean;
899 |
900 | /**
901 | *
902 | */
903 | importAllAEComps(arg1: any): boolean;
904 |
905 | /**
906 | *
907 | */
908 | importFiles(arg1: any): boolean;
909 |
910 | /**
911 | *
912 | */
913 | importSequences(arg1: any): boolean;
914 |
915 | /**
916 | *
917 | */
918 | openSequence(sequenceID: string): boolean;
919 |
920 | /**
921 | *
922 | */
923 | pauseGrowing(pausedOrNot: number): boolean;
924 |
925 | /**
926 | *
927 | */
928 | placeAsset(arg1: any): boolean;
929 |
930 | /**
931 | *
932 | */
933 | save(): void;
934 |
935 | /**
936 | *
937 | */
938 | saveAs(saveAsPath: string): boolean;
939 |
940 | /**
941 | *
942 | */
943 | setEnableTranscodeOnIngest(inEnable: boolean): boolean;
944 |
945 | /**
946 | *
947 | */
948 | setProjectPanelMetadata(): void;
949 |
950 | /**
951 | *
952 | */
953 | setScratchDiskPath(value: string, type: string): void;
954 |
955 | /**
956 | *
957 | */
958 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
959 |
960 | /**
961 | *
962 | */
963 | unbind(eventName: string): void;
964 |
965 | }
966 |
967 | /**
968 | *
969 | */
970 | declare class ProjectItemType {
971 | /**
972 | *
973 | */
974 | readonly BIN: number;
975 |
976 | /**
977 | *
978 | */
979 | readonly CLIP: number;
980 |
981 | /**
982 | *
983 | */
984 | readonly FILE: number;
985 |
986 | /**
987 | *
988 | */
989 | readonly ROOT: number;
990 |
991 | /**
992 | *
993 | */
994 | bind(eventName: string, function_: any): void;
995 |
996 | /**
997 | *
998 | */
999 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1000 |
1001 | /**
1002 | *
1003 | */
1004 | unbind(eventName: string): void;
1005 |
1006 | }
1007 |
1008 | /**
1009 | *
1010 | */
1011 | declare class ProjectItem {
1012 | /**
1013 | *
1014 | */
1015 | readonly children: ProjectItemCollection;
1016 |
1017 | /**
1018 | *
1019 | */
1020 | readonly getAudioChannelMapping: AudioChannelMapping;
1021 |
1022 | /**
1023 | *
1024 | */
1025 | name: string;
1026 |
1027 | /**
1028 | *
1029 | */
1030 | readonly nodeId: string;
1031 |
1032 | /**
1033 | *
1034 | */
1035 | readonly treePath: string;
1036 |
1037 | /**
1038 | *
1039 | */
1040 | readonly type: number;
1041 |
1042 | /**
1043 | *
1044 | */
1045 | readonly videoComponents: ComponentCollection;
1046 |
1047 | /**
1048 | *
1049 | */
1050 | attachProxy(mediaPath: string, isHiRes: number): boolean;
1051 |
1052 | /**
1053 | *
1054 | */
1055 | bind(eventName: string, function_: any): void;
1056 |
1057 | /**
1058 | *
1059 | */
1060 | canChangeMediaPath(): boolean;
1061 |
1062 | /**
1063 | *
1064 | */
1065 | canProxy(): boolean;
1066 |
1067 | /**
1068 | *
1069 | */
1070 | changeMediaPath(mediaPath: string, overrideChecks?: boolean): boolean;
1071 |
1072 | /**
1073 | *
1074 | */
1075 | clearInPoint(mediaType?: number): void;
1076 |
1077 | /**
1078 | *
1079 | */
1080 | clearOutPoint(mediaType?: number): void;
1081 |
1082 | /**
1083 | *
1084 | */
1085 | createBin(name: string): void;
1086 |
1087 | /**
1088 | *
1089 | */
1090 | createSmartBin(name: string, query: string): void;
1091 |
1092 | /**
1093 | *
1094 | */
1095 | createSubClip(name: string, startTime: object, endTime: object, hasHardBoundaries: number, takeVideo?: number, takeAudio?: number): ProjectItem;
1096 |
1097 | /**
1098 | *
1099 | */
1100 | deleteBin(): void;
1101 |
1102 | /**
1103 | *
1104 | */
1105 | findItemsMatchingMediaPath(matchString: string, ignoreSubclips?: number): void;
1106 |
1107 | /**
1108 | *
1109 | */
1110 | getColorLabel(): number;
1111 |
1112 | /**
1113 | *
1114 | */
1115 | getFootageInterpretation(): FootageInterpretation;
1116 |
1117 | /**
1118 | *
1119 | */
1120 | getInPoint(mediaType?: number): Time;
1121 |
1122 | /**
1123 | *
1124 | */
1125 | getMarkers(): MarkerCollection;
1126 |
1127 | /**
1128 | *
1129 | */
1130 | getMediaPath(): string;
1131 |
1132 | /**
1133 | *
1134 | */
1135 | getOutPoint(mediaType?: number): Time;
1136 |
1137 | /**
1138 | *
1139 | */
1140 | getProjectMetadata(): string;
1141 |
1142 | /**
1143 | *
1144 | */
1145 | getProxyPath(): string;
1146 |
1147 | /**
1148 | *
1149 | */
1150 | getXMPMetadata(): string;
1151 |
1152 | /**
1153 | *
1154 | */
1155 | hasProxy(): boolean;
1156 |
1157 | /**
1158 | *
1159 | */
1160 | isAdjustmentLayer(): boolean;
1161 |
1162 | /**
1163 | *
1164 | */
1165 | isOffline(): boolean;
1166 |
1167 | /**
1168 | *
1169 | */
1170 | isReference(): boolean;
1171 |
1172 | /**
1173 | *
1174 | */
1175 | isSequence(): boolean;
1176 |
1177 | /**
1178 | *
1179 | */
1180 | moveBin(destination: ProjectItem): void;
1181 |
1182 | /**
1183 | *
1184 | */
1185 | refreshMedia(): string;
1186 |
1187 | /**
1188 | *
1189 | */
1190 | renameBin(name: string): boolean;
1191 |
1192 | /**
1193 | *
1194 | */
1195 | saveProjectSnapshot(): boolean;
1196 |
1197 | /**
1198 | *
1199 | */
1200 | select(): void;
1201 |
1202 | /**
1203 | *
1204 | */
1205 | setAudioChannelMapping(sourceChannelMapping: AudioChannelMapping): boolean;
1206 |
1207 | /**
1208 | *
1209 | */
1210 | setColorLabel(): void;
1211 |
1212 | /**
1213 | *
1214 | */
1215 | setFootageInterpretation(interpretFootage: FootageInterpretation): boolean;
1216 |
1217 | /**
1218 | *
1219 | */
1220 | setInPoint(arg1: object, mediaType?: number): void;
1221 |
1222 | /**
1223 | *
1224 | */
1225 | setOffline(): boolean;
1226 |
1227 | /**
1228 | *
1229 | */
1230 | setOutPoint(arg1: object, mediaType?: number): void;
1231 |
1232 | /**
1233 | *
1234 | */
1235 | setOverrideFrameRate(frameRate: number): boolean;
1236 |
1237 | /**
1238 | *
1239 | */
1240 | setOverridePixelAspectRatio(numerator: number, denominator: number): boolean;
1241 |
1242 | /**
1243 | *
1244 | */
1245 | setProjectMetadata(buffer: string): void;
1246 |
1247 | /**
1248 | *
1249 | */
1250 | setScaleToFrameSize(): void;
1251 |
1252 | /**
1253 | *
1254 | */
1255 | setStartTime(arg1: object): void;
1256 |
1257 | /**
1258 | *
1259 | */
1260 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1261 |
1262 | /**
1263 | *
1264 | */
1265 | setXMPMetadata(buffer: string): boolean;
1266 |
1267 | /**
1268 | *
1269 | */
1270 | startTime(): Time;
1271 |
1272 | /**
1273 | *
1274 | */
1275 | unbind(eventName: string): void;
1276 |
1277 | }
1278 |
1279 | /**
1280 | *
1281 | */
1282 | declare class ProjectCollection {
1283 | /**
1284 | *
1285 | */
1286 | readonly numProjects: number;
1287 |
1288 | /**
1289 | *
1290 | */
1291 | bind(eventName: string, function_: any): void;
1292 |
1293 | /**
1294 | *
1295 | */
1296 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1297 |
1298 | /**
1299 | *
1300 | */
1301 | unbind(eventName: string): void;
1302 |
1303 | }
1304 |
1305 | /**
1306 | *
1307 | */
1308 | declare class ProjectItemCollection {
1309 | /**
1310 | *
1311 | */
1312 | readonly numItems: number;
1313 |
1314 | /**
1315 | *
1316 | */
1317 | bind(eventName: string, function_: any): void;
1318 |
1319 | /**
1320 | *
1321 | */
1322 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1323 |
1324 | /**
1325 | *
1326 | */
1327 | unbind(eventName: string): void;
1328 |
1329 | }
1330 |
1331 | /**
1332 | *
1333 | */
1334 | declare class TrackCollection {
1335 | /**
1336 | *
1337 | */
1338 | readonly numTracks: number;
1339 |
1340 | /**
1341 | *
1342 | */
1343 | bind(eventName: string, function_: any): void;
1344 |
1345 | /**
1346 | *
1347 | */
1348 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1349 |
1350 | /**
1351 | *
1352 | */
1353 | unbind(eventName: string): void;
1354 |
1355 | }
1356 |
1357 | /**
1358 | *
1359 | */
1360 | declare class ScratchDiskType {
1361 | /**
1362 | *
1363 | */
1364 | readonly FirstAudioCaptureFolder: string;
1365 |
1366 | /**
1367 | *
1368 | */
1369 | readonly FirstAudioPreviewFolder: string;
1370 |
1371 | /**
1372 | *
1373 | */
1374 | readonly FirstAutoSaveFolder: string;
1375 |
1376 | /**
1377 | *
1378 | */
1379 | readonly FirstCClibrariesFolder: string;
1380 |
1381 | /**
1382 | *
1383 | */
1384 | readonly FirstCapsuleMediaFolder: string;
1385 |
1386 | /**
1387 | *
1388 | */
1389 | readonly FirstVideoCaptureFolder: string;
1390 |
1391 | /**
1392 | *
1393 | */
1394 | readonly FirstVideoPreviewFolder: string;
1395 |
1396 | /**
1397 | *
1398 | */
1399 | bind(eventName: string, function_: any): void;
1400 |
1401 | /**
1402 | *
1403 | */
1404 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1405 |
1406 | /**
1407 | *
1408 | */
1409 | unbind(eventName: string): void;
1410 |
1411 | }
1412 |
1413 | /**
1414 | *
1415 | */
1416 | declare class RemoteProductionCollection {
1417 | /**
1418 | *
1419 | */
1420 | readonly numProductions: number;
1421 |
1422 | /**
1423 | *
1424 | */
1425 | bind(eventName: string, function_: any): void;
1426 |
1427 | /**
1428 | *
1429 | */
1430 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1431 |
1432 | /**
1433 | *
1434 | */
1435 | unbind(eventName: string): void;
1436 |
1437 | }
1438 |
1439 | /**
1440 | *
1441 | */
1442 | declare class RemoteProduction {
1443 | /**
1444 | *
1445 | */
1446 | readonly description: string;
1447 |
1448 | /**
1449 | *
1450 | */
1451 | readonly name: string;
1452 |
1453 | /**
1454 | *
1455 | */
1456 | readonly url: string;
1457 |
1458 | /**
1459 | *
1460 | */
1461 | bind(eventName: string, function_: any): void;
1462 |
1463 | /**
1464 | *
1465 | */
1466 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1467 |
1468 | /**
1469 | *
1470 | */
1471 | unbind(eventName: string): void;
1472 |
1473 | }
1474 |
1475 | /**
1476 | *
1477 | */
1478 | declare class EncoderPreset {
1479 | /**
1480 | *
1481 | */
1482 | readonly matchName: string;
1483 |
1484 | /**
1485 | *
1486 | */
1487 | readonly name: string;
1488 |
1489 | /**
1490 | *
1491 | */
1492 | bind(eventName: string, function_: any): void;
1493 |
1494 | /**
1495 | *
1496 | */
1497 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1498 |
1499 | /**
1500 | *
1501 | */
1502 | unbind(eventName: string): void;
1503 |
1504 | /**
1505 | *
1506 | */
1507 | writeToFile(outputFilePath: string): boolean;
1508 |
1509 | }
1510 |
1511 | /**
1512 | *
1513 | */
1514 | declare class Encoder {
1515 | /**
1516 | *
1517 | */
1518 | readonly ENCODE_ENTIRE: number;
1519 |
1520 | /**
1521 | *
1522 | */
1523 | readonly ENCODE_IN_TO_OUT: number;
1524 |
1525 | /**
1526 | *
1527 | */
1528 | readonly ENCODE_WORKAREA: number;
1529 |
1530 | /**
1531 | *
1532 | */
1533 | bind(eventName: string, function_: any): void;
1534 |
1535 | /**
1536 | *
1537 | */
1538 | encodeFile(inputFilePath: string, outputFilePath: string, presetPath: string, removeOnCompletion?: number, startTime?: object, stopTime?: object, startQueueImmediately?: number): string;
1539 |
1540 | /**
1541 | *
1542 | */
1543 | encodeProjectItem(projectItem: ProjectItem, outputFilePath: string, presetPath: string, WorkAreaType?: number, removeOnCompletion?: number, startQueueImmediately?: number): string;
1544 |
1545 | /**
1546 | *
1547 | */
1548 | encodeSequence(sequence: Sequence, outputFilePath: string, presetPath: string, WorkAreaType?: number, removeOnCompletion?: number, startQueueImmediately?: number): string;
1549 |
1550 | /**
1551 | *
1552 | */
1553 | getExporters(): void;
1554 |
1555 | /**
1556 | *
1557 | */
1558 | launchEncoder(): boolean;
1559 |
1560 | /**
1561 | *
1562 | */
1563 | setEmbeddedXMPEnabled(enable: number): void;
1564 |
1565 | /**
1566 | *
1567 | */
1568 | setSidecarXMPEnabled(enable: number): void;
1569 |
1570 | /**
1571 | *
1572 | */
1573 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1574 |
1575 | /**
1576 | *
1577 | */
1578 | startBatch(): boolean;
1579 |
1580 | /**
1581 | *
1582 | */
1583 | unbind(eventName: string): void;
1584 |
1585 | }
1586 |
1587 | /**
1588 | *
1589 | */
1590 | declare class Properties {
1591 | /**
1592 | *
1593 | */
1594 | bind(eventName: string, function_: any): void;
1595 |
1596 | /**
1597 | *
1598 | */
1599 | clearProperty(propertyKey: string): void;
1600 |
1601 | /**
1602 | *
1603 | */
1604 | doesPropertyExist(propertyKey: string): boolean;
1605 |
1606 | /**
1607 | *
1608 | */
1609 | getProperty(propertyKey: string): void;
1610 |
1611 | /**
1612 | *
1613 | */
1614 | isPropertyReadOnly(propertyKey: string): boolean;
1615 |
1616 | /**
1617 | *
1618 | */
1619 | setProperty(propertyKey: string): void;
1620 |
1621 | /**
1622 | *
1623 | */
1624 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1625 |
1626 | /**
1627 | *
1628 | */
1629 | unbind(eventName: string): void;
1630 |
1631 | }
1632 |
1633 | /**
1634 | *
1635 | */
1636 | declare class App {
1637 | /**
1638 | *
1639 | */
1640 | readonly anywhere: Anywhere;
1641 |
1642 | /**
1643 | *
1644 | */
1645 | readonly build: string;
1646 |
1647 | /**
1648 | *
1649 | */
1650 | readonly encoder: Encoder;
1651 |
1652 | /**
1653 | *
1654 | */
1655 | readonly getAppPrefPath: string;
1656 |
1657 | /**
1658 | *
1659 | */
1660 | readonly getAppSystemPrefPath: string;
1661 |
1662 | /**
1663 | *
1664 | */
1665 | readonly getPProPrefPath: string;
1666 |
1667 | /**
1668 | *
1669 | */
1670 | readonly getPProSystemPrefPath: string;
1671 |
1672 | /**
1673 | *
1674 | */
1675 | readonly learnPanelContentDirPath: string;
1676 |
1677 | /**
1678 | *
1679 | */
1680 | readonly learnPanelExampleProjectDirPath: string;
1681 |
1682 | /**
1683 | *
1684 | */
1685 | readonly metadata: Metadata;
1686 |
1687 | /**
1688 | *
1689 | */
1690 | readonly path: string;
1691 |
1692 | /**
1693 | *
1694 | */
1695 | project: Project;
1696 |
1697 | /**
1698 | *
1699 | */
1700 | readonly projectManager: ProjectManager;
1701 |
1702 | /**
1703 | *
1704 | */
1705 | readonly projects: ProjectCollection;
1706 |
1707 | /**
1708 | *
1709 | */
1710 | readonly properties: Properties;
1711 |
1712 | /**
1713 | *
1714 | */
1715 | readonly sourceMonitor: SourceMonitor;
1716 |
1717 | /**
1718 | *
1719 | */
1720 | readonly userGuid: string;
1721 |
1722 | /**
1723 | *
1724 | */
1725 | readonly version: string;
1726 |
1727 | /**
1728 | *
1729 | */
1730 | bind(eventName: string, function_: any): void;
1731 |
1732 | /**
1733 | *
1734 | */
1735 | broadcastPrefsChanged(preferencesThatChanged: string): boolean;
1736 |
1737 | /**
1738 | *
1739 | */
1740 | getConstant(name: string): number;
1741 |
1742 | /**
1743 | *
1744 | */
1745 | getEnableProxies(): number;
1746 |
1747 | /**
1748 | *
1749 | */
1750 | getProjectFromViewID(viewID: string): Project;
1751 |
1752 | /**
1753 | *
1754 | */
1755 | getProjectViewIDs(): void;
1756 |
1757 | /**
1758 | *
1759 | */
1760 | getProjectViewSelection(viewID: string): void;
1761 |
1762 | /**
1763 | *
1764 | */
1765 | getWorkspaces(): void;
1766 |
1767 | /**
1768 | *
1769 | */
1770 | isDocument(filePath: string): boolean;
1771 |
1772 | /**
1773 | *
1774 | */
1775 | isDocumentOpen(): boolean;
1776 |
1777 | /**
1778 | *
1779 | */
1780 | openDocument(): boolean;
1781 |
1782 | /**
1783 | *
1784 | */
1785 | openFCPXML(): boolean;
1786 |
1787 | /**
1788 | *
1789 | */
1790 | quit(): void;
1791 |
1792 | /**
1793 | *
1794 | */
1795 | refresh(): void;
1796 |
1797 | /**
1798 | *
1799 | */
1800 | setEnableProxies(enable: number): boolean;
1801 |
1802 | /**
1803 | *
1804 | */
1805 | setEnableTranscodeOnIngest(inEnable: boolean): void;
1806 |
1807 | /**
1808 | *
1809 | */
1810 | setExtensionPersistent(extensionID: string, state?: number): void;
1811 |
1812 | /**
1813 | *
1814 | */
1815 | setProjectViewSelection(viewID: string): void;
1816 |
1817 | /**
1818 | *
1819 | */
1820 | setSDKEventMessage(value: string, eventType: string): boolean;
1821 |
1822 | /**
1823 | *
1824 | */
1825 | setScratchDiskPath(value: string, type: string): void;
1826 |
1827 | /**
1828 | *
1829 | */
1830 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1831 |
1832 | /**
1833 | *
1834 | */
1835 | setWorkspace(workspace: string): boolean;
1836 |
1837 | /**
1838 | *
1839 | */
1840 | showCursor(enable: boolean): void;
1841 |
1842 | /**
1843 | *
1844 | */
1845 | trace(message: string): void;
1846 |
1847 | /**
1848 | *
1849 | */
1850 | unbind(eventName: string): void;
1851 |
1852 | /**
1853 | *
1854 | */
1855 | write(arg1: any): void;
1856 |
1857 | }
1858 |
1859 | /**
1860 | *
1861 | */
1862 | declare class MarkerCollection {
1863 | /**
1864 | *
1865 | */
1866 | readonly numMarkers: number;
1867 |
1868 | /**
1869 | *
1870 | */
1871 | bind(eventName: string, function_: any): void;
1872 |
1873 | /**
1874 | *
1875 | */
1876 | createMarker(time: number): Marker;
1877 |
1878 | /**
1879 | *
1880 | */
1881 | deleteMarker(marker: Marker): void;
1882 |
1883 | /**
1884 | *
1885 | */
1886 | getFirstMarker(): Marker;
1887 |
1888 | /**
1889 | *
1890 | */
1891 | getLastMarker(): Marker;
1892 |
1893 | /**
1894 | *
1895 | */
1896 | getNextMarker(marker: Marker): Marker;
1897 |
1898 | /**
1899 | *
1900 | */
1901 | getPrevMarker(marker: Marker): Marker;
1902 |
1903 | /**
1904 | *
1905 | */
1906 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1907 |
1908 | /**
1909 | *
1910 | */
1911 | unbind(eventName: string): void;
1912 |
1913 | }
1914 |
1915 | /**
1916 | *
1917 | */
1918 | declare class Marker {
1919 | /**
1920 | *
1921 | */
1922 | comments: string;
1923 |
1924 | /**
1925 | *
1926 | */
1927 | end: Time;
1928 |
1929 | /**
1930 | *
1931 | */
1932 | readonly guid: string;
1933 |
1934 | /**
1935 | *
1936 | */
1937 | name: string;
1938 |
1939 | /**
1940 | *
1941 | */
1942 | start: Time;
1943 |
1944 | /**
1945 | *
1946 | */
1947 | type: string;
1948 |
1949 | /**
1950 | *
1951 | */
1952 | bind(eventName: string, function_: any): void;
1953 |
1954 | /**
1955 | *
1956 | */
1957 | getColorByIndex(): number;
1958 |
1959 | /**
1960 | *
1961 | */
1962 | getWebLinkFrameTarget(): string;
1963 |
1964 | /**
1965 | *
1966 | */
1967 | getWebLinkURL(): string;
1968 |
1969 | /**
1970 | *
1971 | */
1972 | setColorByIndex(arg1: number): void;
1973 |
1974 | /**
1975 | *
1976 | */
1977 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
1978 |
1979 | /**
1980 | *
1981 | */
1982 | setTypeAsChapter(): void;
1983 |
1984 | /**
1985 | *
1986 | */
1987 | setTypeAsComment(): void;
1988 |
1989 | /**
1990 | *
1991 | */
1992 | setTypeAsSegmentation(): void;
1993 |
1994 | /**
1995 | *
1996 | */
1997 | setTypeAsWebLink(url: string, frameTarget: string): void;
1998 |
1999 | /**
2000 | *
2001 | */
2002 | unbind(eventName: string): void;
2003 |
2004 | }
2005 |
2006 | /**
2007 | *
2008 | */
2009 | declare class Document {
2010 | /**
2011 | *
2012 | */
2013 | bind(eventName: string, function_: any): void;
2014 |
2015 | /**
2016 | *
2017 | */
2018 | getFilePath(): string;
2019 |
2020 | /**
2021 | *
2022 | */
2023 | importFiles(arg1: any): boolean;
2024 |
2025 | /**
2026 | *
2027 | */
2028 | setTimeout(eventName: string, function_: any, milliseconds: number): void;
2029 |
2030 | /**
2031 | *
2032 | */
2033 | unbind(eventName: string): void;
2034 |
2035 | }
2036 |
2037 |
--------------------------------------------------------------------------------
/AfterEffects/2018/index.d.ts:
--------------------------------------------------------------------------------
1 | ///
2 | ///
3 |
4 | declare class Global {
5 | app: Application
6 | }
7 |
8 | /** CONSTANTS */
9 | declare const enum AppVersion {
10 | CS3 = 8.0,
11 | CS4 = 9.0,
12 | CS5 = 10.0,
13 | CS5_5 = 10.5,
14 | CS6 = 11.0,
15 | CC = 12.0,
16 | CC2014 = 13.0,
17 | CC2015 = 13.5,
18 | CC2015_1 = 13.6,
19 | CC2015_2 = 13.7,
20 | CC2015_3 = 13.8,
21 | CC2017 = 14.0,
22 | CC2018 = 15.0,
23 | CC2019 = 16.0
24 | }
25 |
26 | declare const enum CommandID {
27 | /**
28 | * File
29 | */
30 | NewProject = 2,
31 | NewFolder = 2139,
32 | NewAdobePhotoshopFile = 3147,
33 | NewMAXONCINEMA4DFile = 4007,
34 | OpenProject = 3,
35 | OpenRecentProject1 = 2330,
36 | OpenRecentProject2 = 2331,
37 | OpenRecentProject3 = 2332,
38 | OpenRecentProject4 = 2333,
39 | OpenRecentProject5 = 2334,
40 | BrowseInBridge = 3689,
41 |
42 | Close = 4,
43 | CloseProject = 3154,
44 | Save = 5,
45 | SaveAs = 6,
46 | SaveACopy = 2166,
47 | SaveACopyAsXML = 3785,
48 | IncrementAndSave = 3088,
49 | Revert = 7,
50 |
51 | ImportFile = 2003,
52 | ImportMultipleFiles = 2236,
53 | ImportPlaceholder = 2126,
54 | ImportSolid = 3000,
55 | ImportRecentFootage1 = 2310,
56 | ImportRecentFootage2 = 2311,
57 | ImportRecentFootage3 = 2312,
58 | ImportRecentFootage4 = 2313,
59 | ImportRecentFootage5 = 2314,
60 | ImportRecentFootage6 = 2315,
61 | ImportRecentFootage7 = 2316,
62 | ImportRecentFootage8 = 2317,
63 | ImportRecentFootage9 = 2318,
64 | ImportRecentFootage10 = 2319,
65 | ExportAddToAdobeMediaEncoderQueue = 3800,
66 | ExportAddToRenderQueue = 2161,
67 |
68 | AddFootageToComp = 2005,
69 | NewCompFromSelection = 2796,
70 |
71 | CollectFiles = 2482,
72 | ConsolidateAllFootage = 2107,
73 | RemoveUnsedFootage = 2109,
74 | ReduceProject = 2735,
75 | FindMissingEffects = 4002,
76 | FindMissingFonts = 4003,
77 | FindMissingFootage = 4004,
78 | WatchFolder = 2457,
79 |
80 | RunScriptFile = 8000,
81 | OpenScriptEditor = 8001,
82 |
83 | CreateProxyStill = 2778,
84 | CreateProxyMovie = 2779,
85 | SetProxyFile = 2003,
86 | SetProxyNone = 2119,
87 | InterpretFootageMain = 2077,
88 | InterpretFootageProxy = 2103,
89 | InterpretFootageRememberInterpretation = 2254,
90 | InterpretFootageApplyInterpretation = 2255,
91 | ReplaceFootageFile = 2003,
92 | ReplaceFootageWithLayeredComp = 3070,
93 | ReplaceFootagePlaceholder = 2126,
94 | ReplaceFootageSolid = 3000,
95 | ReloadFootage = 2257,
96 | RevealInExploler = 2562,
97 | RevealInFinder = 2562,
98 | RevealInBridge = 3690,
99 |
100 | ProjectSettings = 2611,
101 |
102 | /**
103 | * Edit
104 | */
105 | Undo = 16,
106 | Redo = 17,
107 |
108 | Cut = 18,
109 | Copy = 19,
110 | CopyWithPropertyLinks = 10310,
111 | CopyExpressionOnly = 53,
112 | Paste = 20,
113 | Clear = 21,
114 |
115 | Duplicate = 2080,
116 | SplitLayer = 2158,
117 | LiftWorkArea = 2613,
118 | ExtractWorkArea = 2614,
119 | SelectAll = 23,
120 | DeselectAll = 2004,
121 |
122 | PurgeAllMemoryAndDiskCache = 10200,
123 | PurgeAllMemory = 2373,
124 | PurgeUndo = 2371,
125 | PurgeImageCacheMemory = 2372,
126 | PurgeSnapshot = 2481,
127 |
128 | EditOriginal = 2142,
129 | EditInAdobeAudition = 3697,
130 |
131 | TemplatesRenderSettings = 2149,
132 | TemplatesOutputModule = 2150,
133 | PasteMochaMask = 5006,
134 |
135 | /**
136 | * Composition
137 | */
138 | NewComposition = 2000,
139 |
140 | CompositionSettings = 2007,
141 | SetPosterTime = 2012,
142 | TrimCompToWorkArea = 2360,
143 | CropCompToRegionOfInterest = 2997,
144 | AddToAdobeMediaEncoderQueue = 3800,
145 | AddToRenderQueue = 2161,
146 | AddOutputModule = 2154,
147 |
148 | SaveFrameAs = 2233,
149 | SaveFrameAsPhotoshopLayers = 5001,
150 | PreRender = 2780,
151 |
152 | CompositionFlowchart = 2258,
153 | CompositionMiniFlowchart = 3792,
154 |
155 | /**
156 | * Layer
157 | */
158 | NewText = 2836,
159 | NewSolid = 2038,
160 | NewLight = 2563,
161 | NewCamera = 2564,
162 | NewNullObject = 2767,
163 | NewShapeLayer = 3736,
164 | NewAdjustmentLayer = 2279,
165 | // NewAdobePhotoshopFile = 3147,
166 | // NewMAXONCINEMA4DFile = 4007,
167 | LayerSettings = 2021,
168 |
169 | OpenLayer = 3784,
170 | OpenLayerSource = 2523,
171 | // RevealInExploler = 2562,
172 | // RevealInFinder = 2562,
173 |
174 | NewMask = 2367,
175 | ResetMask = 2448,
176 | RemoveMask = 2368,
177 | RemoveAllMasks = 2369,
178 | UnlockAllMasks = 2456,
179 | LockOtherMasks = 2455,
180 | HideLockedMasks = 2524,
181 |
182 | QualityBest = 2045,
183 | QualityDraft = 2044,
184 | QualityWireframe = 2042,
185 | QualityBilinear = 10207,
186 | QualityBicubic = 10208,
187 |
188 | HideOtherVideo = 2054,
189 | ShowAllVideo = 2055,
190 | UnlockAllLayers = 2244,
191 |
192 | FlipHorizontal = 3766,
193 | FlipVertical = 3767,
194 | CenterInView = 3819,
195 | CenterAnchorPointInLayerContent = 10312,
196 | FitToComp = 2156,
197 | FitToCompWidth = 2732,
198 | FitToCompHeight = 2733,
199 | EnableTimeRemapping = 2153,
200 | TimeReverseLayer = 2135,
201 | TimeStretch = 2024,
202 | FreezeFrame = 3695,
203 | AddMarker = 2157,
204 |
205 | LayerStylesConvertToEditableStyles = 3740,
206 | LayerStylesShowAll = 3743,
207 | LayerStylesRemoveAll = 2072,
208 | LayerStylesDropShadow = 9000,
209 | LayerStylesInnerShadow = 9001,
210 | LayerStylesOuterGlow = 9002,
211 | LayerStylesInnerGlow = 9003,
212 | LayerStylesBevelAndEmboss = 9004,
213 | LayerStylesSatin = 9005,
214 | LayerStylesColorOverlay = 9006,
215 | LayerStylesGradientOverlay = 9007,
216 | LayerStylesStroke = 9008,
217 |
218 | GroupShapes = 3741,
219 | UngroupShapes = 3742,
220 |
221 | ConvertToEditableText = 3799,
222 | CreateShapesFromText = 3781,
223 | CreateMasksFromText = 2933,
224 | CreateShapesFromVectorLayer = 3973,
225 | CreateStereo3DRig = 3843,
226 | CreateOrbitNull = 3844,
227 | LinkFocusDistanceToPointOfInterest = 3845,
228 | LinkFocusDistanceToLayer = 3847,
229 | SetFocusDitanceToLayer = 3846,
230 | AutoTrace = 3044,
231 | PreCompose = 2071,
232 |
233 | /**
234 | * Animation
235 | */
236 | SaveAnimationPreset = 3075,
237 | ApplyAnimationPreset = 2450,
238 | RecentAnimationPreset1 = 2460,
239 | RecentAnimationPreset2 = 2461,
240 | RecentAnimationPreset3 = 2462,
241 | RecentAnimationPreset4 = 2463,
242 | RecentAnimationPreset5 = 2464,
243 | BrowsePresets = 3691,
244 |
245 | ConvertAudioToKeyframes = 5015,
246 | ConvertExpressionToKeyframes = 2639,
247 | RPFCameraImport = 5018,
248 | SequenceLayers = 5003,
249 | TimeReverseKeyframes = 3693,
250 |
251 | RemoveAllTextAnimators = 3058,
252 |
253 | AddExpression = 2702,
254 | SeparateDimensions = 3764,
255 | TrackCamera = 3983,
256 | TrackInMochaAE = 5007,
257 | WarpStabilizerVFX = 3986,
258 | TrackMotion = 2568,
259 | TrackMask = 10311,
260 | TrackThisProperty = 2643,
261 |
262 | RevealPropertiesWithKeyframes = 2387,
263 | RevealPropertiesWithAnimation = 4011,
264 | RevealAllModifiedProperties = 2771,
265 |
266 | /**
267 | * View
268 | */
269 | ZoomIn = 2092,
270 | ZoomOut = 2093,
271 |
272 | ResolutionFull = 2048,
273 | ResolutionHalf = 2047,
274 | ResolutionThird = 2081,
275 | ResolutionQuarter = 2046,
276 | ResolutionCustom = 2049,
277 |
278 | UseDisplayColorManagement = 3704,
279 |
280 | ShowRulers = 2280,
281 |
282 | ShowGuides = 2274,
283 | SnapToGuides = 2286,
284 | LockGuides = 2275,
285 | ClearGuides = 2276,
286 |
287 | ShowGrid = 2277,
288 | SnapToGrid = 2278,
289 |
290 | ShowLayerControls = 2435,
291 |
292 | /**
293 | * Window
294 | */
295 | Align = 5022,
296 | Audio = 2029,
297 | Brushed = 3014,
298 | Character = 3011,
299 | EffectsAndPresets = 3718,
300 | Info = 2028,
301 | MaskInterpolation = 5027,
302 | MediaBrowser = 4013,
303 | Metadata = 3788,
304 | MotionSketch = 5024,
305 | Paint = 3045,
306 | Paragraph = 3012,
307 | Preview = 2031,
308 | Progress = 4005,
309 | Smoother = 5028,
310 | Tools = 2010,
311 | Tracker = 5005,
312 | Wiggler = 5030,
313 | }
314 |
315 | declare enum Language {
316 | ENGLISH,
317 | JAPANESE,
318 | GERMAN,
319 | FRENCH,
320 | ITALIAN,
321 | SPANISH,
322 | KOREAN,
323 | CHINESE,
324 | RUSSIAN,
325 | PORTUGUESE,
326 | }
327 |
328 | declare enum PurgeTarget {
329 | /** Purges all data that After Effects has cached to physical memory. */
330 | ALL_CACHES,
331 | /** Purges all data saved in the undo cache. */
332 | UNDO_CACHES,
333 | /** Purges all data cached as composition/layer snapshots. */
334 | SNAPSHOT_CACHES,
335 | /** Purges all saved image data. */
336 | IMAGE_CACHES,
337 | }
338 |
339 | declare enum FrameBlendingType {
340 | FRAME_MIX,
341 | NO_FRAME_BLEND,
342 | PIXEL_MOTION,
343 | }
344 |
345 | declare enum BlendingMode {
346 | ADD,
347 | ALPHA_ADD,
348 | CLASSIC_COLOR_BURN,
349 | CLASSIC_COLOR_DODGE,
350 | CLASSIC_DIFFERENCE,
351 | COLOR,
352 | COLOR_BURN,
353 | COLOR_DODGE,
354 | DANCING_DISSOLVE,
355 | DARKEN,
356 | DARKER_COLOR,
357 | DIFFERENCE,
358 | DISSOLVE,
359 | EXCLUSION,
360 | HARD_LIGHT,
361 | HARD_MIX,
362 | HUE,
363 | LIGHTEN,
364 | LIGHTER_COLOR,
365 | LINEAR_BURN,
366 | LINEAR_DODGE,
367 | LINEAR_LIGHT,
368 | LUMINESCENT_PREMUL,
369 | LUMINOSITY,
370 | MULTIPLY,
371 | NORMAL,
372 | OVERLAY,
373 | PIN_LIGHT,
374 | SATURATION,
375 | SCREEN,
376 | SILHOUETE_ALPHA,
377 | SILHOUETTE_LUMA,
378 | SOFT_LIGHT,
379 | STENCIL_ALPHA,
380 | STENCIL_LUMA,
381 | VIVID_LIGHT,
382 | }
383 |
384 | declare enum TrackMatteType {
385 | ALPHA,
386 | ALPHA_INVERTED,
387 | LUMA,
388 | LUMA_INVERTED,
389 | NO_TRACK_MATTE,
390 | }
391 |
392 | declare enum LayerQuality {
393 | BEST,
394 | DRAFT,
395 | WIREFRAME,
396 | }
397 |
398 | declare enum AutoOrientType {
399 | /** Layer faces in the direction of the motion path. */
400 | ALONG_PATH,
401 | /** Layer always faces the active camera or points at its point of interest. */
402 | CAMERA_OR_POINT_OF_INTEREST,
403 | /** Each character in a per-character 3D text layer automatically faces the active camera. */
404 | CHARACTERS_TOWARD_CAMERA,
405 | /** Layer rotates freely, independent of any motion path, point of interest, or other layers. */
406 | NO_AUTO_ORIENT,
407 | }
408 |
409 | declare enum LayerSamplingQuality {
410 | BICUBIC,
411 | BILINEAR,
412 | }
413 |
414 | declare enum AlphaMode {
415 | IGNORE,
416 | STRAIGHT,
417 | PREMULTIPLIED,
418 | }
419 |
420 | declare enum FieldSeparationType {
421 | OFF,
422 | UPPER_FIELD_FIRST,
423 | LOWER_FIELD_FIRST,
424 | }
425 |
426 | declare enum PulldownPhase {
427 | OFF,
428 | SSWWW,
429 | SWWWS,
430 | SWWWW_24P_ADVANCE,
431 | WSSWW,
432 | WSWWW_24P_ADVANCE,
433 | WWSSW,
434 | WWSWW_24P_ADVANCE,
435 | WWWSS,
436 | WWWSW_24P_ADVANCE,
437 | WWWWS_24P_ADVANCE,
438 | }
439 |
440 | declare enum PulldownMethod {
441 | PULLDOWN_3_2,
442 | ADVANCE_24P,
443 | }
444 |
445 | declare enum ImportAsType {
446 | COMP_CROPPED_LAYERS,
447 | FOOTAGE,
448 | COMP,
449 | PROJECT,
450 | }
451 |
452 | declare enum LightType {
453 | PARALLEL,
454 | SPOT,
455 | POINT,
456 | AMBIENT,
457 | }
458 |
459 | declare enum MaskMode {
460 | NONE,
461 | ADD,
462 | SUBTRACT,
463 | INTERSECT,
464 | LIGHTEN,
465 | DARKEN,
466 | DIFFERENCE,
467 | }
468 |
469 | declare enum MaskMotionBlur {
470 | SAME_AS_LAYER,
471 | ON,
472 | OFF,
473 | }
474 |
475 | declare enum MaskFeatherFalloff {
476 | FFO_LINEAR,
477 | FFO_SMOOTH,
478 | }
479 |
480 | declare enum PostRenderAction {
481 | NONE,
482 | IMPORT,
483 | IMPORT_AND_REPLACE_USAGE,
484 | SET_PROXY,
485 | }
486 |
487 | declare enum GetSettingsFormat {
488 | STRING,
489 | STRING_SETTABLE,
490 | NUMBER,
491 | NUMBER_SETTABLE,
492 | SPEC,
493 | }
494 |
495 | declare enum TimeDisplayType {
496 | FRAMES,
497 | TIMECODE,
498 | }
499 |
500 | declare enum FootageTimecodeDisplayStartType {
501 | FTCS_START_0,
502 | FTCS_USE_SOURCE_MEDIA,
503 | }
504 |
505 | declare enum FeetFramesFilmType {
506 | MM16,
507 | MM35,
508 | }
509 |
510 | declare enum FramesCountType {
511 | FC_START_0,
512 | FC_START_1,
513 | FC_TIMECODE_CONVERSION,
514 | }
515 |
516 | declare enum CloseOptions {
517 | /** Close without saving. */
518 | DO_NOT_SAVE_CHANGES,
519 | /** Prompt for whether to save changes before close. */
520 | PROMPT_TO_SAVE_CHANGES,
521 | /** Save automatically on close. */
522 | SAVE_CHANGES,
523 | }
524 |
525 | declare enum PropertyValueType {
526 | NO_VALUE,
527 | ThreeD_SPATIAL,
528 | ThreeD,
529 | TwoD_SPATIAL,
530 | TwoD,
531 | OneD,
532 | COLOR,
533 | CUSTOM_VALUE,
534 | MARKER,
535 | LAYER_INDEX,
536 | MASK_INDEX,
537 | SHAPE,
538 | TEXT_DOCUMENT,
539 | }
540 |
541 | declare enum KeyframeInterpolationType {
542 | LINEAR,
543 | BEZIER,
544 | HOLD,
545 | }
546 |
547 | declare enum PropertyType {
548 | PROPERTY,
549 | INDEXED_GROUP,
550 | NAMED_GROUP,
551 | }
552 |
553 | declare enum ResolveType {
554 | ACCEPT_THEIRS,
555 | ACCEPT_YOURS,
556 | ACCEPT_THEIRS_AND_COPY,
557 | }
558 |
559 | declare enum RQItemStatus {
560 | WILL_CONTINUE,
561 | NEEDS_OUTPUT,
562 | UNQUEUED,
563 | QUEUED,
564 | RENDERING,
565 | USER_STOPPED,
566 | ERR_STOPPED,
567 | DONE,
568 | }
569 |
570 | declare enum LogType {
571 | ERRORS_ONLY,
572 | ERRORS_AND_SETTINGS,
573 | ERRORS_AND_PER_FRAME_INFO,
574 | }
575 |
576 | declare enum PREFType {
577 | PREF_Type_MACHINE_SPECIFIC,
578 | PREF_Type_MACHINE_INDEPENDENT,
579 | PREF_Type_MACHINE_INDEPENDENT_RENDER,
580 | PREF_Type_MACHINE_INDEPENDENT_OUTPUT,
581 | PREF_Type_MACHINE_INDEPENDENT_COMPOSITION,
582 | PREF_Type_MACHINE_SPECIFIC_TEXT,
583 | PREF_Type_MACHINE_SPECIFIC_PAINT,
584 | }
585 |
586 | declare enum ParagraphJustification {
587 | LEFT_JUSTIFY,
588 | CENTER_JUSTIFY,
589 | RIGHT_JUSTIFY,
590 | FULL_JUSTIFY_LASTLINE_LEFT,
591 | FULL_JUSTIFY_LASTLINE_RIGHT,
592 | FULL_JUSTIFY_LASTLINE_CENTER,
593 | FULL_JUSTIFY_LASTLINE_FULL,
594 | MULTIPLE_JUSTIFICATIONS,
595 | }
596 |
597 | declare enum ViewerType {
598 | VIEWER_COMPOSITION,
599 | VIEWER_LAYER,
600 | VIEWER_FOOTAGE,
601 | }
602 |
603 | declare enum FastPreviewType {
604 | FP_OFF,
605 | FP_ADAPTIVE_RESOLUTION,
606 | FP_DRAFT,
607 | FP_FAST_DRAFT,
608 | FP_WIREFRAME,
609 | }
610 |
611 | declare enum ChannelType {
612 | CHANNEL_RGB,
613 | CHANNEL_RED,
614 | CHANNEL_GREEN,
615 | CHANNEL_BLUE,
616 | CHANNEL_ALPHA,
617 | CHANNEL_RED_COLORIZE,
618 | CHANNEL_GREEN_COLORIZE,
619 | CHANNEL_BLUE_COLORIZE,
620 | CHANNEL_RGB_STRAIGHT,
621 | CHANNEL_ALPHA_OVERLAY,
622 | CHANNEL_ALPHA_BOUNDARY,
623 | }
624 |
625 | /** CC2015.3- */
626 | declare enum GpuAccelType {
627 | CUDA,
628 | METAL,
629 | OPENCL,
630 | SOFTWARE,
631 | }
632 |
633 | /** CC2017- */
634 | declare enum ToolType {
635 | Tool_Arrow,
636 | Tool_Rotate,
637 | Tool_CameraMaya,
638 | Tool_CameraOrbit,
639 | Tool_CameraTrackXY,
640 | Tool_CameraTrackZ,
641 | Tool_Paintbrush,
642 | Tool_CloneStamp,
643 | Tool_Eraser,
644 | Tool_Hand,
645 | Tool_Magnify,
646 | Tool_PanBehind,
647 | Tool_Rect,
648 | Tool_RoundedRect,
649 | Tool_Oval,
650 | Tool_Polygon,
651 | Tool_Star,
652 | Tool_TextH,
653 | Tool_TextV,
654 | Tool_Pen,
655 | Tool_Feather,
656 | Tool_PenPlus,
657 | Tool_PenMinus,
658 | Tool_PenConvert,
659 | Tool_Pin,
660 | Tool_PinStarch,
661 | Tool_PinDepth,
662 | Tool_Quickselect,
663 | Tool_Hairbrush,
664 | }
665 |
666 | /**
667 | * TYPES
668 | */
669 |
670 | /** Clears text from the Info panel. */
671 | declare var clearOutput: () => void
672 |
673 | /** Converts string time value to a numeric time value. */
674 | declare var currentFormatToTime: (
675 | formattedTime: string,
676 | fps: number,
677 | isDuration?: boolean,
678 | ) => number
679 |
680 | /** Converts a numeric time value to a string time value. */
681 | declare var timeToCurrentFormat: (time: number, fps: number, isDuration?: boolean) => string
682 |
683 | /** Writes text to the Info panel, with no line break added. */
684 | declare var write: (text: string) => void
685 |
686 | /** Writes text to the Info panel, adding a line break at the end. */
687 | declare var writeLn: (text: string) => void
688 |
689 | /** When true, the specified object exists. */
690 | declare var isValid: (obj: object) => boolean
691 |
692 | /** Provides access to objects and application settings within the After Effects application. The single global object is always available by its name, app. */
693 | declare class Application {
694 | /** The current After Effects project. */
695 | readonly project: Project
696 |
697 | /** The locale (language and region) in which the application is running. */
698 | readonly isoLanguage: string
699 |
700 | /** The version number of the After Effects application. */
701 | readonly version: string
702 |
703 | /** The name of this build of the application. */
704 | readonly buildName: string
705 |
706 | /** The number of this build of the application. */
707 | readonly buildNumber: number
708 |
709 | /** When true, the local application is running in Watch Folder mode. */
710 | readonly isWatchFolder: boolean
711 |
712 | /** When true, the local After Effects application is running as a render engine. */
713 | readonly isRenderEngine: boolean
714 |
715 | /** The language After Effects is running. */
716 | readonly language: Language
717 |
718 | /** Application settings that can be set via scripting. */
719 | readonly settings: Settings
720 |
721 | /** A callback function that is called when an error occurs in the application. */
722 | onError: string | null
723 |
724 | /** A numeric status code used when executing a script
725 | * externally (that is, from a command line or AppleScript).
726 | * 0 if no error occurred. A positive number indicates an
727 | * error that occurred while running the script.
728 | */
729 | exitCode: number
730 |
731 | /** When true, the application remains open after running a script from the command line on Windows. */
732 | exitAfterLaunchAndEval: boolean
733 |
734 | /** When true, the project is saved if the application closes unexpectedly. */
735 | saveProjectOnCrash: boolean
736 |
737 | /** Memory in use by this application. */
738 | readonly memoryInUse: number
739 |
740 | /** The effects available in the application. */
741 | readonly effects: { displayName: string; matchName: string; version: string; category: string }[]
742 |
743 | /** The currently focused or last-focused viewer panel. */
744 | readonly activeViewer: Viewer | null
745 |
746 | /** Preferences */
747 | readonly preferences: Preferences
748 |
749 | /** CC2017- */
750 | availableGPUAccelTypes: GpuAccelType
751 |
752 | /** Creates a new project in After Effects. */
753 | newProject(): Project | null
754 |
755 | /** Opens a project or an Open Project dialog box. */
756 | open(file?: File): Project | null
757 |
758 | /** Quits the application. */
759 | quit(): void
760 |
761 | /** Starts Watch Folder mode; does not return until Watch Folder mode is turned off. */
762 | watchFolder(folder_object_to_watch: Folder): void
763 |
764 | /** Pauses a current watch-folder process. */
765 | pauseWatchFolder(pause: boolean): void
766 |
767 | /** Ends a current watch-folder process. */
768 | endWatchFolder(): void
769 |
770 | /** Purges a targeted type of cached information(replicates Purge options in the Edit menu). */
771 | purge(target: PurgeTarget): void
772 |
773 | /** Groups the actions that follow it into a single undoable step. */
774 | beginUndoGroup(undoString: string): void
775 |
776 | /** Ends an undo group; needed only when a script contains more than one undo group. */
777 | endUndoGroup(): void
778 |
779 | /** Begins suppression of dialogs in the user interface. */
780 | beginSuppressDialogs(): void
781 |
782 | /** Ends suppression of dialogs in the user interface. */
783 | endSuppressDialogs(alert: boolean): void
784 |
785 | /** Sets memory usage limits as in the Memory & Cache preferences area. */
786 | setMemoryUsageLimits(imageCachePercentage: number, maximumMemoryPercentage: number): void
787 |
788 | /** Sets whether preferences are saved when the application is quit. */
789 | setSavePreferencesOnQuit(doSave: boolean): void
790 |
791 | /** Brings the After Effects main window to the front of the screen. */
792 | activate(): void
793 |
794 | /** Schedules a JavaScript script for delayed execution. */
795 | scheduleTask(stringToExecute: string, delay: number, repeat: boolean): number
796 |
797 | /** Cancels a scheduled task. */
798 | cancelTask(taskID: number): void
799 |
800 | /** Loads a color swatch from an Adobe Swatch Exchange (ASE) file. */
801 | parseSwatchFile(file: File): Swatch
802 |
803 | findMenuCommandId(str: string): number
804 |
805 | executeCommand(id: number): void
806 |
807 | /** CC2015- */
808 | getenv(name: string): string
809 | setTimeout(func: () => void, delay?: number): number
810 | cancelTimeout(id: number): void
811 | }
812 |
813 | declare class Preferences {
814 | deletePref(section: string, key: string, type?: PREFType): void
815 | getPrefAsBool(section: string, key: string, type?: PREFType): boolean
816 | getPrefAsFloat(section: string, key: string, type?: PREFType): number
817 | getPrefAsLong(section: string, key: string, type?: PREFType): number
818 | getPrefAsString(section: string, key: string, type?: PREFType): string
819 | havePref(section: string, key: string, type?: PREFType): boolean
820 | reload(): void
821 | savePrefAsBool(section: string, key: string, value: boolean, type?: PREFType): void
822 | savePrefAsFloat(section: string, key: string, value: number, type?: PREFType): void
823 | savePrefAsLong(section: string, key: string, value: number, type?: PREFType): void
824 | savePrefAsString(section: string, key: string, value: string, type?: PREFType): void
825 | saveToDisk(): void
826 | }
827 |
828 | /** The AVItem object provides access to attributes and methods of audio/visual files imported into After Effects. */
829 | declare class AVItem extends Item {
830 | /** The name of the object as shown in the Project panel. */
831 | name: string
832 |
833 | /** The width of the item. */
834 | width: number
835 |
836 | /** The height of the item. */
837 | height: number
838 |
839 | /** The pixel aspect ratio of the item. */
840 | pixelAspect: number
841 |
842 | /** The frame rate of the item. */
843 | frameRate: number
844 |
845 | /** The frame duration for the item. */
846 | frameDuration: number
847 |
848 | /** The total duration of the item. */
849 | duration: number
850 |
851 | /** When true, a proxy source is used for this item. */
852 | useProxy: boolean
853 |
854 | /** The FootageItem object used as proxy for the item. */
855 | readonly proxySource: FootageSource
856 |
857 | /** Current time of the item. */
858 | time: number
859 |
860 | /** The CompItem objects that use this item. */
861 | readonly usedIn: CompItem[]
862 |
863 | /** When true, the item has a video component. */
864 | readonly hasVideo: boolean
865 |
866 | /** When true, the item has an audio component. */
867 | readonly hasAudio: boolean
868 |
869 | /** When true, the item cannot be found or is a placeholder. */
870 | readonly footageMissing: boolean
871 |
872 | /** Sets a proxy for the item. */
873 | setProxy(file: File): void
874 |
875 | /** Sets a sequence as a proxy for the item. */
876 | setProxyWithSequence(file: File, forceAlphabetical: boolean): void
877 |
878 | /** Sets a solid as a proxy for the item. */
879 | setProxyWithSolid(
880 | color: [number, number, number],
881 | name: string,
882 | width: number,
883 | height: number,
884 | pixelAspect: number,
885 | ): void
886 |
887 | /** Sets a placeholder as a proxy for the item. */
888 | setProxyWithPlaceholder(
889 | name: string,
890 | width: number,
891 | height: number,
892 | frameRate: number,
893 | duration: number,
894 | ): void
895 |
896 | /** Removes the proxy for the item. */
897 | setProxyToNone(): void
898 | }
899 |
900 | /** The AVLayer object provides an interface to those layers that contain AVItem objects (composition layers, footage layers, solid layers, text layers, and sound layers). */
901 | declare class AVLayer extends Layer {
902 | /** The source item for this layer. */
903 | readonly source: any
904 |
905 | /** When true, the layer has no expressly set name, but contains a named source. */
906 | readonly isNameFromSource: boolean
907 |
908 | /** The height of the layer. */
909 | readonly height: number
910 |
911 | /** The width of the layer. */
912 | readonly width: number
913 |
914 | /** When true, the layer's audio is enabled. */
915 | audioEnabled: boolean
916 |
917 | /** When true, the layer's motion blur is enabled. */
918 | motionBlur: boolean
919 |
920 | /** When true, the layer's effects are active. */
921 | effectsActive: boolean
922 |
923 | /** When true, this is an adjustment layer. */
924 | adjustmentLayer: boolean
925 |
926 | /** When true, this is a guide layer. */
927 | guideLayer: boolean
928 |
929 | /** When true, this is a 3D layer. */
930 | threeDLayer: boolean
931 |
932 | /** When true, 3D is set on a per-character basis in this text layer. */
933 | threeDPerChar: boolean
934 |
935 | /** When true, this is an environment layer. */
936 | environmentLayer: boolean
937 |
938 | /** When true, it is legal to change the value of collapseTransformation. */
939 | readonly canSetCollapseTransformation: boolean
940 |
941 | /** When true, collapse transformation is on. */
942 | collapseTransformation: boolean
943 |
944 | /** When true, frame blending is enabled. */
945 | readonly frameBlending: boolean
946 |
947 | /** The type of frame blending for the layer. */
948 | frameBlendingType: FrameBlendingType
949 |
950 | /** When true, it is legal to change the value of timeRemapEnabled. */
951 | readonly canSetTimeRemapEnabled: boolean
952 |
953 | /** When true, time remapping is enabled on this layer. */
954 | timeRemapEnabled: boolean
955 |
956 | /** When true, the layer contains an audio component. */
957 | readonly hasAudio: boolean
958 |
959 | /** When true, the layer's audio is active at the current time. */
960 | readonly audioActive: boolean
961 |
962 | /** The blending mode of the layer. */
963 | blendingMode: BlendingMode
964 |
965 | /** When true, preserve transparency is enabled. */
966 | preserveTransparency: boolean
967 |
968 | /** if layer has a track matte, specifies the way it is applied. */
969 | trackMatteType: TrackMatteType
970 |
971 | /** When true, this layer is being used as a track matte for the layer below it. */
972 | readonly isTrackMatte: boolean
973 |
974 | /** When true, the layer above is being used as a track matte on this layer. */
975 | readonly hasTrackMatte: boolean
976 |
977 | /** The layer quality setting. */
978 | quality: LayerQuality
979 |
980 | /** The layer sampling quality setting. */
981 | samplingQuality: LayerSamplingQuality
982 |
983 | /** Reports whether this layer's audio is active at a given time. */
984 | audioActiveAtTime(time: number): boolean
985 |
986 | /** Calculates a transformation from a set of points in this layer. */
987 | calculateTransformFromPoints(
988 | pointTopLeft: [number, number, number],
989 | pointTopRight: typeof pointTopLeft,
990 | pointBottomRight: typeof pointTopLeft,
991 | ): object
992 |
993 | /** Changes the source item for this layer. */
994 | replaceSource(newSource: AVItem, fixExpressions: boolean): void
995 |
996 | /** Retrieves the source rectangle of a layer. */
997 | sourceRectAtTime(
998 | timeT: number,
999 | extents: boolean,
1000 | ): { top: number; left: number; width: number; height: number }
1001 |
1002 | /** Opens the layer in a Layer panel. */
1003 | openInViewer(): Viewer | null
1004 |
1005 | /** CC 2014.2(13.2)- */
1006 | sourcePointToComp(point: [number, number]): [number, number]
1007 |
1008 | /** CC 2014.2(13.2)- */
1009 | compPointToSource(point: [number, number]): [number, number]
1010 |
1011 | /** Shortcuts */
1012 | readonly timeRemap: Property
1013 | readonly mask: MaskPropertyGroup
1014 | readonly effect: PropertyGroup
1015 | readonly layerStyle: _LayerStyles
1016 | readonly geometryOption: _GeometryOptionsGroup
1017 | readonly materialOption: _MaterialOptionsGroup
1018 | readonly audio: _AudioGroup
1019 | }
1020 |
1021 | /** The CameraLayer object represents a camera layer within a composition. Create it using the LayerCollection object’s addCamera method */
1022 | declare class CameraLayer extends Layer {
1023 | /** Shortcuts */
1024 | readonly cameraOption: _CameraOptionsGroup
1025 | }
1026 |
1027 | /** Like an array, a collection associates a set of objects or values as a logical group and provides access to them by index. However, most collection objects are read-only. You do not assign objects to them yourself—their contents update automatically as objects are created or deleted. */
1028 | declare class Collection {
1029 | /** The number of objects in the collection. */
1030 | readonly length: number
1031 | }
1032 |
1033 | /** The CompItem object represents a composition, and allows you to manipulate and get information about it. Access the objects by position index number in a project’s item collection. */
1034 | declare class CompItem extends AVItem {
1035 | /** The duration of a single frame. */
1036 | frameDuration: number
1037 |
1038 | /** When true, indicates that the composition uses drop-frame timecode. */
1039 | dropFrame: boolean
1040 |
1041 | /** The work area start time. */
1042 | workAreaStart: number
1043 |
1044 | /** The work area duration. */
1045 | workAreaDuration: number
1046 |
1047 | /** The number of layers in the composition. */
1048 | readonly numLayers: number
1049 |
1050 | /** When true, shy layers are visible in the Timeline panel. */
1051 | hideShyLayers: boolean
1052 |
1053 | /** When true, motion blur is enabled for this composition. */
1054 | motionBlur: boolean
1055 |
1056 | /** When true, Draft 3D mode is enabled for the Composition panel. */
1057 | draft3d: boolean
1058 |
1059 | /** When true, time filtering is enabled for this composition. */
1060 | frameBlending: boolean
1061 |
1062 | /** When true, the frame rate of nested compositions is preserved. */
1063 | preserveNestedFrameRate: boolean
1064 |
1065 | /** When true, the resolution of nested compositions is preserved. */
1066 | preserveNestedResolution: boolean
1067 |
1068 | /** The background color of the composition. */
1069 | bgColor: [number, number, number]
1070 |
1071 | /** The current active camera layer. */
1072 | readonly activeCamera: CameraLayer | null
1073 |
1074 | /** Changes the display of the start time in the Timeline panel. */
1075 | displayStartTime: number
1076 |
1077 | /** The factor by which the x and y resolution of the Composition panel is downsampled. */
1078 | resolutionFactor: [number, number]
1079 |
1080 | /** The camera shutter angle. */
1081 | shutterAngle: number
1082 |
1083 | /** The camera shutter phase. */
1084 | shutterPhase: number
1085 |
1086 | /** The minimum number of motion blur samples per frame for Classic 3D layers, shape layers, and certain effects. */
1087 | motionBlurSamplesPerFrame: number
1088 |
1089 | /** The maximum number of motion blur samples of 2D layer motion. */
1090 | motionBlurAdaptiveSampleLimit: number
1091 |
1092 | /** The layers of the composition. */
1093 | readonly layers: LayerCollection
1094 |
1095 | /** CC 2017(14.0)- The markers of the composition. */
1096 | readonly markerProperty: Property
1097 |
1098 | /** The selected layers of the composition. */
1099 | readonly selectedLayers: Layer[]
1100 |
1101 | /** The selected properties of the composition. */
1102 | readonly selectedProperties: PropertyBase[]
1103 |
1104 | /** The rendering plug-in module to be used to render this composition. */
1105 | renderer: string
1106 |
1107 | /** The set of available rendering plug-in modules. */
1108 | readonly renderers: string[]
1109 |
1110 | /** Creates and returns a duplicate of this composition. */
1111 | duplicate(): CompItem
1112 |
1113 | /** Gets a layer from this composition. */
1114 | layer(index: number): Layer
1115 | layer(otherLayer: Layer, relIndex: number): Layer
1116 | layer(name: string): Layer
1117 |
1118 | /** Opens the composition in a Composition panel. */
1119 | openInViewer(): Viewer | null
1120 |
1121 | /** Save the specific frame to a png file */
1122 | saveFrameToPng(time: number, file: File): void
1123 |
1124 | /** Open this Composition in the Preview panel, and change the zoom and exposure settings. */
1125 | ramPreviewTest(unknown: any, zoom: number, exposure: number): void
1126 | }
1127 |
1128 | /** The FileSource object describes footage that comes from a file. */
1129 | declare class FileSource extends FootageSource {
1130 | /** The file that defines this asset. */
1131 | readonly file: File
1132 |
1133 | /** The file that contains footage missing from this asset. */
1134 | readonly missingFootagePath: string
1135 |
1136 | /** Reloads the asset from the file, if it is a mainSource of a FootageItem. */
1137 | reload(): void
1138 | }
1139 |
1140 | /** The FolderItem object corresponds to a folder in your Project panel. It can contain various types of items (footage, compositions, solids) as well as other folders. */
1141 | declare class FolderItem extends Item {
1142 | /** The contents of this folder. */
1143 | readonly items: ItemCollection
1144 |
1145 | /** The number of items contained in the folder. */
1146 | readonly numItems: number
1147 |
1148 | /** Gets an item from the folder. */
1149 | item(index: number): Item
1150 | }
1151 |
1152 | /** The FootageItem object represents a footage item imported into a project, which appears in the Project panel. These are accessed by position index number in a project’s item collection. */
1153 | declare class FootageItem extends AVItem {
1154 | /** The footage source file. */
1155 | readonly file: File | null
1156 |
1157 | /** All settings related to the footage item. */
1158 | readonly mainSource: FootageSource
1159 |
1160 | /** Replaces a footage file with another footage file. */
1161 | replace(file: File): void
1162 |
1163 | /** Replaces a footage file with a placeholder object. */
1164 | replaceWithPlaceholder(
1165 | name: string,
1166 | width: number,
1167 | height: number,
1168 | frameRate: number,
1169 | duration: number,
1170 | ): void
1171 |
1172 | /** Replaces a footage file with an image sequence. */
1173 | replaceWithSequence(file: File, forceAlphabetical: boolean): void
1174 |
1175 | /** Replaces a footage file with a solid. */
1176 | replaceWithSolid(
1177 | color: [number, number, number],
1178 | name: string,
1179 | width: number,
1180 | height: number,
1181 | pixelAspect: number,
1182 | ): void
1183 |
1184 | /** Opens the footage in a Footage panel. */
1185 | openInViewer(): Viewer | null
1186 | }
1187 |
1188 | declare class PlaceholderItem extends FootageItem {}
1189 |
1190 | /** The FootageSource object holds information describing the source of some footage. It is used as the mainSource of a FootageItem, or the proxySource of a CompItem or FootageItem. */
1191 | declare class FootageSource {
1192 | /** The footage source file. */
1193 | readonly file: File | null
1194 |
1195 | /** When true, a footage clip or proxy includes an alpha channel. */
1196 | hasAlpha: boolean
1197 |
1198 | /** The mode of an alpha channel. */
1199 | alphaMode: AlphaMode
1200 |
1201 | /** The color to be premultiplied. */
1202 | premulColor: [number, number, number]
1203 |
1204 | /** When true, an alpha channel in a footage clip or proxy should be inverted. */
1205 | invertAlpha: boolean
1206 |
1207 | /** When true, footage is a still image. */
1208 | readonly isStill: boolean
1209 |
1210 | /** The field separation type. */
1211 | fieldSeparationType: FieldSeparationType
1212 |
1213 | /** How the fields are to be separated in non-still footage. */
1214 | highQualityFieldSeparation: boolean
1215 |
1216 | /** The pulldown type for the footage. */
1217 | removePulldown: PulldownPhase
1218 |
1219 | /** How many times an image sequence is set to loop. */
1220 | loop: number
1221 |
1222 | /** The native frame rate of the footage. */
1223 | nativeFrameRate: number
1224 |
1225 | /** The effective frame rate as displayed and rendered in compositions by After Effects. */
1226 | readonly displayFrameRate: number
1227 |
1228 | /** The rate to which footage should conform. */
1229 | conformFrameRate: number
1230 |
1231 | /** Estimates the alphaMode setting. */
1232 | guessAlphaMode(): void
1233 |
1234 | /** Estimates the pulldownType setting. */
1235 | guessPulldown(method: PulldownMethod): void
1236 | }
1237 |
1238 | /** The ImportOptions object encapsulates the options used to import a file with the Project.importFile methods. */
1239 | declare class ImportOptions {
1240 | constructor(file?: File)
1241 |
1242 | /** The type of file to be imported. */
1243 | importAs: ImportAsType
1244 |
1245 | /** When true, import a sequence of files, rather than an individual file. */
1246 | sequence: boolean
1247 |
1248 | /** When true, the “Force alphabetical order” option is set. */
1249 | forceAlphabetical: boolean
1250 |
1251 | /** The file to import, or the first file of the sequence to import. */
1252 | file: File
1253 |
1254 | /** Restricts input to a particular file type. */
1255 | canImportAs(type: ImportAsType): boolean
1256 | }
1257 |
1258 | /** The Item object represents an item that can appear in the Project panel. */
1259 | declare class Item {
1260 | /** The name of the object as shown in the Project panel. */
1261 | name: string
1262 |
1263 | /** A descriptive string. */
1264 | comment: string
1265 |
1266 | /** A unique identifier for this item. */
1267 | readonly id: number
1268 |
1269 | /** The parent folder of this item. */
1270 | parentFolder: FolderItem
1271 |
1272 | /** When true, this item is currently selected. */
1273 | selected: boolean
1274 |
1275 | /** The type of item. */
1276 | readonly typeName: string
1277 |
1278 | /** The label color for the item. */
1279 | label: number
1280 |
1281 | /** Deletes the item from the project. */
1282 | remove(): void
1283 | }
1284 |
1285 | /** The ItemCollection object represents a collection of items. The ItemCollection belonging to a Project object contains all the Item objects for items in the project. The ItemCollection belonging to a FolderItem object contains all the Item objects for items in that folder. */
1286 | declare class ItemCollection extends Collection {
1287 | /** Retrieves a Item object in the collection by its index number. The first object is at index 1. */
1288 | readonly [index: number]: Item
1289 |
1290 | /** Creates a new CompItem object and adds it to the collection. */
1291 | addComp(
1292 | name: string,
1293 | width: number,
1294 | height: number,
1295 | pixelAspect: number,
1296 | duration: number,
1297 | frameRate: number,
1298 | ): CompItem
1299 |
1300 | /** Creates a new FolderItem object and adds it to the collection. */
1301 | addFolder(name: string): FolderItem
1302 | }
1303 |
1304 | /** The KeyframeEase object encapsulates the keyframe ease settings of a layer’s AE property. Keyframe ease is determined by the speed and influence values that you set using the property’s setTemporalEaseAtKey method. */
1305 | declare class KeyframeEase {
1306 | constructor(speed: number, influence: number)
1307 |
1308 | /** The speed setting for a keyframe. */
1309 | speed: number
1310 |
1311 | /** The influence setting for a keyframe. */
1312 | influence: number
1313 | }
1314 |
1315 | /** The Layer object provides access to layers within compositions. It can be accessed from an item’s layer collection either by index number or by a name string. */
1316 | declare interface Layer {
1317 | (index: number): PropertyBase
1318 | (name: string): PropertyBase
1319 | }
1320 |
1321 | declare class Layer {
1322 | /** The index position of the layer. */
1323 | readonly index: number
1324 |
1325 | /** The name of the layer. */
1326 | name: string
1327 |
1328 | /** The parent of this layer. */
1329 | parent: Layer | null
1330 |
1331 | /** The current time of the layer. */
1332 | readonly time: number
1333 |
1334 | /** The start time of the layer. */
1335 | startTime: number
1336 |
1337 | /** The time stretch percentage of the layer. */
1338 | stretch: number
1339 |
1340 | /** The “in” point of the layer. */
1341 | inPoint: number
1342 |
1343 | /** The “out” point of the layer. */
1344 | outPoint: number
1345 |
1346 | /** When true, the layer is enabled. */
1347 | enabled: boolean
1348 |
1349 | /** When true, the layer is soloed. */
1350 | solo: boolean
1351 |
1352 | /** When true, the layer is shy. */
1353 | shy: boolean
1354 |
1355 | /** When true, the layer is locked. */
1356 | locked: boolean
1357 |
1358 | /** When true, the layer contains a video component. */
1359 | readonly hasVideo: boolean
1360 |
1361 | /** When true, the layer is active at the current time. */
1362 | readonly active: boolean
1363 |
1364 | /** When true, this is a null layer. */
1365 | readonly nullLayer: boolean
1366 |
1367 | /** All selected AE properties in the layer. */
1368 | readonly selectedProperties: PropertyBase[]
1369 |
1370 | /** A descriptive comment for the layer. */
1371 | comment: string
1372 |
1373 | /** The composition that contains this layer. */
1374 | readonly containingComp: CompItem
1375 |
1376 | /** When true, the layer’s name has been explicitly set. */
1377 | readonly isNameSet: boolean
1378 |
1379 | /** The label color for the layer. */
1380 | label: number
1381 |
1382 | /** The type of automatic orientation for the layer. */
1383 | autoOrient: AutoOrientType
1384 |
1385 | /** Deletes the layer from the composition. */
1386 | remove(): void
1387 |
1388 | /** Moves the layer to the top of the composition (makes it the first layer). */
1389 | moveToBeginning(): void
1390 |
1391 | /** Moves the layer to the bottom of the composition (makes it the last layer). */
1392 | moveToEnd(): void
1393 |
1394 | /** Moves the layer below another layer. */
1395 | moveAfter(layer: Layer): void
1396 |
1397 | /** Moves the layer above another layer. */
1398 | moveBefore(layer: Layer): void
1399 |
1400 | /** Duplicates the layer. */
1401 | duplicate(): Layer
1402 |
1403 | /** Copies the layer to the top (beginning) of another composition. */
1404 | copyToComp(intoComp: CompItem): void
1405 |
1406 | /** Reports whether this layer will be active at a specified time. */
1407 | activeAtTime(time: number): boolean
1408 |
1409 | /** Sets a new parent for this layer. */
1410 | setParentWithJump(newParent?: Layer): void
1411 |
1412 | /** Applies a named collection of animation settings to the layer. */
1413 | applyPreset(presetName: File): void
1414 |
1415 | /** From PropertyGroup */
1416 | readonly matchName: string
1417 | readonly propertyDepth: number
1418 | readonly propertyType: PropertyType
1419 | selected: boolean
1420 | readonly numProperties: number
1421 |
1422 | propertyGroup(countUp?: number): PropertyGroup
1423 | property(index: number): PropertyBase
1424 | property(name: string): PropertyBase
1425 |
1426 | /** Shortcuts */
1427 | readonly marker: Property
1428 | readonly transform: _TransformGroup
1429 |
1430 | /** Transform shortcuts */
1431 | readonly anchorPoint: Property
1432 | readonly position: Property
1433 | readonly xPosition: Property
1434 | readonly yPosition: Property
1435 | readonly zPosition: Property
1436 | readonly scale: Property
1437 | readonly orientation: Property
1438 | readonly rotation: Property
1439 | readonly xRotation: Property
1440 | readonly yRotation: Property
1441 | readonly zRotation: Property
1442 | readonly opacity: Property
1443 | readonly pointOfInterest: Property
1444 | }
1445 |
1446 | /** The LayerCollection object represents a set of layers. The LayerCollection belonging to a CompItem object contains all the layer objects for layers in the composition. The methods of the collection object allow you to manipulate the layer list. */
1447 | declare class LayerCollection extends Collection {
1448 | /** Retrieves a Layer object in the collection by its index number. The first object is at index 1. */
1449 | readonly [index: number]: Layer
1450 |
1451 | /** Creates a new AVLayer and adds it to this collection. */
1452 | add(item: AVItem, duration?: number): AVLayer
1453 |
1454 | /** Creates a new, null layer and adds it to this collection. */
1455 | addNull(duration?: number): AVLayer
1456 |
1457 | /** Creates a new layer, a FootageItem with a SolidSource, and adds it to this collection. */
1458 | addSolid(
1459 | color: [number, number, number],
1460 | name: string,
1461 | width: number,
1462 | height: number,
1463 | pixelAspect: number,
1464 | duration?: number,
1465 | ): AVLayer
1466 |
1467 | /** Creates a new point text layer and adds it to this collection. */
1468 | addText(sourceText?: string | TextDocument): TextLayer
1469 |
1470 | /** Creates a new paragraph (box) text layer and adds it to this collection. */
1471 | addBoxText(size: [number, number], sourceText?: string | TextDocument): TextLayer
1472 |
1473 | /** Creates a new camera layer and adds it to this collection. */
1474 | addCamera(name: string, centerPoint: [number, number]): CameraLayer
1475 |
1476 | /** Creates a new light layer and adds it to this collection. */
1477 | addLight(name: string, centerPoint: [number, number]): LightLayer
1478 |
1479 | /** Creates a new shape layer and adds it to this collection. */
1480 | addShape(): ShapeLayer
1481 |
1482 | /** Retrieves the layer object with a specified name. */
1483 | byName(name: string): Layer | null
1484 |
1485 | /** Collects specified layers into a new composition. */
1486 | precompose(layerIndicies: number[], name: string, moveAllAttributes?: boolean): CompItem
1487 | }
1488 |
1489 | /** The LightLayer object represents a light layer within a composition. Create it using the LayerCollection object’s addLight method */
1490 | declare class LightLayer extends Layer {
1491 | /** For light layers, the type of light. */
1492 | lightType: LightType
1493 |
1494 | /** Shortcuts */
1495 | readonly lightOption: _LightOptionsGroup
1496 | }
1497 |
1498 | /** The MarkerValue object represents a layer marker, which associates a comment, and optionally a chapter reference point, Web-page link, or Flash Video cue point with a particular point in a layer. */
1499 | declare class MarkerValue {
1500 | constructor(
1501 | comment: string,
1502 | chapter?: string,
1503 | url?: string,
1504 | frameTarget?: string,
1505 | cuePointName?: string,
1506 | params?: string,
1507 | )
1508 |
1509 | /** A comment on the associated layer. */
1510 | comment: string
1511 |
1512 | /** The amount of time represented by the marker. */
1513 | duration: number
1514 |
1515 | /** A chapter link reference point for the associated layer. */
1516 | chapter: string
1517 |
1518 | /** The Flash Video cue point name. */
1519 | cuePointName: string
1520 |
1521 | /** Whether the Flash Video cue point is for an event or navigation. */
1522 | eventCuePoint: boolean
1523 |
1524 | /** A URL for Web page to be associated with the layer. */
1525 | url: string
1526 |
1527 | /** A specific frame target within the Web page specified by url. */
1528 | frameTarget: string
1529 |
1530 | /** Retrieves the key-value pairs associated with the marker value. */
1531 | getParameters(): object
1532 |
1533 | /** Sets the key-value pairs associated with the marker value. */
1534 | setParameters(keyValuePairs: object): void
1535 | }
1536 |
1537 | declare interface MaskPropertyGroup {
1538 | (index: number): MaskPropertyGroup
1539 | (name: string): MaskPropertyGroup
1540 | }
1541 |
1542 | /** The MaskPropertyGroup object encapsulates mask attributes in a layer. */
1543 | declare class MaskPropertyGroup extends PropertyGroup {
1544 | /** The mask mode. */
1545 | maskMode: MaskMode
1546 |
1547 | /** When true, the mask is inverted. */
1548 | inverted: boolean
1549 |
1550 | /** When true, the shape of the mask is RotoBezier. */
1551 | rotoBezier: boolean
1552 |
1553 | /** How motion blur is applied to this mask. */
1554 | maskMotionBlur: MaskMotionBlur
1555 |
1556 | /** When true, the mask is locked. */
1557 | locked: boolean
1558 |
1559 | /** The color used to draw the mask outline in the user interface. */
1560 | color: [number, number, number]
1561 |
1562 | /** The feather falloff mode for the mask. */
1563 | maskFeatherFalloff: MaskFeatherFalloff
1564 |
1565 | /** The shape of the mask */
1566 | maskShape: Property
1567 | }
1568 |
1569 | /** The OMCollection contains all of the output modules in a render queue. The collection provides access to the OutputModule objects, but does not provide any additional functionality. The first OutputModule object in the collection is at index position 1. */
1570 | declare class OMCollection extends Collection {
1571 | /** Retrieves a OutputModule object in the collection by its index number. The first object is at index 1. */
1572 | readonly [index: number]: OutputModule
1573 | }
1574 |
1575 | /** An OutputModule object of a RenderQueueItem generates a single file or sequence via a render operation, and contains attributes and methods relating to the file to be rendered. */
1576 | declare class OutputModule {
1577 | /** The path and name of the file to be rendered. */
1578 | file: File
1579 |
1580 | /** An action to be taken after rendering. */
1581 | postRenderAction: PostRenderAction
1582 |
1583 | /** The user-interface name of the output module. */
1584 | readonly name: string
1585 |
1586 | /** All templates for the output module */
1587 | readonly templates: string[]
1588 |
1589 | /** When true, writes all source footage XMP metadata to the output file. */
1590 | includeSourceXMP: boolean
1591 |
1592 | /** Removes this output module from the render-queue item’s list. */
1593 | remove(): void
1594 |
1595 | /** Saves a new output-module template. */
1596 | saveAsTemplate(name: string): void
1597 |
1598 | /** Applies an output-module template. */
1599 | applyTemplate(templateName: string): void
1600 |
1601 | getSetting(key: string): string | number
1602 |
1603 | getSettings(
1604 | format?: GetSettingsFormat,
1605 | ): {
1606 | "Audio Bit Depth": string
1607 | "Audio Channels": string
1608 | "Audio Sample Rate": string
1609 | Channels: string
1610 | Color: string
1611 | Crop: string
1612 | "Crop Bottom": string
1613 | "Crop Left": string
1614 | "Crop Right": string
1615 | "Crop Top": string
1616 | Depth: string
1617 | Format: string
1618 | "Include Project Link": string
1619 | "Include Source XMP Metadata": string
1620 | "Lock Aspect Ratio": string
1621 | "Output Audio": string
1622 | "Output File Info": string
1623 | "Post-Render Action": string
1624 | Resize: string
1625 | "Resize Quality": string
1626 | "Resize to": object
1627 | "Starting #": string
1628 | "Use Comp Frame Number": string
1629 | "Use Region of Interest": string
1630 | "Video Output": string
1631 | }
1632 |
1633 | setSetting(key: string, value: string | number): void
1634 |
1635 | setSettings(settings: object): void
1636 | }
1637 |
1638 | /** The PlaceholderSource object describes the footage source of a placeholder. */
1639 | declare class PlaceholderSource extends FootageSource {}
1640 |
1641 | /** The project object represents an After Effects project. Attributes provide access to specific objects within the project, such as imported files or footage and compositions, and also to project settings such as the timecode base. Methods can import footage, create solids, compositions and folders, and save changes. */
1642 | declare class Project {
1643 | /** The file for the currently open project. */
1644 | readonly file: File | null
1645 |
1646 | /** The folder containing all the contents of the project; the equivalent of the Project panel */
1647 | readonly rootFolder: FolderItem
1648 |
1649 | /** All items in the project. */
1650 | readonly items: ItemCollection
1651 |
1652 | /** The currently active item. */
1653 | readonly activeItem: Item | null
1654 |
1655 | /** The color depth of the current project. */
1656 | bitsPerChannel: number
1657 |
1658 | /** When true, thumbnail views use the transparency checkerboard pattern. */
1659 | transparencyGridThumbnails: boolean
1660 |
1661 | /** The total number of items contained in the project. */
1662 | readonly numItems: number
1663 |
1664 | /** All items selected in the Project panel. */
1665 | readonly selection: Item[]
1666 |
1667 | /** The project’s render queue. */
1668 | readonly renderQueue: RenderQueue
1669 |
1670 | /** The time display style, corresponding to the Time Display Style section in the Project Settings dialog box. */
1671 | timeDisplayType: TimeDisplayType
1672 |
1673 | /** CC 2017(14.0)- The active tool in the Tools panel. */
1674 | toolType: ToolType
1675 |
1676 | /** The Footage Start Time setting in the Project Settings dialog box, which is enabled when Timecode is selected as the time display style. */
1677 | footageTimecodeDisplayStartType: FootageTimecodeDisplayStartType
1678 |
1679 | /** The Use Feet + Frames setting in the Project Settings dialog box. */
1680 | framesUseFeetFrames: boolean
1681 |
1682 | /** The Use Feet + Frames menu setting in the Project Settings dialog box. */
1683 | feetFramesFilmType: FeetFramesFilmType
1684 |
1685 | /** CC 2015.3(13.8)- */
1686 | gpuAccelType: GpuAccelType
1687 |
1688 | /** The Frame Count menu setting in the Project Settings dialog box. */
1689 | framesCountType: FramesCountType
1690 |
1691 | /** The frame at which to start numbering when displaying the project. */
1692 | displayStartFrame: number
1693 |
1694 | /** When true, linear blending is used for the project. */
1695 | linearBlending: boolean
1696 |
1697 | /** The project’s XMP metadata. */
1698 | xmpPacket: string
1699 |
1700 | /** Retrieves an item from the project. */
1701 | item(index: number): Item
1702 |
1703 | /** Consolidates all footage in the project. */
1704 | consolidateFootage(): number
1705 |
1706 | /** Removes unused footage from the project. */
1707 | removeUnusedFootage(): number
1708 |
1709 | /** Reduces the project to a specified set of items. */
1710 | reduceProject(array_of_items: Item[]): number
1711 |
1712 | /** Closes the project with normal save options. */
1713 | close(closeOptions: CloseOptions): boolean
1714 |
1715 | /** Saves the project. */
1716 | save(file?: File): void
1717 |
1718 | /** Displays a Save dialog box. */
1719 | saveWithDialog(): boolean
1720 |
1721 | /** Imports a placeholder into the project. */
1722 | importPlaceholder(
1723 | name: string,
1724 | width: number,
1725 | height: number,
1726 | frameRate: number,
1727 | duration: number,
1728 | ): PlaceholderItem
1729 |
1730 | /** Imports a file into the project. */
1731 | importFile(importOptions: ImportOptions): Item
1732 |
1733 | /** Displays an Import File dialog box. */
1734 | importFileWithDialog(): Item[] | null
1735 |
1736 | /** Shows or hides the Project panel. */
1737 | showWindow(doShow: boolean): void
1738 |
1739 | /** Automatically replaces text in all expressions. */
1740 | autoFixExpressions(oldText: string, newText: string): void
1741 |
1742 | /** Creates a new team project. */
1743 | newTeamProject(
1744 | teamProjectName: string,
1745 | description: string
1746 | ): boolean
1747 |
1748 | /** Opens a team project. */
1749 | openTeamProject(
1750 | teamProjectName: string
1751 | ): boolean
1752 |
1753 | /** Shares the currently open team project. */
1754 | shareTeamProject(
1755 | comment: string
1756 | ): boolean
1757 |
1758 | /** Syncs the currently open team project. */
1759 | syncTeamProject(): boolean
1760 |
1761 | /** Closes a currently open team project. */
1762 | closeTeamProject(): boolean
1763 |
1764 | /** Converts a team project to an After Effects project on a local disk. */
1765 | convertTeamProjectToProject(
1766 | project_file: File
1767 | ): boolean
1768 |
1769 | /** Returns an array containing the name strings for all team projects available for the current user. Archived Team Projects are not included. */
1770 | listTeamProjects(): string[]
1771 |
1772 | /** Checks whether specified team project is currently open. */
1773 | isTeamProjectOpen(
1774 | teamProjectName: string
1775 | ): boolean
1776 |
1777 | /** Checks whether any team project is currently open. */
1778 | isAnyTeamProjectOpen(): boolean
1779 |
1780 | /** Checks whether or not team projects is enabled for After Effects. (This will almost always return true.) */
1781 | isTeamProjectEnabled(): boolean
1782 |
1783 | /** Checks whether or not the client (After Effects) is currently logged into the team project server. */
1784 | isLoggedInToTeamProject(): boolean
1785 |
1786 | /** Checks whether or not the Sync command is enabled. */
1787 | isSyncCommandEnabled(): boolean
1788 |
1789 | /** Checks whether or not the Share command is enabled. */
1790 | isShareCommandEnabled(): boolean
1791 |
1792 | /** Checks whether or not the Resolve command is enabled. */
1793 | isResolveCommandEnabled(): boolean
1794 |
1795 | /** Resolves a conflict between the open team project and the version on the team projects server, using the specified resolution method. */
1796 | resolveConflict(
1797 | ResolveType: ResolveType
1798 | ): boolean
1799 |
1800 | }
1801 |
1802 | declare type PropertyValue =
1803 | | void
1804 | | boolean
1805 | | number
1806 | | [number, number]
1807 | | [number, number, number]
1808 | | [number, number, number, number]
1809 | | MarkerValue
1810 | | Shape
1811 | | TextDocument
1812 |
1813 | /** The Property object contains value, keyframe, and expression information about a particular AE property of a layer. */
1814 | declare class Property extends PropertyBase {
1815 | /** Type of value stored in this property. */
1816 | readonly propertyValueType: PropertyValueType
1817 |
1818 | /** Current value of the property. */
1819 | readonly value: PropertyValue
1820 |
1821 | /** When true, there is a minimum permitted value. */
1822 | readonly hasMin: boolean
1823 |
1824 | /** When true, there is a maximum permitted value. */
1825 | readonly hasMax: boolean
1826 |
1827 | /** The minimum permitted value. */
1828 | readonly minValue: number
1829 |
1830 | /** The maximum permitted value. */
1831 | readonly maxValue: number
1832 |
1833 | /** When true, the property defines a spatial value. */
1834 | readonly isSpatial: boolean
1835 |
1836 | /** When true, the property can be keyframed. */
1837 | readonly canVaryOverTime: boolean
1838 |
1839 | /** When true, the property has keyframes or an expression enabled that can vary its values. */
1840 | readonly isTimeVarying: boolean
1841 |
1842 | /** The number of keyframes on this property. */
1843 | readonly numKeys: number
1844 |
1845 | /** A text description of the units in which the value is expressed. */
1846 | readonly unitsText: string
1847 |
1848 | /** The expression string for this property. */
1849 | expression: string
1850 |
1851 | /** When true, the expression can be set by a script. */
1852 | readonly canSetExpression: boolean
1853 |
1854 | /** When true, the expression is used to generate values for the property. */
1855 | expressionEnabled: boolean
1856 |
1857 | /** The error, if any, that occurred when the last expression was evaluated. */
1858 | readonly expressionError: string
1859 |
1860 | /** All selected keyframes of the property. */
1861 | readonly selectedKeys: number[]
1862 |
1863 | /** The position index of this property. */
1864 | readonly propertyIndex: number
1865 |
1866 | /** When true, the property’s dimensions are represented as separate properties. */
1867 | dimensionsSeparated: boolean
1868 |
1869 | /** When true, the property represents one of the separated dimensions for a multidimensional property. */
1870 | readonly isSeparationFollower: boolean
1871 |
1872 | /** When true, the property is multidimensional and can be separated. */
1873 | readonly isSeparationLeader: boolean
1874 |
1875 | /** For a separated follower, the dimension it represents in the multidimensional leader. */
1876 | readonly separationDimension: number
1877 |
1878 | /** The original multidimensional property for this separated follower. */
1879 | readonly separationLeader: Property
1880 |
1881 | /** Gets the value of the property evaluated at given time. */
1882 | valueAtTime(time: number, preExpression: boolean): PropertyValue
1883 |
1884 | /** Sets the static value of the property. */
1885 | setValue(newValue: PropertyValue): void
1886 |
1887 | /** Creates a keyframe for the property. */
1888 | setValueAtTime(time: number, newValue: PropertyValue): void
1889 |
1890 | /** Creates a set of keyframes for the property. */
1891 | setValuesAtTimes(times: number[], newValues: PropertyValue[]): void
1892 |
1893 | /** Finds a keyframe and sets the value of the property at that keyframe. */
1894 | setValueAtKey(keyIndex: number, newValue: PropertyValue): void
1895 |
1896 | /** Gets the keyframe nearest to a specified time. */
1897 | nearestKeyIndex(time: number): number
1898 |
1899 | /** Gets the time at which a condition occurs. */
1900 | keyTime(keyIndex: number): number
1901 | keyTime(markerComment: string): number
1902 |
1903 | /** Gets the value of a keyframe at the time at which a condition occurs. */
1904 | keyValue(keyIndex: number): PropertyValue
1905 | keyValue(markerComment: string): MarkerValue
1906 |
1907 | /** Adds a new keyframe to the property at a given time. */
1908 | addKey(time: number): number
1909 |
1910 | /** Removes a keyframe from the property. */
1911 | removeKey(keyIndex: number): void
1912 |
1913 | /** When true, this property can be interpolated. */
1914 | isInterpolationTypeValid(type: KeyframeInterpolationType): boolean
1915 |
1916 | /** Sets the interpolation type for a key. */
1917 | setInterpolationTypeAtKey(
1918 | keyIndex: number,
1919 | inType: KeyframeInterpolationType,
1920 | outType?: KeyframeInterpolationType,
1921 | ): void
1922 |
1923 | /** Gets the 'in' interpolation type for a key. */
1924 | keyInInterpolationType(keyIndex: number): KeyframeInterpolationType
1925 |
1926 | /** Gets the 'out' interpolation type for a key. */
1927 | keyOutInterpolationType(keyIndex: number): KeyframeInterpolationType
1928 |
1929 | /** Sets the “in” and “out” tangent vectors for a key. */
1930 | setSpatialTangentsAtKey(
1931 | keyIndex: number,
1932 | inTangent: [number, number],
1933 | outTangent: typeof inTangent,
1934 | ): void
1935 | setSpatialTangentsAtKey(
1936 | keyIndex: number,
1937 | inTangent: [number, number, number],
1938 | outTangent: typeof inTangent,
1939 | ): void
1940 |
1941 | /** Gets the “in” spatial tangent for a key. */
1942 | keyInSpatialTangent(keyIndex: number): [number, number] | [number, number, number]
1943 |
1944 | /** Gets the “out” spatial tangent for a key. */
1945 | keyOutSpatialTangent(keyIndex: number): [number, number] | [number, number, number]
1946 |
1947 | /** Sets the “in” and “out” temporal ease for a key. */
1948 | setTemporalEaseAtKey(
1949 | keyIndex: number,
1950 | inTemporalEase: [KeyframeEase],
1951 | outTemporalEase?: typeof inTemporalEase,
1952 | ): void
1953 | setTemporalEaseAtKey(
1954 | keyIndex: number,
1955 | inTemporalEase: [KeyframeEase, KeyframeEase],
1956 | outTemporalEase?: typeof inTemporalEase,
1957 | ): void
1958 | setTemporalEaseAtKey(
1959 | keyIndex: number,
1960 | inTemporalEase: [KeyframeEase, KeyframeEase, KeyframeEase],
1961 | outTemporalEase?: typeof inTemporalEase,
1962 | ): void
1963 |
1964 | /** Gets the “in” temporal ease for a key. */
1965 | keyInTemporalEase(
1966 | keyIndex: number,
1967 | ): [KeyframeEase] | [KeyframeEase, KeyframeEase] | [KeyframeEase, KeyframeEase, KeyframeEase]
1968 |
1969 | /** Gets the “out” temporal ease for a key. */
1970 | keyOutTemporalEase(
1971 | keyIndex: number,
1972 | ): [KeyframeEase] | [KeyframeEase, KeyframeEase] | [KeyframeEase, KeyframeEase, KeyframeEase]
1973 |
1974 | /** Sets whether a keyframe has temporal continuity. */
1975 | setTemporalContinuousAtKey(keyIndex: number, newVal: boolean): void
1976 |
1977 | /** Reports whether a keyframe has temporal continuity. */
1978 | keyTemporalContinuous(keyIndex: number): boolean
1979 |
1980 | /** Sets whether a keyframe has temporal auto-Bezier. */
1981 | setTemporalAutoBezierAtKey(keyIndex: number, newVal: boolean): void
1982 |
1983 | /** Reports whether a keyframe has temporal auto-Bezier. */
1984 | keyTemporalAutoBezier(keyIndex: number): boolean
1985 |
1986 | /** Sets whether a keyframe has spatial continuity. */
1987 | setSpatialContinuousAtKey(keyIndex: number, newVal: boolean): void
1988 |
1989 | /** Reports whether a keyframe has spatial continuity. */
1990 | keySpatialContinuous(keyIndex: number): boolean
1991 |
1992 | /** Sets whether a keyframe has spatial auto-Bezier. */
1993 | setSpatialAutoBezierAtKey(keyIndex: number, newVal: boolean): void
1994 |
1995 | /** Reports whether a keyframe has spatial auto-Bezier. */
1996 | keySpatialAutoBezier(keyIndex: number): boolean
1997 |
1998 | /** Sets whether a keyframe is roving. */
1999 | setRovingAtKey(keyIndex: number, newVal: boolean): void
2000 |
2001 | /** Reports whether a keyframe is roving. */
2002 | keyRoving(keyIndex: number): boolean
2003 |
2004 | /** Sets whether a keyframe is selected. */
2005 | setSelectedAtKey(keyIndex: number, onOff: boolean): void
2006 |
2007 | /** Reports whether a keyframe is selected. */
2008 | keySelected(keyIndex: number): boolean
2009 |
2010 | /** For a separated, multidimensional property, retrieves a specific follower property. */
2011 | getSeparationFollower(dim: number): Property
2012 | }
2013 |
2014 | /** Properties are accessed by name through layers, using various kinds of expression syntax, as controlled by application preferences. */
2015 | declare interface PropertyBase {
2016 | (index: number): PropertyBase
2017 | (name: string): PropertyBase
2018 | }
2019 |
2020 | declare class PropertyBase {
2021 | /** Name of the property. */
2022 | name: string
2023 |
2024 | /** A special name for the property used to build unique naming paths. */
2025 | readonly matchName: string
2026 |
2027 | /** Index of this property within its parent group. */
2028 | readonly propertyIndex: number
2029 |
2030 | /** The number of levels of parent groups between this property and the containing layer. */
2031 | readonly propertyDepth: number
2032 |
2033 | /** The property type. */
2034 | readonly propertyType: PropertyType
2035 |
2036 | /** The immediate parent group of this property. */
2037 | readonly parentProperty: PropertyGroup
2038 |
2039 | /** When true, the property has been changed since its creation. */
2040 | readonly isModified: boolean
2041 |
2042 | /** When true, the user interface displays an eyeball icon for this property. */
2043 | readonly canSetEnabled: boolean
2044 |
2045 | /** When true, this property is enabled. */
2046 | enabled: boolean
2047 |
2048 | /** When true, this property is active. */
2049 | readonly active: boolean
2050 |
2051 | /** When true, this property is not displayed in the user interface. */
2052 | readonly elided: boolean
2053 |
2054 | /** When true, this property is an effect. */
2055 | readonly isEffect: boolean
2056 |
2057 | /** When true, this property is a mask. */
2058 | readonly isMask: boolean
2059 |
2060 | /** When true, this property is selected. */
2061 | selected: boolean
2062 |
2063 | /** Gets the parent group for this property. */
2064 | propertyGroup(countUp?: number): PropertyGroup
2065 |
2066 | /** Removes this from the project. */
2067 | remove(): void
2068 |
2069 | /** Moves this property to a new position in its parent group. */
2070 | moveTo(newIndex: number): void
2071 |
2072 | /** Duplicates this property object. */
2073 | duplicate(): PropertyBase
2074 |
2075 | /** Gets a member property or group. Strictly, this should be PropertyGroup method. */
2076 | property(index: number): PropertyBase
2077 | property(name: string): PropertyBase
2078 | }
2079 |
2080 | /** The PropertyGroup object represents a group of properties. It can contain Property objects and other PropertyGroup objects. Property groups can be nested to provide a parent-child hierarchy, with a Layer object at the top (root) down to a single Property object, such as the mask feather of the third mask. To traverse the group hierarchy, use PropertyBase methods and attributes. */
2081 | declare class PropertyGroup extends PropertyBase {
2082 | /** The number of indexed properties in the group. */
2083 | readonly numProperties: number
2084 |
2085 | /** Gets a member property or group. */
2086 | // property(index: number): PropertyBase;
2087 | // property(name: string): PropertyBase;
2088 |
2089 | /** Reports whether a property can be added to the group. */
2090 | canAddProperty(name: string): boolean
2091 |
2092 | /** Adds a property to the group. */
2093 | addProperty(name: string): PropertyBase
2094 | }
2095 |
2096 | /** The RenderQueue object represents the render automation process, the data and functionality that is available through the Render Queue panel of a particular After Effects project. Attributes provide access to items in the render queue and their render status. Methods can start, pause, and stop the rendering process. */
2097 | declare class RenderQueue {
2098 | /** When true, a render is in progress. */
2099 | readonly rendering: boolean
2100 |
2101 | /** The total number of items in the render queue. */
2102 | readonly numItems: number
2103 |
2104 | /** CC 2017(14.0)- */
2105 | readonly canQueueInAME: boolean
2106 |
2107 | /** The collection of items in the render queue. */
2108 | readonly items: RQItemCollection
2109 |
2110 | /** Show or hides the Render Queue panel. */
2111 | showWindow(doShow: boolean): void
2112 |
2113 | /** Starts the rendering process; does not return until render is complete. */
2114 | render(): void
2115 |
2116 | /** Pauses or restarts the rendering process. */
2117 | pauseRendering(pause: boolean): void
2118 |
2119 | /** Stops the rendering process. */
2120 | stopRendering(): void
2121 |
2122 | /** Gets a render-queue item from the collection. */
2123 | item(index: number): RenderQueueItem
2124 |
2125 | /** CC 2017(14.0)- */
2126 | queueInAME(render_immediately_in_AME: boolean): void
2127 | }
2128 |
2129 | /** The RenderQueueItem object represents an individual item in the render queue. It provides access to the specific settings for an item to be rendered. Create the object by adding a composition to the Render Queue with the RQItemCollection object; */
2130 | declare class RenderQueueItem {
2131 | /** The total number of Output Modules assigned to the item. */
2132 | readonly numOutputModules: number
2133 |
2134 | /** When true, this item is rendered when the queue is started. */
2135 | render: boolean
2136 |
2137 | /** The time when rendering began for the item. */
2138 | readonly startTime: Date | null
2139 |
2140 | /** The time elapsed in the current rendering of this item. */
2141 | readonly elapsedSeconds: number | null
2142 |
2143 | /** The start time in the composition to be rendered. */
2144 | timeSpanStart: number
2145 |
2146 | /** The duration of the composition to be rendered. */
2147 | timeSpanDuration: number
2148 |
2149 | /** The number of frames to skip when rendering this item. */
2150 | skipFrames: number
2151 |
2152 | /** The composition to be rendered by this item. */
2153 | readonly comp: CompItem
2154 |
2155 | /** The collection of Output Modules for this item. */
2156 | readonly outputModules: OMCollection
2157 |
2158 | /** A set of Render Settings templates. */
2159 | readonly templates: string[]
2160 |
2161 | /** The current rendering status of the item. */
2162 | readonly status: RQItemStatus
2163 |
2164 | /** A callback function that is called during the rendering process when the status of the item changes. */
2165 | onStatusChanged: string | null
2166 |
2167 | /** A log type for this item. */
2168 | logType: LogType
2169 |
2170 | /** Gets an Output Module for the item. */
2171 | outputModule(index: number): OutputModule
2172 |
2173 | /** Removes the item from the render queue. */
2174 | remove(): void
2175 |
2176 | /** Saves a new Render Settings template. */
2177 | saveAsTemplate(name: string): void
2178 |
2179 | /** Applies a Render Settings template. */
2180 | applyTemplate(templateName: string): void
2181 |
2182 | /** Duplicates this item. */
2183 | duplicate(): RenderQueueItem
2184 |
2185 | getSetting(key: string): string | number
2186 |
2187 | getSettings(format: GetSettingsFormat): object
2188 |
2189 | setSetting(key: string, value: string | number): void
2190 |
2191 | setSettings(settings: object): void
2192 | }
2193 |
2194 | /** The RQItemCollection contains all of the render-queue items in a project, as shown in the Render Queue panel of the project. The collection provides access to the RenderQueueItem objects, and allows you to create them from compositions. The first RenderQueueItem object in the collection is at index position 1. */
2195 | declare class RQItemCollection extends Collection {
2196 | /** Retrieves an RenderQueueItem in the collection by its index number. The first object is at index 1. */
2197 | [index: number]: RenderQueueItem
2198 |
2199 | /** Adds a composition to the Render Queue. */
2200 | add(comp: CompItem): RenderQueueItem
2201 | }
2202 |
2203 | /** The Settings object provides an easy way to manage settings for scripts. The settings are saved in the After Effects preferences file and are persistent between application sessions. Settings are identified by section and key within the file, and each key name is associated with a value. In the preferences file, section names are enclosed in brackets and quotation marks, and key names are listing in quotation marks below the section name. All values are strings. */
2204 | declare class Settings {
2205 | /** Saves a default value for a setting. */
2206 | saveSetting(sectionName: string, keyName: string, value: string, type?: PREFType): void
2207 |
2208 | /** Retrieves a setting value. */
2209 | getSetting(sectionName: string, keyName: string, type?: PREFType): string
2210 |
2211 | /** Reports whether a specified setting is assigned. */
2212 | haveSetting(sectionName: string, keyName: string, type?: PREFType): boolean
2213 | }
2214 |
2215 | /** The Shape object encapsulates information describing a shape in a shape layer, or the outline shape of a Mask. */
2216 | declare class Shape {
2217 | /** When true, the shape is a closed curve. */
2218 | closed: boolean
2219 |
2220 | /** The anchor points of the shape. */
2221 | vertices: [number, number][]
2222 |
2223 | /** The tangent vectors coming into the shape vertices. */
2224 | inTangents: [number, number][]
2225 |
2226 | /** The tangent vectors coming out of the shape vertices. */
2227 | outTangents: [number, number][]
2228 |
2229 | /** The mask path segment (sections of a mask path between vertices) containing each feather point. */
2230 | featherSegLocs: number[]
2231 |
2232 | /** The relative position of each feather point on its mask path segment. */
2233 | featherRelSegLocs: number[]
2234 |
2235 | /** The feather amount (radius) for each feather point. */
2236 | featherRadii: number[]
2237 |
2238 | /** The feather radius interpolation type for each feather point. */
2239 | featherInterps: number[]
2240 |
2241 | /** The feather tension at each feather point. */
2242 | featherTensions: number[]
2243 |
2244 | /** The direction (inner or outer) of each feather point. */
2245 | featherTypes: number[]
2246 |
2247 | /** The relative angle between the two normals on either side of a curved outer feather boundary at a corner on a mask path. */
2248 | featherRelCornerAngles: number[]
2249 | }
2250 |
2251 | /** The ShapeLayer object represents a shape layer within a composition. Create it using the LayerCollection object’s addShape() method. */
2252 | declare class ShapeLayer extends AVLayer {}
2253 |
2254 | /** The SolidSource object represents a solid-color footage source. */
2255 | declare class SolidSource extends FootageSource {
2256 | /** The color of the solid. */
2257 | color: [number, number, number]
2258 | }
2259 |
2260 | /** The file specification, an ExtendScript File object. */
2261 | declare class Swatch {
2262 | /** The ASE version number. */
2263 | majorVersion: number
2264 |
2265 | /** The ASE version number. */
2266 | minorVersion: number
2267 |
2268 | /** An array of SwatchValue. */
2269 | values: SwatchValue[]
2270 | }
2271 |
2272 | /** The file specification, an ExtendScript File object. */
2273 | declare class SwatchValue {
2274 | /** One of "RGB", "CMYK", "LAB", "Gray" */
2275 | type: "RGB" | "CMYK" | "LAB" | "Gray"
2276 |
2277 | /** When type = "RGB", the color values in the range [0.0..1.0]. 0, 0, 0 is Black. */
2278 | r: number
2279 | g: number
2280 | b: number
2281 |
2282 | /** When type = "CMYK", the color values in the range [0.0..1.0]. 0, 0, 0, 0 is White. */
2283 | c: number
2284 | m: number
2285 | y: number
2286 | k: number
2287 |
2288 | /** When type = "LAB", the color values. L is in the range [0.0..1.0]. a and b are in the range [-128.0..+128.0] 0, 0, 0 is Black. */
2289 | L: number
2290 | a: number
2291 | // b:number;
2292 |
2293 | /** When type = "Gray", the value range is [0.0..1.0]. 0.0 is Black. */
2294 | gray: number
2295 | value: number
2296 | }
2297 |
2298 | /** The System object provides access to attributes found on the user’s system, such as the user name and the name and version of the operating system. It is available through the system global variable. */
2299 | declare class System {
2300 | /** The current user name. */
2301 | readonly userName: string
2302 |
2303 | /** The name of the host computer. */
2304 | readonly machineName: string
2305 |
2306 | /** The name of the operating system. */
2307 | readonly osName: string
2308 |
2309 | /** The version of the operating system. */
2310 | readonly osVersion: string
2311 |
2312 | /** Execute’s a command on the system’s command line. */
2313 | callSystem(cmdLineToExecute: string): string
2314 | }
2315 |
2316 | /** The TextDocument object stores a value for a TextLayer's Source Text property. Create it with the constructor, passing the string to be encapsulated. */
2317 | declare class TextDocument {
2318 | constructor(docText: string)
2319 |
2320 | /** The text layer’s Source Text value. */
2321 | text: string
2322 |
2323 | /** The text layer’s font specified by its PostScript name. */
2324 | font: string
2325 |
2326 | /** string with path of font file, providing its location on disk (not guaranteed to be returned for all font types; return value may be empty string for some kinds of fonts) */
2327 | readonly fontLocation: string
2328 |
2329 | /** string with style information — e.g., “bold”, “italic” */
2330 | readonly fontStyle: string
2331 |
2332 | /** a string with the name of the font family */
2333 | readonly fontFamily: string
2334 |
2335 | /** The text layer’s font size in pixels. */
2336 | fontSize: number
2337 |
2338 | /** When true, the text layer shows a fill. */
2339 | applyFill: boolean
2340 |
2341 | /** When true, the text layer shows a stroke. */
2342 | applyStroke: boolean
2343 |
2344 | /** The text layer’s fill color. */
2345 | fillColor: [number, number, number]
2346 |
2347 | /** The text layer’s stroke color. */
2348 | strokeColor: [number, number, number]
2349 |
2350 | /** Indicates the rendering order for the fill and stroke of a text layer. */
2351 | strokeOverFill: boolean
2352 |
2353 | /** The text layer’s stroke thickness. */
2354 | strokeWidth: number
2355 |
2356 | /** The paragraph justification for the text layer. */
2357 | justification: ParagraphJustification
2358 |
2359 | /** The text layer’s spacing between characters. */
2360 | tracking: number
2361 |
2362 | /** When true, the text layer is point (unbounded) text. */
2363 | readonly pointText: boolean
2364 |
2365 | /** When true, the text layer is paragraph (bounded) text. */
2366 | readonly boxText: boolean
2367 |
2368 | /** For box text, the pixel dimensions for the text bounds. */
2369 | boxTextSize: [number, number]
2370 |
2371 | /** CC 2014.2(13.2)- */
2372 | readonly fauxBold: boolean
2373 |
2374 | /** CC 2014.2(13.2)- */
2375 | readonly fauxItalic: boolean
2376 |
2377 | /** CC 2014.2(13.2)- */
2378 | readonly allCaps: boolean
2379 |
2380 | /** CC 2014.2(13.2)- */
2381 | readonly smallCaps: boolean
2382 |
2383 | /** CC 2014.2(13.2)- */
2384 | readonly superscript: boolean
2385 |
2386 | /** CC 2014.2(13.2)- */
2387 | readonly subscript: boolean
2388 |
2389 | /** CC 2014.2(13.2)- */
2390 | readonly verticalScale: number
2391 |
2392 | /** CC 2014.2(13.2)- */
2393 | readonly horizontalScale: number
2394 |
2395 | /** CC 2014.2(13.2)- */
2396 | readonly baselineShift: number
2397 |
2398 | /** CC 2014.2(13.2)- */
2399 | readonly tsume: number
2400 |
2401 | /** CC 2014.2(13.2)- */
2402 | readonly boxTextPos: [number, number]
2403 |
2404 | /** CC 2015(13.6)- */
2405 | readonly baselineLocs: number[]
2406 |
2407 | /** Restores the default character settings in the Character panel. */
2408 | resetCharStyle(): void
2409 |
2410 | /** Restores the default paragraph settings in the Paragraph panel. */
2411 | resetParagraphStyle(): void
2412 | }
2413 |
2414 | /** The TextLayer object represents a text layer within a composition. Create it using the LayerCollection object’s addText method. */
2415 | declare class TextLayer extends AVLayer {
2416 | readonly source: null
2417 |
2418 | readonly text: _TextProperties
2419 | }
2420 |
2421 | /** The Viewer object represents a Composition, Layer, or Footage panel. */
2422 | declare class Viewer {
2423 | /** The type of content in the viewer. */
2424 | readonly type: ViewerType
2425 |
2426 | /** When true, the viewer is focused. */
2427 | readonly active: boolean
2428 |
2429 | activeViewIndex: number
2430 |
2431 | readonly views: View[]
2432 |
2433 | /** When true, the viewer is at its maximized size. */
2434 | maximized: boolean
2435 |
2436 | /** Moves the viewer to front and places focus on it. */
2437 | setActive(): boolean
2438 | }
2439 |
2440 | declare class View {
2441 | readonly active: boolean
2442 | readonly options: ViewOptions
2443 |
2444 | setActive(): void
2445 | }
2446 |
2447 | declare class ViewOptions {
2448 | channels: ChannelType
2449 | checkerboards: boolean
2450 | exposure: number
2451 | fastPreview: FastPreviewType
2452 | zoom: number
2453 | }
2454 |
2455 | /**
2456 | * Properties for Shortcuts
2457 | */
2458 | declare class _TransformGroup extends PropertyGroup {
2459 | readonly anchorPoint: Property
2460 | readonly position: Property
2461 | readonly xPosition: Property
2462 | readonly yPosition: Property
2463 | readonly zPosition: Property
2464 | readonly scale: Property
2465 | readonly orientation: Property
2466 | readonly rotation: Property
2467 | readonly xRotation: Property
2468 | readonly yRotation: Property
2469 | readonly zRotation: Property
2470 | readonly opacity: Property
2471 | readonly pointOfInterest: Property
2472 | }
2473 |
2474 | declare class _LightOptionsGroup extends PropertyGroup {
2475 | readonly intensity: Property
2476 | readonly color: Property
2477 | readonly coneAngle: Property
2478 | readonly coneFeather: Property
2479 | readonly falloff: Property
2480 | readonly radius: Property
2481 | readonly falloffDistance: Property
2482 | readonly castsShadows: Property
2483 | readonly shadowDarkness: Property
2484 | readonly shadowDiffusion: Property
2485 | }
2486 |
2487 | declare class _CameraOptionsGroup extends PropertyGroup {
2488 | readonly zoom: Property
2489 | readonly depthOfField: Property
2490 | readonly focusDistance: Property
2491 | readonly aperture: Property
2492 | readonly blurLevel: Property
2493 | readonly irisShape: Property
2494 | readonly irisRotation: Property
2495 | readonly irisRoundness: Property
2496 | readonly irisAspectRatio: Property
2497 | readonly irisDiffractionFringe: Property
2498 | readonly highlightGain: Property
2499 | readonly highlightThreshold: Property
2500 | readonly highlightSaturation: Property
2501 | }
2502 |
2503 | declare class _LayerStyles extends PropertyGroup {
2504 | readonly blendingOption: _BlendOptionsGroup
2505 | readonly dropShadow: _DropShadow
2506 | readonly innerShadow: _InnerShadow
2507 | readonly outerGlow: _OuterGlow
2508 | readonly innerGlow: _InnerGlow
2509 | readonly bevelAndEmboss: _BevelAndEmboss
2510 | readonly satin: _Satin
2511 | readonly colorOverlay: _ColorOverlay
2512 | readonly gradientOverlay: _GradientOverlay
2513 | readonly stroke: _Stroke
2514 | }
2515 |
2516 | declare class _BlendOptionsGroup extends PropertyGroup {
2517 | readonly globalLightAngle: Property
2518 | readonly globalLightAltitude: Property
2519 | readonly advancedBlending: _AdvBlendGroup
2520 | }
2521 |
2522 | declare class _AdvBlendGroup extends PropertyGroup {
2523 | readonly fillOpacity: Property
2524 | readonly red: Property
2525 | readonly green: Property
2526 | readonly blue: Property
2527 | readonly blendInteriorStylesAsGroup: Property
2528 | readonly useBlendRangesFromSource: Property
2529 | }
2530 |
2531 | declare class _DropShadow extends PropertyGroup {
2532 | readonly blendMode: Property
2533 | readonly color: Property
2534 | readonly opacity: Property
2535 | readonly useGlobalLight: Property
2536 | readonly angle: Property
2537 | readonly distance: Property
2538 | readonly spread: Property
2539 | readonly size: Property
2540 | readonly noise: Property
2541 | readonly layerKnocksOutDropShadow: Property
2542 | }
2543 |
2544 | declare class _InnerShadow extends PropertyGroup {
2545 | readonly blendMode: Property
2546 | readonly color: Property
2547 | readonly opacity: Property
2548 | readonly useGlobalLight: Property
2549 | readonly angle: Property
2550 | readonly distance: Property
2551 | readonly choke: Property
2552 | readonly size: Property
2553 | readonly noise: Property
2554 | }
2555 |
2556 | declare class _OuterGlow extends PropertyGroup {
2557 | readonly blendMode: Property
2558 | readonly opacity: Property
2559 | readonly noise: Property
2560 | readonly colorType: Property
2561 | readonly color: Property
2562 | readonly colors: Property
2563 | readonly gradientSmoothness: Property
2564 | readonly technique: Property
2565 | readonly spread: Property
2566 | readonly size: Property
2567 | readonly range: Property
2568 | readonly jitter: Property
2569 | }
2570 |
2571 | declare class _InnerGlow extends PropertyGroup {
2572 | readonly blendMode: Property
2573 | readonly opacity: Property
2574 | readonly noise: Property
2575 | readonly colorType: Property
2576 | readonly color: Property
2577 | readonly colors: Property
2578 | readonly gradientSmoothness: Property
2579 | readonly technique: Property
2580 | readonly source: Property
2581 | readonly choke: Property
2582 | readonly size: Property
2583 | readonly range: Property
2584 | readonly jitter: Property
2585 | }
2586 |
2587 | declare class _BevelAndEmboss extends PropertyGroup {
2588 | readonly style: Property
2589 | readonly technique: Property
2590 | readonly depth: Property
2591 | readonly direction: Property
2592 | readonly size: Property
2593 | readonly soften: Property
2594 | readonly useGlobalLight: Property
2595 | readonly angle: Property
2596 | readonly altitude: Property
2597 | readonly highlightMode: Property
2598 | readonly highlightColor: Property
2599 | readonly highlightOpacity: Property
2600 | readonly shadowMode: Property
2601 | readonly shadowColor: Property
2602 | readonly shadowOpacity: Property
2603 | }
2604 |
2605 | declare class _Satin extends PropertyGroup {
2606 | readonly blendMode: Property
2607 | readonly color: Property
2608 | readonly opacity: Property
2609 | readonly angle: Property
2610 | readonly distance: Property
2611 | readonly size: Property
2612 | readonly invert: Property
2613 | }
2614 |
2615 | declare class _ColorOverlay extends PropertyGroup {
2616 | readonly blendMode: Property
2617 | readonly color: Property
2618 | readonly opacity: Property
2619 | }
2620 |
2621 | declare class _GradientOverlay extends PropertyGroup {
2622 | readonly blendMode: Property
2623 | readonly opacity: Property
2624 | readonly colors: Property
2625 | readonly gradientSmoothness: Property
2626 | readonly angle: Property
2627 | readonly style: Property
2628 | readonly reverse: Property
2629 | readonly alignWithLayer: Property
2630 | readonly scale: Property
2631 | readonly offset: Property
2632 | }
2633 |
2634 | declare class _Stroke extends PropertyGroup {
2635 | readonly color: Property
2636 | readonly blendMode: Property
2637 | readonly size: Property
2638 | readonly opacity: Property
2639 | readonly position: Property
2640 | }
2641 |
2642 | declare class _GeometryOptionsGroup extends PropertyGroup {
2643 | readonly curvature: Property
2644 | readonly segments: Property
2645 |
2646 | readonly bevelStyle: Property
2647 | readonly bevelDepth: Property
2648 | readonly holeBevelDepth: Property
2649 | readonly extrusionDepth: Property
2650 | }
2651 |
2652 | declare class _MaterialOptionsGroup extends PropertyGroup {
2653 | readonly castsShadows: Property
2654 | readonly lightTransmission: Property
2655 | readonly acceptsShadows: Property
2656 | readonly acceptsLights: Property
2657 | readonly appearsInReflections: Property
2658 | readonly ambient: Property
2659 | readonly diffuse: Property
2660 | readonly specularIntensity: Property
2661 | readonly specularShininess: Property
2662 | readonly metal: Property
2663 | readonly reflectionIntensity: Property
2664 | readonly reflectionSharpness: Property
2665 | readonly reflectionRolloff: Property
2666 | readonly transparency: Property
2667 | readonly transparencyRolloff: Property
2668 | readonly indexOfRefraction: Property
2669 | }
2670 |
2671 | declare class _AudioGroup extends PropertyGroup {
2672 | readonly audioLevels: Property
2673 | }
2674 |
2675 | declare class _TextProperties extends PropertyGroup {
2676 | readonly sourceText: Property
2677 | readonly pathOption: _TextPathOptions
2678 | readonly moreOption: _TextMoreOptions
2679 | }
2680 |
2681 | declare class _TextPathOptions extends PropertyGroup {
2682 | readonly path: Property
2683 | }
2684 |
2685 | declare class _TextMoreOptions extends PropertyGroup {
2686 | readonly anchorPointGrouping: Property
2687 | readonly groupingAlignment: Property
2688 | readonly fillANdStroke: Property
2689 | readonly interCharacterBlending: Property
2690 | }
2691 |
--------------------------------------------------------------------------------