// Media Encoder + ScriptUI — Adobe Media Encoder 2027 // Generated from Adobe’s object model export on 2026-11-10. // https://www.indesignjs.de/indesignapi/media-encoder/ // // Object model, Core JavaScript, the global names AND ScriptUI in one // file — for scripts that put up a dialog. // // 0 product classes give way to the ScriptUI classes of the same name: . // TypeScript holds one meaning per global name, and a dialog needs // new Window(…). References to them read "any" — no help, but nothing // false either. Where those classes matter more than a dialog, take // the plain product file instead. // // ExtendScript is not a browser. With the DOM library loaded, Document, // Event, Text and Window resolve to the browser versions and everything // below becomes invisible — doc.pages would be unknown, doc.createElement // would not. Put this next to your scripts as jsconfig.json: // // { // "compilerOptions": { "lib": ["es5"], "types": [], "checkJs": false }, // "include": ["**/*.js", "**/*.d.ts"] // } // // The descriptive texts are Adobe’s. Where Adobe’s own type information // is unusable, the type is "any" — see the project README. // // Parameters whose Adobe name is a reserved word carry a trailing // underscore: findKeyStrings(for_), prompt(…, default_, …). // Adobe references these type names without ever defining them. // The name is kept so the intent stays readable; the type is not known. type PixelAspectRatioObject = any; type Sequence = any; type TimecodeObject = any; type TopLevelWindow = any; type TrackItem = any; type UINode = any; /** * The $ object provides a number of debugging facilities and informational * methods. */ declare class $ { /** * The ExtendScript build information. */ static readonly build: string; /** * The ExtendScript build date. */ static readonly buildDate: Date; /** * The character used as the decimal point character in formatted numeric * output. */ static decimalPoint: string; /** * The name of the current ExtendScript engine, if set. */ static readonly engineName: string; /** * The most recent run-time error information. */ static error: Error; /** * The file name of the current script. */ static readonly fileName: string; /** * Gets or sets low-level debug output flags. */ static flags: number; /** * A reference to the global object, which contains the JavaScript global * namespace. */ static readonly global: any; /** * A high-resolution timer, measuring the time in microseconds. The timer * starts when ExtendScript is initialized during the application startup * sequence. Every read access resets the timer to Zero. */ static readonly hiresTimer: number; /** * The path for include files for the current script. */ static readonly includePath: string; /** * The current debugging level, which enables or disables the JavaScript * debugger. */ static level: number; /** * The current line number of the currently executing script. */ static readonly line: number; /** * Gets or sets the current locale. */ static locale: string; /** * Set to true to enable the extended localization features of the built-in * toString() method. */ static localize: boolean; /** * The ExtendScript memory cache size, in bytes. */ static memCache: number; /** * The current operating system version information. */ static readonly os: string; /** * An array of objects containing information about the display screens * attached to your computer. */ static readonly screens: Object[]; /** * The current stack trace. */ static readonly stack: string; /** * Sets or clears strict mode for object modification. */ static strict: any; /** * The version number of the ExtendScript engine. */ static readonly version: string; /** * Shows an About box for the ExtendScript component, and returns the text for * the box. */ static about(): string; /** * Breaks execution at the current position. * @param condition A string containing a JavaScript statement to be used as a condition. If the statement evaluates to true or nonzero when this point is reached, execution stops. */ static bp(condition?: any): void; /** * Invokes the platform-specific color selection dialog, and returns the * selected color. * @param color The color to be preselected in the dialog, as 0xRRGGBB, or -1 for the platform default. */ static colorPicker(color: number): number; /** * Loads and evaluates a file. * @param file The file to load. * @param timeout An optional timeout in milliseconds. */ static evalFile(file: File, timeout?: number): any; /** * Initiates garbage collection in the ExtendScript engine. */ static gc(): void; /** * Retrieves the value of an environment variable. * @param name The name of the variable. */ static getenv(name: string): string; /** * Sets the value of an environment variable. * @param name The name of the variable. * @param value The value of the variable. */ static setenv(name: string, value: string): void; /** * Suspends the calling thread for a number of milliseconds. * @param msecs Number of milliseconds to sleep. */ static sleep(msecs: number): void; /** * Converts this object to a string. */ static toString(): string; /** * Prints text to the Console. * @param text The text to print. All arguments are concatenated. */ static write(text: any): void; /** * Prints text to the Console, and adds a newline character. * @param text The text to print. All arguments are concatenated. */ static writeln(text: any): void; } /** * The event will be sent after batch item creation failed. Can be used for the * following FrontendScriptObject API's: 'addFileToBatch', * 'addTeamProjectsItemToBatch' and 'addDLToBatch'. */ declare class AMEBatchItemCreationFailedEvent { /** * Get the error string */ readonly error: string; /** * Notify when the batch item creation failed. */ static readonly onBatchItemCreationFailed: string; /** * Get the source file path. */ readonly srcFilePath: string; static addEventListener(): any; static dispatchEvent(): any; static removeEventListener(): any; } /** * Provides the following event types: onMediaInfoCreated, * onBatchItemStatusChanged, onItemEncodingStarted, onAudioPreEncodeProgress, * onEncodingItemProgressUpdated, onEncodeComplete, onError, * onPostProcessListInitialized */ declare class AMEExportEvent { /** * Returns the audio pre-encoding info for the event type * onAudioPreEncodeProgress (available since 24.0). */ readonly audioInfo: string; /** * Returns the audio pre-encoding progress for the event type * onAudioPreEncodeProgress (available since 24.0). */ readonly audioProgress: number; /** * Returns true after encoding has been completed for a batch item. Can be * called for onEncodeComplete event. */ readonly encodeCompleteStatus: boolean; /** * Returns the encoding time in milliseconds. Can be called for * onEncodeComplete event. */ readonly encodeCompleteTime: number; /** * Returns export error string (available since 25.2). */ readonly error: string; /** * Returns the batch group index. Can be called for onBatchItemStatusChanged * event. */ readonly groupIndex: number; /** * Returns the batch item index. Can be called for onBatchItemStatusChanged * event. */ readonly itemIndex: number; /** * Notify the encoding progress (Deprecated). */ static readonly oEncodingItemProgressUpdated: string; /** * Notify when the audio pre-encode progress changes (available since 24.0) */ static readonly onAudioPreEncodeProgress: string; /** * Notify when batch item status has been changed. You can call the API's * groupIndex itemIndex and status for more info. */ static readonly onBatchItemStatusChanged: string; /** * Notify when the batch item has been encoded. You can call the API's * encodeCompleteStatus and encodeCompleteTime for more info. */ static readonly onEncodeComplete: string; /** * Notify the encoding progress. */ static readonly onEncodingItemProgressUpdated: string; /** * Notify when there's an error while encoding the batch item. */ static readonly onError: string; /** * Notify when the encoding of a batch item has started. */ static readonly onItemEncodingStarted: string; /** * Notify when media info has been created. */ static readonly onMediaInfoCreated: string; /** * Notify when the post process list is initialized. */ static readonly onPostProcessListInitialized: string; /** * Returns the batch item encoding progress value which is between 0 and 1. Can * be called for onEncodingItemProgressUpdated event */ readonly progress: number; readonly status: any; static addEventListener(): any; static dispatchEvent(): any; static removeEventListener(): any; } /** * The event will be sent after a batch item has been created successfully. */ declare class AMEFrontendEvent { /** * Notify when a batch item has been created successfully. Can be used for all * FrontendScriptObject API's which creates a batch item. */ static readonly onItemAddedToBatch: string; static addEventListener(): any; static dispatchEvent(): any; static removeEventListener(): any; } /** * AME UXP event root */ declare class AMEUXPApplication { } /** * Static clustering object for Affinity Propagation algorithm */ declare class AffinityPropagation { /** * Performs affinity propagation clustering on data points. The preferences * parameter contains: convergenceIterations (int32) maximumIterations (int32) * dampingFactor (float) preferenceSize (float) * @param dataPointMatrix * @param preferences */ static cluster(dataPointMatrix: Object, preferences: Object): Clusters; } /** * Analyzer Host which contains ongoing analysis tasks and provides APIs to * manage them. */ declare class AnalyzerHost { /** * Return the number of currently running analyzers for the given analyzer * guid. * @param analyzerGuid */ countJobsForAnalyzer(analyzerGuid: Object): Object; /** * Get the default analyzer host for the running application */ static getDefault(): Object; /** * Return the number of currently running analyzers for the given analyzer * guid. * @param analyzerGuid */ waitForAnalyzerCompletion(analyzerGuid: Object): Object; } /** * Top level app object */ declare class Application { /** * Get application build number */ readonly buildNumber: string; /** * Redirect assert output to stdout. */ assertToConsole(): boolean; /** * Bring application to front */ bringToFront(): boolean; /** * Cancel the task that matches the task ID * @param taskID */ cancelTask(taskID: number): boolean; /** * Get the encoder host object. See EncoderHostScriptObject */ getEncoderHost(): Object; /** * Get the exporter object. See ExporterScriptObject */ getExporter(): Object; /** * Get the front end object. See FrontendScriptObject */ getFrontend(): Object; /** * Get the watch folder object. See WatchFolderScriptObject */ getWatchFolder(): Object; /** * True if all frames are black * @param sourcePath */ isBlackVideo(sourcePath: string): boolean; /** * True if audio is silent * @param sourcePath */ isSilentAudio(sourcePath: string): boolean; /** * Quit the AME app */ quit(): boolean; /** * Render still frames for given source * @param sourcePath * @param outputPath * @param renderAll * @param startFrame */ renderFrameSequence(sourcePath: string, outputPath: string, renderAll: boolean, startFrame: number): boolean; /** * Schedule a script to run after delay returns task ID * @param scriptToExecute Put your script as text, e.g. 'app.getEncoderHost().runBatch()'. * @param delayInMilliseconds * @param repeat */ scheduleTask(scriptToExecute: string, delayInMilliseconds: number, repeat: boolean): number; /** * Non UI blocking wait in milliseconds * @param milliseconds */ wait(milliseconds: number): boolean; /** * Write text to std out * @param text */ write(text: string): boolean; } /** * Provides scripting env access to MF::ArbData */ declare class ArbData { /** * Construct an ArbData Object. * @param inBase64EncodedStringData */ constructor(inBase64EncodedStringData: string); /** * Gets the binary value encoded with base64 */ getBase64EncodeStringValue(): string; } /** * AudioChannelLayout represents a channel layout with named channels proved as * constants AUDIOCHANNELLABEL_ ... An AudioChannelLayout can be created using * an Array of these constants or it could be created using one of the * constants CHANNELLAYOUT_ ... to create a common layout. */ declare class AudioChannelLayout { /** * Returns an audio channel label. */ readonly ".index": number; /** * Ambisonic-W */ static readonly AUDIOCHANNELLABEL_AMBISONIC_W: number; /** * Ambisonic-X */ static readonly AUDIOCHANNELLABEL_AMBISONIC_X: number; /** * Ambisonic-Y */ static readonly AUDIOCHANNELLABEL_AMBISONIC_Y: number; /** * Ambisonic-Z */ static readonly AUDIOCHANNELLABEL_AMBISONIC_Z: number; /** * Back-Center */ static readonly AUDIOCHANNELLABEL_BACKCENTER: number; /** * Back-Left */ static readonly AUDIOCHANNELLABEL_BACKLEFT: number; /** * Back-Right */ static readonly AUDIOCHANNELLABEL_BACKRIGHT: number; /** * Bottom-Front-Center */ static readonly AUDIOCHANNELLABEL_BOTTOMFRONTCENTER: number; /** * Bottom-Front-Left */ static readonly AUDIOCHANNELLABEL_BOTTOMFRONTLEFT: number; /** * Bottom-Front-Right */ static readonly AUDIOCHANNELLABEL_BOTTOMFRONTRIGHT: number; /** * Discrete */ static readonly AUDIOCHANNELLABEL_DISCRETE: number; /** * Front-Center */ static readonly AUDIOCHANNELLABEL_FRONTCENTER: number; /** * Front-Left */ static readonly AUDIOCHANNELLABEL_FRONTLEFT: number; /** * Front-Left-Of-Center */ static readonly AUDIOCHANNELLABEL_FRONTLEFTOFCENTER: number; /** * Front-Left-Wide */ static readonly AUDIOCHANNELLABEL_FRONTLEFTWIDE: number; /** * Front-Right */ static readonly AUDIOCHANNELLABEL_FRONTRIGHT: number; /** * Front-Right-Of-Center */ static readonly AUDIOCHANNELLABEL_FRONTRIGHTOFCENTER: number; /** * Front-Right-Wide */ static readonly AUDIOCHANNELLABEL_FRONTRIGHTWIDE: number; /** * Left-Height */ static readonly AUDIOCHANNELLABEL_LEFTHEIGHT: number; /** * Left-Total */ static readonly AUDIOCHANNELLABEL_LEFTTOTAL: number; /** * LFE2 */ static readonly AUDIOCHANNELLABEL_LFE2: number; /** * Low-Frequency */ static readonly AUDIOCHANNELLABEL_LOWFREQUENCY: number; /** * Proximity-Left */ static readonly AUDIOCHANNELLABEL_PROXIMITYLEFT: number; /** * Proximity-Right */ static readonly AUDIOCHANNELLABEL_PROXIMITYRIGHT: number; /** * Rear-Surround-Left */ static readonly AUDIOCHANNELLABEL_REARSURROUNDLEFT: number; /** * Rear-Surround-Right */ static readonly AUDIOCHANNELLABEL_REARSURROUNDRIGHT: number; /** * Right-Height */ static readonly AUDIOCHANNELLABEL_RIGHTHEIGHT: number; /** * Right-Total */ static readonly AUDIOCHANNELLABEL_RIGHTTOTAL: number; /** * Side-Left */ static readonly AUDIOCHANNELLABEL_SIDELEFT: number; /** * Side-Right */ static readonly AUDIOCHANNELLABEL_SIDERIGHT: number; /** * Top-Back-Center */ static readonly AUDIOCHANNELLABEL_TOPBACKCENTER: number; /** * Top-Back-Left */ static readonly AUDIOCHANNELLABEL_TOPBACKLEFT: number; /** * Top-Back-Right */ static readonly AUDIOCHANNELLABEL_TOPBACKRIGHT: number; /** * Top-Center */ static readonly AUDIOCHANNELLABEL_TOPCENTER: number; /** * Top-Front-Center */ static readonly AUDIOCHANNELLABEL_TOPFRONTCENTER: number; /** * Top-Front-Left */ static readonly AUDIOCHANNELLABEL_TOPFRONTLEFT: number; /** * Top-Front-Right */ static readonly AUDIOCHANNELLABEL_TOPFRONTRIGHT: number; /** * 32 Channel Configuration Discrete Discrete Discrete Discrete Discrete * Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete * Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete * Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete * Discrete Discrete Discrete */ static readonly CHANNELLAYOUT_32_DISCRETE_CHANNELS: number; /** * 4 Channel Configuration Discrete Discrete Discrete Discrete */ static readonly CHANNELLAYOUT_4_DISCRETE_CHANNELS: number; /** * 6 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right */ static readonly CHANNELLAYOUT_51: number; /** * 8 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Front-Left-Of-Center Front-Right-Of-Center */ static readonly CHANNELLAYOUT_7_1: number; /** * 8 Channel Configuration Front-Left Front-Right Back-Left Back-Right * Front-Center Low-Frequency Front-Left-Of-Center Front-Right-Of-Center */ static readonly CHANNELLAYOUT_7_1EMAGIC: number; /** * 8 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Rear-Surround-Left Rear-Surround-Right */ static readonly CHANNELLAYOUT_7_1ITU: number; /** * 8 Channel Configuration Front-Center Front-Left-Of-Center * Front-Right-Of-Center Front-Left Front-Right Back-Left Back-Right * Low-Frequency */ static readonly CHANNELLAYOUT_7_1MPEG: number; /** * 8 Channel Configuration Discrete Discrete Discrete Discrete Discrete * Discrete Discrete Discrete */ static readonly CHANNELLAYOUT_8_DISCRETE_CHANNELS: number; /** * 4 Channel Configuration Ambisonic-W Ambisonic-X Ambisonic-Y Ambisonic-Z */ static readonly CHANNELLAYOUT_AMBISONICSBFORMAT: number; /** * 2 Channel Configuration Bottom-Front-Left Bottom-Front-Right */ static readonly CHANNELLAYOUT_BFL_BFR: number; /** * 6 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right */ static readonly CHANNELLAYOUT_BROADCAST51: number; /** * 8 Channel Configuration Front-Left Front-Right Back-Left Back-Right * Top-Front-Left Top-Front-Right Top-Back-Left Top-Back-Right */ static readonly CHANNELLAYOUT_CUBE: number; /** * 2 Channel Configuration Front-Center Low-Frequency */ static readonly CHANNELLAYOUT_C_LFE: number; /** * 3 Channel Configuration Front-Center Front-Left Front-Right */ static readonly CHANNELLAYOUT_C_L_R: number; /** * 4 Channel Configuration Front-Center Front-Left Front-Right Back-Center */ static readonly CHANNELLAYOUT_C_L_R_CS: number; /** * 5 Channel Configuration Front-Center Front-Left Front-Right Back-Left * Back-Right */ static readonly CHANNELLAYOUT_C_L_R_LS_RS: number; /** * 6 Channel Configuration Front-Center Front-Left Front-Right Back-Left * Back-Right Back-Center */ static readonly CHANNELLAYOUT_C_L_R_LS_RS_CS: number; /** * 7 Channel Configuration Front-Center Front-Left Front-Right Back-Left * Back-Right Back-Center Low-Frequency */ static readonly CHANNELLAYOUT_C_L_R_LS_RS_CS_LFE: number; /** * 6 Channel Configuration Front-Center Front-Left Front-Right Back-Left * Back-Right Low-Frequency */ static readonly CHANNELLAYOUT_C_L_R_LS_RS_LFE: number; /** * 7 Channel Configuration Front-Center Front-Left Front-Right Back-Left * Back-Right Rear-Surround-Left Rear-Surround-Right */ static readonly CHANNELLAYOUT_C_L_R_LS_RS_RLS_RRS: number; /** * 8 Channel Configuration Front-Center Front-Left Front-Right Back-Left * Back-Right Rear-Surround-Left Rear-Surround-Right Back-Center */ static readonly CHANNELLAYOUT_C_L_R_LS_RS_RLS_RRS_CS: number; /** * 6 Channel Configuration Front-Left Front-Right Back-Left Back-Right * Front-Center Back-Center */ static readonly CHANNELLAYOUT_HEXAGONAL: number; /** * 2 Channel Configuration Front-Left-Of-Center Front-Right-Of-Center */ static readonly CHANNELLAYOUT_LC_RC: number; /** * 6 Channel Configuration Front-Left Front-Right Back-Left Back-Right * Front-Center Low-Frequency */ static readonly CHANNELLAYOUT_LEGACY51: number; /** * 2 Channel Configuration Side-Left Side-Right */ static readonly CHANNELLAYOUT_LSD_RSD: number; /** * 2 Channel Configuration Back-Left Back-Right */ static readonly CHANNELLAYOUT_LS_RS: number; /** * 3 Channel Configuration Front-Left Front-Center Front-Right */ static readonly CHANNELLAYOUT_L_C_R: number; /** * 4 Channel Configuration Front-Left Front-Center Front-Right Back-Center */ static readonly CHANNELLAYOUT_L_C_R_CS: number; /** * 5 Channel Configuration Front-Left Front-Center Front-Right Back-Center * Low-Frequency */ static readonly CHANNELLAYOUT_L_C_R_CS_LFE: number; /** * 4 Channel Configuration Front-Left Front-Center Front-Right Low-Frequency */ static readonly CHANNELLAYOUT_L_C_R_LFE: number; /** * 5 Channel Configuration Front-Left Front-Center Front-Right Back-Left * Back-Right */ static readonly CHANNELLAYOUT_L_C_R_LS_RS: number; /** * 6 Channel Configuration Front-Left Front-Center Front-Right Back-Left * Back-Right Low-Frequency */ static readonly CHANNELLAYOUT_L_C_R_LS_RS_LFE: number; /** * 3 Channel Configuration Front-Left Front-Right Front-Center */ static readonly CHANNELLAYOUT_L_R_C: number; /** * 3 Channel Configuration Front-Left Front-Right Back-Center */ static readonly CHANNELLAYOUT_L_R_CS: number; /** * 4 Channel Configuration Front-Left Front-Right Back-Center Low-Frequency */ static readonly CHANNELLAYOUT_L_R_CS_LFE: number; /** * 4 Channel Configuration Front-Left Front-Right Front-Center Back-Center */ static readonly CHANNELLAYOUT_L_R_C_CS: number; /** * 4 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency */ static readonly CHANNELLAYOUT_L_R_C_LFE: number; /** * 5 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Center */ static readonly CHANNELLAYOUT_L_R_C_LFE_CS: number; /** * 7 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Back-Center */ static readonly CHANNELLAYOUT_L_R_C_LFE_LS_RS_CS: number; /** * 9 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Back-Center Side-Left Side-Right */ static readonly CHANNELLAYOUT_L_R_C_LFE_LS_RS_CS_LSD_RSD: number; /** * 14 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Back-Center Top-Center Top-Front-Left Top-Front-Center * Top-Front-Right Top-Back-Left Top-Back-Center Top-Back-Right */ static readonly CHANNELLAYOUT_L_R_C_LFE_LS_RS_CS_TS_VHL_VHC_VHR_TBL_TBR: number; /** * 9 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Front-Left-Of-Center Front-Right-Of-Center Back-Center */ static readonly CHANNELLAYOUT_L_R_C_LFE_LS_RS_LC_RC_CS: number; /** * 8 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Side-Left Side-Right */ static readonly CHANNELLAYOUT_L_R_C_LFE_LS_RS_LSD_RSD: number; /** * 10 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Side-Left Side-Right Left-Height Right-Height */ static readonly CHANNELLAYOUT_L_R_C_LFE_LS_RS_LSD_RSD_TSL_TSR: number; /** * 8 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Proximity-Left Proximity-Right */ static readonly CHANNELLAYOUT_L_R_C_LFE_LS_RS_PL_PR: number; /** * 12 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Top-Center Top-Front-Left Top-Front-Center * Top-Front-Right Top-Back-Left Top-Back-Right */ static readonly CHANNELLAYOUT_L_R_C_LFE_LS_RS_TS_VHL_VHC_VHR_TBL_TBR: number; /** * 11 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Top-Center Top-Front-Left Top-Front-Right Top-Back-Left * Top-Back-Right */ static readonly CHANNELLAYOUT_L_R_C_LFE_LS_RS_TS_VHL_VHR_TBL_TBR: number; /** * 10 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Top-Front-Left Top-Front-Right Top-Back-Left * Top-Back-Right */ static readonly CHANNELLAYOUT_L_R_C_LFE_LS_RS_VHL_VHR_TBL_TBR: number; /** * 5 Channel Configuration Front-Left Front-Right Front-Center Back-Left * Back-Right */ static readonly CHANNELLAYOUT_L_R_C_LS_RS: number; /** * 6 Channel Configuration Front-Left Front-Right Front-Center Back-Left * Back-Right Back-Center */ static readonly CHANNELLAYOUT_L_R_C_LS_RS_CS: number; /** * 8 Channel Configuration Front-Left Front-Right Front-Center Back-Left * Back-Right Back-Center Side-Left Side-Right */ static readonly CHANNELLAYOUT_L_R_C_LS_RS_CS_LSD_RSD: number; /** * 13 Channel Configuration Front-Left Front-Right Front-Center Back-Left * Back-Right Back-Center Top-Center Top-Front-Left Top-Front-Center * Top-Front-Right Top-Back-Left Top-Back-Center Top-Back-Right */ static readonly CHANNELLAYOUT_L_R_C_LS_RS_CS_TS_VHL_VHC_VHR_TBL_TBR: number; /** * 7 Channel Configuration Front-Left Front-Right Front-Center Back-Left * Back-Right Front-Left-Of-Center Front-Right-Of-Center */ static readonly CHANNELLAYOUT_L_R_C_LS_RS_LC_RC: number; /** * 8 Channel Configuration Front-Left Front-Right Front-Center Back-Left * Back-Right Front-Left-Of-Center Front-Right-Of-Center Back-Center */ static readonly CHANNELLAYOUT_L_R_C_LS_RS_LC_RC_CS: number; /** * 7 Channel Configuration Front-Left Front-Right Front-Center Back-Left * Back-Right Side-Left Side-Right */ static readonly CHANNELLAYOUT_L_R_C_LS_RS_LSD_RSD: number; /** * 11 Channel Configuration Front-Left Front-Right Front-Center Back-Left * Back-Right Top-Center Top-Front-Left Top-Front-Center Top-Front-Right * Top-Back-Left Top-Back-Right */ static readonly CHANNELLAYOUT_L_R_C_LS_RS_TS_VHL_VHC_VHR_TBL_TBR: number; /** * 10 Channel Configuration Front-Left Front-Right Front-Center Back-Left * Back-Right Top-Center Top-Front-Left Top-Front-Right Top-Back-Left * Top-Back-Right */ static readonly CHANNELLAYOUT_L_R_C_LS_RS_TS_VHL_VHR_TBL_TBR: number; /** * 9 Channel Configuration Front-Left Front-Right Front-Center Back-Left * Back-Right Top-Front-Left Top-Front-Right Top-Back-Left Top-Back-Right */ static readonly CHANNELLAYOUT_L_R_C_LS_RS_VHL_VHR_TBL_TBR: number; /** * 3 Channel Configuration Front-Left Front-Right Low-Frequency */ static readonly CHANNELLAYOUT_L_R_LFE: number; /** * 4 Channel Configuration Front-Left Front-Right Low-Frequency Back-Center */ static readonly CHANNELLAYOUT_L_R_LFE_CS: number; /** * 5 Channel Configuration Front-Left Front-Right Low-Frequency Back-Left * Back-Right */ static readonly CHANNELLAYOUT_L_R_LFE_LS_RS: number; /** * 7 Channel Configuration Front-Left Front-Right Low-Frequency Back-Left * Back-Right Side-Left Side-Right */ static readonly CHANNELLAYOUT_L_R_LFE_LS_RS_LSD_RSD: number; /** * 9 Channel Configuration Front-Left Front-Right Low-Frequency Back-Left * Back-Right Top-Front-Left Top-Front-Center Top-Front-Right * Bottom-Front-Center */ static readonly CHANNELLAYOUT_L_R_LFE_LS_RS_VHL_VHC_VHR_BFC: number; /** * 5 Channel Configuration Front-Left Front-Right Back-Left Back-Right * Front-Center */ static readonly CHANNELLAYOUT_L_R_LS_RS_C: number; /** * 7 Channel Configuration Front-Left Front-Right Back-Left Back-Right * Front-Center Front-Left-Of-Center Front-Right-Of-Center */ static readonly CHANNELLAYOUT_L_R_LS_RS_C_LC_RC: number; /** * 7 Channel Configuration Front-Left Front-Right Back-Left Back-Right * Front-Center Rear-Surround-Left Rear-Surround-Right */ static readonly CHANNELLAYOUT_L_R_LS_RS_C_RLS_RRS: number; /** * 5 Channel Configuration Front-Left Front-Right Back-Left Back-Right * Low-Frequency */ static readonly CHANNELLAYOUT_L_R_LS_RS_LFE: number; /** * 6 Channel Configuration Front-Left Front-Right Back-Left Back-Right * Side-Left Side-Right */ static readonly CHANNELLAYOUT_L_R_LS_RS_LSD_RSD: number; /** * 2 Channel Configuration Left-Total Right-Total */ static readonly CHANNELLAYOUT_MATRIXSTEREO: number; /** * 1 Channel Configuration Discrete */ static readonly CHANNELLAYOUT_MONO: number; /** * 8 Channel Configuration Front-Left Front-Right Back-Left Back-Right * Front-Center Back-Center Side-Left Side-Right */ static readonly CHANNELLAYOUT_OCTAGONAL: number; /** * 5 Channel Configuration Front-Left Front-Right Back-Left Back-Right * Front-Center */ static readonly CHANNELLAYOUT_PENTAGONAL: number; /** * 4 Channel Configuration Front-Left Front-Right Back-Left Back-Right */ static readonly CHANNELLAYOUT_QUADRAPHONIC: number; /** * 16 Channel Configuration Discrete Discrete Front-Center Discrete Discrete * Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete * Discrete Discrete Discrete */ static readonly CHANNELLAYOUT_SMPTEDIGITALCINEMA1: number; /** * 16 Channel Configuration Left-Total Right-Total Discrete Discrete Discrete * Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete * Discrete Discrete Discrete */ static readonly CHANNELLAYOUT_SMPTEDIGITALCINEMA2: number; /** * 16 Channel Configuration Front-Left Front-Right Front-Center Discrete * Back-Center Discrete Discrete Discrete Discrete Discrete Discrete Discrete * Discrete Discrete Discrete Discrete */ static readonly CHANNELLAYOUT_SMPTEDIGITALCINEMA4: number; /** * 16 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Discrete Discrete Discrete Discrete Discrete Discrete * Discrete Discrete Discrete Discrete */ static readonly CHANNELLAYOUT_SMPTEDIGITALCINEMA6: number; /** * 16 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Discrete Discrete Back-Center Discrete Discrete * Discrete Discrete Discrete Discrete Discrete */ static readonly CHANNELLAYOUT_SMPTEDIGITALCINEMA7: number; /** * 16 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Front-Left-Of-Center Front-Right-Of-Center Discrete * Discrete Discrete Discrete Discrete Discrete Discrete Discrete */ static readonly CHANNELLAYOUT_SMPTEDIGITALCINEMA8: number; /** * 16 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Front-Left-Of-Center Front-Right-Of-Center Back-Center * Discrete Discrete Discrete Discrete Discrete Discrete Discrete */ static readonly CHANNELLAYOUT_SMPTEDIGITALCINEMA9: number; /** * 8 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Left-Total Right-Total */ static readonly CHANNELLAYOUT_SMPTEDTV: number; /** * 2 Channel Configuration Front-Left Front-Right */ static readonly CHANNELLAYOUT_STEREO: number; /** * 2 Channel Configuration Top-Back-Left Top-Back-Right */ static readonly CHANNELLAYOUT_TBL_TBR: number; /** * 2 Channel Configuration Left-Height Right-Height */ static readonly CHANNELLAYOUT_TSL_TSR: number; /** * 2 Channel Configuration Top-Front-Left Top-Front-Right */ static readonly CHANNELLAYOUT_VHL_VHR: number; /** * 12 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Top-Front-Left Top-Front-Center Top-Front-Right * Top-Back-Left Top-Back-Right LFE2 */ static readonly CHANNELLAYOUT_VST10_2: number; /** * 14 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Front-Left-Of-Center Front-Right-Of-Center * Top-Front-Left Top-Front-Center Top-Front-Right Top-Back-Left Top-Back-Right * LFE2 */ static readonly CHANNELLAYOUT_VST10_2_PLUS: number; /** * 8 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Back-Center Top-Front-Center */ static readonly CHANNELLAYOUT_VST_7_1_CINE_CENTER_HIGH: number; /** * 8 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Top-Front-Left Top-Front-Right */ static readonly CHANNELLAYOUT_VST_7_1_CINE_FRONT_HIGH: number; /** * 8 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Left-Height Right-Height */ static readonly CHANNELLAYOUT_VST_7_1_CINE_SIDE_HIGH: number; /** * 8 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency * Back-Left Back-Right Back-Center Top-Center */ static readonly CHANNELLAYOUT_VST_7_1_CINE_TOP_CENTER: number; /** * Audio channel layout description */ readonly description: string; /** * Number of audio channels. */ readonly length: number; /** * Create a audio channel layout. * @param labels */ static createAudioChannelLayout(labels: any): AudioChannelLayout; /** * Create a common audio channel layout. * @param layout */ static createCommonAudioChannelLayout(layout: number): AudioChannelLayout; /** * Returns an audio channel label. * @param index */ getByIndex(index: number): number; /** * Get the number of audio channels. */ getLength(): number; /** * Label string of a single audio channel label * @param label */ static label(label: number): string; } /** * The AudioFilterIDs object exposes the AudioFilterIDs as read-only string * constants. */ declare class AudioFilterIDs { /** * Accusonus Denoise filter ID. */ static readonly ACCUSONUS_DENOISE: string; /** * Accusonus Dereverb filter ID. */ static readonly ACCUSONUS_DEREVERB: string; /** * Adaptive Noise Reduction filter ID. */ static readonly ADAPTIVE_NOISE_REDUCTION: string; /** * Ambisonics Binauralizer filter ID. */ static readonly AMBISONICS_BINAURALIZER: string; /** * Ambisonics Panner filter ID. */ static readonly AMBISONICS_PANNER: string; /** * Amplify filter ID. */ static readonly AMPLIFY: string; /** * Audio 4-to-6 channel converter ID. */ static readonly AUDIO_4_TO_6_CHANNEL_CONVERTER: string; /** * Balance filter ID. */ static readonly AUDIO_BALANCE: string; /** * Bandpass filter ID. */ static readonly AUDIO_BAND_PASS: string; /** * Bandreject filter ID. */ static readonly AUDIO_BAND_REJECT: string; /** * Bass filter ID. */ static readonly AUDIO_BASS: string; /** * Channel Volume filter ID. */ static readonly AUDIO_CHANNEL_VOLUME: string; /** * Delay filter ID. */ static readonly AUDIO_DELAY: string; /** * Fill Left filter ID. */ static readonly AUDIO_FILL_LEFT: string; /** * Fill Right filter ID. */ static readonly AUDIO_FILL_RIGHT: string; /** * Highpass filter ID. */ static readonly AUDIO_HIGH_PASS: string; /** * Invert filter ID. */ static readonly AUDIO_INVERT: string; /** * Lowpass filter ID. */ static readonly AUDIO_LOW_PASS: string; /** * Mute filter ID. */ static readonly AUDIO_MUTE: string; /** * Parametric EQ filter ID. */ static readonly AUDIO_PARAMETRIC_EQ: string; /** * Swap Channels filter ID. */ static readonly AUDIO_SWAP_CHANNEL: string; /** * Treble filter ID. */ static readonly AUDIO_TREBLE: string; /** * Volume filter ID. */ static readonly AUDIO_VOLUME: string; /** * Auto Click Remover filter ID. */ static readonly AUTO_CLICK_REMOVER: string; /** * Channel Mixer filter ID. */ static readonly CHANNEL_MIXER: string; /** * Dry|Wet Mixer filter ID. */ static readonly DRY_WET_MIXER: string; /** * Dynamics filter ID. */ static readonly DYNAMICS: string; /** * Enhance Audio Mixer filter ID. */ static readonly ENHANCE_AUDIO_MIXER: string; /** * Enhance Speech filter ID. */ static readonly ENHANCE_SPEECH: string; /** * Fast Hard Limiter filter ID. */ static readonly FAST_HARD_LIMITER: string; /** * FFT Filter ID. */ static readonly FFT_FILTER: string; /** * Flanger filter ID. */ static readonly FLANGER: string; /** * Graphic EQ (10 bands) filter ID. */ static readonly GRAPHIC_EQ_10_BANDS: string; /** * Graphic EQ (20 bands) filter ID. */ static readonly GRAPHIC_EQ_20_BANDS: string; /** * Graphic EQ (30 bands) filter ID. */ static readonly GRAPHIC_EQ_30_BANDS: string; /** * Hard Limiter filter ID. */ static readonly HARD_LIMITER: string; /** * Legacy Hard Limiter filter ID. */ static readonly HARD_LIMITER_LEGACY: string; /** * iZotope Analog Delay filter ID. */ static readonly IZOTOPE_ANALOG_DELAY: string; /** * iZotope Chorus|Flanger filter ID. */ static readonly IZOTOPE_CHORUS_FLANGER: string; /** * iZotope Convolution Reverb filter ID. */ static readonly IZOTOPE_CONVOLUTION_REVERB: string; /** * iZotope De-Esser filter ID. */ static readonly IZOTOPE_DE_ESSER: string; /** * iZotope De-Hummer filter ID. */ static readonly IZOTOPE_DE_HUMMER: string; /** * iZotope Distortion filter ID. */ static readonly IZOTOPE_DISTORTION: string; /** * iZotope Guitar Suite filter ID. */ static readonly IZOTOPE_GUITAR_SUITE: string; /** * iZotope Multi-Band Compressor filter ID. */ static readonly IZOTOPE_MULTI_BAND_COMPRESSOR: string; /** * iZotope Phaser filter ID. */ static readonly IZOTOPE_PHASER: string; /** * iZotope Simple Mastering filter ID. */ static readonly IZOTOPE_SIMPLE_MASTERING: string; /** * iZotope Single Band Compressor filter ID. */ static readonly IZOTOPE_SINGLE_BAND_COMPRESSOR: string; /** * iZotope Surround Reverb filter ID. */ static readonly IZOTOPE_SURROUND_REVERB: string; /** * iZotope Tube-Modeled Compressor filter ID. */ static readonly IZOTOPE_TUBE_MODELED_COMPRESSOR: string; /** * iZotope Vocal Enhancer filter ID. */ static readonly IZOTOPE_VOCAL_ENHANCER: string; /** * Latency Generator filter ID. */ static readonly LATENCY_GENERATOR: string; /** * Loudness Meter filter ID. */ static readonly LOUDNESS_METER: string; /** * Multitap Delay filter ID. */ static readonly MULTITAP_DELAY: string; /** * Notch Filter ID. */ static readonly NOTCH_FILTER: string; /** * Parametric Dynamics filter ID. */ static readonly PARAMETRIC_DYNAMICS: string; /** * Parametric EQ filter ID. */ static readonly PARAMETRIC_EQ: string; /** * Pitch Shift filter ID. */ static readonly PITCH_SHIFT: string; /** * Scientific Filter ID. */ static readonly SCIENTIFIC_FILTER: string; /** * Single Band Dynamics filter ID. */ static readonly SINGLE_BAND_DYNAMICS: string; /** * Sliding Window Normalizer filter ID. */ static readonly SLIDING_WINDOW_NORMALIZER: string; /** * Sound Lift filter ID. */ static readonly SOUND_LIFT: string; /** * Spectrum Meter filter ID. */ static readonly SPECTRUM_METER: string; /** * Stereo Expander filter ID. */ static readonly STEREO_EXPANDER: string; /** * Studio Reverb filter ID. */ static readonly STUDIO_REVERB: string; /** * TC Radar Meter component ID. */ static readonly TC_RADAR_METER_COMPONENT: string; } /** * An audio filter */ declare class AudioFilterModule { /** * Cast an object to AudioFilterModule. In case the provided object can be used * as AudioFilterModule a corresponding object is returned. Otherwise an * exception is thrown. * @param object */ static castOrThrow(object: Object): AudioFilterModule; /** * Get whether the filter is internal. */ isInternal(): boolean; /** * Cast an object to AudioFilterModule. In case the provided object can be used * as AudioFilterModule a corresponding object is returned. Otherwise null is * returned. * @param object */ static queryCast(object: Object): AudioFilterModule; } /** * The AudioFilterProcessor object provides methods to apply audio filters to * wave files and to comopare the results against a baseline. */ declare class AudioFilterProcessor { /** * Compare an input file against a baseline and return the maximum difference. * @param input * @param baseline */ static compare(input: WaveFile, baseline: WaveFile): Object; /** * Get the output bus names for an audio filter when applied to the provided * audio channel layout. * @param audioFilter * @param audioChannelLayout */ static getOutputBusNames(audioFilter: string, audioChannelLayout: AudioChannelLayout): any; /** * Get all factory preset names for the specified audio filter. * @param audioFilter */ static getPresetsForAudioFilter(audioFilter: string): any; /** * Is the specified audio channel layout supported by the specified audio * filter? * @param audioChannelLayout * @param audioFilter */ static isAudioChannelLayoutSupportedByAudioFilter(audioChannelLayout: AudioChannelLayout, audioFilter: string): boolean; /** * Apply a specified preset of an audio filter to an input file and write the * result to disk again. * @param audioFilter * @param preset * @param input * @param outputs */ static process(audioFilter: string, preset: string, input: WaveFile, outputs: WaveFile[]): Object; } /** * Scripting methods to the Batch */ declare class Batch { static addEventListener(): any; static dispatchEvent(): any; static removeEventListener(): any; /** * Start listening for batch events. */ static startListening(): boolean; } /** * BatchEncoder event object */ declare class BatchEncoderEvent { /** * Sent when the batch encoder status is changed. */ static readonly EVENT_ENCODER_STATUS_CHANGED: string; /** * Sent when Description message is updated. */ static readonly EVENT_ENCODINGITEM_DESCRIPTION: string; /** * Reflects an sdk error event that has come in pertaining to this batch item * as we surmise. */ static readonly EVENT_ENCODINGITEM_EVENT: string; /** * Send on a progress update for an Item. */ static readonly EVENT_ENCODINGITEM_PROGRESS_UPDATE: string; /** * Sent after a new item starts encoding. */ static readonly EVENT_ENCODINGITEM_STARTED: string; /** * Sent when encoding is complete. */ static readonly EVENT_ENCODING_COMPLETE: string; /** * Sent after a paused item starts encoding. */ static readonly EVENT_ENCODING_PAUSED_ITEM_STARTED: string; /** * A generic progress message that can be sent for operations after encoding * with progress. */ static readonly EVENT_ENCODING_POST_OPERATION_PROGRESS: string; /** * A generic progress message that can be sent for operations before encoding. */ static readonly EVENT_ENCODING_PRE_OPERATION_PROGRESS: string; /** * Sent when Media Info is created. */ static readonly EVENT_MEDIA_INFO_CREATED: string; /** * On encoding completion this indicates whether a source can be moved * otherwise false. */ readonly allowMoveSource: boolean; /** * Return the message related batchitem. Otherwise empty. */ readonly batchItem: any; /** * Get the current event flag for an event message. Zero if unset. */ readonly eventFlag: number; /** * The current progress negative if unknown or invalid (-1). */ readonly progress: number; /** * A text or event message if required by this event. Otherwise empty. */ readonly textMessage: string; static addEventListener(): any; static dispatchEvent(): any; static removeEventListener(): any; } /** * Scripting methods to batch encoder */ declare class BatchEncoderScriptObject { } /** * Batch event object */ declare class BatchEvent { /** * Sent when a batch group is added. */ static readonly BATCH_GROUP_INSERTED: string; /** * Sent when a batch group is removed. */ static readonly BATCH_GROUP_REMOVED: string; /** * Sent when a batch item is added. */ static readonly BATCH_ITEM_INSERTED: string; /** * Sent when a batch item is removed. */ static readonly BATCH_ITEM_REMOVED: string; /** * Return the message related batch. Otherwise empty. */ readonly batchGroupID: string; /** * A text or event message if required by this event. Otherwise empty. */ readonly batchItemID: string; static addEventListener(): any; static dispatchEvent(): any; static removeEventListener(): any; } /** * Scripting methods to the Batch Item Group */ declare class BatchItemGroup { /** * List of all contained BatchItemScriptObjects. */ readonly batchItems: any[]; /** * Progress of complete batch group (calculated from the progress of all * contained batch items) in percent. */ readonly combinedProgress: number; /** * Rendering status of the complete batch group. */ readonly combinedStatus: number; /** * GUID of the batch item group. */ readonly id: string; /** * JSON of all post-processor items of the current batch item group. */ readonly postProcessorItemsJSON: string; /** * JSON of the current source settings. */ readonly sourceInfo: string; } /** * BetaFeature class */ declare class BetaFeature { /** * Feature Flag follows default. */ static readonly FEATURE_FLAG_OVERRIDE_DEFAULT: number; /** * Feature Flag turned off. */ static readonly FEATURE_FLAG_OVERRIDE_OFF: number; /** * Feature Flag turned on. */ static readonly FEATURE_FLAG_OVERRIDE_ON: number; /** * Returns true if the entitlement is set to indicate an internal user. */ static readonly isEntitlementSetToInternalFeaturesAllowed: boolean; /** * Returns true if a beta feature is enabled. * @param featureID */ static isFeatureEnabled(featureID: string): boolean; /** * Check to see if a feature is overridden by Floodgate. If it is then use the * value according to the set floodgate configuration of the feature. If the * feature is not overridden this will fall back on the underlying Beta Feature * value * @param featureID */ static isFeatureEnabledFloodgate(featureID: string): boolean; /** * Set beta feature to enabled | disabled. Returns true if override was set * successfully. * @param featureID */ static setFeatureFlagOverride(featureID: number): boolean; } /** * Defines the boundaries of a window within the screen’s coordinate space, or * of a UI element within the container’s coordinate space. */ declare class Bounds { /** * The vertical coordinate, a pixel offset from the origin of the element's * coordinate space. */ bottom: number; /** * The height in pixels. */ height: number; /** * The horizontal coordinate, a pixel offset from the origin of the element's * coordinate space. */ left: number; /** * The array length. */ readonly length: number; /** * The width in pixels. */ right: number; /** * The height in pixels. */ top: number; /** * The width in pixels. */ width: number; /** * The horizontal coordinate, a pixel offset from the origin of the element's * coordinate space. */ x: number; /** * The vertical coordinate, a pixel offset from the origin of the element's * coordinate space. */ y: number; } /** * A pushbutton element containing a mouse-sensitive text string. */ declare class Button { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * A number of characters for which to reserve space when calculating the * preferred size of the element. * @remarks Range: 0 to … */ characters: number; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help string that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The text justification style. */ justify: string; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The text to display, a localizable string. */ text: string; /** * The element type; "button". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the element has been clicked */ onClick(): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * Represents captioning metadata of caption tracks */ declare class CaptioningMetadata { /** * Returns true if the given CaptioningMetadata is equal to this * CaptioningMetadata object * @param metadata */ equals(metadata: CaptioningMetadata): boolean; } /** * A dual-state control showing a box that has a checkmark when the value is * true, and is empty when the value is false. */ declare class Checkbox { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * A number of characters for which to reserve space when calculating the * preferred size of the element. * @remarks Range: 0 to … */ characters: number; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The default text justification style for child text elements. */ justify: string; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the item * (properties used only when the element is created). */ properties: Object; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The text to display, a localizable string. */ text: string; /** * The element type; "checkbox". */ readonly type: string; /** * The selection state of the control. */ value: boolean; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the element has been * clicked. */ onClick(): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * The ClientInfo object provides information about the application. */ declare class ClientInfo { /** * Application name */ static readonly application: string; /** * True when app is being branded and named as beta-prime */ static readonly betaPrime: boolean; /** * Build number */ static readonly build: string; /** * Client name */ static readonly client: string; /** * Company name */ static readonly company: string; /** * Returns true if running in automation environment */ static readonly isRunningAutomation: boolean; /** * Patch number */ static readonly patch: string; /** * File path to the ScriptingAPIManifest.json resource */ static readonly scriptingAPIManifestPath: string; /** * Scripting host name */ static readonly scriptingHost: string; /** * Version string */ static readonly version: string; /** * Long version string */ static readonly versionInternal: string; /** * Returns the full version string (Major.Minor.Patch.Build) */ static getAppFullVersion(): string; /** * Get Application Location. */ static getAppLocation(): string; /** * Get Application Preference Path */ static getAppPrefPath(): string; } /** * Object containing cluster information from clustering algorithms. */ declare class Clusters { /** * Total number of clusters found. */ readonly numClusters: number; /** * Gets the centroid of a specific cluster. * @param clusterIndex */ centroid(clusterIndex: number): Object; /** * Gets the member indices for a specific cluster. * @param clusterIndex */ memberIndices(clusterIndex: number): any; } /** * Color class */ declare class Color { /** * Read|Write property to get|set alpha value of color object */ alpha: number; /** * Read|Write property to get|set blue value of color object */ blue: number; /** * Read|Write property to get|set green value of color object */ green: number; /** * Read|Write property to get|set red value of color object */ red: number; /** * Construct a Color Object with parameters for Red Green Blue and Alpha values * which are in range [0.0-1.0] * @param Red * @param Green * @param Blue * @param Alpha */ constructor(Red: number, Green: number, Blue: number, Alpha: number); /** * Returns true if the given ColorObject is equal to this ColorObject * @param colorObject */ equals(colorObject: Color): boolean; } /** * ColorProfile class */ declare class ColorProfileObject { /** * Read property to get Profile name */ readonly getProfileName: string; /** * Construct a ColorProfileObject Object from ColorProfile name * @param Name */ constructor(Name: string); /** * Returns true if the given ColorProfileObject is equal to this * ColorProfileObject * @param colorProfileObject */ equals(colorProfileObject: ColorProfileObject): boolean; } /** * ColorSpaceMetaData class */ declare class ColorSpaceMetaDataObject { /** * Read|Write property to get|set DataRangeInfoValid */ dataRangeInfoValid: boolean; /** * Read|Write property to get|set peak luminance */ peakLuminance: number; /** * Construct a ColorSpaceMetaData Object with parameters for PeakLuminance and * DataRangeInfoValid values * @param PeakLuminance * @param DataRangeInfoValid */ constructor(PeakLuminance: number, DataRangeInfoValid: boolean); /** * Returns true if the given ColorSpaceMetaDataObject is equal to this * ColorSpaceMetaDataObject * @param colorSpaceMetaDataObject */ equals(colorSpaceMetaDataObject: ColorSpaceMetaDataObject): boolean; } /** * ColorSpace class */ declare class ColorSpaceObject { /** * Read property to get Profile Type */ readonly getBaseProfileType: number; /** * Read property to get Profile Type */ readonly getIsLinear: boolean; /** * Construct a ColorSpaceObject Object from ColorSpaceObject name * @param ColorSpaceMetaData * @param ColorProfile * @param ColorBaseProfileType * @param IsLinear */ constructor(ColorSpaceMetaData: Object, ColorProfile: Object, ColorBaseProfileType: number, IsLinear: boolean); /** * Returns true if the given ColorProfileObject is equal to this * ColorProfileObject * @param colorProfileObject */ equals(colorProfileObject: ColorProfileObject): boolean; /** * Get ColorProfile Object */ getColorProfile(): Object; /** * Get ColorSpaceMetaData Object */ getColorSpaceMetaData(): Object; } /** * An object represent the dvacore::debug::CodeProfiler mechanism on * ExtendScript. */ declare class CommonDirs { /** * On Windows the directory the app was launched in. On Mac the directory |Contents|MacOS */ static readonly executableDir: string; /** * On Windows the path to the .exe file. On Mac the path to the .app bundle. */ static readonly mainExecutableFile: string; /** * On Windows the directory Plug-ins next to the executable. On Mac the * directory |Contents|Plug-ins. */ static readonly pluginsDir: string; /** * On Windows the directory the app was launched in. On Mac the directory |Contents|Resources */ static readonly resourcesDir: string; } /** * The Console object provides access to the DVA console. */ declare class Console { /** * Executes a console command whose feedback is returned as string. Throws an * error if the command could not be found. * @param command */ static execute(command: string): string; /** * Output on console * @param text * @param lf */ static print(text: string, lf: boolean): boolean; } /** * DebugAssert class provides the ability to log debug asserts in scripting. */ declare class DebugAssert { /** * Get log (as a dictionary object) of all asserts hit during receive period */ static getLog(): any; /** * Start logging all asserts hit during receive period */ static startLog(): boolean; } /** * DebugDatabase class provides access to debug database. */ declare class DebugDatabase { /** * Get value for a key. * @param key */ static get(key: string): string; /** * Get the master list of all debug flags */ static getDebugFlagMasterList(): Object; /** * Gets the default value for an entry * @param key */ static getDefault(key: string): string; /** * Get value for a boolean key(if present) or return given default value * @param key * @param defaultValue */ static getOrDefaultBoolValue(key: string, defaultValue: boolean): boolean; /** * Get value for a key(if present) or return given default value * @param key * @param defaultValue */ static getOrDefaultValue(key: string, defaultValue: string): string; /** * Checks if an entry exists for the given key * @param key */ static hasKey(key: string): boolean; /** * Checks if an entry's value is the default value or not * @param key */ static isDefault(key: string): boolean; /** * Sets a value for a given key in Debug Database. * @param key * @param value */ static set(key: string, value: string): boolean; } /** * DebugMonitor script object */ declare class DebugMonitor { /** * constructor for debug monitor */ constructor(); /** * removes category from opened category list * @param categoryId */ closeCategory(categoryId: string): boolean; /** * Get debug information for an identifier * @param categoryId */ getDebugInformation(categoryId: string): string; /** * Get all the debug categories */ getDebugMonitorCategories(): any; /** * get debug info of opened category of debug monitor */ getOpenedListDebugInfo(): any; /** * inserts category in opened category list * @param categoryId */ openCategory(categoryId: string): boolean; } /** * Defines the size of a window or UI element. Contains a 2-element array. */ declare class Dimension { /** * The height in pixels. */ height: number; /** * The array length. */ readonly length: number; /** * The width in pixels. */ width: number; } /** * Describes an input state at the time of the triggering * ScriptUIGraphics.onDraw() event. */ declare class DrawState { /** * True if the Alt key is being pressed (in Windows only). */ readonly altKeyPressed: boolean; /** * True if the Caps Lock key is being pressed. */ readonly capsLockKeyPressed: boolean; /** * True if the Command key is being pressed (in Mac OS only). */ readonly cmdKeyPressed: boolean; /** * True if the Ctrl key is being pressed. */ readonly ctrlKeyPressed: boolean; /** * True if the element has the input focus. */ readonly hasFocus: boolean; /** * True if the left mouse button is being pressed. */ readonly leftButtonPressed: boolean; /** * True if the middle mouse button is being pressed. */ readonly middleButtonPressed: boolean; /** * True if the cursor is hovering over this element. */ readonly mouseOver: boolean; /** * True if the Num Lock key is being pressed. */ readonly numLockKeyPressed: boolean; /** * True if the Option key is being pressed (in Mac OS only). */ readonly optKeyPressed: boolean; /** * True if the right mouse button is being pressed. */ readonly rightButtonPressed: boolean; /** * True if the Shift key is being pressed. */ readonly shiftKeyPressed: boolean; } /** * Displays a single visible item. When you click the control, a list drops * down or pops up, and allows you to select one of the other items in the * list. */ declare class DropDownList { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The width and height in pixels of each item in the list. */ itemSize: Dimension; /** * The array of choice items displayed in the drop-down or pop-up list. */ readonly items: ListItem[]; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The currently selected list item. */ selection: ListItem; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The element type; "dropdownlist". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Adds an item or separator to the choices in this list. * @param type The type of the child element. * @param text The localizable text label for the item. */ add(type: string, text?: string): ListItem; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Retrieves an item object from the list that has a given text label. * @param text The text string to match. */ find(text: string): ListItem; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the content of the element * has been changed */ onChange(): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Removes a child item from the list. * @param what The item or child to remove, specified by 0-based index, text value, or as a ListItem object. */ remove(what: any): void; /** * Removes all child items from the list. */ removeAll(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * An editable text field that the user can select and change. */ declare class EditText { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * A number of characters for which to reserve space when calculating the * preferred size of the element. * @remarks Range: 0 to … */ characters: number; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The text justification style. */ justify: string; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The current text displayed in the field, a localizable string. */ text: string; /** * The currently selected text, or the empty string if there is no text * selected. */ textselection: string; /** * The element type; "edittext". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the content of the element * has been changed */ onChange(): void; /** * An event-handler callback function, called when the content of the element * is in the process of changing */ onChanging(): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * High level interface object that gives access to the EmbeddingStorage */ declare class EmbeddingStorage { /** * Close the open index for the given scope node and return the number of * closed indexes * @param node */ closeScope(node: Object): any; /** * Get an object representing the embedding storage */ static getInstance(): Object; } /** * Provides several utility methods including batch commands to run, pause or * stop the batch. */ declare class EncoderHostScriptObject { /** * Returns an 'EncoderWrapper' script object for the requested format. * @param inFormatName */ createEncoderForFormat(inFormatName: string): Object; /** * Returns the current status of the batch encoder. The values are: invalid * paused running stopped stopping (available since 23.3). * @param arg1 */ getBatchEncoderStatus(arg1: string): any; /** * Writes out the current batch preview image (tiff format) to the given path. * @param inOutputPath Path to store a 'tiff' file. */ getCurrentBatchPreview(inOutputPath: string): boolean; /** * Returns a list of all available formats. */ getFormatList(): any; /** * Returns a 'SourceMediaInfo' script object which can give detailed info about * the provided source. * @param sourcePath Media path */ getSourceInfo(sourcePath: string): SourceMediaInfo; /** * Returns list of all available formats. */ getSupportedImportFileTypes(): any; /** * Returns true if a batch job is running. */ isBatchRunning(): boolean; /** * Pauses the batch (always returns true). ### Todo: Do we want to return a * result when e.g. the batch was already paused or something went wrong? * @param arg1 */ pauseBatch(arg1: boolean): any; /** * Runs the batch (always returns true). ### Todo: Do we want to return a * result when e.g. the batch was already running or something went wrong? * @param arg1 */ runBatch(arg1: boolean): any; /** * Stops the batch (always returns true). ### Todo: Do we want to return a * result when e.g. the batch was already stopped or something went wrong? * @param arg1 */ stopBatch(arg1: boolean): any; } /** * Provides the following event types for items in the batch queue: * onItemEncodingStarted, onAudioPreEncodeProgress, * onEncodingItemProgressUpdate, onItemEncodeComplete.For multiple batch items * in the queue we recommend to use this event to ensure that the event types * will be received for all batch items.It provides the following event type * for the whole batch queue: onBatchEncoderStatusChanged. */ declare class EncoderHostWrapperEvent { /** * Returns the audio pre-encoding info for the event type * onAudioPreEncodeProgress (available since 24.0). */ readonly audioInfo: string; /** * Returns the audio pre-encoding progress for the event type * onAudioPreEncodeProgress (available since 24.0). */ readonly audioProgress: number; readonly batchEncoderStatus: any; /** * Notify when the audio pre-encode progress changes (available since 24.0). */ static readonly onAudioPreEncodeProgress: string; /** * Notify when the batch encoder status has changed. Get the new status from * the batchEncoderStatus property. (available since 23.3) */ static readonly onBatchEncoderStatusChanged: string; /** * Notify of the batch item encoding progress (available since 23.1). */ static readonly onEncodingItemProgressUpdate: string; /** * Notify when the batch item has been encoded. */ static readonly onItemEncodeComplete: string; /** * Notify when the batch item encoding started (available since 23.1). */ static readonly onItemEncodingStarted: string; /** * Returns the path of the output file. Can be called for onItemEncodingStarted * and onItemEncodeComplete events. */ readonly outputFilePath: string; /** * Returns the encoding progress between 0 and 1. Can be called for * onEncodingItemProgressUpdate event. */ readonly progress: number; /** * Returns the encoding result 'True' or 'False'. Can be called for * onItemEncodeComplete event. */ readonly result: string; /** * Returns the path of the source file. Can be called for onItemEncodingStarted * and onItemEncodeComplete events. */ readonly sourceFilePath: string; static addEventListener(): any; static dispatchEvent(): any; static removeEventListener(): any; } /** * Queue item object to set encode properties */ declare class EncoderWrapper { /** * Gets the list of files the encode generated */ readonly outputFiles: any; /** * Gets the height of the encoded output file */ readonly outputHeight: number; /** * Gets the width of the encoded output file */ readonly outputWidth: number; /** * Toggle the inclusion of source XMP [boolean] input value required * @param includeSourceXMP */ SetIncludeSourceXMP(includeSourceXMP: boolean): boolean; /** * Returns the encode progress as percentage */ getEncodeProgress(): number; /** * Return the encode time in milliseconds */ getEncodeTime(): number; /** * Returns the log output including possible warnings and errors (available * since 23.2.). */ getLogOutput(): string; /** * Returns a list of missing assets * @param includeSource Get missing asset list from the source group if requested * @param includeOutput */ getMissingAssets(includeSource: boolean, includeOutput: boolean): any; /** * Returns the presets available for the assigned format */ getPresetList(): any; /** * Changes the format for the batch item * @param format E.g. 'H.264' Loads all presets available for the assigned format */ loadFormat(format: string): boolean; /** * Loads and assigns the preset to the batch item * @param presetPath */ loadPreset(presetPath: string): boolean; /** * Sets the crop offsets * @param left * @param top * @param right * @param bottom */ setCropOffsets(left: number, top: number, right: number, bottom: number): boolean; /** * Sets the crop state [boolean] input value required * @param cropState */ setCropState(cropState: boolean): boolean; /** * Sets the scale type * @param cropType * @param arg2 * @param arg3 * @param arg4 * @param arg5 * @param arg6 6 StretchToFillBeforeCrop */ setCropType(cropType: any, arg2: any, arg3: any, arg4: any, arg5: any, arg6: number): boolean; /** * Sets the cue point data * @param inCuePointsFilePath */ setCuePointData(inCuePointsFilePath: string): boolean; /** * Sets the frame rate for the batch item * @param framerate E.g. '24' as string */ setFrameRate(framerate: string): boolean; /** * Toggle the inclusion of cue points [boolean] input value required * @param includeSourceCuePoints */ setIncludeSourceCuePoints(includeSourceCuePoints: boolean): boolean; /** * Sets the output frame size * @param width * @param height */ setOutputFrameSize(width: number, height: number): boolean; /** * Sets the rotation (in a 360 degree system) * @param rotationValue E.g. 0.0 - 360.0 */ setRotation(rotationValue: number): boolean; /** * Sets the scale type * @param scaleType * @param arg2 * @param arg3 * @param arg4 * @param arg5 * @param arg6 6 StretchToFillBeforeCrop */ setScaleType(scaleType: any, arg2: any, arg3: any, arg4: any, arg5: any, arg6: number): boolean; /** * Set the time interpolation type * @param interpolationType * @param arg2 2 OpticalFlow */ setTimeInterpolationType(interpolationType: any, arg2: number): boolean; /** * Toggle the use of frame blending [boolean] input value required * @param useFrameBlending */ setUseFrameBlending(useFrameBlending: boolean): boolean; /** * Toggle the use of maximum render quality [boolean] input value required * @param useMaximumRenderQuality */ setUseMaximumRenderQuality(useMaximumRenderQuality: boolean): boolean; /** * Toggle the use of previews files. [boolean] input value required * @param usePreviewFiles */ setUsePreviewFiles(usePreviewFiles: boolean): boolean; /** * Sets the work area type start and end time for the batch item * @param workAreaType * @param arg2 * @param arg3 * @param arg4 4 UseDefault * @param startTime * @param endTime */ setWorkArea(workAreaType: any, arg2: any, arg3: any, arg4: number, startTime: number, endTime: number): boolean; /** * Sets the work area type start and end time in ticks for the batch item * (available since 23.3) * @param workAreaType * @param arg2 * @param arg3 * @param arg4 4 UseDefault * @param startTime * @param endTime */ setWorkAreaInTicks(workAreaType: any, arg2: any, arg3: any, arg4: number, startTime: string, endTime: string): boolean; /** * Sets XMP data to given template * @param templateXMPFilePath */ setXMPData(templateXMPFilePath: string): boolean; } /** * An event to inform of encode progress and completion. */ declare class EncoderWrapperEvent { /** * Returns the audio pre-encoding info for the event type * onAudioPreEncodeProgress (available since 24.0). */ readonly audioInfo: string; /** * Returns the audio pre-encoding progress for the event type * onAudioPreEncodeProgress (available since 24.0). */ readonly audioProgress: string; /** * Notify when the audio pre-encode progress changes (available since 24.0). */ static readonly onAudioPreEncodeProgress: string; /** * Notify when the batch item has been encoded. */ static readonly onEncodeFinished: string; /** * Notify when the batch item encode progress changes. */ static readonly onEncodeProgress: string; /** * Returns the encoding result 'Done!' 'Failed!' or 'Stopped!' for the event * type onEncodeFinished resp. the encoding progress for the event type * onEncodeProgress which is between 0 and 100. */ readonly result: string; static addEventListener(): any; static dispatchEvent(): any; static removeEventListener(): any; } /** * Defines attributes of the ScriptUI environment. */ declare class Environment { /** * An object that reports the active state of the keyboard at any time. */ readonly keyboardState: KeyboardState; } /** * Supports installing and importing Motion Graphics Templates */ declare class EssentialGraphicsUtils { /** * Install a Motion Graphics Template (MOGRT) to the default location. On win * that's e.g. C:\Users\[username]\AppData\Roaming\Adobe\Common\Motion Graphics * Templates . When the argument subFolderPath isn't empty a folder of that * name will be created and the MOGRT will be copied to that folder. * @param sourcePath * @param subFolderPath */ static installMOGRT(sourcePath: string, subFolderPath: string): string; /** * Check if the input Mogrt was authored in AE * @param sourcePath */ static isAEMogrt(sourcePath: string): any; } /** * Base class for UIEvent. */ declare class Event { static readonly AT_TARGET: any; static readonly BUBBLING_PHASE: any; static readonly CAPTURING_PHASE: any; static readonly NOT_DISPATCHING: any; /** * True if the event is of a type that bubbles. */ readonly bubbles: boolean; /** * True if the default action associated with the event can be canceled with * preventDefault(). */ readonly cancelable: boolean; /** * True if this event can be captured. */ readonly captures: boolean; /** * The event target object which is currently handling the event. During * capturing and bubbling, this is different from the property target. */ readonly currentTarget: boolean; /** * The current phase of event propagation; one of none, target, capture, * bubble. */ readonly eventPhase: string; /** * The event target object for this event. */ readonly target: any; /** * The date and time at which the event occurred. */ readonly timeStamp: Date; /** * The name of the event that this object represents. */ readonly type: string; /** * Prevents the default action associated with this event from being called. */ preventDefault(): void; /** * Stops the propagation of this event. */ stopPropagation(): void; } /** * Provides access to objects used in the ScriptUI event system. */ declare class Events { /** * Creates an instance of the specified Event subclass. * @param eventType The name of an event type: one of "UIEvent", "KeyboardEvent", or "MouseEvent". */ createEvent(eventType: string): Event; } /** * The Export Utilities object provides the main access for export utilities. */ declare class ExportFS { /** * Return the last used export folder path. */ readonly getLastExportFolder: string; /** * Return the last used folder path. */ readonly lastSelectedFolder: string; /** * If the file does not exist return filePath otherwise return modified * filePath in order to avoid overwriting the existing file. * @param filePath */ ensureFilepathUniqueness(filePath: string): string; /** * Returns JSON containing significant elements of the path. * @param filePath */ parseFilePath(filePath: string): string; /** * Returns the result of joining two path strings using the platform-dependent * path separator. * @param pathString1 * @param pathString2 */ pathJoin(pathString1: string, pathString2: string): string; /** * Deprecated: Use dvascripting.FileUtils.revealAndSelectFiles instead. * @param filePaths */ revealAndSelectFiles(filePaths: any): boolean; /** * Returns the full path to a selected file * @param defaultDir * @param defaultFileName * @param extension */ saveAsDialog(defaultDir: string, defaultFileName: string, extension: string): string; /** * Returns the full path to a selected file * @param fullPathWithExtension */ saveAsDialogWithFullPath(fullPathWithExtension: string): string; /** * Returns the full path to a selected folder * @param startFolder */ selectFolder(startFolder: string): string; /** * Set and store the last used export folder path. * @param exportFolder */ setlastExportFolder(exportFolder: string): boolean; /** * Returns truncated string if its length exceeds truncationWidth for * endEllipsis and pathEllipsis types truncated part is replaced with an * ellipsis pathEllipsis truncates the middle of the string * @param filePath * @param truncationWidth * @param truncationType */ truncateString(filePath: string, truncationWidth: number, truncationType: string): string; } /** * The ExportMenuManager object provides the main access for export menu (quick * export) settings information and control. */ declare class ExportMenuManager { /** * Returns if the app is running in Export Menu Mode and the Quick Export * Settings are visible. */ readonly isExportMenuRunning: boolean; /** * Returns true if the Match Sequence Preview Settings Feature has been * enabled. */ readonly isMatchSequenceFeatureEnabled: boolean; /** * Get the current Transcoder. */ readonly transcoder: Transcoder; /** * Trigger an export action from the Quick Export. Will return true if the host * application take care of the action. Otherwise the client is responsible for * the action. * @param exportMenuAction * @param inSdmContextGuid */ processExportMenuAction(exportMenuAction: number, inSdmContextGuid: string): boolean; } /** * The ExportModeManager object provides the main access for full export * settings information and control. */ declare class ExportModeManager { /** * Returns a string representing aspect ratio currently selected for source * crop. */ readonly cropAspectRatioSelected: string; /** * Returns a JSON list of strings representing aspect ratio options to select * for source crop. */ readonly cropAspectRatiosList: string; /** * Returns a JSON list of total 4 integer crop boundary values in the order * representing left top right and bottom. */ readonly cropBoundariesList: string; /** * Returns a JSON list of total 2 integers representing X and Y of current crop * center position. */ readonly cropCenter: string; /** * Returns a JSON list of destination categories that should be collapsed in * the view. */ readonly destinationCategoriesCollapsedList: string; /** * Returns a JSON list of destination categories to view categories in order. */ readonly destinationCategoriesList: string; /** * Returns a JSON list of all destinations for an export. */ readonly destinations: string; /** * Returns if the app is running in Export Mode and the full Export Settings * are visible. */ readonly isExportModeRunning: boolean; /** * Returns the index of the currently selected destination. */ readonly selectedDestinationIndex: number; /** * Returns a JSON list of all source selected objects that request an export. */ readonly sourceSelections: string; /** * Get the current Transcoder. */ readonly transcoder: Transcoder; /** * Add a new destination of type destID with destName as custom display name. * @param destID * @param destName */ addDestination(destID: string, destName: string): boolean; /** * Apply source crop with the given aspect ratio. * @param inCropAspectRatioOptionStr */ applyCropAspectRatio(inCropAspectRatioOptionStr: string): boolean; /** * Apply source crop with the given pixels for the given direction. * @param inDirection * @param inPixelsToCrop */ applyCropBoundary(inDirection: number, inPixelsToCrop: number): boolean; /** * Adjust crop such that crop horizontal center is at the given center * position. * @param inCenterX */ applyCropCenterX(inCenterX: number): boolean; /** * Adjust crop such that crop vertical center is at the given center position. * @param inCenterY */ applyCropCenterY(inCenterY: number): boolean; /** * Delete a destination. * @param destID * @param groupIndex */ deleteDestination(destID: string, groupIndex: number): boolean; /** * Disable crop and reset crop parameters in standard filter. */ disableAndResetCrop(): boolean; /** * Trigger an export action from the Export Mode. Will return true if the host * application take care of the action. Otherwise the client is responsible for * the action. * @param exportModeAction * @param inSdmContextGuid */ processExportModeAction(exportModeAction: number, inSdmContextGuid: string): boolean; /** * Rename a destination. * @param destID * @param groupIndex * @param destDisplayName */ renameDestination(destID: string, groupIndex: number, destDisplayName: string): boolean; /** * Restore default destinations */ restoreDefaultDestinations(): boolean; /** * Select a new destination. * @param destID * @param groupIndex */ selectDestination(destID: string, groupIndex: number): boolean; /** * Should export a destination. * @param destID * @param groupIndex * @param shouldExport */ shouldExportDestination(destID: string, groupIndex: number, shouldExport: boolean): boolean; /** * Toggle the given category as collapsed vs expanded in the local set that * tracks collapsed export destination categories. * @param inDestinationCategory */ toggleDestinationCategory(inDestinationCategory: string): boolean; } /** * The ExportPreset object provides the main access for export settings * information in a export preset. */ declare class ExportPreset { /** * The display name of the preset. */ readonly displayName: string; /** * The fullpath to the presetfile. */ readonly filePath: string; /** * The folder display path of the preset. */ readonly folderDisplayPath: string; /** * Returns true|false if the preset is an ingest preset. */ readonly isIngestPreset: boolean; /** * The search match name of the preset. */ readonly matchName: string; /** * Returns the Menu Preset summary for this preset. */ readonly presetSummaryJSON: string; /** * The unique ID of the preset. */ readonly uniqueID: string; /** * User-provided comments for the preset. */ readonly userComments: string; /** * The comments of the preset as loc string or resolved. * @param resolveZString */ comments(resolveZString: boolean): string; } /** * The ExportPresetManager object provides the main access for export settings * information and control. */ declare class ExportPresetManager { /** * Returns list of all presets that should be displayed in the preset menu list * (Format independent). */ readonly favoritePresetList: any[]; /** * Import presets */ readonly importPresets: any; /** * Returns true if the preset manager has been enabled by a debug console flag */ readonly isPresetManagerEnabled: boolean; /** * Returns list of recent used presets that should be displayed in the preset * menu list (Format independent). */ readonly recentPresetList: any[]; /** * Returns list of all unsupported formats. */ readonly unsupportedFormatList: any; /** * Returns list of known unsupported preset names. */ readonly unsupportedPresetNameList: any; /** * Returns list of all user presets. */ readonly userPresetList: any; /** * Deletes custom presets * @param presetIDs */ deletePresets(presetIDs: any): Object; /** * Export presets * @param exportPresetsJSON */ exportPresets(exportPresetsJSON: string): boolean; /** * Returns the Menu Preset summary for this presetID. * @param presetID * @param filePath */ presetSummaryJSON(presetID: string, filePath: string): string; /** * Request active preset to be changed. * @param presetToBeSetAsActive */ requestActivePresetChange(presetToBeSetAsActive: string): boolean; /** * Save the favorite JSON string to a dva shared preference file. * @param presetsJSON */ saveFavoritePresetsJSON(presetsJSON: string): boolean; } /** * The ExportSettings object provides the main access for export settings * information and control. */ declare class ExportSettings { /** * Export Settings popup separator identifier. */ static readonly CONST_POPUP_SEPARATOR: string; /** * Get the Export Menu Manager that manages the Quick Export Settings. */ static readonly exportMenuManager: ExportMenuManager; /** * Get the Export Mode Manager that manages the full Export Settings. */ static readonly exportModeManager: ExportModeManager; /** * Returns list of all available export formats. */ static readonly formatNameList: any; /** * Get the export filesystem to access export related file functionality. */ static readonly fs: ExportFS; /** * Get the Preset Manager that manages all the presets. */ static readonly presetManager: ExportPresetManager; /** * Returns list of all presets for one export format. * @param formatName */ static presetFormatList(formatName: string): any[]; } /** * Contains several encoding methods. You can listen to different types of the * AMEExportEvent: onEncodeComplete, onError, onMediaInfoCreated, * onBatchItemStatusChanged, onItemEncodingStarted, * onEncodingItemProgressUpdated, onAudioPreEncodeProgress, * onPostProcessListInitialized */ declare class ExporterScriptObject { /** * Returns the encode time in milliseconds. */ readonly elapsedMilliseconds: number; readonly encodeID: any; readonly encodeSuccess: any; /** * Export the source with the provided list of presets. Returns true in case of * success. * @param sourcePath Media path (Premiere Pro projects aren't supported). * @param outputPath If outputPath is empty, then the output file location will be generated based on the source location. * @param presetsPath Multiple preset paths can be provided separated via a | (e.g. 'path1|path2|path3' * @param matchSource Optional. Default value is false */ exportGroup(sourcePath: string, outputPath: string, presetsPath: string, matchSource?: boolean): boolean; /** * Export the source with the provided preset. Returns an EncoderWrapper * object. * @param sourcePath Media path or Premiere Pro project path (In case of a Premiere Pro project the last sequence will be used). * @param outputPath If outputPath is empty, then the output file location will be generated based on the source location. * @param presetPath * @param matchSource Optional. Default value is false * @param writeFramesToDisk Optional. Default value is false. True writes five frames at 0% * @param arg7 * @param arg8 75% and 100% of the full duration. Known issue, Currently it only works with parallel encoding disabled. */ exportItem(sourcePath: string, outputPath: string, presetPath: string, matchSource?: boolean, writeFramesToDisk?: any, arg7?: any, arg8?: boolean): EncoderWrapper; /** * Export the Premiere Pro sequence with the provided preset. Returns true in * case of success. * @param projectPath Premiere Pro project path. * @param outputPath If outputPath is empty, then the output file location will be generated based on the source location. * @param presetPath * @param matchSource Optional. Default value is false. * @param writeFramesToDisk Optional. Default value is false. True writes five frames at 0% * @param arg7 * @param arg8 75% and 100% of the full duration. Known issue, Currently it only works with parallel encoding disabled. * @param leadingFramesToTrim Optional. Default value is 0. * @param trailingFramesToTrim Optional. Default value is 0. * @param sequenceName Optional. If sequence name is empty then we use the last sequence of the project. */ exportSequence(projectPath: string, outputPath: string, presetPath: string, matchSource?: boolean, writeFramesToDisk?: any, arg7?: any, arg8?: boolean, leadingFramesToTrim?: number, trailingFramesToTrim?: number, sequenceName?: string): boolean; /** * Returns a SourceMediaInfo object. * @param sourcePath */ getSourceMediaInfo(sourcePath: string): SourceMediaInfo; /** * Remove all batch items from the queue. Returns true in case of success. * @param arg1 */ removeAllBatchItems(arg1: boolean): any; /** * Smart render the source with the provided preset. Returns true in case of * success. * @param sourcePath Media path or Premiere Pro project path (In case of a Premiere Pro project the last sequence will be used). * @param outputPath If outputPath is empty, then the output file location will be generated based on the source location. * @param presetPath * @param matchSource Optional. Default value is false. * @param writeFramesToDisk Optional. Default value is false. True writes five frames at 0% * @param arg7 * @param arg8 75% and 100% of the full duration. Known issue, Currently it only works with parallel encoding disabled. * @param leadingFramesToTrim Optional. Default value is 0. * @param trailingFramesToTrim Optional. Default value is 0. */ trimExportForSR(sourcePath: string, outputPath: string, presetPath: string, matchSource?: boolean, writeFramesToDisk?: any, arg7?: any, arg8?: boolean, leadingFramesToTrim?: number, trailingFramesToTrim?: number): boolean; } /** * Represents a file in the local file system in a platform-independent manner. */ declare class File { /** * The full path name for the referenced file in URI notation. */ readonly absoluteURI: string; /** * If true, the object refers to a file system alias or shortcut. */ readonly alias: boolean; /** * The creation date of the referenced file, or null if the object does not * refer to a file on disk. */ readonly created: Date; /** * In Mac OS, the file creator as a four-character string. In Windows or UNIX, * value is "????". */ readonly creator: string; /** * The localized name of the referenced file, without the path specification. */ readonly displayName: string; /** * Gets or sets the encoding for subsequent read/write operations. */ encoding: string; /** * When true, a read attempt caused the current position to be at the end of * the file, or the file is not open. */ readonly eof: boolean; /** * A string containing a message describing the most recent file system error. */ error: string; /** * If true, this object refers to a file or file-system alias that actually * exists in the file system. */ readonly exists: boolean; /** * The name of the file system. */ static readonly fs: string; /** * The platform-specific full path name for the referenced file. */ readonly fsName: string; /** * The full path name for the referenced file in URI notation. */ readonly fullName: string; /** * When true, the file is not shown in the platform-specific file browser. */ hidden: boolean; /** * The size of the file in bytes. */ length: number; /** * How line feed characters are written in the file system. */ lineFeed: string; /** * The date of the referenced file's last modification, or null if the object * does not refer to a file on the disk. */ readonly modified: Date; /** * The file name portion of the absolute URI for the referenced file, without * the path specification. */ readonly name: string; /** * The Folder object for the folder that contains this file. */ readonly parent: Folder; /** * The path portion of the absolute URI for the referenced file, without the * file name. */ readonly path: string; /** * When true, prevents the file from being altered or deleted. */ readonly: boolean; /** * The path name for the object in URI notation, relative to the current * folder. */ readonly relativeURI: string; /** * The file type as a four-character string. */ readonly type: string; /** * Creates and returns a new File object referring to a given file system * location. * @param path The full or partial path name of the file, in platform-specific or URI format. */ constructor(path?: string); /** * Changes the path specification of the referenced file. * @param path A string containing the new path, absolute or relative to the current folder. */ changePath(path: string): boolean; /** * Closes this open file. */ close(): boolean; /** * Copies this object’s referenced file to the specified target location. * @param target A string with the URI path to the target location, or a File object that references the target location. */ copy(target: string | File): boolean; /** * Makes this file a file-system alias or shortcut to the specified file. * @param path A string containing the path of the target file. */ createAlias(path: string): void; /** * Decodes a UTF-8 encoded string as required by RFC 2396, and returns the * decoded string. * @param uri The UTF-8 encoded string to decode. */ static decode(uri: string): string; /** * Encodes a string as required by RFC 2396, and returns the encoded string. * @param name The string to encode. */ static encode(name: string): string; /** * Executes or opens this file using the appropriate application, as if it had * been double-clicked in a file browser. */ execute(): boolean; /** * Retrieves and returns the path for this file, relative to the specified base * path, in URI notation. * @param basePath A base path in URI notation. */ getRelativeURI(basePath: string): string; /** * Reports whether a given encoding is available. * @param name The encoding name. */ static isEncodingAvailable(name: string): boolean; /** * Opens the referenced file for subsequent read/write operations. The method * resolves any aliases to find the file. * @param mode The read-write mode, a single-character string. * @param type In Mac OS, the type of a newly created file, a 4-character string. Ignored in Windows and UNIX. * @param creator In Mac OS, the creator of a newly created file, a 4-character string. Ignored in Windows and UNIX. */ open(mode: string, type?: string, creator?: string): boolean; /** * Opens a dialog so the user can select one or more files to open. * @param prompt The prompt text, displayed if the dialog allows a prompt. * @param filter A filter that limits the types of files displayed in the dialog. * @param multiSelect When true, the user can select multiple files and the return value is an array. */ static openDialog(prompt: string, filter?: any, multiSelect?: boolean): File; /** * Opens the built-in platform-specific file-browsing dialog, in which the user * can select an existing file or files, and creates new File objects to * represent the selected files. * @param prompt A string containing the prompt text, if the dialog allows a prompt. * @param filter A filter that limits the types of files displayed in the dialog. * @param multiSelect When true, the user can select multiple files and the return value is an array. */ openDlg(prompt: string, filter?: any, multiSelect?: boolean): File; /** * Reads the contents of the file, starting at the current position. * @param chars An integer specifying the number of characters to read. */ read(chars?: number): string; /** * Reads a single text character from the file at the current position. */ readch(): string; /** * Reads a single line of text from the file at the current position. */ readln(): string; /** * Deletes the file associated with this object from disk immediately, without * moving it to the system trash. */ remove(): boolean; /** * Renames the associated file. * @param newName The new file name, with no path information. */ rename(newName: string): boolean; /** * Attempts to resolve the file-system alias or shortcut that this object * refers to. */ resolve(): File; /** * Opens a dialog so the user can select a file name to save to. * @param prompt The prompt text, displayed if the dialog allows a prompt. * @param filter In Windows only, a filter that limits the types of files displayed in the dialog. */ static saveDialog(prompt: string, filter?: any): File; /** * Opens the built-in platform-specific file-browsing dialog, in which the user * can select an existing file location to which to save information, and * creates a new File object to represent the selected file. * @param prompt A string containing the prompt text, if the dialog allows a prompt. * @param filter In Windows only, a filter that limits the types of files displayed in the dialog. */ saveDlg(prompt: string, filter?: any): File; /** * Seeks to a given position in the file. * @param pos The new current position in the file as an offset in bytes from the start, current position, or end, depending on the mode. * @param mode The seek mode. */ seek(pos: number, mode?: number): boolean; /** * Retrieves the current position as a byte offset from the start of the file. */ tell(): number; /** * Creates and returns a serialized string representation of this object. */ toSource(): string; /** * Converts this object to a string. */ toString(): string; /** * Writes the specified text to the file at the current position. * @param text A text string to be written. */ write(text: string): boolean; /** * Writes a string to the file at the current position and appends a line-feed * sequence. * @param text A text string to be written. */ writeln(text: string): boolean; } /** * A filter (audio/video) of a project */ declare class FilterModule { /** * Returns the display name for the filter */ readonly displayName: string; /** * Returns the internal matchname for the filter */ readonly matchName: string; /** * Returns the media type guid for the filter object */ readonly mediaType: any; /** * Cast an object to FilterModule. In case the provided object can be used as * FilterModule a corresponding object is returned. Otherwise an exception is * thrown. * @param object */ static castOrThrow(object: Object): FilterModule; /** * Cast an object to FilterModule. In case the provided object can be used as * FilterModule a corresponding object is returned. Otherwise null is returned. * @param object */ static queryCast(object: Object): FilterModule; } /** * A control that contains a Flash Player, which can load and play Flash movies * stored in SWF files. */ declare class FlashPlayer { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * True if this element is enabled. */ enabled: boolean; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The current dimensions of this element. */ size: Dimension; /** * The element type, "flashplayer". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * A function definition for a callback from the Flash ActionScript * environment. */ callback(): void; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * Invokes an ActionScript function defined in the Flash application. * @param name The name of a Flash ActionScript function that has been registered with the ExternalInterface object by the currently loaded SWF file. * @param argument An argument to pass through to the function. */ invokePlayerFunction(name: string, argument?: any): any; /** * Loads a movie into the Flash Player, and begins playing it. * @param file The File object for the SWF file to load. */ loadMovie(file: File): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * Restarts a movie that has been stopped. * @param rewind When true, restarts the movie from the beginning; otherwise, starts playing from the point where it was stopped. */ playMovie(rewind: boolean): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; /** * Halts playback of the current movie. */ stopMovie(): void; } /** * Represents a file-system folder or directory in a platform-independent * manner. */ declare class Folder { /** * The full path name for the referenced folder in URI notation. */ readonly absoluteURI: string; /** * When true, the object refers to a file system alias or shortcut. */ readonly alias: boolean; /** * The folder containing the application data for all users. */ static readonly appData: Folder; /** * In Mac OS, a Folder object for the folder containing the bundle of the * running application. */ static readonly appPackage: Folder; /** * A Folder object for the folder containing common files for all programs * installed by the user. */ static readonly commonFiles: Folder; /** * The creation date of the referenced folder, or null if the object does not * refer to a folder on disk. */ readonly created: Date; /** * A Folder object for the current folder. */ static current: Folder; /** * A Folder object for the folder that contains the user’s desktop. */ static readonly desktop: Folder; /** * The localized name portion of the absolute URI for the referenced folder, * without the path specification. */ readonly displayName: string; /** * A message describing the most recent file system error. */ error: string; /** * When true, this object refers to a folder that currently exists in the file * system. */ readonly exists: boolean; /** * The name of the current file system. */ static readonly fs: string; /** * The platform-specific name of the referenced folder as a full path name. */ readonly fsName: string; /** * The full path name for the referenced folder in URI notation. . */ readonly fullName: string; /** * The date of the referenced folder's last modification, or null if the object * does not refer to a folder on disk. */ readonly modified: Date; /** * A folder pointing to the user's My Documents folder. */ static readonly myDocuments: Folder; /** * The folder name portion of the absolute URI for the referenced file, without * the path specification. */ readonly name: string; /** * TThe Folder object for the folder that contains this folder, or null if this * object refers to the root folder of a volume. */ readonly parent: Folder; /** * The path portion of the object absolute URI for the referenced file, without * the folder name. */ readonly path: string; /** * The path name for the referenced folder in URI notation, relative to the * current folder. */ readonly relativeURI: string; /** * A Folder object for the folder containing the executable image of the * running application. */ static readonly startup: Folder; /** * A Folder object for the folder containing the operating system files. */ static readonly system: Folder; /** * A Folder object for the default folder for temporary files. */ static readonly temp: Folder; /** * A Folder object for the folder containing deleted items. On Windows, the * trash folder is a virtual folder containing a database; therefore, the * property value is null on Windows. */ static readonly trash: Folder; /** * A Folder object for the folder containing the user's application data. */ static readonly userData: Folder; /** * Creates and returns a new Folder object referring to a given file-system * location. * @param path The absolute or relative path to the folder associated with this object, specified in URI format. */ constructor(path?: string); /** * Changes the path specification of the referenced folder. * @param path A string containing the new path, absolute or relative to the current folder. */ changePath(path: string): boolean; /** * Creates a folder at the location given by this object's path property. */ create(): boolean; /** * Decodes a UTF-8 encoded string as required by RFC 2396, and returns the * decoded string. * @param uri The UTF-8 string to decode. */ static decode(uri: string): string; /** * Encodes a string as required by RFC 2396, and returns the encoded string. * @param name The string to encode. */ static encode(name: string): string; /** * Opens this folder in the platform-specific file browser (as if it had been * double-clicked in the file browser). */ execute(): boolean; /** * Retrieves the contents of this folder, filtered by the supplied mask. * @param mask A search mask for file names, specified as a string or a function. */ getFiles(mask: any): any[]; /** * Retrieves and returns the path for this file, relative to the specified base * path, in URI notation. * @param basePath A base path in URI notation. */ getRelativeURI(basePath?: string): string; /** * Reports whether a given encoding is available. * @param name The encoding name. */ static isEncodingAvailable(name: string): boolean; /** * Deletes the folder associated with this object from disk immediately, * without moving it to the system trash. */ remove(): boolean; /** * Renames the associated folder. * @param newName The new folder name, with no path information. */ rename(newName: string): boolean; /** * Attempts to resolve the file-system alias or shortcut that this object * refers to. */ resolve(): Folder; /** * Opens the built-in platform-specific file-browsing dialog, and creates a new * File or Folder object for the selected file or folder. * @param prompt The prompt text, if the dialog allows a prompt. */ static selectDialog(prompt: string): Folder; /** * Opens the built-in platform-specific file-browsing dialog, and creates a new * File or Folder object for the selected file or folder. * @param prompt The prompt text, if the dialog allows a prompt. */ selectDlg(prompt: string): Folder; /** * Creates and returns a serialized string representation of this object. */ toSource(): string; /** * Converts this object to a string. */ toString(): string; } /** * FrameRate class */ declare class FrameRate { /** * Read|Write property to get|set ticks per frame. */ ticksPerFrame: number; /** * Get the number of frames per second. */ readonly value: number; /** * Constructs a FrameRateObject object */ constructor(); /** * Create frame rate object with a value * @param value */ static createWithValue(value: number): FrameRate; /** * Returns true if the given FrameRate is equal to this FrameRate object * @param frameRate */ equals(frameRate: FrameRate): boolean; } /** * Scripting methods to the frontend */ declare class FrontendScriptObject { /** * Adds the first comp of an After Effects project resp. the first sequence of * a Premiere Pro project to the batch. * @param compPath Path to e.g. an After Effects project or Premiere Pro project. The first comp resp. sequence will be used. * @param presetPath Optional. If presetPath is empty, then the default preset will be applied. * @param outputPath Optional. If outputPath is empty, then the output file name will be generated based on the comp path. */ addCompToBatch(compPath: string, presetPath?: string, outputPath?: string): boolean; /** * Adds e.g. an After Effects comp or Premiere Pro sequence to the batch and * returns an EncoderWrapper object. * @param projectPath E.g. Premiere Pro or After Effects project path. * @param format E.g. 'H.264' * @param presetPath Either a preset or a format input must be present. If no preset is used then the default preset of the specified format will be applied. * @param guid The unique id of e.g. a Premiere Pro sequence or After Effects composition. * @param outputPath Optional. If outputPath is empty, then the output file name will be generated based on the project path. */ addDLToBatch(projectPath: string, format: string, presetPath: string, guid: string, outputPath?: string): Object; /** * Adds an image sequence to the batch. The images will be sorted in * alphabetical order. * @param containingFolder The folder containing image files. * @param imagePath All images from the containing folder with the same extension will be added to the output file. * @param presetPath * @param outputPath Optional. If outputPath is empty, then the output file name will be generated based on the containingFolder name */ addFileSequenceToBatch(containingFolder: string, imagePath: string, presetPath: string, outputPath?: string): boolean; /** * Adds a file to the batch and returns an EncoderWrapper object. * @param filePath File path of a media source. * @param format E.g. 'H.264' * @param presetPath Either a preset or a format input must be present. If no preset is used then the default preset of the specified format will be applied. * @param outputPath Optional. If outputPath is empty, then the output file name will be generated based on the file path. */ addFileToBatch(filePath: string, format: string, presetPath: string, outputPath?: string): Object; /** * Adds a media source to the batch. * @param sourcePath Path of the media source. */ addItemToBatch(sourcePath: string): boolean; /** * Adds a team project item to the batch and returns an EncoderWrapper object. * @param projectsURL Team Projects URL or Team Projects Snap. You can create a tp2snap file in PPro for a ProjectItem via the scripting API saveProjectSnapshot. * @param format E.g. 'H.264' * @param presetPath Either a preset or a format input must be present. If no preset is used then the default preset of the specified format will be applied. * @param outputPath */ addTeamProjectsItemToBatch(projectsURL: string, format: string, presetPath: string, outputPath: string): Object; /** * Adds Final Cut Pro xml to the batch. * @param xmlPath Path to a Final Cut Pro xml file. * @param presetPath * @param outputFolderPath Optional. If outputFolderPath is empty, then the output file name will be generated based on the XML file path. */ addXMLToBatch(xmlPath: string, presetPath: string, outputFolderPath?: string): boolean; /** * Returns the list of GUIDs for objects (sequences|comps) at the top|root * level. * @param projectPath E.g. Premiere Pro or After Effects project path. */ getDLItemsAtRoot(projectPath: string): any; /** * Adds a batch item for the given media and returns an EncoderWrapper object. * @param mediaPaths Semicolon delimited list of media paths. * @param format E.g. 'H.264' * @param presetPath Either a preset or a format input must be present. If no preset is used then the default preset of the specified format will be applied. * @param outputPath */ stitchFiles(mediaPaths: string, format: string, presetPath: string, outputPath: string): Object; /** * Stops the batch. */ stopBatch(): boolean; } /** * This provides the utility to access Gen extend job */ declare class GenExtend { /** * Creates a GenExtend object */ constructor(); /** * Appends the short-side GenExtend sub-actions for resizing the given * transition to span [newStart newEnd] into the caller's compound action * without executing it (the backend the effect-controls trim|slide entry point * uses). Must be called with the backend upgrade lock already held (e.g. * inside executeNonUndoableTransaction|scopeBackendAccess). Returns an opaque * params handle to pass to dispatchGenExtendExtensionsAsync after the compound * action executes * @param sequence * @param transitiontrackitem * @param newstart * @param newend * @param compoundaction */ static appendGenExtendTransitionDurationChangeMissingFramesAction(sequence: Object, transitiontrackitem: Object, newstart: Object, newend: Object, compoundaction: Object): Object; /** * Appends the GenExtend missing-frames sub-actions for the transition at the * given cut into the caller's compound action without executing it. Must be * called with the backend upgrade lock already held (e.g. inside * executeNonUndoableTransaction|scopeBackendAccess). Returns an opaque params * handle to pass to dispatchGenExtendExtensionsAsync after the compound action * executes * @param sequence * @param mediatype * @param trackindex * @param editpoint * @param compoundaction */ static appendGenExtendTransitionMissingFramesAction(sequence: Object, mediatype: Object, trackindex: number, editpoint: Object, compoundaction: Object): Object; /** * Generate the missing frames on both sides of the given transition same as * the Generate Missing Frames command; returns the dispatched jobs (empty when * there was nothing to generate) * @param transitiontrackitem * @param sequence */ static applyGenExtendTransitionMissingFrames(transitiontrackitem: Object, sequence: Object): any[]; /** * Whether the given committed transition qualifies for GenExtend * missing-frames generation * @param transitiontrackitem * @param sequence */ static canGenExtendTransition(transitiontrackitem: Object, sequence: Object): boolean; /** * Whether the given transition is GenExtend-eligible when resized to span * [newStart newEnd] (the same eligibility query the effect-controls trim|slide * path uses): true when every short side is fully satisfiable by generated * frames * @param transitiontrackitem * @param sequence * @param newstart * @param newend */ static canGenExtendTransitionForDurationChange(transitiontrackitem: Object, sequence: Object, newstart: Object, newend: Object): boolean; /** * Check for pre validation errors * @param audiotrackitem * @param videotrackitem * @param deltatime * @param isbackwarddirection */ static checkPrevalidation(audiotrackitem: Object, videotrackitem: Object, deltatime: Object, isbackwarddirection: boolean): any; /** * Create Job for Generative Extend * @param sequence * @param trackitem * @param deltatime * @param isbackwarddirection */ static createGenExtendJob(sequence: Object, trackitem: Object, deltatime: Object, isbackwarddirection: boolean): any[]; /** * Dispatches the async generation jobs for the params returned by * appendGenExtendTransitionMissingFramesAction once the compound action has * committed. Returns the dispatched jobs (empty when there was nothing to * generate) * @param genextendparams */ static dispatchGenExtendExtensionsAsync(genextendparams: Object): any[]; /** * Regenerate extension * @param sequence * @param trackitem * @param isbackwarddirection */ static regenerateExtension(sequence: Object, trackitem: Object, isbackwarddirection: boolean): any[]; /** * Revert To Original * @param sequence * @param trackitem */ static revertToOriginal(sequence: Object, trackitem: Object): boolean; } /** * This provides the utility for Gen Extend Job */ declare class GenExtendJob { /** * Creates a GenExtend Job object */ constructor(); /** * Gets the error message for Generative Extend job failure */ getGenExtendJobErrorMessage(): string; /** * Gets the progress item for Generative Extend Job */ getGenExtendJobProgress(): Object; } /** * Opaque handle for GenExtend params pending dispatch, produced by * GenExtend.appendGenExtendTransitionMissingFramesAction */ declare class GenExtendParams { /** * Holds GenExtend params pending dispatch */ constructor(); /** * True when there was nothing to generate (neither side needed frames) */ isEmpty(): boolean; } /** * Scripting bridge for Generative Music job submission and result inspection */ declare class GenMusic { /** * Creates a GenMusic object */ constructor(); /** * Trigger a Generative Music job for the given range on an audio track * @param sequence * @param targettrack * @param starttime * @param durationseconds * @param prompt * @param beatsperminute * @param loop */ static createGenMusicJob(sequence: Object, targettrack: Object, starttime: Object, durationseconds: number, prompt: string, beatsperminute: number, loop: boolean): boolean; /** * Trigger a Generative Music job using the video clip above the range as * reference (Beta) * @param sequence * @param targettrack * @param starttime * @param durationseconds * @param prompt * @param beatsperminute * @param loop */ static createGenMusicJobUnderVideo(sequence: Object, targettrack: Object, starttime: Object, durationseconds: number, prompt: string, beatsperminute: number, loop: boolean): boolean; /** * AI-enhance the prompt text (blocked: kGenMusic not yet in * GenTypeHasPromptEnhance) * @param prompt * @param expansionenabled */ static enhancePrompt(prompt: string, expansionenabled: boolean): string; /** * Returns the active variation index (0-3) from TrackItemChainHistory * @param trackitem */ static getActiveVariationIndex(trackitem: Object): number; /** * Returns the channel format of the generated compound clip's audio (e.g. * "Stereo") * @param trackitem */ static getClipChannelFormat(trackitem: Object): string; /** * Returns mLoop from the master clip's persisted MusicGenerationParams JSON * @param trackitem */ static getClipLoopMode(trackitem: Object): boolean; /** * Returns the sample rate in Hz of the generated compound clip's audio * @param trackitem */ static getClipSampleRate(trackitem: Object): number; /** * Scans the audio track at starttime for an online compound clip; returns it * when generation is complete * @param sequence * @param targettrack * @param starttime */ static getGeneratedTrackItem(sequence: Object, targettrack: Object, starttime: Object): any[]; /** * Returns the total variation count from VariationGroupMetadata * @param trackitem */ static getVariationCount(trackitem: Object): number; /** * Generate a music prompt suggestion from a local video file path via Firefly * |v3|prompts|suggest * @param videofilepath */ static getVideoPromptSuggestion(videofilepath: string): string; /** * Re-submit a Generative Music job targeting an existing compound clip * @param sequence * @param existingtrackitem * @param prompt * @param beatsperminute * @param loop */ static regenerateGenMusicJob(sequence: Object, existingtrackitem: Object, prompt: string, beatsperminute: number, loop: boolean): boolean; /** * Swap the active variation (0-3) of the compound track item * @param sequence * @param trackitem * @param variationindex */ static selectVariation(sequence: Object, trackitem: Object, variationindex: number): boolean; } /** * Utility to invoke prompt-based Generate Sound Effects */ declare class GenSFx { /** * Creates a GenSFx object */ constructor(); /** * Runs prompt-based Generate Sound Effects directly on the sequence bypassing * the CTB.Returns a status string ('ok' on dispatch); the generated audio * lands asynchronouslyreplacing the offline placeholder that appears over the * range. * @param inSequence * @param inPrompt * @param inStartSeconds * @param inDurationSeconds */ static generate(inSequence: Sequence, inPrompt: string, inStartSeconds: number, inDurationSeconds: number): string; } /** * A container for other controls within a window. */ declare class Group { /** * Tells the layout manager how unlike-sized children of this container should * be aligned within a column or row. */ alignChildren: string; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The layout manager for this container. */ layout: LayoutManager; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The number of pixels between the edges of a container and the outermost * child elements. */ margins: number; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The layout orientation of children in a container. */ orientation: string; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the control * (properties used only when the element is created). */ properties: Object; /** * The current dimensions of this element. */ size: Dimension; /** * The number of pixels separating one child element from its adjacent sibling * element. */ spacing: number; /** * The element type; "group". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Adds a child element to this container. * @param type The type of the child element, as specified for the type property. * @param bounds A bounds specification that describes the size and position of the new control or container, relative to its parent. * @param text The text or label, a localizable string. * @param properties An object that contains one or more creation properties of the new child (properties used only when the element is created). */ add(type: string, bounds?: Bounds, text?: string, properties?: Object): any; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * An event-handler callback function, called when the group is about to be * drawn. */ onDraw(): void; /** * Removes the specified child control from this group's children array. * @param what The child control to remove, specified by 0-based index, text property value, or as a control object. */ remove(what: any): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * A random GUID */ declare class Guid { /** * constructor for empty guid */ constructor(); /** * Create a unique guid */ static createUnique(): Guid; /** * Returnes true if the content of this GUID is equal to the given GUID object * @param Guid */ equals(Guid: Object): boolean; /** * Create a guid from a string * @param stringValue */ static fromString(stringValue: string): Guid; /** * Return string representation of the GUID */ toString(): string; } /** * A mouse-sensitive pushbutton that displays an image instead of text. */ declare class IconButton { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The image object that defines the image to be drawn. */ image: ScriptUIImage; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The element type; "iconbutton". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the element has been * clicked. */ onClick(): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * Reports the active state of the keyboard. */ declare class KeyboardState { /** * True if the Alt or Option key is pressed. */ readonly altKey: boolean; /** * True if the Ctrl key is pressed. */ readonly ctrlKey: boolean; /** * A string containing the name of the currently pressed key, such as "a", or * an empty string. */ readonly keyName: string; /** * True if the Cmd key (in Mac OS) or Windows key (in Windows) is pressed. */ readonly metaKey: boolean; /** * True if the Shift key is pressed. */ readonly shiftKey: boolean; } /** * Controls the automatic layout behavior for a window or container. */ declare class LayoutManager { /** * Invokes the automatic layout behavior for the managed container. */ layout(): void; /** * Performs a layout after a Window is resized, based on the new size. */ resize(): void; } /** * Displays a list of choices, represented by ListItem objects. */ declare class ListBox { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * An array of child ListItem elements. */ readonly children: Object[]; /** * For a multi-column list box, the column properties. */ readonly columns: any; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The width and height in pixels of each item in the list. */ itemSize: Dimension; /** * The array of choice items displayed in the list. */ readonly items: ListItem[]; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the control * (properties used only when the element is created). */ properties: Object; /** * The currently selected item for a single-selection list, or an array of * items for current selection in a multi-selection list. */ selection: ListItem; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The element type; "listbox". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Adds an item to the choices in this list. * @param type The type of the child element, the string "item". * @param text The localizable text label for the item. */ add(type: string, text?: string): ListItem; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Retrieves an item object from the list that has a given text label. * @param text The text string to match. */ find(text: string): ListItem; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the content of the element * has been changed */ onChange(): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when an item in the listbox is * double-clicked */ onDoubleClick(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Removes a child item from the list. * @param what The item or child to remove, specified by 0-based index, text value, or as a ListItem object. */ remove(what: any): void; /** * Removes all child items from the list. */ removeAll(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * An item in a list box, drop-down list, or tree view. */ declare class ListItem { /** * The checked state of an item in a list. */ checked: boolean; /** * The expansion state of an item of type node that is a child of a TreeView * list control. */ expanded: boolean; /** * An image object for an icon to display in the item. */ image: ScriptUIImage; /** * The 0-based index of this item in the items collection of its parent list * control. */ readonly index: number; /** * The parent element, a list control. */ readonly parent: any; /** * An object that contains one or more creation properties of the item * (properties used only when the element is created). */ properties: Object; /** * The selection state of this item. */ selected: boolean; /** * When the parent is a multi-column ListBox, this describes the labels for * this selectable row in additional columns. */ readonly subItems: any[]; /** * The label text to display for the item, a localizable string. */ text: string; /** * The element type. */ readonly type: string; } /** * Algebra BLAS data class */ declare class Matrix { /** * Get number of columns in this data object. */ readonly cols: number; /** * Get number of rows in this data object. */ readonly rows: number; /** * Constructs a new BLAS Matrix object. * @param rows * @param cols * @param data */ constructor(rows: number, cols: number, data: any); /** * Element-wise absolute value; returns a new vector or matrix. */ abs(): Object; /** * Element-wise add another vector or matrix of the same shape; returns a new * vector or matrix. * @param other */ add(other: Object): Object; /** * Get the linear (column-major) index of the maximum element. */ argMax(): number; /** * Get the value at the given row and column index. * @param rowIdx * @param colIdx */ at(rowIdx: number, colIdx: number): number; /** * Element-wise divide by another vector or matrix of the same shape; returns a * new vector or matrix. * @param other */ divide(other: Object): Object; /** * Create a [vectors[0].length x vectors.length] matrix that contains the given * vectors as columns. The vectors must all have the same length. * @param vectors */ static fromVectors(vectors: any[]): Object; /** * Get the maximum element value in this vector or matrix. */ max(): number; /** * Element-wise maximum of each element and the given scalar; returns a new * vector or matrix. * @param scalar */ maximum(scalar: number): Object; /** * Element-wise multiply by another vector or matrix of the same shape; returns * a new vector or matrix. * @param other */ multiply(other: Object): Object; /** * Compute the norm of this vector or matrix. */ norm(): number; /** * Element-wise power; returns a new vector or matrix. * @param exponent */ pow(exponent: number): Object; /** * Multiply each element by the given scalar; returns a new vector or matrix. * @param factor */ scale(factor: number): Object; /** * Compute the squared L2 norm of this vector or matrix. */ squaredNorm(): number; /** * Element-wise subtract another vector or matrix of the same shape; returns a * new vector or matrix. * @param other */ subtract(other: Object): Object; /** * Compute the sum of all elements in this vector or matrix. */ sum(): number; } /** * Scripting interfaces to Media Browser. Can be used to make and/or cancel * thumbnail and project item requests. */ declare class MediaBrowser { /** * Cancel all outstanding project item requests. Typical use would be changing * directories while metadata is still being retrieved for items in the * previous directory. */ static cancelProjectItemRequests(): number; /** * Cancel all outstanding thumbnail requests. Typical use would be changing * directories while thumbnails are still being retrieved for items in the * previous directory. */ static cancelThumbnailRequests(): number; } /** * Stateless scripting object for the Median Filter algorithm */ declare class MedianFilter { /** * Performs median filtering on an input vector. The kernel size must be a * positive integer. Border values are padded with zeros. Using a kernel size * of 1 will return the input vector unchanged. Values lower than 1 will throw * an exception. * @param vector * @param kernelSize */ static filter(vector: Object, kernelSize: number): any; /** * Performs component wise median filtering on an input matrix that is * interpreted as col major vectors. Border values are padded with zeros. The * kernel size must be a positive integer. Using a kernel size of 1 will return * the input matrix unchanged. Values lower then 1 will throw an exception. * @param vector * @param kernelSize */ static filterND(vector: Object, kernelSize: number): any; } /** * Runs MultiTrackClusterStrategy directly with configurable parameters. */ declare class MultiTrackClustering { /** * Runs the MultiTrackClusterStrategy and returns an array of * TimedFeatureVectorWithIndexVector one per cluster: timeRange|embedding are * the cluster's representative and indices are the positions (into * embeddings|timeRanges) of that cluster's members. * @param embeddings * @param timeRanges * @param similarityThreshold */ static cluster(embeddings: Vector[], timeRanges: TimeRange[], similarityThreshold: number): Object; } /** * A XML namespace object. */ declare class Namespace { /** * The named prefix. */ readonly prefix: string; /** * The URI. */ readonly uri: string; /** * Creates a Namespace object. * @param prefix The URI prefix, specified as an existing Namespace object, QName object, or string. * @param uri The URI if the prefix is specified as a string. */ constructor(prefix: any, uri?: string); } /** * The OSInfo object provides information about the operating system. */ declare class OSInfo { /** * Operating system architecture arm64 or x64. */ readonly architecture: string; /** * Operating system emulation. */ readonly emulation: boolean; /** * Operating system name. */ readonly name: string; } /** * The ObjectReflection object provides information about the behavior of an * object. */ declare class ObjectReflection { /** * The object class properties. */ readonly classProperties: any[]; /** * The object class description. */ readonly description: string; /** * true if the object is an event object. */ readonly eventObject: boolean; /** * true if the object is an event target object. */ readonly eventTarget: boolean; /** * The object instance properties. */ readonly instanceProperties: any[]; /** * The object class name. */ readonly name: string; /** * Construct ObjectReflection object for given object. * @param object object to inspect */ constructor(object: Object); /** * Retrieve object reflections for given namespace settings. Optionally pass in * an Object where each property name is a namespace name with the value true * or false for visible or excluded. * @param namespaces */ static getObjectReflections(namespaces: Object): any[]; /** * Retrieve third party object reflections for given namespace settings. * Optionally pass in an Object where each property name is a namespace name * with the value true or false for visible or excluded. * @param namespaces */ static getThirdPartyObjectReflections(namespaces: Object): any[]; } /** * A container for other types of controls, with an optional frame. */ declare class Panel { /** * Specifies how to align the child elements. */ alignChildren: string; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * Reserve space for the specified number of characters; affects calculation of * preferredSize . * @remarks Range: 0 to … */ characters: number; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The default text justification style for child text elements. */ justify: string; /** * The layout manager for this container. */ layout: LayoutManager; /** * The upper left corner of this element's frame relative to its parent. */ location: Point; /** * The number of pixels between the edges of a container and the outermost * child elements. */ margins: number; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The layout orientation of children in a container. */ orientation: string; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the control * (properties used only when the element is created). */ properties: Object; /** * The current dimensions of this element. */ size: Dimension; /** * The number of pixels separating one child element from its adjacent sibling * element. */ spacing: number; /** * The title or label text, a localizable string. */ text: string; /** * The element type; "panel". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Adds a child element to this container. * @param type The type of the child element, as specified for the type property. * @param bounds A bounds specification that describes the size and position of the new control or container, relative to its parent. * @param text The text or label, a localizable string. * @param properties An object that contains one or more creation properties of the new child (properties used only when the element is created). */ add(type: string, bounds?: Bounds, text?: string, properties?: Object): any; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * An event-handler callback function, called when the panel is about to be * drawn. */ onDraw(): void; /** * Removes the specified child control from this group's children array. * @param what The child control to remove, specified by 0-based index, text property value, or as a control object. */ remove(what: any): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * Panko class provides the ability to leave and read Panko breadcrumb trails * in scripting. */ declare class Panko { /** * Get all Panko trail checkpoints logged since the last call each as { data * callstack } */ static getLog(): any[]; /** * Leave a Panko breadcrumb trail with the given data * @param data */ static leaveTrail(data: Object): boolean; /** * Start logging all Panko trail checkpoints hit during the receive period */ static startLog(): boolean; } /** * The ParameterReflection object provides information about the behavior of * parameters of methods or constructors. */ declare class ParameterReflection { /** * The data type of the parameter. */ readonly dataType: any; readonly description: any; /** * The parameter name. */ readonly name: string; } /** * Scripting surface for the in-product paywall. Dispatches * EVENT_PURCHASE_COMPLETED when a credit purchase completes so an extension * can refresh credit-dependent UI. */ declare class Paywall { /** * Dispatched on a Paywall object when a paywall purchase completes so an * extension can refresh credit-dependent UI such as a buy-credits banner. */ static readonly EVENT_PURCHASE_COMPLETED: string; static addEventListener(): any; static dispatchEvent(): any; /** * Get a Paywall event target. Call * subscribeToEvent(Paywall.EVENT_PURCHASE_COMPLETED) then add a listener for * it. */ static getInstance(): Paywall; static removeEventListener(): any; /** * Open the account menu showing the user's generative credit balance. Returns * true if the request was dispatched false if no account menu is available; * the result does not confirm the menu opened. */ static showCreditBalance(): boolean; /** * Propagates the given event on this object. * @param eventKey */ subscribeToEvent(eventKey: string): boolean; } /** * Pixel aspect ratio has a numerator and a denominator. */ declare class PixelAspectRatio { /** * Pixel aspect ration denominator. */ denominator: number; /** * Pixel aspect ratio numerator. */ numerator: number; /** * Construct a PixelAspectRatio Object with parameters * @param numerator * @param denominator */ constructor(numerator: number, denominator: number); /** * Returns true if the given PixelAspectRatioObject is equal to this * PixelAspectRatioObject * @param pixelAspectRatioObject */ equals(pixelAspectRatioObject: PixelAspectRatioObject): boolean; } /** * Results of a pixel-based comparison. Includes number of different pixels, * percent variation, and an error message if necessary. */ declare class PixelCompareTestResults { /** * Calculated average variance. Total variance | num diff pixels */ readonly avgVariance: number; /** * Image data for the diff image generated */ readonly diffData: string; /** * Minimum variance. */ readonly minVariance: number; /** * Number of pixels that were different between the 2 images */ readonly numDiffPixels: number; /** * Calculated peak signal-to-noise ratio. */ readonly psnr: number; /** * Error message if any for pixel comparison process. Or successful result */ readonly result: number; /** * Calculated variance between images as a percent */ readonly variance: number; /** * Construct a pixelComparator test result object */ constructor(); } /** * Performs pixel comparison between two video frames. */ declare class PixelComparison { /** * Construct a pixelComparator object */ constructor(); /** * Takes in 2 PNGs or two VFRaw files and an epsilon value and performs * pixel-based comparison on the images. For PNGs the epsilon value should be * an integer for comparing 8-bit or 15|16-bit integer values. For VFRaw files * the epsilon value should be a float for comparing float values in the * nominal [0.0 .. 1.0] range. * @param inImagePath * @param compareImagePath * @param epsilon */ static pixelCompare(inImagePath: string, compareImagePath: string, epsilon: number): any; /** * Takes in 3 PNGs and performs pixel-based comparison on the non-mask region * of the images * @param inOriginalImagePath * @param inCompareImagePath * @param inMaskOnlyPath */ static pixelCompareNonMaskRegion(inOriginalImagePath: string, inCompareImagePath: string, inMaskOnlyPath: string): any; } /** * PluginSupport has various utility helper functions useful for runtime * diagnosis of issues reported to the user from the plugin layer. */ declare class PluginSupport { /** * The date and time when the event occurred */ static eventDateTime(): string; /** * The description of the event - may be empty for some events */ static eventDescription(): string; /** * The title of the event */ static eventTitle(): string; /** * The type of event - 1=Informational 2=Warning 3=Error */ static eventType(): number; /** * Total Events available in Events panel */ static eventsCount(): number; } /** * Defines the location of a window or UI element. Contains a 2-element array. */ declare class Point { /** * The left coordinate. */ left: number; /** * The array length. */ readonly length: number; /** * The top coordinate. */ top: number; /** * The horizontal coordinate, a pixel offset from the origin of the element's * coordinate space. */ x: number; /** * The vertical coordinate, a pixel offset from the origin of the element's * coordinate space. */ y: number; } /** * Provides scripting env access to dvacore::geom::Point. */ declare class PointF { /** * Get|Set the x value of a point */ x: number; /** * Get|Set the y value of a point */ y: number; /** * Construct a PointFloat Object. * @param inX * @param inY */ constructor(inX: number, inY: number); /** * Get the distance from one point to another point * @param point */ distanceTo(point: PointF): number; } /** * Preset manager event object */ declare class PresetManagerEvent { /** * The active preset is requested to be changed. */ static readonly EVENT_ACTIVE_PRESET_CHANGE_REQUESTED: string; /** * The favorite and recent preset lists have been updated. */ static readonly EVENT_FAVORITE_AND_RECENT_PRESETS_UPDATED: string; /** * The favorite preset list has been updated. */ static readonly EVENT_FAVORITE_PRESETS_UPDATED: string; /** * Returns the updated favorite preset list */ readonly favoriteList: any[]; /** * Returns the preset ID of the preset that should be set in transcoder as the * currently selected active preset */ readonly presetToBeSetAsActive: string; /** * Returns the updated recent preset list */ readonly recentList: any[]; static addEventListener(): any; static dispatchEvent(): any; static removeEventListener(): any; } /** * ProgressCategory class */ declare class ProgressCategory { /** * Get the unique category id of the progress category. */ readonly id: string; /** * Cancel all jobs being reported under this progress category. */ cancelProgress(): boolean; /** * Create a new progress item with the given title. * @param title */ createProgressItem(title: string): Object; /** * Create a new progress item with the given title and reference id. * @param title * @param referenceId */ createProgressItemWithReferenceId(title: string, referenceId: Object): Object; /** * Get the icon of the progress category as base64 encoded svg. */ getIcon(): string; /** * Get a progress item that represents all the progress in this category * encapsulated in a single item. */ getOverallProgressItem(): Object; /** * Retrieve a progress item by it's reference ID. The returned object can be * null in case there is no progress item under this reference id. * @param referenceGuid */ getProgressItemFromReferenceID(referenceGuid: Object): Object; /** * Get all the progress items in this progress category. */ getProgressItems(): any[]; /** * Get the title of the progress category. */ getTitle(): string; /** * Counts all progress items registered in this category. */ getTotalJobs(): number; /** * Get the cumulative progress value of the progress category. */ getValue(): number; /** * Check if the progress category has any completed progress items. */ hasDoneJobs(): boolean; /** * Check if the progress category has any pending jobs. */ hasPendingJobs(): boolean; /** * Check progress category has progress item that has been configured as * unknown progress. */ isIndeterminateProgress(): boolean; /** * Remove the cancelled and failed progress items from the progress category. */ removeCancelledJobs(): boolean; /** * Remove the completed progress items from the progress category. */ removeDoneJobs(): boolean; /** * Remove the specified progress item from the progress category. * @param inProgressItem */ removeProgressItem(inProgressItem: Object): boolean; /** * Indicates that this progress category will be shown in the header bar * progress panel */ showInHeaderBar(): boolean; /** * Indicates that this progress category will only show the status column. */ showOnlyStatusColumn(): boolean; /** * Check if the progress category can be cancelled. */ supportsCancellation(): boolean; } /** * ProgressCategoryContainer class */ declare class ProgressCategoryContainer { /** * Event object for when a new progress category is added. */ static readonly EVENT_PROGRESS_CATEGORY_ADDED: string; /** * Event object for when a progress category is removed. */ static readonly EVENT_PROGRESS_CATEGORY_REMOVED: string; /** * Event object for when a new progress item is added. */ static readonly EVENT_PROGRESS_ITEM_ADDED: string; /** * Event object for when a progress item is removed from the category. */ static readonly EVENT_PROGRESS_ITEM_REMOVED: string; static addEventListener(): any; static dispatchEvent(): any; /** * Get the list of all the Progress categories. */ getAllProgressCategories(): any[]; /** * Get the Progress Category Container object. */ static getContainer(): Object; /** * Gets or create the given progress category * @param inCategoryID * @param inTitle */ getOrCreateProgressCategory(inCategoryID: string, inTitle: string): Object; /** * Retrieve a progress item by it's reference ID. The returned object can be * null in case there is no progress item under this reference id. * @param referenceGuid */ getProgressItemFromReferenceID(referenceGuid: Object): Object; /** * Check if it has any completed jobs */ hasDoneJobs(): boolean; /** * Pause all progress items. */ pauseAllProgressItems(): boolean; /** * Remove all the completed jobs */ removeDoneJobs(): boolean; static removeEventListener(): any; /** * Remove the progress category corresponding to the given ID * @param inProgressCategory */ removeProgressCategory(inProgressCategory: Object): boolean; /** * Resume all progress items. */ resumeAllProgressItems(): boolean; /** * Propagates the given event on this object. * @param eventKey */ subscribeToEvent(eventKey: string): boolean; } /** * Collection of Progress Item properties and methods to pause, resume and * cancel progress items. */ declare class ProgressItem { /** * Event object for progress item cancelled. */ static readonly EVENT_PROGRESS_ITEM_CANCELLED: string; /** * Event object for progress item title changed. */ static readonly EVENT_PROGRESS_ITEM_TITLE_CHANGED: string; /** * Event object for progress item value changed. */ static readonly EVENT_PROGRESS_ITEM_VALUE_CHANGED: string; /** * Cancelled progress state. */ static readonly PROGRESS_STATE_CANCELLED: number; /** * Failed progress state. */ static readonly PROGRESS_STATE_FAILED: number; /** * Normal progress state. */ static readonly PROGRESS_STATE_NORMAL: number; /** * Paused progress state. */ static readonly PROGRESS_STATE_PAUSED: number; /** * Resumed progress state. */ static readonly PROGRESS_STATE_RESUMED: number; /** * Waiting progress state. */ static readonly PROGRESS_STATE_WAITING: number; readonly creationTime: any; /** * Get the ID of the Progress Item. */ readonly referenceId: any; addEventListener(): any; /** * Cancel the job being reported by this progress item */ cancelProgress(): boolean; dispatchEvent(): any; /** * Get the maximum progress value of the progress item. */ getMaxValue(): number; /** * Get the progress state of the progress item. */ getProgressState(): number; /** * Get the status message of the progress item. */ getStatusMessage(): string; /** * Get the title of the progress item. */ getTitle(): string; /** * Get the progress value of the progress item. */ getValue(): number; /** * Check whether the progress item has finished executing. */ isComplete(): boolean; /** * Check if the progress item has started execution but not yet complete. */ isInProgress(): boolean; /** * Check if the progress item has been configured as unknown progress. */ isIndeterminateProgress(): boolean; /** * Check if the progress item is waiting to start or has started but not yet * complete. */ isPending(): boolean; /** * Pause or resume the progress job based on the state provided. * @param inProgresState */ pauseOrResumeProgress(inProgresState: number): boolean; removeEventListener(): any; /** * Set the tooltip for the cancel button of the progress item. * @param toolTip */ setCancelToolTip(toolTip: string): boolean; /** * Set the progress state for the progress item. * @param state */ setProgressState(state: number): boolean; /** * Set the progress value and maximum value for the progress item. * @param value * @param maxValue */ setProgressStatus(value: number, maxValue: number): boolean; /** * Set the progress value maximum value status message and tooltip for the * progress item. * @param value * @param maxValue * @param statusMessage * @param toolTip */ setProgressStatusAndToolTip(value: number, maxValue: number, statusMessage: string, toolTip: string): boolean; /** * Set the status message for the progress item. * @param statusMessage */ setStatusMessage(statusMessage: string): boolean; /** * Set the title for the progress item. * @param title */ setTitle(title: string): boolean; /** * Set the tooltip for the progress item. * @param toolTip */ setToolTip(toolTip: string): boolean; /** * Set the type for the progress item. * @param type */ setType(type: Guid): boolean; /** * Set the progress item to unknown progress state. * @param statusMessage */ setUnknownProgress(statusMessage: string): boolean; /** * Propagates the given event on this object. * @param eventKey */ subscribeToEvent(eventKey: string): boolean; /** * Check if the progress item can be cancelled. */ supportsCancellation(): boolean; /** * Check if the progress item can be paused|resumed. */ supportsPauseAndResume(): boolean; } /** * A horizontal bar with an indicator that shows the progress of an operation. */ declare class Progressbar { /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The maximum value in the range. Default is 100. */ maxvalue: number; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The minimum value in the range; always 0. If set to a different value, it is * ignored. */ minvalue: number; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The current dimensions of this element. */ size: Dimension; /** * The element type, "progessbar". */ readonly type: string; /** * The current position of the indicator. */ value: number; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * The PropertyReflection object provides information about the behavior of an * property. */ declare class PropertyReflection { /** * true if it is an asynchronous property. */ readonly async: boolean; /** * Output type. */ readonly dataType: any; /** * The property description. */ readonly description: string; /** * The property name. */ readonly name: string; /** * Parameters of method or constructor undefined for other property types */ readonly parameters: any[]; readonly type: any; } /** * A qualified XML name, containing the URI and the local name. */ declare class QName { /** * The local name part of the qualified name. */ readonly localName: string; /** * The URI part of the qualified name. */ readonly uri: string; /** * Creates a QName object. * @param uri The URI, specified as a Namespace object, an existing QName object, or string. * @param name The local name. Used only if URI is given as a string. */ constructor(uri: any, name?: string); } /** * A dual-state control, grouped with other radiobuttons, of which only one can * be in the selected state. */ declare class RadioButton { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * A number of characters for which to reserve space when calculating the * preferred size of the element. * @remarks Range: 0 to … */ characters: number; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The default text justification style for child text elements. */ justify: string; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The label text for this button, a localizable string. */ text: string; /** * The element type; "radiobutton". */ readonly type: string; /** * The selection state of this button, selected when true. */ value: boolean; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the element has been * clicked. */ onClick(): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * RectFloatObject class provides scripting access to dvacore Rect. */ declare class RectF { /** * Get|Set the bottom point of a rect */ bottom: number; /** * Get|Set the height of a rect */ height: number; /** * Get|Set the left point of a rect */ left: number; /** * Get|Set the right point of a rect */ right: number; /** * Get|Set the size (width|height as a point) for a rect */ size: any; /** * Get|Set the top point of a rect */ top: number; /** * Get|Set the width of a rect */ width: number; /** * Construct a RectFloat Object. * @param inLeft * @param inTop * @param inWidth * @param inHeight */ constructor(inLeft: number, inTop: number, inWidth: number, inHeight: number); /** * Get the center point of a rect */ center(): any; /** * Get distance from rect to another point * @param inPoint */ distanceTo(inPoint: Object): any; } /** * Provides information about a class. */ declare class Reflection { /** * The long description text. */ readonly description: string; /** * The short description text. */ readonly help: string; /** * An array of method descriptions. */ readonly methods: ReflectionInfo[]; /** * The class name. */ readonly name: string; /** * An array of property descriptions. */ readonly properties: ReflectionInfo[]; /** * Sample code, if present. */ readonly sampleCode: string; /** * A file containing sample code. May be null. */ readonly sampleFile: File; /** * An array of class method descriptions. */ readonly staticMethods: ReflectionInfo[]; /** * An array of class property descriptions. */ readonly staticProperties: ReflectionInfo[]; /** * Finds an element description by name. * @param name The name of the element to find. */ find(name: string): ReflectionInfo; /** * Returns this class information as XML in OMV format. */ toXML(): XML; } /** * Provides information about a method, a property or a method parameters. */ declare class ReflectionInfo { /** * The description of method or function arguments. */ readonly arguments: ReflectionInfo[]; /** * The data type. */ readonly dataType: string; /** * The default value. */ readonly defaultValue: any; /** * The long description text. */ readonly description: string; /** * The short description text. */ readonly help: string; /** * Contains true if the class describes a collection class. */ readonly isCollection: boolean; /** * The maximum value. */ readonly max: number; /** * The minimum value. */ readonly min: number; /** * The element name. */ readonly name: string; /** * The class object that this element belongs to. */ readonly parent: Reflection; /** * Sample code, if present. */ readonly sampleCode: string; /** * A file containing sample code. May be null. */ readonly sampleFile: File; /** * The element type. */ readonly type: string; } /** * A global class containing central information about ScriptUI. Not * instantiable. */ declare class ScriptUI { /** * Collects the enumerated values that can be used in the alignment and * alignChildren properties of controls and containers. */ static readonly Alignment: string; /** * Collects the enumerated values that can be used as the style argument to the * ScriptUI.newFont() method. */ static readonly FontStyle: any; /** * The font constants defined by the host application. */ static readonly applicationFonts: any; /** * An object whose properties are the names of compatability modes supported by * the host application. */ static readonly compatibility: any; /** * A string containing the internal version number of the ScriptUI module. */ static readonly coreVersion: string; /** * An object whose properties define attributes of the environment in which * ScriptUI operates. */ static readonly environment: Environment; /** * An object whose properties and methods provide access to objects used in the * ScriptUI event system. */ static readonly events: Events; /** * A string containing the name of the UI component framework with which this * version of ScriptUI is compatible. */ static readonly frameworkName: string; /** * A string containing the version number of the ScriptUI component framework */ static readonly version: any; /** * Finds and returns the resource for a given text string from the host * application's resource data. * @param text The text to match. */ static getResourceText(text: string): string; /** * Creates a new font object for use in text controls and titles. * @param name The font name, or the font family name. * @param style The font style; can be string, or one of the values of ScriptUI.FontStyle. * @param size The font size in points. */ static newFont(name: string, style: string | number, size: number): ScriptUIFont; /** * Loads a new image from resources or disk files into an image object. * @param normal The resource name or the disk file path to the image used for the normal state. * @param disabled The resource name, or the disk file path to the image used for the disabled state. * @param pressed The resource name, or the file-system path to the image used for the pressed state. * @param rollover The resource name, or the file-system path to the image used for the rollover state. */ static newImage(normal: string, disabled?: string, pressed?: string, rollover?: string): ScriptUIImage; } /** * A painting brush that encapsulates a color or pattern used to fill paths. */ declare class ScriptUIBrush { /** * The brush color. */ readonly color: number[]; /** * The theme name. */ readonly theme: string; /** * The brush type, solid or theme. */ readonly type: number; } /** * Encapsulates the qualities of a font used to draw text into a control. */ declare class ScriptUIFont { /** * The font family name. */ readonly family: string; /** * The complete font name, consisting of the family and style, if specified. */ readonly name: string; /** * The font point size. */ readonly size: number; /** * The font style. One of the constants in ScriptUIGraphics.FontStyle. */ readonly style: any; /** * The name of a substitution font, a fallback font to substitute for this font * if the requested font family or style is not available. */ readonly substitute: string; } /** * An object used to draw custom graphics, found in the graphics property of * window, container, and control objects. */ declare class ScriptUIGraphics { /** * Contains the enumerated constants for the type argument of newBrush(). */ static readonly BrushType: any; /** * Contains the enumerated constants for the type argument of newPen(). */ static readonly PenType: any; /** * The background color for containers; for non-containers, the parent * background color. */ backgroundColor: ScriptUIBrush; /** * The current drawing path, encapsulated in a path object. */ readonly currentPath: ScriptUIPath; /** * The current position in the current drawing path. */ readonly currentPoint: Point; /** * The background color for containers when disabled or inactive; for * non-containers, the parent background color. */ disabledBackgroundColor: ScriptUIBrush; /** * The text color when the element is disabled or inactive. */ disabledForegroundColor: ScriptUIPen; /** * The default font to use for displaying text. */ font: ScriptUIFont; /** * The text color. */ foregroundColor: ScriptUIPen; /** * Closes the current path. */ closePath(): void; /** * Draws a focus ring within a region of this element. * @param left The left coordinate of the region. * @param top The top coordinate of the region. * @param width The width of the region in pixels. * @param height The height of the region in pixels. */ drawFocusRing(left: number, top: number, width: number, height: number): void; /** * Draws an image within a given region of the element. * @param image The image to draw. * @param left The left coordinate of the region, relative to the origin of this element. * @param top The top coordinate of the region, relative to the origin of this element. * @param width The width in pixels. If provided, the image is stretched or shrunk to fit. If omitted, uses the original image width. * @param height The height in pixels. If provided, the image is stretched or shrunk to fit. If omitted, uses the original image height. */ drawImage(image: ScriptUIImage, left: number, top: number, width?: number, height?: number): void; /** * Draw the platform-specific control associated with this element. */ drawOSControl(): void; /** * Draw a string of text starting at a given point in this element, using a * given drawing pen and font. * @param text The text string. * @param pen The drawing pen to use. * @param x The left coordinate, relative to the origin of this element. * @param y The top coordinate, relative to the origin of this element. * @param font The font to use. Default is the font value in this object. */ drawString(text: string, pen: ScriptUIPen, x: number, y: number, font?: ScriptUIFont): void; /** * Defines an elliptical path within a given rectangular area in the * currentPath object, which can be filled using fillPath() or stroked using * strokePath(). * @param left The left coordinate of the region, relative to the origin of this element. * @param top The top coordinate of the region, relative to the origin of this element. * @param width The width of the region in pixels. * @param height The height of the region in pixels. */ ellipsePath(left: number, top: number, width: number, height: number): Point; /** * Fills a path using a given painting brush. * @param brush The brush object that defines the fill color. * @param path The path object. Default is the currentPath. */ fillPath(brush: ScriptUIBrush, path?: ScriptUIPath): void; /** * Adds a path segment to the currentPath. * @param x The X coordinate for the destination point, relative to the origin of this element. * @param y The Y coordinate for the destination point, relative to the origin of this element. */ lineTo(x: number, y: number): Point; /** * Calculates the size needed to display a string using the given font. * @param text The text string to measure. * @param font The font to use. Default is the font value in this object. * @param boundingWidth The bounding width. */ measureString(text: string, font?: ScriptUIFont, boundingWidth?: number): Dimension; /** * Adds a given point to the currentPath, and makes it the current drawing * position. * @param x The X coordinate for the new point, relative to the origin of this element. * @param y The Y coordinate for the new point, relative to the origin of this element. */ moveTo(x: number, y: number): Point; /** * Creates a new painting brush object. * @param type The brush type, solid or theme. * @param color The brush color. */ newBrush(type: number, color: (number | string)[]): ScriptUIBrush; /** * Creates a new, empty path object. */ newPath(): ScriptUIPath; /** * Creates a new drawing pen object. * @param type The pen type, solid or theme. * @param color The pen color. * @param width The width of the pen line in pixels. */ newPen(type: number, color: (number | string)[], width: number): ScriptUIPen; /** * Defines a rectangular path in the currentPath object. * @param left The left coordinate relative to the origin of this element. * @param top The top coordinate relative to the origin of this element. * @param width The width in pixels. * @param height The height in pixels. */ rectPath(left: number, top: number, width: number, height: number): Point; /** * Strokes the path segments of a path with a given drawing pen. * @param pen The drawing pen that defines the color and line width. * @param path The path object. Default is the currentPath. */ strokePath(pen: ScriptUIPen, path?: ScriptUIPath): void; } /** * Encapsulates a set of images that can be drawn into a control. */ declare class ScriptUIImage { /** * The image format. One of: resource, JPEG, GIF, TIFF, PNG, or PICT * (Macintosh). */ readonly format: string; /** * The image name. Either the file name, or the resource name. */ readonly name: string; /** * The full path to the file that contains the image. */ readonly pathname: string; /** * The image size in pixels. */ readonly size: Dimension; } /** * A helper object that encapsulates a drawing path for a figure to be drawn * into a window or control. */ declare class ScriptUIPath { } /** * A drawing pen that defines a color and line width used to stroke paths. */ declare class ScriptUIPen { /** * The pen color. */ readonly color: number[]; /** * The pixel width of the drawing line. * @remarks Range: 1 to … */ lineWidth: number; /** * The theme name. */ readonly theme: string; /** * The pen type, solid or theme. */ readonly type: string; } /** * A scrollbar with a draggable scroll indicator and stepper buttons to move * the indicator. */ declare class Scrollbar { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The amount to increment or decrement a scrollbar indicator's position when * the user clicks ahead or behind the moveable element. * @remarks Range: 0 to … */ jumpdelta: number; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The maximum value allowed in the value property. */ maxvalue: number; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The minimum value allowed in the value property. */ minvalue: number; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The amount by which to increment or decrement a scrollbar element's position * when the user clicks a stepper button. * @remarks Range: 0 to … */ stepdelta: number; /** * The element type, "scrollbar". */ readonly type: string; /** * The current position of the indicator. */ value: number; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the user has finished * dragging the position indicator, or has clicked the control. */ onChange(): void; /** * An event-handler callback function, called when the content of the element * is in the process of changing */ onChanging(): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * Static clustering object for Sequential Clustering algorithm */ declare class SequentialClustering { /** * Compare all vectors in a cluster to the next cluster candidate */ static readonly CLUSTER_COMPARE_MODE_ALL_IN_CLUSTER: number; /** * Compare the centroid of a cluster to the next cluster candidate */ static readonly CLUSTER_COMPARE_MODE_CENTROID: number; /** * Compare the last vector of a cluster to the next cluster candidate */ static readonly CLUSTER_COMPARE_MODE_LAST_VECTOR: number; /** * Performs sequential clustering on data points. The preferences parameter * contains: threshold (float) compareMode (int32) * @param dataPointMatrix * @param preferences */ static cluster(dataPointMatrix: Object, preferences: Object): Clusters; } /** * SimplifySequenceParams is the collection of settings used to script * SimplifySequence as a user would in the ui. */ declare class SimplifySequenceParams { /** * Constant for label color 0 */ static readonly LABEL_COLOR_0: number; /** * Constant for label color 1 */ static readonly LABEL_COLOR_1: number; /** * Constant for label color 10 */ static readonly LABEL_COLOR_10: number; /** * Constant for label color 11 */ static readonly LABEL_COLOR_11: number; /** * Constant for label color 12 */ static readonly LABEL_COLOR_12: number; /** * Constant for label color 13 */ static readonly LABEL_COLOR_13: number; /** * Constant for label color 14 */ static readonly LABEL_COLOR_14: number; /** * Constant for label color 15 */ static readonly LABEL_COLOR_15: number; /** * Constant for label color 2 */ static readonly LABEL_COLOR_2: number; /** * Constant for label color 3 */ static readonly LABEL_COLOR_3: number; /** * Constant for label color 4 */ static readonly LABEL_COLOR_4: number; /** * Constant for label color 5 */ static readonly LABEL_COLOR_5: number; /** * Constant for label color 6 */ static readonly LABEL_COLOR_6: number; /** * Constant for label color 7 */ static readonly LABEL_COLOR_7: number; /** * Constant for label color 8 */ static readonly LABEL_COLOR_8: number; /** * Constant for label color 9 */ static readonly LABEL_COLOR_9: number; /** * Constant for marker color blue */ static readonly MARKER_COLOR_BLUE: number; /** * Constant for marker color cyan */ static readonly MARKER_COLOR_CYAN: number; /** * Constant for marker color green */ static readonly MARKER_COLOR_GREEN: number; /** * Constant for marker color magenta */ static readonly MARKER_COLOR_MAGENTA: number; /** * Constant for marker color orange */ static readonly MARKER_COLOR_ORANGE: number; /** * Constant for marker color red */ static readonly MARKER_COLOR_RED: number; /** * Constant for marker color white */ static readonly MARKER_COLOR_WHITE: number; /** * Constant for marker color yellow */ static readonly MARKER_COLOR_YELLOW: number; /** * Set to apply options to Audio items */ applyToAudio: boolean; /** * Set to apply options to video items */ applyToVideo: boolean; /** * Set to close vertical gaps on video tracks */ closeVerticalGaps: boolean; /** * Set to flatten multicam clips */ flattenMulticam: boolean; /** * SimplifySequence parameters */ static readonly parameters: any; /** * Set to remove clips with label color(s) - set to an array of LABEL_COLOR_ * constants */ removeClipsWithLabelColors: any; /** * Set to remove disabled clips */ removeDiabledClips: boolean; /** * Set to remove disabled tracks */ removeDiabledTracks: boolean; /** * Set to remove empty tracks */ removeEmptyTracks: boolean; /** * Set to remove graphics clips */ removeGraphicClips: boolean; /** * Set to remove offline clips */ removeOfflineClips: boolean; /** * Set to remove sequence markers with color(s) - set to an array of * MARKER_COLOR_ constants */ removeSequenceMarkerColors: any; /** * Set to join through edits */ removeThroughEdits: boolean; /** * Set to remove transitions */ removeTransitions: boolean; /** * Create a new SimplifySequenceParameterObject instance. */ constructor(); /** * Apply Simplify Sequence to a copied sequence from the currently active * sequence * @param newSimplifiedSequenceName */ simplifySequenceOnActiveSequence(newSimplifiedSequenceName: string): boolean; } /** * A slider bar that indicates a numeric value with a moveable position * indicator. */ declare class Slider { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The maximum value allowed in the value property. */ maxvalue: number; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The minimum value allowed in the value property. */ minvalue: number; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The element type, "slider". */ readonly type: string; /** * The current position of the indicator. */ value: number; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the user has finished * dragging the position indicator, or has clicked the control. */ onChange(): void; /** * An event-handler callback function, called when the content of the element * is in the process of changing */ onChanging(): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * Creates a TCP/IP connection, or establishes a TCP/IP server. */ declare class Socket { /** * When true, the connection is active. */ readonly connected: boolean; /** * Sets or retrieves the name of the encoding used to transmit data. */ encoding: string; /** * When true, the receive buffer is empty. */ readonly eof: boolean; /** * A message describing the most recent error. Setting this value clears any * error message. */ error: string; /** * The name of the remote computer when a connection is established. */ readonly host: string; /** * The timeout in seconds to be applied to read or write operations. */ timeout: number; /** * Creates a new Socket object. */ constructor(); /** * Terminates the open connection. */ close(): boolean; /** * Instructs the object to start listening for an incoming connection. * @param port The TCP/IP port number to listen on. * @param encoding The encoding to be used for the connection */ listen(port: number, encoding?: string): boolean; /** * Opens the connection for subsequent read/write operations. * @param host The server to connect to. * @param encoding The encoding to be used for the connection */ open(host: string, encoding?: string): boolean; /** * Checks a listening object for a new incoming connection. */ poll(): Socket; /** * Reads up to the specified number of characters from the connection. CR * characters are ignored unless the encoding is set to "BINARY". * @param count The number of characters to read. */ read(count?: number): string; /** * Reads one line of text up to the next line feed. */ readln(): string; /** * Concatenates all arguments into a single string and writes that string to * the connection. * @param text Any number of string values. All arguments are concatenated to form the string to be written. CRLF sequences are converted to LFs unless the encoding is set to "BINARY". */ write(text: string): boolean; /** * Concatenates all arguments into a single string, appends a LF character, and * writes that string to the connection. * @param text Any number of string values. All arguments are concatenated to form the string to be written. CRLF sequences are converted to LFs unless the encoding is set to "BINARY". */ writeln(text: string): boolean; } /** * Get the width, height, PAR, duration, etc about the imported source */ declare class SourceMediaInfo { /** * Returns the audio duration of the source */ readonly audioDuration: string; /** * Returns embedded description of the source */ readonly description: string; /** * Returns true if the timecode is a drop frame timecode */ readonly dropFrameTimeCode: boolean; /** * Returns duration of the source */ readonly duration: string; /** * Returns duration of the source in ticks (available since 23.3) */ readonly durationInTicks: string; /** * Returns field type of the source */ readonly fieldType: string; /** * Returns frame rate of the source */ readonly frameRate: string; /** * Returns height of the source */ readonly height: string; /** * Returns the importer used to decode the source */ readonly importer: string; /** * Returns the number of audio channels of the source */ readonly numChannels: string; /** * Returns the X PAR of the source */ readonly parX: string; /** * Returns the Y PAR of the source */ readonly parY: string; /** * Returns sample rate of the source */ readonly sampleRate: string; /** * Returns width of the source */ readonly width: string; /** * Returns xmp xml of the source */ readonly xmp: string; } /** * Algebra BLAS data class */ declare class SparseMatrix { /** * Get number of columns in this data object. */ readonly cols: number; /** * Get number of rows in this data object. */ readonly rows: number; /** * Constructs a new BLAS Matrix object. * @param rows * @param cols * @param data */ constructor(rows: number, cols: number, data: any); /** * Element-wise absolute value; returns a new vector or matrix. */ abs(): Object; /** * Element-wise add another vector or matrix of the same shape; returns a new * vector or matrix. * @param other */ add(other: Object): Object; /** * Get the value at the given row and column index. * @param rowIdx * @param colIdx */ at(rowIdx: number, colIdx: number): number; /** * Create a [vectors[0].length x vectors.length] matrix that contains the given * vectors as columns. The vectors must all have the same length. * @param vectors */ static fromVectors(vectors: any[]): Object; /** * Element-wise multiply by another vector or matrix of the same shape; returns * a new vector or matrix. * @param other */ multiply(other: Object): Object; /** * Compute the norm of this vector or matrix. */ norm(): number; /** * Multiply each element by the given scalar; returns a new vector or matrix. * @param factor */ scale(factor: number): Object; /** * Compute the squared L2 norm of this vector or matrix. */ squaredNorm(): number; /** * Element-wise subtract another vector or matrix of the same shape; returns a * new vector or matrix. * @param other */ subtract(other: Object): Object; /** * Compute the sum of all elements in this vector or matrix. */ sum(): number; } /** * Algebra BLAS data class */ declare class SparseVector { /** * Get number of columns in this data object. */ readonly cols: number; /** * Get the length of the vector. */ readonly length: number; /** * Get number of rows in this data object. */ readonly rows: number; /** * Constructs a new BLAS Vector object. * @param rows * @param data */ constructor(rows: number, data: any); /** * Element-wise absolute value; returns a new vector or matrix. */ abs(): Object; /** * Element-wise add another vector or matrix of the same shape; returns a new * vector or matrix. * @param other */ add(other: Object): Object; /** * Get the value at the given row index. * @param rowIdx */ at(rowIdx: number): number; /** * Compute the dot product of this vector with another. * @param other */ dot(other: Object): number; /** * Element-wise multiply by another vector or matrix of the same shape; returns * a new vector or matrix. * @param other */ multiply(other: Object): Object; /** * Compute the norm of this vector or matrix. */ norm(): number; /** * Multiply each element by the given scalar; returns a new vector or matrix. * @param factor */ scale(factor: number): Object; /** * Compute the squared L2 norm of this vector or matrix. */ squaredNorm(): number; /** * Element-wise subtract another vector or matrix of the same shape; returns a * new vector or matrix. * @param other */ subtract(other: Object): Object; /** * Compute the sum of all elements in this vector or matrix. */ sum(): number; } /** * Utility to invoke Speaker Separation */ declare class SpeakerSeparation { /** * Creates a SpeakerSeparation object */ constructor(); /** * Returns the billable duration in seconds Separate() would submit for the * track item. Does not submit a job. * @param inTrackItem */ static getBillableDurationSeconds(inTrackItem: TrackItem): number; /** * Returns a promise that resolves to the estimated credit cost for the given * audio duration (seconds). Does not submit a job. * @param inAudioDurationSeconds */ static getCostEstimate(inAudioDurationSeconds: number): number; /** * Returns whether Separate Crosstalk would be enabled for the given track-item * selection. Does not submit a job. * @param inSelection */ static isEnabled(inSelection: Object): boolean; /** * Maps a service|backend dvacore::Result (int) to the user-facing toast result * code (int). Does not submit a job. * @param inResult */ static mapToastCode(inResult: number): number; /** * Runs Speaker Separation directly on the given track item(s) bypassing the * confirmation dialog. Returns a promise that resolves once the service job * (upload process download) completes; stems are imported and placed on the * timeline asynchronously afterwards. * @param inTrackItems * @param inSequence */ static separate(inTrackItems: any[], inSequence: Object): boolean; /** * Runs the Speaker Separation command on the current timeline audio selection. */ static separateSpeakers(): boolean; /** * Validates a track item's duration for Speaker Separation; returns the * dvacore::Result as an int (0 == success). Does not submit a job. * @param inTrackItem */ static validate(inTrackItem: TrackItem): number; } /** * Interface to OS spellcheck operations */ declare class Spellcheck { /** * Add word to the specified language set * @param text * @param language */ static addWord(text: string, language: string): boolean; /** * Check spelling for a word. Returns a promise to the results. * @param text * @param language */ static checkSpelling(text: string, language: string): Object; /** * Return a list of candidate words to replace a given substring * @param text * @param startEnd * @param language */ static getCandidates(text: string, startEnd: Object, language: string): any; /** * Returns true if spell checking is supported on this OS and configuration. */ static spellcheckSupported(): boolean; } /** * A text label that the user cannot change. */ declare class StaticText { /** * Always false. This element cannot have input focus. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * A number of characters for which to reserve space when calculating the * preferred size of the element. * @remarks Range: 0 to … */ characters: number; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The text justification style. */ justify: string; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The text to display, a localizable string. */ text: string; /** * The element type, "statictext". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * The stock wrangler object for testing stock audio. */ declare class StockWrangler { /** * number of results from last time initiateSearch was called */ readonly numResults: number; /** * Current Stock Wrangler. */ static readonly wrangler: any; /** * start an SFX search using the parameters in the Parameter object * @param params */ initiateSFXSearch(params: StockWranglerParameter): boolean; /** * start a music search using the parameters in the Parameter object * @param params */ initiateSearch(params: StockWranglerParameter): boolean; } /** * Script object for stock wrangler search parameters. */ declare class StockWranglerParameter { /** * Set the max bpm .Next search will only have results below this tempo. */ bpmMax: number; /** * Set the min bpm. Next search will only have results above this tempo */ bpmMin: number; /** * Set the categories.Next search will only have results that fall within the * supplied categories */ categories: any; /** * Set the max duration.Next search will only have results below this duration. */ durationMax: number; /** * Set the min duration.Next search will only have results above this duration */ durationMin: number; /** * Set the genres.Next search will only have results that fall within the * supplied genres */ genres: any; /** * Set boolean to search for assets regardless of BPM.Next search will have * results containing assets without BPM if true. */ includeAssetsWithoutBPM: boolean; /** * Set the moods.Next search will only have results that fall within the * supplied moods */ moods: any; /** * Stock Wrangler search parameters */ static readonly params: any; } /** * Provide system compatibility report generation */ declare class SystemCompatibilityReport { /** * @param filePath */ static CreateReport(filePath: string): boolean; } /** * The SystemInfo object provides information about the system. */ declare class SystemInfo { /** * Available physical memory (MB). */ static readonly availablePhysicalMemory: number; /** * Decription of hardware device */ static readonly deviceDescription: string; /** * Operating system related information. */ static readonly os: OSInfo; /** * Total physical memory (MB). */ static readonly totalPhysicalMemory: number; /** * List of video devices. */ static readonly videoDevices: any; } /** * A workspace tab panel. */ declare class TabPanel { /** * Return this tab panel as a UINode object. */ getAsUINode(): UINode; /** * Get the global bounds of the panel */ getBounds(): RectF; /** * Get the first child UI node matching the given node ID. * @param nodeID */ getChildNodeByNodeID(nodeID: string): UINode; /** * Get the global bounds of the panel content area */ getContentBounds(): RectF; /** * Get the top-level window that contains this panel. */ getTopLevelWindow(): TopLevelWindow; } /** * TickTime class */ declare class TickTime { /** * Invalid Tick Time Constant */ static readonly TIME_INVALID: TickTime; /** * Max Tick Time Constant */ static readonly TIME_MAX: TickTime; /** * Min Tick Time Constant */ static readonly TIME_MIN: TickTime; /** * One Hour Tick Time Constant */ static readonly TIME_ONE_HOUR: TickTime; /** * One Second Tick Time Constant */ static readonly TIME_ONE_MINUTE: TickTime; /** * One Second Tick Time Constant */ static readonly TIME_ONE_SECOND: TickTime; /** * Zero Tick Time Constant */ static readonly TIME_ZERO: TickTime; /** * Get the TickTime in seconds */ readonly seconds: number; /** * Get the TickTime in ticks as a string */ readonly ticks: string; /** * Get the TickTime in ticks as a number */ readonly ticksNumber: number; /** * Constructs a TickTime object */ constructor(); /** * Add another TickTime to this one and return it. This TickTime is not * modified. * @param tickTime */ add(tickTime: TickTime): TickTime; /** * alignToFrame will return a TickTime that is aligned to the nearest frame * boundary less than the given time for a given frame rate by rounding any * fractional portion. * @param frameRate */ alignToFrame(frameRate: FrameRate): TickTime; /** * AlignToNearestFrame will return a TickTime that is aligned to the nearest * frame boundary greater than or less than the given time for a given frame * rate by rounding any fractional portion. * @param frameRate */ alignToNearestFrame(frameRate: FrameRate): TickTime; /** * Constructs a TickTime object with a frame and a frame rate. * @param frameCount * @param frameRate */ static createWithFrameAndFrameRate(frameCount: number, frameRate: FrameRate): TickTime; /** * Constructs a TickTime object with seconds. * @param seconds */ static createWithSeconds(seconds: number): TickTime; /** * Constructs a TickTime object with ticks as a string. * @param ticks */ static createWithTicks(ticks: string): TickTime; /** * Constructs a TickTime object with ticks as a number. * @param ticksNumber */ static createWithTicksNumber(ticksNumber: number): TickTime; /** * Divide this TickTime by a divisor and return it. In case of a division by * zero TIME_INVALID is returned. This TickTime is not modified. * @param divisor */ divide(divisor: number): TickTime; /** * Returns true if the given TickTime is equal to the TickTime object * @param tickTime */ equals(tickTime: TickTime): boolean; /** * Multiply this TickTime with a factor and return it. This TickTime is not * modified. * @param factor */ multiply(factor: number): TickTime; /** * Subtract another TickTime from this one and return it. This TickTime is not * modified. * @param tickTime */ subtract(tickTime: TickTime): TickTime; /** * Convert a TickTime to a string using the current display format * @param tickTime * @param frameRate * @param timeDisplay */ static timeToTimecode(tickTime: TickTime, frameRate: FrameRate, timeDisplay: TimeDisplay): string; /** * Convert a timecode string to a TickTime using the current display format * @param timecode * @param frameRate * @param timeDisplay */ static timecodeToTime(timecode: string, frameRate: FrameRate, timeDisplay: TimeDisplay): TickTime; /** * Convert the TickTime to a frame number with respect to the provided frame * rate. * @param frameRate */ toFrame(frameRate: FrameRate): number; } /** * TimeDisplay class */ declare class TimeDisplay { /** * Read|Write property to get|set the time display custom frames per second * value */ customFPS: number; /** * Read|Write property to get|set the time display type numeric code */ type: number; /** * Constructs a TimeDisplay object */ constructor(); /** * Returns true if the given TimeDisplay is equal to this TimeDisplay object * @param timeDisplay */ equals(timeDisplay: TimeDisplay): boolean; } /** * TimeRange class */ declare class TimeRange { /** * Constructs a TimeRange object */ constructor(); /** * Returns a new TimeRange with its start and end times aligned to the given * FrameRate. The start time is aligned towards zero and the end time is * aligned to the next frame greater than or equal to the end time. This * TimeRange is not modified. * @param frameRate */ alignToFrame(frameRate: FrameRate): TimeRange; /** * Returns true if the given point in time is within the TimeRange. * @param time */ contains(time: TickTime): boolean; /** * Constructs a TimeRange object from start and end TickTime objects. * @param startTime * @param endTime */ static createWithStartAndEnd(startTime: TickTime, endTime: TickTime): TimeRange; /** * Returns true if the given TimeRange is equal to this TimeRange. * @param other */ equals(other: TimeRange): boolean; /** * Returns a new TimeRange extended (or shrunk if the given time is negative) * by the given time on both sides. This TimeRange is not modified. * @param time */ extend(time: TickTime): TimeRange; /** * Returns the duration of the TimeRange object */ getDuration(): Object; /** * Returns the end time of the TimeRange object */ getEndTime(): Object; /** * Returns the start time of the TimeRange object */ getStartTime(): Object; /** * Returns a new TimeRange which is the intersection of this range and the * given range. If no intersection exists an invalid TimeRange is returned. * This TimeRange is not modified. * @param other */ intersection(other: TimeRange): TimeRange; } /** * Mezzanine Timecode Object */ declare class Timecode { /** * Read|Write property to get|set prefer drop frame of timecode object */ preferDropFrame: boolean; /** * Read|Write property to get|set start time of timecode object */ startTime: Object; /** * Construct a Timecode Object with parameters for StartTime and * PreferDropFrame * @param StartTime * @param PreferDropFrame */ constructor(StartTime: Object, PreferDropFrame: boolean); /** * Returns true if the given TimecodeObject is equal to this TimecodeObject * @param TimecodeObject */ equals(TimecodeObject: TimecodeObject): boolean; } /** * Constants for dvamediatypes::TrackIndex */ declare class TrackIndex { /** * Constant meaning the topmost video track. */ static readonly ALWAYS_ON_TOP: number; /** * Constant meaning unset track index. */ static readonly INVALID: number; } /** * The Transcoder object provides the main access for full export settings * information and control. */ declare class Transcoder { /** * Returns color management info. */ readonly colorManagementInfo: string; /** * Returns the JSON for the current selected destination. */ readonly currentDestination: string; /** * Returns the logged-in state of the current selected destination. Returns * 'false' if we can't determine logged-in state (MediaFile CreativeCloud FTP). */ readonly currentDestinationIsLoggedIn: boolean; /** * Returns the list and names of the current Preset Setting Groups. */ readonly currentPresetSettingsGroups: string; /** * Get the currently selected source masterclip(s). */ readonly currentSourceMasterClips: any[]; /** * Get the currently selected source sequence. */ readonly currentSourceSequence: Sequence; /** * Returns a JSON list of all destinations for an export. */ readonly destinations: string; /** * Returns the calculated file size information for the current source with the * selected Preset. */ readonly estimatedFileSize: string; /** * Start a direct modal Export with all for export marked destinations of the * current Transcoder settings. */ readonly exportDestinationsDirect: boolean; /** * Start a direct modal Export with the current Transcoder settings. */ readonly exportDirect: boolean; /** * Returns the current JSON convert option for hide hidden params. */ readonly getJSONConvertOptionIncludeHiddenParams: boolean; /** * Returns the current JSON convert option for hide unset values. */ readonly getJSONConvertOptionIncludeUnsetValues: boolean; /** * Returns the import into Project preference value. */ readonly importIntoProject: boolean; /** * Check if match Sequence settings are allowed. */ readonly isMatchSequenceSettingsAllowed: boolean; /** * Returns the locked status of the output file. */ readonly isOutputFilePathLocked: boolean; /** * Returns the match Sequence settings value. */ readonly matchSequenceSettings: boolean; /** * Returns JSON describing whether the selected format cannot match the source * audio channelization plus source|output channel counts. */ readonly matchSourceAudioChannelMismatch: string; /** * Check if the original applied preset contains any enabled publish settings. * Publish settings will be controlled by the destination settings which * overwrites any original preset publish settings. */ readonly originPresetHasEnabledPublishGroups: boolean; /** * Returns the path to the output file. */ readonly outputFilePath: string; /** * Returns the current selected Preset Actions Settings. */ readonly presetActionsGroupSettings: string; /** * Returns the current selected Preset Audio Settings. */ readonly presetAudioGroupSettings: string; /** * Returns the current selected Preset Caption Settings. */ readonly presetCaptionGroupSettings: string; /** * Returns the current selected Preset Effects Settings. */ readonly presetEffectsGroupSettings: string; /** * Returns the current selected Preset Ingest Settings. */ readonly presetIngestGroupSettings: string; /** * Returns the current selected Preset Metadata Settings. */ readonly presetMetadataGroupSettings: string; /** * Returns the current selected Preset Publish Settings. */ readonly presetPublishGroupSettings: string; /** * Returns the current selected Preset Video Settings. */ readonly presetVideoGroupSettings: string; readonly rangeOption: any; readonly scalingOption: any; /** * Returns a JSON list of the currently selected source object. */ readonly sourceSelection: string; /** * Change the export format selected preset will be reset to the default preset * for a given format. * @param newFormat */ changeFormat(newFormat: string): boolean; /** * Change match source state for the given Parameter. * @param id * @param value */ changeMatchSource(id: string, value: boolean): boolean; /** * Change an existing Parameter. * @param group * @param id * @param value */ changeParameter(group: string, id: string, value: string): boolean; /** * Returns the information about the current selected Preset. * @param includeSettings */ currentPresetInfo(includeSettings: boolean): string; /** * Returns the current selected Preset settings from a special group. * @param groupKey */ currentPresetSettingsForGroup(groupKey: string): string; /** * Export the current Preset. * @param filePath * @param presetComments */ exportCurrentPresetTo(filePath: string, presetComments: string): boolean; /** * Get the aspect ratio lock state. */ getAspectRatioLock(): boolean; /** * Returns the localized display string for Output Summary when content * credentials are applied. */ getContentCredentialsApplyDisplayString(): string; /** * Returns true if the current selection (sequence or project items) contains * content credentials. */ hasContentCredentials(): boolean; /** * Returns true if the export of content credentials (cr) is activated */ isExportCRActivated(): boolean; /** * Returns true if the export format is supported by content credentials (cr) */ isFormatSupportedByCR(): boolean; /** * Returns the full path to a selected file * @param defaultDir * @param defaultFileName * @param extension */ saveAsDialog(defaultDir: string, defaultFileName: string, extension: string): string; /** * Returns the full path to a selected file * @param fullPathWithExtension */ saveAsDialogWithFullPath(fullPathWithExtension: string): string; /** * Save a custom preset. * @param presetName * @param saveEffectSettings * @param savePublishSettings */ saveCustomPreset(presetName: string, saveEffectSettings: boolean, savePublishSettings: boolean): boolean; /** * Select a new destination. * @param destID * @param groupIndex */ selectDestination(destID: string, groupIndex: number): boolean; /** * Set the aspect ratio lock state. * @param value */ setAspectRatioLock(value: boolean): boolean; /** * Set currently selected Preset. * @param presetID */ setCurrentPreset(presetID: string): boolean; /** * Set new Custom Data to the destination to store plugin or UI related * information for this destination as JSON. * @param destID * @param groupIndex * @param customData */ setDestinationCustomData(destID: string, groupIndex: number, customData: string): boolean; /** * Set the import into Project preference value. * @param importExportedFile */ setImportIntoProject(importExportedFile: boolean): boolean; /** * Set the JSON return parameter for this class. Hide Hidden doesn't expose not * UI visible params. Hide Unset returns smaller JSON by not exposing the * parameter when set to default (e.g. disable = false will not expose but * disable = true will). Will return true then an options has changed. * @param includeHiddenParams * @param includeUnsetValues */ setJSONConvertOptions(includeHiddenParams: boolean, includeUnsetValues: boolean): boolean; /** * Set the Sequence settings as Preset. * @param matchSequenceSettings */ setMatchSequenceSettings(matchSequenceSettings: boolean): boolean; /** * Set the new path to the output file. The filename can be made unique based * on other files already on disk. * @param filePath * @param createUniqueFilename */ setOutputFilePath(filePath: string, createUniqueFilename: boolean): boolean; /** * Set the current Range Option: Entire(0) InToOut(1) WorkArea(2) Custom(3) * Default(4). * @param rangeOption */ setRangeOption(rangeOption: number): boolean; /** * Set the current Scaling Option: Scale to fit(0) Scale to fill(3) Stretch to * fill(5). * @param scalingOption */ setScalingOption(scalingOption: number): boolean; /** * Returns output filepath collision type for a given filepath. There could be * no collision collision with another destination or collision with existing * file on disk. * @param filePath */ validateOutputFilePathCollisions(filePath: string): number; /** * Returns true if the current selection (sequence or project items) will be * signed with content credentials. */ willSignWithContentCredentials(): boolean; } /** * Transcoder event object */ declare class TranscoderEvent { /** * A new (publish) destination was selected. */ static readonly EVENT_DESTINATIONSELECTED: string; /** * Exported File size needs an update. */ static readonly EVENT_DISKSPACEREQUIREMENTCHANGED: string; /** * The export range option changed. */ static readonly EVENT_EXPORTWORKAREACHANGED: string; /** * The export format has changed. */ static readonly EVENT_FORMATCHANGED: string; /** * A new event is generated */ static readonly EVENT_NEWEVENTGENERATED: string; /** * The output filename has changed and needs to be updated. */ static readonly EVENT_OUTPUTFILENAMECHANGED: string; /** * A new preset is selected. */ static readonly EVENT_SELECTNEWPRESET: string; /** * Export Warning should be displayed. EventInfo contains the warning message. */ static readonly EVENT_SHOWEXPORTWARNING: string; /** * Settings changed and all settings needs to be updated. */ static readonly EVENT_UPDATEALLSETTINGS: string; /** * One Parameter or Parameter Group changed. EventInfo contains the changed * parameter ID. */ static readonly EVENT_UPDATEDEPENDENCIES: string; /** * Additional info as string or JSON if required by this event. Otherwise * empty. */ readonly eventInfo: string; static addEventListener(): any; static dispatchEvent(): any; static removeEventListener(): any; } /** * A hierarchical list whose items can contain child items. */ declare class TreeView { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The width and height in pixels of each item in the list. */ itemSize: Dimension; /** * The array of top-level items displayed in the list. */ readonly items: ListItem[]; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the control * (properties used only when the element is created). */ properties: Object; /** * The currently selected list item. */ selection: ListItem; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The element type, "treeview". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Adds an item to the top-level choices in this list. * @param type The type of the child element, the string "item". * @param text The localizable text label for the item. */ add(type: string, text?: string): ListItem; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Retrieves an item object from the list that has a given text label. * @param text The text string to match. */ find(text: string): ListItem; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the content of the element * has been changed */ onChange(): void; /** * An event-handler callback function, called when the user collapses (closes) * an expanded node in the treeview. * @param item The ListItem node that collapsed. */ onCollapse(item: ListItem): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the user expands (opens) a * collapsed node in the treeview. * @param item The ListItem node that expanded. */ onExpand(item: ListItem): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Removes a child item from the list. * @param what The item or child to remove, specified by 0-based index in the top-level item list, text value, or as a ListItem object. */ remove(what: any): void; /** * Removes all child items from the list. */ removeAll(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * The TypeReflection object provides information about the behavior of type of * a property. */ declare class TypeReflection { /** * true if it is an array type. */ readonly arrayType: boolean; /** * The type name. */ readonly name: string; /** * true if the value could be undefined. */ readonly optionalType: boolean; } /** * Encapsulates input event information for an event that propagates through a * container and control hierarchy. */ declare class UIEvent { /** * True if the event is of a type that bubbles. */ readonly bubbles: boolean; /** * True if the default action associated with the event can be canceled with * preventDefault(). */ readonly cancelable: boolean; /** * True if this event can be captured. */ readonly captures: boolean; /** * The event target object which is currently handling the event. During * capturing and bubbling, this is different from the property target. */ readonly currentTarget: boolean; /** * The click count for a mouse-click event. */ readonly detail: any; /** * The current phase of event propagation; one of none, target, capture, * bubble. */ readonly eventPhase: string; /** * The event target object for this event. */ readonly target: any; /** * The date and time at which the event occurred. */ readonly timeStamp: Date; /** * The name of the event that this object represents. */ readonly type: string; /** * The ScriptUI element that this event relates to. */ readonly view: any; /** * Creates an event. * @param type The event type. See UIEvent.type property. * @param captures Set to true if this event can be captured. * @param bubbles Set to true if the event bubbles. * @param view The ScriptUI element that this event relates to. * @param detail The click count for a mouse-click event. */ constructor(type: string, captures: boolean, bubbles: boolean, view?: Object, detail?: number); /** * Initializes a UI event as a core W3C event. * @param type The event type. * @param captures Set to true if this event can be captured. * @param bubbles Set to true if the event bubbles. * @param cancelable Set to true if the default action is cancelable. */ initEvent(type: string, captures: boolean, bubbles: boolean, cancelable: boolean): void; /** * Initializes an event. * @param type The event type. * @param captures Set to true if this event can be captured. * @param bubbles Set to true if the event bubbles. * @param view The ScriptUI element that this event relates to. * @param detail The click count for a mouse-click event. */ initUIEvent(type: string, captures: boolean, bubbles: boolean, view?: Object, detail?: number): void; /** * Prevents the default action associated with this event from being called. */ preventDefault(): void; /** * Stops the propagation of this event. */ stopPropagation(): void; } /** * UPXHost class provides private functionality to interact with the host from * the plugin */ declare class UXPHost { /** * Returns a vector of namespaces - a union of those provided as default by the * host and defined in the manifest of the plugin * @param pluginId */ static getNamespacesForPluginId(pluginId: string): any; /** * Returns the file system path of a UXP plugin given its plugin ID * @param pluginId */ static getPathFromPluginId(pluginId: string): string; } /** * Represents a measurement as a combination of values and unit. */ declare class UnitValue { /** * The base unit for all conversions. */ static baseUnit: UnitValue; /** * The base unit. */ baseUnit: UnitValue; /** * The unit name. */ readonly type: string; /** * The numeric value. */ value: number; /** * Returns this instance as a different unit. * @param unitName The unit name. */ as(unitName: string): UnitValue; /** * Converts this instance to a different unit. * @param unitName The unit name. */ convert(unitName: string): any; } /** * High level interface object that gives access to the UniversalSearchAPI * Layer */ declare class UniversalSearchAPI { /** * Sort result values in ascending order. */ static readonly ORDER_ASCENDING: number; /** * Sort result values in descending order. */ static readonly ORDER_DESCENDING: number; /** * Sort result values by duration. */ static readonly SORT_DURATION: number; /** * Sort result values by name. */ static readonly SORT_NAME: number; /** * Sort result values by score. */ static readonly SORT_SCORE: number; /** * Sort result values by time. */ static readonly SORT_TIME: number; /** * Return the facets that are provided by this set of search results. * @param query * @param pageOptions * @param searchOptions */ findAll(query: Object, pageOptions: Object, searchOptions: any): Object; /** * Get an object representing the universal search API backend */ static getInstance(): Object; } /** * Query that can be used in connection with the universal search API */ declare class UniversalSearchQuery { /** * AND operator for field queries. */ static readonly BOOLEAN_FIELD_OPERATOR_AND: number; /** * OR operator for field queries. */ static readonly BOOLEAN_FIELD_OPERATOR_OR: number; /** * Find fields that contain the given content. */ static readonly FIELD_QUERY_CONTAINS: number; /** * Find fields that end with the given content. */ static readonly FIELD_QUERY_ENDS_WITH: number; /** * Find fields that equal the given content. */ static readonly FIELD_QUERY_EQUALS: number; /** * Find fields that start with the given content. */ static readonly FIELD_QUERY_STARTS_WITH: number; readonly description: string; /** * Constructs a filter query that only enables agents other then the given * agents. * @param disallowedAgents * @param subQuery */ static createAgentDisallowFilterQuery(disallowedAgents: any, subQuery: Object): Object; /** * Constructs a filter query that only enables the given agents. * @param agents * @param subQuery */ static createAgentFilterQuery(agents: any, subQuery: Object): Object; /** * Constructs a text query that searches on agents for the given text. * @param queryText */ static createAgentTextQuery(queryText: string): Object; /** * Constructs a field query consisting of a vector of {schema:string * property:string content:string * operator:FIELD_QUERY_CONTAINS|FIELD_QUERY_EQUALS|FIELD_QUERY_STARTS_WITH|FIELD_QUERY_ENDSWITH} * objects that can be used to query e.g. the metadata search index for path * based queries. The second parameter is an operator * (BOOLEAN_FIELD_OPERATOR_AND|BOOLEAN_FIELD_OPERATOR_OR) for the metadata * search aggregation which can be either * @param fieldSpecs * @param operator */ static createFieldQuery(fieldSpecs: any[], operator: number): Object; /** * Constructs a merge query that merges results from multiple subqueries. Merge * queries will not perform any deduplication. Results from all subqueries are * merged into one final output result set. * @param subQueries */ static createMergeQuery(subQueries: any[]): Object; /** * Constructs a join query that joins results from 2 subqueries on a set of * given paths. The join operation will be successful if the same objects exist * under the same pathes for both objects and return a joined object with all * paths merged in that case. Otherwise the join operation will fail.A path is * a seperated string that represents the path to the object in the * result object. e.g. key1.key2.key3 * @param leftQuery * @param rightQuery * @param keyPaths */ static createPathJoinQuery(leftQuery: Object, rightQuery: Object, keyPaths: any): Object; /** * Constructs a query from a valid query JSON file. * @param jsonString */ static createQueryFromJSON(jsonString: string): Object; /** * Constructs a join query that joins results from 2 subqueries on the * universal search result object hash. Meaning that two results will be joined * if and only if the refer to the same object within the host * @param leftQuery * @param rightQuery */ static createUniversalJoinQuery(leftQuery: Object, rightQuery: Object): Object; } /** * Result object that represents one search result in the universal search API. * Search results can refer to any entity within the application. Source Clips, * Markers, Commands etc. It is up to the client to interpret the result based * on the provided type and payload. */ declare class UniversalSearchResult { /** * The identifier of the search agent that was used to create this result. */ readonly agent: string; /** * Return the facets that are provided by this search result. */ readonly facets: any; /** * The hash of this search results. Identical hashes lead to the exact same * rendition of an item in the UI. */ readonly hash: any; /** * The payload of the search result in JSON string format. The payload contains * all data that is needed to get the actual referenced object of this search * result. */ readonly payload: string; /** * The score for the search result in range [01]. Higher numbers indicate a * better match. Search agents that only match on exact hits will only return * 1.0 as score for best matches. */ readonly score: number; /** * The type of this search result. This can be e.g. 'MasterClip' 'Marker'... */ readonly type: string; /** * The hash of the object this search results is referring to. Generally if two * search results are referencing the same object regardless of modality or * details they will feature an identical universalJoinHash. A good example * would be the same project item referenced by metadata and transcript search * would lead to the same universalJoinHash. */ readonly universalJoinHash: any; } /** * A collection of universal search results */ declare class UniversalSearchResults { /** Returns the UniversalSearchResult with the specified index or name. */ [index: number]: UniversalSearchResult; /** * Return the facets that are provided by this set of search results. */ readonly facets: any; /** * The individual results provided by this results object that match the given * facet. */ readonly results: any[]; /** * Returns the result codes for failed agents segmented by agent in JSON format * of pairs {agent errorCode}. If an error occurred the error message can be * retrieved using getLocalizedErrorMessageForAgent. */ getErrors(): Object; /** * The individual results provided by this results object that match the given * facet. The facet vector can be empty in which case all existing search * results will be returned. * @param facets */ getFacetedResults(facets: any): any[]; /** * If the search for this result set failed this call returns a localized error * message in the current application language that can be presented to the * user. In case search was successful this call returns an empty string. * Agents do not have to provide a localized error message in which case this * function will return a generic error message saying "Search failed with * code: " * @param agentIdentifier */ getLocalizedErrorMessageForAgent(agentIdentifier: string): string; } /** * Algebra BLAS data class */ declare class Vector { /** * Get number of columns in this data object. */ readonly cols: number; /** * Get the length of the vector. */ readonly length: number; /** * Get number of rows in this data object. */ readonly rows: number; /** * Constructs a new BLAS Vector object. * @param rows * @param data */ constructor(rows: number, data: any); /** * Element-wise absolute value; returns a new vector or matrix. */ abs(): Object; /** * Element-wise add another vector or matrix of the same shape; returns a new * vector or matrix. * @param other */ add(other: Object): Object; /** * Get the linear (column-major) index of the maximum element. */ argMax(): number; /** * Get the value at the given row index. * @param rowIdx */ at(rowIdx: number): number; /** * Element-wise divide by another vector or matrix of the same shape; returns a * new vector or matrix. * @param other */ divide(other: Object): Object; /** * Compute the dot product of this vector with another. * @param other */ dot(other: Object): number; /** * Get the maximum element value in this vector or matrix. */ max(): number; /** * Element-wise maximum of each element and the given scalar; returns a new * vector or matrix. * @param scalar */ maximum(scalar: number): Object; /** * Element-wise multiply by another vector or matrix of the same shape; returns * a new vector or matrix. * @param other */ multiply(other: Object): Object; /** * Compute the norm of this vector or matrix. */ norm(): number; /** * Element-wise power; returns a new vector or matrix. * @param exponent */ pow(exponent: number): Object; /** * Multiply each element by the given scalar; returns a new vector or matrix. * @param factor */ scale(factor: number): Object; /** * Compute the squared L2 norm of this vector or matrix. */ squaredNorm(): number; /** * Element-wise subtract another vector or matrix of the same shape; returns a * new vector or matrix. * @param other */ subtract(other: Object): Object; /** * Compute the sum of all elements in this vector or matrix. */ sum(): number; } /** * Represents a wave file on disk and can be used to retrieve basic metadata. */ declare class WaveFile { /** * The bit depth of the referenced wave file. */ readonly bitDepth: number; /** * The channel layout of the referenced wave file. */ readonly channelLayout: any; /** * The file path of the referenced wave file. */ readonly filePath: string; /** * The sample count of the referenced wave file. */ readonly sampleCount: number; /** * The sample rate of the referenced wave file. */ readonly sampleRate: number; /** * Create a new wave file object referencing a file on disk. * @param filePath */ constructor(filePath: string); } /** * The instance represents a top-level window or dialog box, which contains * user-interface elements. */ declare class Window { /** * Set to true to make this window active. */ active: boolean; /** * Tells the layout manager how unlike-sized children of this container should * be aligned within a column or row. */ alignChildren: string; /** * The alignment style for child elements of a container. If defined, this * value overrides the alignChildren setting for the parent container. */ alignment: string; /** * The bounds of the window's drawable area, excluding the frame, in screen * coordinates. */ bounds: Bounds; /** * For windows of type dialog, the UI element to notify when the user presses a * cancellation key combination. */ cancelElement: Object; /** * A number of characters for which to reserve space when calculating the * preferred size of the window. * @remarks Range: 0 to … */ characters: number; /** * The collection of UI elements that have been added to this container. */ readonly children: Object[]; /** * For windows of type dialog, the UI element to notify when the user presses a * Enter key. */ defaultElement: Object; /** * True if this element is enabled. */ enabled: boolean; /** * The bounds of the window frame in screen coordinates. */ readonly frameBounds: Bounds; /** * The top left corner of the window frame in screen coordinates. */ frameLocation: Point; /** * The size and location of the window's frame in screen coordinates. */ readonly frameSize: Dimension; /** * Deprecated. Use ScriptUI.frameworkName instead. */ static readonly frameworkName: string; /** * The graphics object that can be used to customize the window’s appearance, * in response to the onDraw event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element. * @remarks Range: 0 to … */ indent: number; /** * The default text justification style for child text elements. */ justify: string; /** * The layout manager for this container. */ layout: LayoutManager; /** * The upper left corner of the window's drawable area. */ location: Point; /** * The number of pixels between the edges of a container and the outermost * child elements. */ margins: number; /** * True if the window is expanded. */ maximized: boolean; /** * The largest rectangle to which the window can be resized. */ maximumSize: Dimension; /** * True if the window is minimized or iconified. */ minimized: boolean; /** * The smallest rectangle to which the window can be resized. */ minimumSize: Dimension; /** * The opacity of the window, in the range [0..1]. */ opacity: number; /** * The layout orientation of children in a container. */ orientation: string; /** * The immediate parent element. */ readonly parent: any; /** * The preferred size of the window. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The keypress combination that invokes this element's onShortcutKey() * callback. */ shortcutKey: string; /** * The current size and location of the content area of the window in screen * coordinates. */ size: Dimension; /** * The number of pixels separating one child element from its adjacent sibling * element. */ spacing: number; /** * The title, label, or displayed text, a localizeable string. */ text: string; /** * The element type; "dialog", "palette", or "window". */ readonly type: string; /** * Deprecated. Use ScriptUI.version instead. */ static readonly version: any; /** * When true, the element is shown, when false it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this window relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Creates a new window. * @param type The window type. * @param title The window title, a localizable string. * @param bounds The window's position and size. * @param properties An object containing creation-only properties. */ constructor(type: string, title?: string, bounds?: Bounds, properties?: Object); /** * Creates and returns a new control or container object and adds it to the * children of this window. * @param type The type of the child element, as specified for the type property. * @param bounds A bounds specification that describes the size and position of the new control or container, relative to its parent. * @param text The text or label, a localizable string. * @param properties An object that contains one or more creation properties of the new child (properties used only when the element is created). */ add(type: string, bounds?: Bounds, text?: string, properties?: Object): any; /** * Registers an event handler for a particular type of event occuring in this * window. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase?: boolean): boolean; /** * Displays a platform-standard dialog containing a short message and an OK * button. * @param message TThe string for the displayed message. * @param title A string to appear as the title of the dialog, if the platform supports a title. * @param errorIcon When true, the platform-standard alert icon is replaced by the platform-standard error icon in the dialog. */ static alert(message: string, title?: string, errorIcon?: boolean): void; /** * Centers this window on screen or with repect to another window. * @param window The relative window. If not specified, centers on the screen. */ center(window?: Window): void; /** * Closes this window. * @param return_ A number to be returned from the show() method that invoked this window as a modal dialog. */ close(return_?: any): void; /** * Displays a platform-standard dialog containing a short message and two * buttons labeled Yes and No. * @param message The string for the displayed message. * @param noAsDefault When true, the No button is the default choice, selected when the user types Enter. * @param title A string to appear as the title of the dialog, if the platform supports a title. */ static confirm(message: string, noAsDefault: boolean, title?: string): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): UIEvent; /** * Use this method to find an existing window. * @param type The name of a predefined resource available to JavaScript in the current application; or the window type. * @param title The window title. */ static find(type: string, title: string): Window; /** * Hides this windows. */ hide(): void; /** * Sends a notification message to all listeners, simulating the specified user * interaction event. * @param eventName The event name; if omitted, the default event is sent. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the window acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the window is about to be * closed. */ onClose(): boolean; /** * An event-handler callback function, called when the window loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window has been moved */ onMove(): void; /** * An event-handler callback function, called when the window is being moved */ onMoving(): void; /** * An event-handler callback function, called after the window has been resized */ onResize(): void; /** * An event-handler callback function, called while a window is being resized */ onResizing(): void; /** * In Windows only, an event-handler callback function, called a shortcut-key * sequence is typed that matches the shortcutKey value for this window. */ onShortcutKey(): void; /** * An event-handler callback function, called just before the window is * displayed */ onShow(): void; /** * Displays a modal dialog that returns the user’s text input. * @param prompt The string for the displayed message. * @param default_ The initial value to be displayed in the text edit field. * @param title A string to appear as the title of the dialog. */ static prompt(prompt: string, default_?: string, title?: string): string; /** * Removes the specified child control from this window’s children array. * @param what The child control to remove, specified by 0-based index, text property value, or as a control object. */ remove(what: any): void; /** * Unregisters an event handler for a particular type of event occuring in this * window. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Makes this window visible. */ show(): any; } /** * Wraps XML into an object. */ declare class XML { /** * Controls whether XML comments should be parsed (false) or ignored (true). */ static ignoreComments: boolean; /** * Controls whether XML preprocessing instructions should be parsed (false) or * ignored (true). */ static ignoreProcessingInstructions: boolean; /** * Controls whether whitespace should be parsed (false) or ignored (true). */ static ignoreWhitespace: boolean; /** * The number of spaces used to indent pretty-printed XML. */ static prettyIndent: number; /** * When true, XML is pretty-printed when converting to a string. */ static prettyPrinting: boolean; /** * Parses an XML string. Throws an error if the XML is incorrect. * @param text The text to parse. */ constructor(text: string); /** * Adds a namespace declaration to the node. Returns the XML object itself. * @param namespace The namespace to add. */ addNamespace(namespace: Namespace): XML; /** * Appends the given XML to this XML as a child. Returns the XML object itself. * @param child The child XML to add. */ appendChild(child: XML): XML; /** * Returns a list containing all attribute elements matching the given name. * @param name The attribute name to look for. */ attribute(name: string): XML; /** * Returns a list containing all attribute elements. */ attributes(): XML; /** * Returns a list containing all children of this XML matching the given * element name. * @param name The name or the index of the child element. */ child(name: string): XML; /** * Returns a number representing the ordinal position of this XML object within * the context of its parent. */ childIndex(): number; /** * Returns an XML object containing all the properties of this XML object in * order. */ children(): XML; /** * Returns an XML object containing the properties of this XML object that * represent XML comments. */ comments(): XML; /** * Checks if this XML object contains the given XML object. * @param xml The XML to search for. */ contains(xml: XML): boolean; /** * Creates a copy of this XML object. */ copy(): XML; /** * Returns an object containing the default parsing and print settings for XML. */ static defaultSettings(): Object; /** * Returns all the XML-valued descendants of this XML object with the given * name. * @param name The name of the descendant to find. */ descendants(name?: string): XML; /** * Returns a list of XML children that are elements with a given name, or all * children that are XML elements. * @param name The element name. If not supplied, gets all children that are XML elements. */ elements(name?: string): XML; /** * Reports whether this XML object contains complex content. */ hasComplexContent(): boolean; /** * Reports whether this XML object contains simple content. */ hasSimpleContent(): boolean; /** * Returns an array of Namespace objects mirroring the current list of valid * namespaces at this element. */ inScopeNamespaces(): any[]; /** * Inserts the given child2 after the given child1 in this XML object and * returns this XML object. * @param child1 The child to insert the other child after. * @param child2 The XML to insert. */ insertChildAfter(child1: XML, child2: XML): void; /** * Inserts the given child2 before the given child1 in this XML object and * returns this XML object. * @param child1 The child to search for. * @param child2 The XML to insert. */ insertChildBefore(child1: XML, child2: XML): void; /** * Returns the number of elements contained in an XML list. If this XML object * is not a list, returns 1. */ length(): number; /** * Returns the local name of this XML object. */ localName(): string; /** * Returns a QName object containing the URI and the local name of the element. */ name(): QName; /** * Returns a Namespace object containing the namespace URI of the current * element. */ namespace(): Namespace; /** * Returns an array containing all namespace declarations of this XML object. */ namespaceDeclarations(): any[]; /** * Returns the type of this XML object as one of the strings "element", * "attribute", "comment", "processing-instruction", or "text". */ nodeKind(): string; /** * Puts all text nodes in this and all descendant XML objects into a normal * form by merging adjacent text nodes and eliminating empty text nodes. * Returns this XML object. */ normalize(): XML; /** * Returns the parent object of this XML object. */ parent(): XML; /** * Inserts a given child into this object before its existing XML properties, * and returns this XML object. * @param child The XML to insert. */ prependChild(child: XML): XML; /** * Returns a list of preprocessing instructions. * @param name The name of the preprocessing instruction to return. */ processingInstructions(name?: string): XML; /** * Removes the given namespace from this XML, and returns this XML. * @param namespace The namespace to remove. */ removeNamespace(namespace: Namespace): XML; /** * Replaces the value of specified XML properties of this XML object returns * this XML object. * @param name The property name. * @param value The XML with which to replace the value of the matching property. */ replace(name: string, value: XML): XML; /** * Replaces all of the XML-valued properties in this object with a new value, * and returns this XML object. * @param value The new value, which can be a single XML object or an XML list. */ setChildren(value: XML): XML; /** * Replaces the local name of this XML object with a string constructed from * the given name * @param name The name to set. */ setLocalName(name: string): void; /** * Replaces the name of this XML object with the given QName object. * @param name The fully qualified name. */ setName(name: QName): void; /** * Sets the namespace for this XML element. * @param namespace The namespace to set. */ setNamespace(namespace: Namespace): void; /** * Sets the parsing and print setting for XML using an object returned by the * settings() method. * @param obj The object containing the settings to set. */ static setSettings(obj: Object): void; /** * Returns an object containing the current parsing and print settings for XML. */ static settings(): Object; /** * Returns an XML list containing all XML properties of this XML object that * represent XML text nodes. */ text(): XML; /** * Returns the string representation of this object. */ toString(): string; /** * Returns an XML-encoded string representation of this XML object. */ toXMLString(): string; /** * Evaluates the given XPath expression in accordance with the W3C XPath * recommendation, using this XML object as the context node. * @param expr The XPath expression to use. */ xpath(expr: string): XML; } /** * An XML list object. */ declare class XMLList { } /** * ZString class provides access to localized version of a string. */ declare class ZString { /** * Get localized value for a loc-key. * @param locKey */ static getZString(locKey: string): string; /** * Get localized value for a loc-key. * @param locKey * @param stringSubstitutions */ static getZStringAndReplace(locKey: string, stringSubstitutions: any): string; } /** * The application object */ declare const app: Application; /** * Displays an alert box * @param message The text to display * @param title The title of the alert; ignored on the Macintosh * @param errorIcon Display an Error icon; ignored on the Macintosh */ declare function alert(message: string, title?: string, errorIcon?: boolean): void; /** * Displays an alert box with Yes and No buttons; returns true for Yes * @param message The text to display * @param noAsDefault Set to true to set the No button as the default button * @param title The title of the alert; ignored on the Macintosh */ declare function confirm(message: string, noAsDefault: boolean, title?: string): boolean; /** * Returns true if the supplied string is a valid XML name. * @param name The XML name to test. */ declare function isXMLName(name: string): boolean; /** * Localizes a ZString-encoded string and merges additional arguments into the * string. * @param what The string to localize. A ZString-encoded string that can contain placeholder for additional arguments in the form %1 to %n. * @param argument Optional argument(s) to be merged into the string. There may be more than one argument. */ declare function localize(what: string, argument?: any): string; /** * Displays a dialog allowing the user to enter text * @param prompt The text to display * @param default_ The default text to preset the edit field with * @param title The title of the dialog; */ declare function prompt(prompt: string, default_?: string, title?: string): string; /** * Defines the default XML namespace. * @param namespace The namespace to use. */ declare function setDefaultXMLNamespace(namespace: Namespace): void; /** * Creates a source code representation of the supplied argument, and returns * it as a string. * @param what The object to uneval. */ declare function uneval(what: any): string;