{ "formatVersion": 2, "product": "Media Encoder", "slug": "media-encoder", "version": "Adobe Media Encoder 2027", "generated": "2026-11-10", "runtimes": [ "extendscript" ], "counts": { "objects": 100, "properties": 569, "events": 1, "methods": 467 }, "objects": [ { "name": "AMEBatchItemCreationFailedEvent", "page": "AMEBatchItemCreationFailedEvent.html", "kind": "Object", "description": "The event will be sent after batch item creation failed. Can be used for the following FrontendScriptObject API's: 'addFileToBatch', 'addTeamProjectsItemToBatch' and 'addDLToBatch'.", "properties": [ { "name": "error", "type": "string", "description": "Get the error string", "access": "readonly" }, { "name": "onBatchItemCreationFailed", "type": "string", "description": "Notify when the batch item creation failed.", "access": "readonly", "static": true }, { "name": "srcFilePath", "type": "string", "description": "Get the source file path.", "access": "readonly" } ], "events": [], "methods": [ { "name": "addEventListener", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "dispatchEvent", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "removeEventListener", "returns": "any", "static": true, "description": "", "parameters": [] } ] }, { "name": "AMEExportEvent", "page": "AMEExportEvent.html", "kind": "Object", "description": "Provides the following event types: onMediaInfoCreated, onBatchItemStatusChanged, onItemEncodingStarted, onAudioPreEncodeProgress, onEncodingItemProgressUpdated, onEncodeComplete, onError, onPostProcessListInitialized", "properties": [ { "name": "audioInfo", "type": "string", "description": "Returns the audio pre-encoding info for the event type onAudioPreEncodeProgress (available since 24.0).", "access": "readonly" }, { "name": "audioProgress", "type": "number", "description": "Returns the audio pre-encoding progress for the event type onAudioPreEncodeProgress (available since 24.0).", "access": "readonly" }, { "name": "encodeCompleteStatus", "type": "boolean", "description": "Returns true after encoding has been completed for a batch item. Can be called for onEncodeComplete event.", "access": "readonly" }, { "name": "encodeCompleteTime", "type": "number", "description": "Returns the encoding time in milliseconds. Can be called for onEncodeComplete event.", "access": "readonly" }, { "name": "error", "type": "string", "description": "Returns export error string (available since 25.2).", "access": "readonly" }, { "name": "groupIndex", "type": "number", "description": "Returns the batch group index. Can be called for onBatchItemStatusChanged event.", "access": "readonly" }, { "name": "itemIndex", "type": "number", "description": "Returns the batch item index. Can be called for onBatchItemStatusChanged event.", "access": "readonly" }, { "name": "oEncodingItemProgressUpdated", "type": "string", "description": "Notify the encoding progress (Deprecated).", "access": "readonly", "static": true }, { "name": "onAudioPreEncodeProgress", "type": "string", "description": "Notify when the audio pre-encode progress changes (available since 24.0)", "access": "readonly", "static": true }, { "name": "onBatchItemStatusChanged", "type": "string", "description": "Notify when batch item status has been changed. You can call the API's groupIndex itemIndex and status for more info.", "access": "readonly", "static": true }, { "name": "onEncodeComplete", "type": "string", "description": "Notify when the batch item has been encoded. You can call the API's encodeCompleteStatus and encodeCompleteTime for more info.", "access": "readonly", "static": true }, { "name": "onEncodingItemProgressUpdated", "type": "string", "description": "Notify the encoding progress.", "access": "readonly", "static": true }, { "name": "onError", "type": "string", "description": "Notify when there's an error while encoding the batch item.", "access": "readonly", "static": true }, { "name": "onItemEncodingStarted", "type": "string", "description": "Notify when the encoding of a batch item has started.", "access": "readonly", "static": true }, { "name": "onMediaInfoCreated", "type": "string", "description": "Notify when media info has been created.", "access": "readonly", "static": true }, { "name": "onPostProcessListInitialized", "type": "string", "description": "Notify when the post process list is initialized.", "access": "readonly", "static": true }, { "name": "progress", "type": "number", "description": "Returns the batch item encoding progress value which is between 0 and 1. Can be called for onEncodingItemProgressUpdated event", "access": "readonly" }, { "name": "status", "type": "any", "description": "", "access": "readonly" } ], "events": [], "methods": [ { "name": "addEventListener", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "dispatchEvent", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "removeEventListener", "returns": "any", "static": true, "description": "", "parameters": [] } ] }, { "name": "AMEFrontendEvent", "page": "AMEFrontendEvent.html", "kind": "Object", "description": "The event will be sent after a batch item has been created successfully.", "properties": [ { "name": "onItemAddedToBatch", "type": "string", "description": "Notify when a batch item has been created successfully. Can be used for all FrontendScriptObject API's which creates a batch item.", "access": "readonly", "static": true } ], "events": [], "methods": [ { "name": "addEventListener", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "dispatchEvent", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "removeEventListener", "returns": "any", "static": true, "description": "", "parameters": [] } ] }, { "name": "AMEUXPApplication", "page": "AMEUXPApplication.html", "kind": "Object", "description": "AME UXP event root", "properties": [], "events": [], "methods": [] }, { "name": "AffinityPropagation", "page": "AffinityPropagation.html", "kind": "Object", "description": "Static clustering object for Affinity Propagation algorithm", "properties": [], "events": [], "methods": [ { "name": "cluster", "returns": "Clusters", "static": true, "description": "Performs affinity propagation clustering on data points. The preferences parameter contains: convergenceIterations (int32) maximumIterations (int32) dampingFactor (float) preferenceSize (float)", "parameters": [ { "name": "dataPointMatrix", "type": "Object", "description": "" }, { "name": "preferences", "type": "Object", "description": "" } ] } ] }, { "name": "AnalyzerHost", "page": "AnalyzerHost.html", "kind": "Object", "description": "Analyzer Host which contains ongoing analysis tasks and provides APIs to manage them.", "properties": [], "events": [], "methods": [ { "name": "countJobsForAnalyzer", "returns": "Object", "description": "Return the number of currently running analyzers for the given analyzer guid.", "parameters": [ { "name": "analyzerGuid", "type": "Object", "description": "" } ] }, { "name": "getDefault", "returns": "Object", "static": true, "description": "Get the default analyzer host for the running application", "parameters": [] }, { "name": "waitForAnalyzerCompletion", "returns": "Object", "description": "Return the number of currently running analyzers for the given analyzer guid.", "parameters": [ { "name": "analyzerGuid", "type": "Object", "description": "" } ] } ] }, { "name": "Application", "page": "Application.html", "kind": "Object", "description": "Top level app object", "properties": [ { "name": "buildNumber", "type": "string", "description": "Get application build number", "access": "readonly" } ], "events": [], "methods": [ { "name": "assertToConsole", "returns": "boolean", "description": "Redirect assert output to stdout.", "parameters": [] }, { "name": "bringToFront", "returns": "boolean", "description": "Bring application to front", "parameters": [] }, { "name": "cancelTask", "returns": "boolean", "description": "Cancel the task that matches the task ID", "parameters": [ { "name": "taskID", "type": "number", "description": "" } ] }, { "name": "getEncoderHost", "returns": "Object", "description": "Get the encoder host object. See EncoderHostScriptObject", "parameters": [] }, { "name": "getExporter", "returns": "Object", "description": "Get the exporter object. See ExporterScriptObject", "parameters": [] }, { "name": "getFrontend", "returns": "Object", "description": "Get the front end object. See FrontendScriptObject", "parameters": [] }, { "name": "getWatchFolder", "returns": "Object", "description": "Get the watch folder object. See WatchFolderScriptObject", "parameters": [] }, { "name": "isBlackVideo", "returns": "boolean", "description": "True if all frames are black", "parameters": [ { "name": "sourcePath", "type": "string", "description": "" } ] }, { "name": "isSilentAudio", "returns": "boolean", "description": "True if audio is silent", "parameters": [ { "name": "sourcePath", "type": "string", "description": "" } ] }, { "name": "quit", "returns": "boolean", "description": "Quit the AME app", "parameters": [] }, { "name": "renderFrameSequence", "returns": "boolean", "description": "Render still frames for given source", "parameters": [ { "name": "sourcePath", "type": "string", "description": "" }, { "name": "outputPath", "type": "string", "description": "" }, { "name": "renderAll", "type": "boolean", "description": "" }, { "name": "startFrame", "type": "number", "description": "" } ] }, { "name": "scheduleTask", "returns": "number", "description": "Schedule a script to run after delay returns task ID", "parameters": [ { "name": "scriptToExecute", "type": "string", "description": "Put your script as text, e.g. 'app.getEncoderHost().runBatch()'." }, { "name": "delayInMilliseconds", "type": "number", "description": "" }, { "name": "repeat", "type": "boolean", "description": "" } ] }, { "name": "wait", "returns": "boolean", "description": "Non UI blocking wait in milliseconds", "parameters": [ { "name": "milliseconds", "type": "number", "description": "" } ] }, { "name": "write", "returns": "boolean", "description": "Write text to std out", "parameters": [ { "name": "text", "type": "string", "description": "" } ] } ] }, { "name": "ArbData", "page": "ArbData.html", "kind": "Object", "description": "Provides scripting env access to MF::ArbData", "properties": [], "events": [], "methods": [ { "name": "ArbData", "returns": "ArbData", "description": "Construct an ArbData Object.", "parameters": [ { "name": "inBase64EncodedStringData", "type": "string", "description": "" } ] }, { "name": "getBase64EncodeStringValue", "returns": "string", "description": "Gets the binary value encoded with base64", "parameters": [] } ] }, { "name": "AudioChannelLayout", "page": "AudioChannelLayout.html", "kind": "Object", "description": "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.", "properties": [ { "name": ".index", "type": "number", "description": "Returns an audio channel label.", "access": "readonly" }, { "name": "AUDIOCHANNELLABEL_AMBISONIC_W", "type": "number", "description": "Ambisonic-W", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_AMBISONIC_X", "type": "number", "description": "Ambisonic-X", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_AMBISONIC_Y", "type": "number", "description": "Ambisonic-Y", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_AMBISONIC_Z", "type": "number", "description": "Ambisonic-Z", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_BACKCENTER", "type": "number", "description": "Back-Center", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_BACKLEFT", "type": "number", "description": "Back-Left", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_BACKRIGHT", "type": "number", "description": "Back-Right", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_BOTTOMFRONTCENTER", "type": "number", "description": "Bottom-Front-Center", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_BOTTOMFRONTLEFT", "type": "number", "description": "Bottom-Front-Left", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_BOTTOMFRONTRIGHT", "type": "number", "description": "Bottom-Front-Right", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_DISCRETE", "type": "number", "description": "Discrete", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_FRONTCENTER", "type": "number", "description": "Front-Center", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_FRONTLEFT", "type": "number", "description": "Front-Left", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_FRONTLEFTOFCENTER", "type": "number", "description": "Front-Left-Of-Center", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_FRONTLEFTWIDE", "type": "number", "description": "Front-Left-Wide", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_FRONTRIGHT", "type": "number", "description": "Front-Right", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_FRONTRIGHTOFCENTER", "type": "number", "description": "Front-Right-Of-Center", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_FRONTRIGHTWIDE", "type": "number", "description": "Front-Right-Wide", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_LEFTHEIGHT", "type": "number", "description": "Left-Height", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_LEFTTOTAL", "type": "number", "description": "Left-Total", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_LFE2", "type": "number", "description": "LFE2", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_LOWFREQUENCY", "type": "number", "description": "Low-Frequency", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_PROXIMITYLEFT", "type": "number", "description": "Proximity-Left", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_PROXIMITYRIGHT", "type": "number", "description": "Proximity-Right", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_REARSURROUNDLEFT", "type": "number", "description": "Rear-Surround-Left", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_REARSURROUNDRIGHT", "type": "number", "description": "Rear-Surround-Right", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_RIGHTHEIGHT", "type": "number", "description": "Right-Height", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_RIGHTTOTAL", "type": "number", "description": "Right-Total", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_SIDELEFT", "type": "number", "description": "Side-Left", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_SIDERIGHT", "type": "number", "description": "Side-Right", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_TOPBACKCENTER", "type": "number", "description": "Top-Back-Center", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_TOPBACKLEFT", "type": "number", "description": "Top-Back-Left", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_TOPBACKRIGHT", "type": "number", "description": "Top-Back-Right", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_TOPCENTER", "type": "number", "description": "Top-Center", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_TOPFRONTCENTER", "type": "number", "description": "Top-Front-Center", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_TOPFRONTLEFT", "type": "number", "description": "Top-Front-Left", "access": "readonly", "static": true }, { "name": "AUDIOCHANNELLABEL_TOPFRONTRIGHT", "type": "number", "description": "Top-Front-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_32_DISCRETE_CHANNELS", "type": "number", "description": "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", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_4_DISCRETE_CHANNELS", "type": "number", "description": "4 Channel Configuration Discrete Discrete Discrete Discrete", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_51", "type": "number", "description": "6 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency Back-Left Back-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_7_1", "type": "number", "description": "8 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency Back-Left Back-Right Front-Left-Of-Center Front-Right-Of-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_7_1EMAGIC", "type": "number", "description": "8 Channel Configuration Front-Left Front-Right Back-Left Back-Right Front-Center Low-Frequency Front-Left-Of-Center Front-Right-Of-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_7_1ITU", "type": "number", "description": "8 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency Back-Left Back-Right Rear-Surround-Left Rear-Surround-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_7_1MPEG", "type": "number", "description": "8 Channel Configuration Front-Center Front-Left-Of-Center Front-Right-Of-Center Front-Left Front-Right Back-Left Back-Right Low-Frequency", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_8_DISCRETE_CHANNELS", "type": "number", "description": "8 Channel Configuration Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_AMBISONICSBFORMAT", "type": "number", "description": "4 Channel Configuration Ambisonic-W Ambisonic-X Ambisonic-Y Ambisonic-Z", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_BFL_BFR", "type": "number", "description": "2 Channel Configuration Bottom-Front-Left Bottom-Front-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_BROADCAST51", "type": "number", "description": "6 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency Back-Left Back-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_CUBE", "type": "number", "description": "8 Channel Configuration Front-Left Front-Right Back-Left Back-Right Top-Front-Left Top-Front-Right Top-Back-Left Top-Back-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_C_LFE", "type": "number", "description": "2 Channel Configuration Front-Center Low-Frequency", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_C_L_R", "type": "number", "description": "3 Channel Configuration Front-Center Front-Left Front-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_C_L_R_CS", "type": "number", "description": "4 Channel Configuration Front-Center Front-Left Front-Right Back-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_C_L_R_LS_RS", "type": "number", "description": "5 Channel Configuration Front-Center Front-Left Front-Right Back-Left Back-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_C_L_R_LS_RS_CS", "type": "number", "description": "6 Channel Configuration Front-Center Front-Left Front-Right Back-Left Back-Right Back-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_C_L_R_LS_RS_CS_LFE", "type": "number", "description": "7 Channel Configuration Front-Center Front-Left Front-Right Back-Left Back-Right Back-Center Low-Frequency", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_C_L_R_LS_RS_LFE", "type": "number", "description": "6 Channel Configuration Front-Center Front-Left Front-Right Back-Left Back-Right Low-Frequency", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_C_L_R_LS_RS_RLS_RRS", "type": "number", "description": "7 Channel Configuration Front-Center Front-Left Front-Right Back-Left Back-Right Rear-Surround-Left Rear-Surround-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_C_L_R_LS_RS_RLS_RRS_CS", "type": "number", "description": "8 Channel Configuration Front-Center Front-Left Front-Right Back-Left Back-Right Rear-Surround-Left Rear-Surround-Right Back-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_HEXAGONAL", "type": "number", "description": "6 Channel Configuration Front-Left Front-Right Back-Left Back-Right Front-Center Back-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_LC_RC", "type": "number", "description": "2 Channel Configuration Front-Left-Of-Center Front-Right-Of-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_LEGACY51", "type": "number", "description": "6 Channel Configuration Front-Left Front-Right Back-Left Back-Right Front-Center Low-Frequency", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_LSD_RSD", "type": "number", "description": "2 Channel Configuration Side-Left Side-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_LS_RS", "type": "number", "description": "2 Channel Configuration Back-Left Back-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_C_R", "type": "number", "description": "3 Channel Configuration Front-Left Front-Center Front-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_C_R_CS", "type": "number", "description": "4 Channel Configuration Front-Left Front-Center Front-Right Back-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_C_R_CS_LFE", "type": "number", "description": "5 Channel Configuration Front-Left Front-Center Front-Right Back-Center Low-Frequency", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_C_R_LFE", "type": "number", "description": "4 Channel Configuration Front-Left Front-Center Front-Right Low-Frequency", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_C_R_LS_RS", "type": "number", "description": "5 Channel Configuration Front-Left Front-Center Front-Right Back-Left Back-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_C_R_LS_RS_LFE", "type": "number", "description": "6 Channel Configuration Front-Left Front-Center Front-Right Back-Left Back-Right Low-Frequency", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C", "type": "number", "description": "3 Channel Configuration Front-Left Front-Right Front-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_CS", "type": "number", "description": "3 Channel Configuration Front-Left Front-Right Back-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_CS_LFE", "type": "number", "description": "4 Channel Configuration Front-Left Front-Right Back-Center Low-Frequency", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_CS", "type": "number", "description": "4 Channel Configuration Front-Left Front-Right Front-Center Back-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LFE", "type": "number", "description": "4 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LFE_CS", "type": "number", "description": "5 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency Back-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LFE_LS_RS_CS", "type": "number", "description": "7 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency Back-Left Back-Right Back-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LFE_LS_RS_CS_LSD_RSD", "type": "number", "description": "9 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency Back-Left Back-Right Back-Center Side-Left Side-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LFE_LS_RS_CS_TS_VHL_VHC_VHR_TBL_TBR", "type": "number", "description": "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", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LFE_LS_RS_LC_RC_CS", "type": "number", "description": "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", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LFE_LS_RS_LSD_RSD", "type": "number", "description": "8 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency Back-Left Back-Right Side-Left Side-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LFE_LS_RS_LSD_RSD_TSL_TSR", "type": "number", "description": "10 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency Back-Left Back-Right Side-Left Side-Right Left-Height Right-Height", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LFE_LS_RS_PL_PR", "type": "number", "description": "8 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency Back-Left Back-Right Proximity-Left Proximity-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LFE_LS_RS_TS_VHL_VHC_VHR_TBL_TBR", "type": "number", "description": "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", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LFE_LS_RS_TS_VHL_VHR_TBL_TBR", "type": "number", "description": "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", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LFE_LS_RS_VHL_VHR_TBL_TBR", "type": "number", "description": "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", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LS_RS", "type": "number", "description": "5 Channel Configuration Front-Left Front-Right Front-Center Back-Left Back-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LS_RS_CS", "type": "number", "description": "6 Channel Configuration Front-Left Front-Right Front-Center Back-Left Back-Right Back-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LS_RS_CS_LSD_RSD", "type": "number", "description": "8 Channel Configuration Front-Left Front-Right Front-Center Back-Left Back-Right Back-Center Side-Left Side-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LS_RS_CS_TS_VHL_VHC_VHR_TBL_TBR", "type": "number", "description": "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", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LS_RS_LC_RC", "type": "number", "description": "7 Channel Configuration Front-Left Front-Right Front-Center Back-Left Back-Right Front-Left-Of-Center Front-Right-Of-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LS_RS_LC_RC_CS", "type": "number", "description": "8 Channel Configuration Front-Left Front-Right Front-Center Back-Left Back-Right Front-Left-Of-Center Front-Right-Of-Center Back-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LS_RS_LSD_RSD", "type": "number", "description": "7 Channel Configuration Front-Left Front-Right Front-Center Back-Left Back-Right Side-Left Side-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LS_RS_TS_VHL_VHC_VHR_TBL_TBR", "type": "number", "description": "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", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LS_RS_TS_VHL_VHR_TBL_TBR", "type": "number", "description": "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", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_C_LS_RS_VHL_VHR_TBL_TBR", "type": "number", "description": "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", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_LFE", "type": "number", "description": "3 Channel Configuration Front-Left Front-Right Low-Frequency", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_LFE_CS", "type": "number", "description": "4 Channel Configuration Front-Left Front-Right Low-Frequency Back-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_LFE_LS_RS", "type": "number", "description": "5 Channel Configuration Front-Left Front-Right Low-Frequency Back-Left Back-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_LFE_LS_RS_LSD_RSD", "type": "number", "description": "7 Channel Configuration Front-Left Front-Right Low-Frequency Back-Left Back-Right Side-Left Side-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_LFE_LS_RS_VHL_VHC_VHR_BFC", "type": "number", "description": "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", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_LS_RS_C", "type": "number", "description": "5 Channel Configuration Front-Left Front-Right Back-Left Back-Right Front-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_LS_RS_C_LC_RC", "type": "number", "description": "7 Channel Configuration Front-Left Front-Right Back-Left Back-Right Front-Center Front-Left-Of-Center Front-Right-Of-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_LS_RS_C_RLS_RRS", "type": "number", "description": "7 Channel Configuration Front-Left Front-Right Back-Left Back-Right Front-Center Rear-Surround-Left Rear-Surround-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_LS_RS_LFE", "type": "number", "description": "5 Channel Configuration Front-Left Front-Right Back-Left Back-Right Low-Frequency", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_L_R_LS_RS_LSD_RSD", "type": "number", "description": "6 Channel Configuration Front-Left Front-Right Back-Left Back-Right Side-Left Side-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_MATRIXSTEREO", "type": "number", "description": "2 Channel Configuration Left-Total Right-Total", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_MONO", "type": "number", "description": "1 Channel Configuration Discrete", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_OCTAGONAL", "type": "number", "description": "8 Channel Configuration Front-Left Front-Right Back-Left Back-Right Front-Center Back-Center Side-Left Side-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_PENTAGONAL", "type": "number", "description": "5 Channel Configuration Front-Left Front-Right Back-Left Back-Right Front-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_QUADRAPHONIC", "type": "number", "description": "4 Channel Configuration Front-Left Front-Right Back-Left Back-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_SMPTEDIGITALCINEMA1", "type": "number", "description": "16 Channel Configuration Discrete Discrete Front-Center Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_SMPTEDIGITALCINEMA2", "type": "number", "description": "16 Channel Configuration Left-Total Right-Total Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_SMPTEDIGITALCINEMA4", "type": "number", "description": "16 Channel Configuration Front-Left Front-Right Front-Center Discrete Back-Center Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete Discrete", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_SMPTEDIGITALCINEMA6", "type": "number", "description": "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", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_SMPTEDIGITALCINEMA7", "type": "number", "description": "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", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_SMPTEDIGITALCINEMA8", "type": "number", "description": "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", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_SMPTEDIGITALCINEMA9", "type": "number", "description": "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", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_SMPTEDTV", "type": "number", "description": "8 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency Back-Left Back-Right Left-Total Right-Total", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_STEREO", "type": "number", "description": "2 Channel Configuration Front-Left Front-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_TBL_TBR", "type": "number", "description": "2 Channel Configuration Top-Back-Left Top-Back-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_TSL_TSR", "type": "number", "description": "2 Channel Configuration Left-Height Right-Height", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_VHL_VHR", "type": "number", "description": "2 Channel Configuration Top-Front-Left Top-Front-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_VST10_2", "type": "number", "description": "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", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_VST10_2_PLUS", "type": "number", "description": "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", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_VST_7_1_CINE_CENTER_HIGH", "type": "number", "description": "8 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency Back-Left Back-Right Back-Center Top-Front-Center", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_VST_7_1_CINE_FRONT_HIGH", "type": "number", "description": "8 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency Back-Left Back-Right Top-Front-Left Top-Front-Right", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_VST_7_1_CINE_SIDE_HIGH", "type": "number", "description": "8 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency Back-Left Back-Right Left-Height Right-Height", "access": "readonly", "static": true }, { "name": "CHANNELLAYOUT_VST_7_1_CINE_TOP_CENTER", "type": "number", "description": "8 Channel Configuration Front-Left Front-Right Front-Center Low-Frequency Back-Left Back-Right Back-Center Top-Center", "access": "readonly", "static": true }, { "name": "description", "type": "string", "description": "Audio channel layout description", "access": "readonly" }, { "name": "length", "type": "number", "description": "Number of audio channels.", "access": "readonly" } ], "events": [], "methods": [ { "name": "createAudioChannelLayout", "returns": "AudioChannelLayout", "static": true, "description": "Create a audio channel layout.", "parameters": [ { "name": "labels", "type": "any", "description": "" } ] }, { "name": "createCommonAudioChannelLayout", "returns": "AudioChannelLayout", "static": true, "description": "Create a common audio channel layout.", "parameters": [ { "name": "layout", "type": "number", "description": "" } ] }, { "name": "getByIndex", "returns": "number", "description": "Returns an audio channel label.", "parameters": [ { "name": "index", "type": "number", "description": "" } ] }, { "name": "getLength", "returns": "number", "description": "Get the number of audio channels.", "parameters": [] }, { "name": "label", "returns": "string", "static": true, "description": "Label string of a single audio channel label", "parameters": [ { "name": "label", "type": "number", "description": "" } ] } ] }, { "name": "AudioFilterIDs", "page": "AudioFilterIDs.html", "kind": "Object", "description": "The AudioFilterIDs object exposes the AudioFilterIDs as read-only string constants.", "properties": [ { "name": "ACCUSONUS_DENOISE", "type": "string", "description": "Accusonus Denoise filter ID.", "access": "readonly", "static": true }, { "name": "ACCUSONUS_DEREVERB", "type": "string", "description": "Accusonus Dereverb filter ID.", "access": "readonly", "static": true }, { "name": "ADAPTIVE_NOISE_REDUCTION", "type": "string", "description": "Adaptive Noise Reduction filter ID.", "access": "readonly", "static": true }, { "name": "AMBISONICS_BINAURALIZER", "type": "string", "description": "Ambisonics Binauralizer filter ID.", "access": "readonly", "static": true }, { "name": "AMBISONICS_PANNER", "type": "string", "description": "Ambisonics Panner filter ID.", "access": "readonly", "static": true }, { "name": "AMPLIFY", "type": "string", "description": "Amplify filter ID.", "access": "readonly", "static": true }, { "name": "AUDIO_4_TO_6_CHANNEL_CONVERTER", "type": "string", "description": "Audio 4-to-6 channel converter ID.", "access": "readonly", "static": true }, { "name": "AUDIO_BALANCE", "type": "string", "description": "Balance filter ID.", "access": "readonly", "static": true }, { "name": "AUDIO_BAND_PASS", "type": "string", "description": "Bandpass filter ID.", "access": "readonly", "static": true }, { "name": "AUDIO_BAND_REJECT", "type": "string", "description": "Bandreject filter ID.", "access": "readonly", "static": true }, { "name": "AUDIO_BASS", "type": "string", "description": "Bass filter ID.", "access": "readonly", "static": true }, { "name": "AUDIO_CHANNEL_VOLUME", "type": "string", "description": "Channel Volume filter ID.", "access": "readonly", "static": true }, { "name": "AUDIO_DELAY", "type": "string", "description": "Delay filter ID.", "access": "readonly", "static": true }, { "name": "AUDIO_FILL_LEFT", "type": "string", "description": "Fill Left filter ID.", "access": "readonly", "static": true }, { "name": "AUDIO_FILL_RIGHT", "type": "string", "description": "Fill Right filter ID.", "access": "readonly", "static": true }, { "name": "AUDIO_HIGH_PASS", "type": "string", "description": "Highpass filter ID.", "access": "readonly", "static": true }, { "name": "AUDIO_INVERT", "type": "string", "description": "Invert filter ID.", "access": "readonly", "static": true }, { "name": "AUDIO_LOW_PASS", "type": "string", "description": "Lowpass filter ID.", "access": "readonly", "static": true }, { "name": "AUDIO_MUTE", "type": "string", "description": "Mute filter ID.", "access": "readonly", "static": true }, { "name": "AUDIO_PARAMETRIC_EQ", "type": "string", "description": "Parametric EQ filter ID.", "access": "readonly", "static": true }, { "name": "AUDIO_SWAP_CHANNEL", "type": "string", "description": "Swap Channels filter ID.", "access": "readonly", "static": true }, { "name": "AUDIO_TREBLE", "type": "string", "description": "Treble filter ID.", "access": "readonly", "static": true }, { "name": "AUDIO_VOLUME", "type": "string", "description": "Volume filter ID.", "access": "readonly", "static": true }, { "name": "AUTO_CLICK_REMOVER", "type": "string", "description": "Auto Click Remover filter ID.", "access": "readonly", "static": true }, { "name": "CHANNEL_MIXER", "type": "string", "description": "Channel Mixer filter ID.", "access": "readonly", "static": true }, { "name": "DRY_WET_MIXER", "type": "string", "description": "Dry|Wet Mixer filter ID.", "access": "readonly", "static": true }, { "name": "DYNAMICS", "type": "string", "description": "Dynamics filter ID.", "access": "readonly", "static": true }, { "name": "ENHANCE_AUDIO_MIXER", "type": "string", "description": "Enhance Audio Mixer filter ID.", "access": "readonly", "static": true }, { "name": "ENHANCE_SPEECH", "type": "string", "description": "Enhance Speech filter ID.", "access": "readonly", "static": true }, { "name": "FAST_HARD_LIMITER", "type": "string", "description": "Fast Hard Limiter filter ID.", "access": "readonly", "static": true }, { "name": "FFT_FILTER", "type": "string", "description": "FFT Filter ID.", "access": "readonly", "static": true }, { "name": "FLANGER", "type": "string", "description": "Flanger filter ID.", "access": "readonly", "static": true }, { "name": "GRAPHIC_EQ_10_BANDS", "type": "string", "description": "Graphic EQ (10 bands) filter ID.", "access": "readonly", "static": true }, { "name": "GRAPHIC_EQ_20_BANDS", "type": "string", "description": "Graphic EQ (20 bands) filter ID.", "access": "readonly", "static": true }, { "name": "GRAPHIC_EQ_30_BANDS", "type": "string", "description": "Graphic EQ (30 bands) filter ID.", "access": "readonly", "static": true }, { "name": "HARD_LIMITER", "type": "string", "description": "Hard Limiter filter ID.", "access": "readonly", "static": true }, { "name": "HARD_LIMITER_LEGACY", "type": "string", "description": "Legacy Hard Limiter filter ID.", "access": "readonly", "static": true }, { "name": "IZOTOPE_ANALOG_DELAY", "type": "string", "description": "iZotope Analog Delay filter ID.", "access": "readonly", "static": true }, { "name": "IZOTOPE_CHORUS_FLANGER", "type": "string", "description": "iZotope Chorus|Flanger filter ID.", "access": "readonly", "static": true }, { "name": "IZOTOPE_CONVOLUTION_REVERB", "type": "string", "description": "iZotope Convolution Reverb filter ID.", "access": "readonly", "static": true }, { "name": "IZOTOPE_DE_ESSER", "type": "string", "description": "iZotope De-Esser filter ID.", "access": "readonly", "static": true }, { "name": "IZOTOPE_DE_HUMMER", "type": "string", "description": "iZotope De-Hummer filter ID.", "access": "readonly", "static": true }, { "name": "IZOTOPE_DISTORTION", "type": "string", "description": "iZotope Distortion filter ID.", "access": "readonly", "static": true }, { "name": "IZOTOPE_GUITAR_SUITE", "type": "string", "description": "iZotope Guitar Suite filter ID.", "access": "readonly", "static": true }, { "name": "IZOTOPE_MULTI_BAND_COMPRESSOR", "type": "string", "description": "iZotope Multi-Band Compressor filter ID.", "access": "readonly", "static": true }, { "name": "IZOTOPE_PHASER", "type": "string", "description": "iZotope Phaser filter ID.", "access": "readonly", "static": true }, { "name": "IZOTOPE_SIMPLE_MASTERING", "type": "string", "description": "iZotope Simple Mastering filter ID.", "access": "readonly", "static": true }, { "name": "IZOTOPE_SINGLE_BAND_COMPRESSOR", "type": "string", "description": "iZotope Single Band Compressor filter ID.", "access": "readonly", "static": true }, { "name": "IZOTOPE_SURROUND_REVERB", "type": "string", "description": "iZotope Surround Reverb filter ID.", "access": "readonly", "static": true }, { "name": "IZOTOPE_TUBE_MODELED_COMPRESSOR", "type": "string", "description": "iZotope Tube-Modeled Compressor filter ID.", "access": "readonly", "static": true }, { "name": "IZOTOPE_VOCAL_ENHANCER", "type": "string", "description": "iZotope Vocal Enhancer filter ID.", "access": "readonly", "static": true }, { "name": "LATENCY_GENERATOR", "type": "string", "description": "Latency Generator filter ID.", "access": "readonly", "static": true }, { "name": "LOUDNESS_METER", "type": "string", "description": "Loudness Meter filter ID.", "access": "readonly", "static": true }, { "name": "MULTITAP_DELAY", "type": "string", "description": "Multitap Delay filter ID.", "access": "readonly", "static": true }, { "name": "NOTCH_FILTER", "type": "string", "description": "Notch Filter ID.", "access": "readonly", "static": true }, { "name": "PARAMETRIC_DYNAMICS", "type": "string", "description": "Parametric Dynamics filter ID.", "access": "readonly", "static": true }, { "name": "PARAMETRIC_EQ", "type": "string", "description": "Parametric EQ filter ID.", "access": "readonly", "static": true }, { "name": "PITCH_SHIFT", "type": "string", "description": "Pitch Shift filter ID.", "access": "readonly", "static": true }, { "name": "SCIENTIFIC_FILTER", "type": "string", "description": "Scientific Filter ID.", "access": "readonly", "static": true }, { "name": "SINGLE_BAND_DYNAMICS", "type": "string", "description": "Single Band Dynamics filter ID.", "access": "readonly", "static": true }, { "name": "SLIDING_WINDOW_NORMALIZER", "type": "string", "description": "Sliding Window Normalizer filter ID.", "access": "readonly", "static": true }, { "name": "SOUND_LIFT", "type": "string", "description": "Sound Lift filter ID.", "access": "readonly", "static": true }, { "name": "SPECTRUM_METER", "type": "string", "description": "Spectrum Meter filter ID.", "access": "readonly", "static": true }, { "name": "STEREO_EXPANDER", "type": "string", "description": "Stereo Expander filter ID.", "access": "readonly", "static": true }, { "name": "STUDIO_REVERB", "type": "string", "description": "Studio Reverb filter ID.", "access": "readonly", "static": true }, { "name": "TC_RADAR_METER_COMPONENT", "type": "string", "description": "TC Radar Meter component ID.", "access": "readonly", "static": true } ], "events": [], "methods": [] }, { "name": "AudioFilterModule", "page": "AudioFilterModule.html", "kind": "Object", "description": "An audio filter", "properties": [], "events": [], "methods": [ { "name": "castOrThrow", "returns": "AudioFilterModule", "static": true, "description": "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.", "parameters": [ { "name": "object", "type": "Object", "description": "" } ] }, { "name": "isInternal", "returns": "boolean", "description": "Get whether the filter is internal.", "parameters": [] }, { "name": "queryCast", "returns": "AudioFilterModule", "static": true, "description": "Cast an object to AudioFilterModule. In case the provided object can be used as AudioFilterModule a corresponding object is returned. Otherwise null is returned.", "parameters": [ { "name": "object", "type": "Object", "description": "" } ] } ] }, { "name": "AudioFilterProcessor", "page": "AudioFilterProcessor.html", "kind": "Object", "description": "The AudioFilterProcessor object provides methods to apply audio filters to wave files and to comopare the results against a baseline.", "properties": [], "events": [], "methods": [ { "name": "compare", "returns": "Object", "static": true, "description": "Compare an input file against a baseline and return the maximum difference.", "parameters": [ { "name": "input", "type": "WaveFile", "description": "" }, { "name": "baseline", "type": "WaveFile", "description": "" } ] }, { "name": "getOutputBusNames", "returns": "any", "static": true, "description": "Get the output bus names for an audio filter when applied to the provided audio channel layout.", "parameters": [ { "name": "audioFilter", "type": "string", "description": "" }, { "name": "audioChannelLayout", "type": "AudioChannelLayout", "description": "" } ] }, { "name": "getPresetsForAudioFilter", "returns": "any", "static": true, "description": "Get all factory preset names for the specified audio filter.", "parameters": [ { "name": "audioFilter", "type": "string", "description": "" } ] }, { "name": "isAudioChannelLayoutSupportedByAudioFilter", "returns": "boolean", "static": true, "description": "Is the specified audio channel layout supported by the specified audio filter?", "parameters": [ { "name": "audioChannelLayout", "type": "AudioChannelLayout", "description": "" }, { "name": "audioFilter", "type": "string", "description": "" } ] }, { "name": "process", "returns": "Object", "static": true, "description": "Apply a specified preset of an audio filter to an input file and write the result to disk again.", "parameters": [ { "name": "audioFilter", "type": "string", "description": "" }, { "name": "preset", "type": "string", "description": "" }, { "name": "input", "type": "WaveFile", "description": "" }, { "name": "outputs", "type": "WaveFile[]", "description": "" } ] } ] }, { "name": "Batch", "page": "Batch.html", "kind": "Object", "description": "Scripting methods to the Batch", "properties": [], "events": [], "methods": [ { "name": "addEventListener", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "dispatchEvent", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "removeEventListener", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "startListening", "returns": "boolean", "static": true, "description": "Start listening for batch events.", "parameters": [] } ] }, { "name": "BatchEncoderEvent", "page": "BatchEncoderEvent.html", "kind": "Object", "description": "BatchEncoder event object", "properties": [ { "name": "EVENT_ENCODER_STATUS_CHANGED", "type": "string", "description": "Sent when the batch encoder status is changed.", "access": "readonly", "static": true }, { "name": "EVENT_ENCODINGITEM_DESCRIPTION", "type": "string", "description": "Sent when Description message is updated.", "access": "readonly", "static": true }, { "name": "EVENT_ENCODINGITEM_EVENT", "type": "string", "description": "Reflects an sdk error event that has come in pertaining to this batch item as we surmise.", "access": "readonly", "static": true }, { "name": "EVENT_ENCODINGITEM_PROGRESS_UPDATE", "type": "string", "description": "Send on a progress update for an Item.", "access": "readonly", "static": true }, { "name": "EVENT_ENCODINGITEM_STARTED", "type": "string", "description": "Sent after a new item starts encoding.", "access": "readonly", "static": true }, { "name": "EVENT_ENCODING_COMPLETE", "type": "string", "description": "Sent when encoding is complete.", "access": "readonly", "static": true }, { "name": "EVENT_ENCODING_PAUSED_ITEM_STARTED", "type": "string", "description": "Sent after a paused item starts encoding.", "access": "readonly", "static": true }, { "name": "EVENT_ENCODING_POST_OPERATION_PROGRESS", "type": "string", "description": "A generic progress message that can be sent for operations after encoding with progress.", "access": "readonly", "static": true }, { "name": "EVENT_ENCODING_PRE_OPERATION_PROGRESS", "type": "string", "description": "A generic progress message that can be sent for operations before encoding.", "access": "readonly", "static": true }, { "name": "EVENT_MEDIA_INFO_CREATED", "type": "string", "description": "Sent when Media Info is created.", "access": "readonly", "static": true }, { "name": "allowMoveSource", "type": "boolean", "description": "On encoding completion this indicates whether a source can be moved otherwise false.", "access": "readonly" }, { "name": "batchItem", "type": "Object", "description": "Return the message related batchitem. Otherwise empty.", "access": "readonly" }, { "name": "eventFlag", "type": "number", "description": "Get the current event flag for an event message. Zero if unset.", "access": "readonly" }, { "name": "progress", "type": "number", "description": "The current progress negative if unknown or invalid (-1).", "access": "readonly" }, { "name": "textMessage", "type": "string", "description": "A text or event message if required by this event. Otherwise empty.", "access": "readonly" } ], "events": [], "methods": [ { "name": "addEventListener", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "dispatchEvent", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "removeEventListener", "returns": "any", "static": true, "description": "", "parameters": [] } ] }, { "name": "BatchEncoderScriptObject", "page": "BatchEncoderScriptObject.html", "kind": "Object", "description": "Scripting methods to batch encoder", "properties": [], "events": [], "methods": [] }, { "name": "BatchEvent", "page": "BatchEvent.html", "kind": "Object", "description": "Batch event object", "properties": [ { "name": "BATCH_GROUP_INSERTED", "type": "string", "description": "Sent when a batch group is added.", "access": "readonly", "static": true }, { "name": "BATCH_GROUP_REMOVED", "type": "string", "description": "Sent when a batch group is removed.", "access": "readonly", "static": true }, { "name": "BATCH_ITEM_INSERTED", "type": "string", "description": "Sent when a batch item is added.", "access": "readonly", "static": true }, { "name": "BATCH_ITEM_REMOVED", "type": "string", "description": "Sent when a batch item is removed.", "access": "readonly", "static": true }, { "name": "batchGroupID", "type": "string", "description": "Return the message related batch. Otherwise empty.", "access": "readonly" }, { "name": "batchItemID", "type": "string", "description": "A text or event message if required by this event. Otherwise empty.", "access": "readonly" } ], "events": [], "methods": [ { "name": "addEventListener", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "dispatchEvent", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "removeEventListener", "returns": "any", "static": true, "description": "", "parameters": [] } ] }, { "name": "BatchItemGroup", "page": "BatchItemGroup.html", "kind": "Object", "description": "Scripting methods to the Batch Item Group", "properties": [ { "name": "batchItems", "type": "any[]", "description": "List of all contained BatchItemScriptObjects.", "access": "readonly" }, { "name": "combinedProgress", "type": "number", "description": "Progress of complete batch group (calculated from the progress of all contained batch items) in percent.", "access": "readonly" }, { "name": "combinedStatus", "type": "number", "description": "Rendering status of the complete batch group.", "access": "readonly" }, { "name": "id", "type": "string", "description": "GUID of the batch item group.", "access": "readonly" }, { "name": "postProcessorItemsJSON", "type": "string", "description": "JSON of all post-processor items of the current batch item group.", "access": "readonly" }, { "name": "sourceInfo", "type": "string", "description": "JSON of the current source settings.", "access": "readonly" } ], "events": [], "methods": [] }, { "name": "BetaFeature", "page": "BetaFeature.html", "kind": "Object", "description": "BetaFeature class", "properties": [ { "name": "FEATURE_FLAG_OVERRIDE_DEFAULT", "type": "number", "description": "Feature Flag follows default.", "access": "readonly", "static": true }, { "name": "FEATURE_FLAG_OVERRIDE_OFF", "type": "number", "description": "Feature Flag turned off.", "access": "readonly", "static": true }, { "name": "FEATURE_FLAG_OVERRIDE_ON", "type": "number", "description": "Feature Flag turned on.", "access": "readonly", "static": true }, { "name": "isEntitlementSetToInternalFeaturesAllowed", "type": "boolean", "description": "Returns true if the entitlement is set to indicate an internal user.", "access": "readonly", "static": true } ], "events": [], "methods": [ { "name": "isFeatureEnabled", "returns": "boolean", "static": true, "description": "Returns true if a beta feature is enabled.", "parameters": [ { "name": "featureID", "type": "string", "description": "" } ] }, { "name": "isFeatureEnabledFloodgate", "returns": "boolean", "static": true, "description": "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", "parameters": [ { "name": "featureID", "type": "string", "description": "" } ] }, { "name": "setFeatureFlagOverride", "returns": "boolean", "static": true, "description": "Set beta feature to enabled | disabled. Returns true if override was set successfully.", "parameters": [ { "name": "featureID", "type": "number", "description": "" } ] } ] }, { "name": "CaptioningMetadata", "page": "CaptioningMetadata.html", "kind": "Object", "description": "Represents captioning metadata of caption tracks", "properties": [], "events": [], "methods": [ { "name": "equals", "returns": "boolean", "description": "Returns true if the given CaptioningMetadata is equal to this CaptioningMetadata object", "parameters": [ { "name": "metadata", "type": "CaptioningMetadata", "description": "" } ] } ] }, { "name": "ClientInfo", "page": "ClientInfo.html", "kind": "Object", "description": "The ClientInfo object provides information about the application.", "properties": [ { "name": "application", "type": "string", "description": "Application name", "access": "readonly", "static": true }, { "name": "betaPrime", "type": "boolean", "description": "True when app is being branded and named as beta-prime", "access": "readonly", "static": true }, { "name": "build", "type": "string", "description": "Build number", "access": "readonly", "static": true }, { "name": "client", "type": "string", "description": "Client name", "access": "readonly", "static": true }, { "name": "company", "type": "string", "description": "Company name", "access": "readonly", "static": true }, { "name": "isRunningAutomation", "type": "boolean", "description": "Returns true if running in automation environment", "access": "readonly", "static": true }, { "name": "patch", "type": "string", "description": "Patch number", "access": "readonly", "static": true }, { "name": "scriptingAPIManifestPath", "type": "string", "description": "File path to the ScriptingAPIManifest.json resource", "access": "readonly", "static": true }, { "name": "scriptingHost", "type": "string", "description": "Scripting host name", "access": "readonly", "static": true }, { "name": "version", "type": "string", "description": "Version string", "access": "readonly", "static": true }, { "name": "versionInternal", "type": "string", "description": "Long version string", "access": "readonly", "static": true } ], "events": [], "methods": [ { "name": "getAppFullVersion", "returns": "string", "static": true, "description": "Returns the full version string (Major.Minor.Patch.Build)", "parameters": [] }, { "name": "getAppLocation", "returns": "string", "static": true, "description": "Get Application Location.", "parameters": [] }, { "name": "getAppPrefPath", "returns": "string", "static": true, "description": "Get Application Preference Path", "parameters": [] } ] }, { "name": "Clusters", "page": "Clusters.html", "kind": "Object", "description": "Object containing cluster information from clustering algorithms.", "properties": [ { "name": "numClusters", "type": "number", "description": "Total number of clusters found.", "access": "readonly" } ], "events": [], "methods": [ { "name": "centroid", "returns": "Object", "description": "Gets the centroid of a specific cluster.", "parameters": [ { "name": "clusterIndex", "type": "number", "description": "" } ] }, { "name": "memberIndices", "returns": "any", "description": "Gets the member indices for a specific cluster.", "parameters": [ { "name": "clusterIndex", "type": "number", "description": "" } ] } ] }, { "name": "Color", "page": "Color.html", "kind": "Object", "description": "Color class", "properties": [ { "name": "alpha", "type": "number", "description": "Read|Write property to get|set alpha value of color object", "access": "read/write" }, { "name": "blue", "type": "number", "description": "Read|Write property to get|set blue value of color object", "access": "read/write" }, { "name": "green", "type": "number", "description": "Read|Write property to get|set green value of color object", "access": "read/write" }, { "name": "red", "type": "number", "description": "Read|Write property to get|set red value of color object", "access": "read/write" } ], "events": [], "methods": [ { "name": "Color", "returns": "Color", "description": "Construct a Color Object with parameters for Red Green Blue and Alpha values which are in range [0.0-1.0]", "parameters": [ { "name": "Red", "type": "number", "description": "" }, { "name": "Green", "type": "number", "description": "" }, { "name": "Blue", "type": "number", "description": "" }, { "name": "Alpha", "type": "number", "description": "" } ] }, { "name": "equals", "returns": "boolean", "description": "Returns true if the given ColorObject is equal to this ColorObject", "parameters": [ { "name": "colorObject", "type": "Color", "description": "" } ] } ] }, { "name": "ColorProfileObject", "page": "ColorProfileObject.html", "kind": "Object", "description": "ColorProfile class", "properties": [ { "name": "getProfileName", "type": "string", "description": "Read property to get Profile name", "access": "readonly" } ], "events": [], "methods": [ { "name": "ColorProfileObject", "returns": "ColorProfileObject", "description": "Construct a ColorProfileObject Object from ColorProfile name", "parameters": [ { "name": "Name", "type": "string", "description": "" } ] }, { "name": "equals", "returns": "boolean", "description": "Returns true if the given ColorProfileObject is equal to this ColorProfileObject", "parameters": [ { "name": "colorProfileObject", "type": "ColorProfileObject", "description": "" } ] } ] }, { "name": "ColorSpaceMetaDataObject", "page": "ColorSpaceMetaDataObject.html", "kind": "Object", "description": "ColorSpaceMetaData class", "properties": [ { "name": "dataRangeInfoValid", "type": "boolean", "description": "Read|Write property to get|set DataRangeInfoValid", "access": "read/write" }, { "name": "peakLuminance", "type": "number", "description": "Read|Write property to get|set peak luminance", "access": "read/write" } ], "events": [], "methods": [ { "name": "ColorSpaceMetaDataObject", "returns": "ColorSpaceMetaDataObject", "description": "Construct a ColorSpaceMetaData Object with parameters for PeakLuminance and DataRangeInfoValid values", "parameters": [ { "name": "PeakLuminance", "type": "number", "description": "" }, { "name": "DataRangeInfoValid", "type": "boolean", "description": "" } ] }, { "name": "equals", "returns": "boolean", "description": "Returns true if the given ColorSpaceMetaDataObject is equal to this ColorSpaceMetaDataObject", "parameters": [ { "name": "colorSpaceMetaDataObject", "type": "ColorSpaceMetaDataObject", "description": "" } ] } ] }, { "name": "ColorSpaceObject", "page": "ColorSpaceObject.html", "kind": "Object", "description": "ColorSpace class", "properties": [ { "name": "getBaseProfileType", "type": "number", "description": "Read property to get Profile Type", "access": "readonly" }, { "name": "getIsLinear", "type": "boolean", "description": "Read property to get Profile Type", "access": "readonly" } ], "events": [], "methods": [ { "name": "ColorSpaceObject", "returns": "ColorSpaceObject", "description": "Construct a ColorSpaceObject Object from ColorSpaceObject name", "parameters": [ { "name": "ColorSpaceMetaData", "type": "Object", "description": "" }, { "name": "ColorProfile", "type": "Object", "description": "" }, { "name": "ColorBaseProfileType", "type": "number", "description": "" }, { "name": "IsLinear", "type": "boolean", "description": "" } ] }, { "name": "equals", "returns": "boolean", "description": "Returns true if the given ColorProfileObject is equal to this ColorProfileObject", "parameters": [ { "name": "colorProfileObject", "type": "ColorProfileObject", "description": "" } ] }, { "name": "getColorProfile", "returns": "Object", "description": "Get ColorProfile Object", "parameters": [] }, { "name": "getColorSpaceMetaData", "returns": "Object", "description": "Get ColorSpaceMetaData Object", "parameters": [] } ] }, { "name": "CommonDirs", "page": "CommonDirs.html", "kind": "Object", "description": "An object represent the dvacore::debug::CodeProfiler mechanism on ExtendScript.", "properties": [ { "name": "executableDir", "type": "string", "description": "On Windows the directory the app was launched in. On Mac the directory |Contents|MacOS", "access": "readonly", "static": true }, { "name": "mainExecutableFile", "type": "string", "description": "On Windows the path to the .exe file. On Mac the path to the .app bundle.", "access": "readonly", "static": true }, { "name": "pluginsDir", "type": "string", "description": "On Windows the directory Plug-ins next to the executable. On Mac the directory |Contents|Plug-ins.", "access": "readonly", "static": true }, { "name": "resourcesDir", "type": "string", "description": "On Windows the directory the app was launched in. On Mac the directory |Contents|Resources", "access": "readonly", "static": true } ], "events": [], "methods": [] }, { "name": "Console", "page": "Console.html", "kind": "Object", "description": "The Console object provides access to the DVA console.", "properties": [], "events": [], "methods": [ { "name": "execute", "returns": "string", "static": true, "description": "Executes a console command whose feedback is returned as string. Throws an error if the command could not be found.", "parameters": [ { "name": "command", "type": "string", "description": "" } ] }, { "name": "print", "returns": "boolean", "static": true, "description": "Output on console", "parameters": [ { "name": "text", "type": "string", "description": "" }, { "name": "lf", "type": "boolean", "description": "" } ] } ] }, { "name": "DebugAssert", "page": "DebugAssert.html", "kind": "Object", "description": "DebugAssert class provides the ability to log debug asserts in scripting.", "properties": [], "events": [], "methods": [ { "name": "getLog", "returns": "any", "static": true, "description": "Get log (as a dictionary object) of all asserts hit during receive period", "parameters": [] }, { "name": "startLog", "returns": "boolean", "static": true, "description": "Start logging all asserts hit during receive period", "parameters": [] } ] }, { "name": "DebugDatabase", "page": "DebugDatabase.html", "kind": "Object", "description": "DebugDatabase class provides access to debug database.", "properties": [], "events": [], "methods": [ { "name": "get", "returns": "string", "static": true, "description": "Get value for a key.", "parameters": [ { "name": "key", "type": "string", "description": "" } ] }, { "name": "getDebugFlagMasterList", "returns": "Object", "static": true, "description": "Get the master list of all debug flags", "parameters": [] }, { "name": "getDefault", "returns": "string", "static": true, "description": "Gets the default value for an entry", "parameters": [ { "name": "key", "type": "string", "description": "" } ] }, { "name": "getOrDefaultBoolValue", "returns": "boolean", "static": true, "description": "Get value for a boolean key(if present) or return given default value", "parameters": [ { "name": "key", "type": "string", "description": "" }, { "name": "defaultValue", "type": "boolean", "description": "" } ] }, { "name": "getOrDefaultValue", "returns": "string", "static": true, "description": "Get value for a key(if present) or return given default value", "parameters": [ { "name": "key", "type": "string", "description": "" }, { "name": "defaultValue", "type": "string", "description": "" } ] }, { "name": "hasKey", "returns": "boolean", "static": true, "description": "Checks if an entry exists for the given key", "parameters": [ { "name": "key", "type": "string", "description": "" } ] }, { "name": "isDefault", "returns": "boolean", "static": true, "description": "Checks if an entry's value is the default value or not", "parameters": [ { "name": "key", "type": "string", "description": "" } ] }, { "name": "set", "returns": "boolean", "static": true, "description": "Sets a value for a given key in Debug Database.", "parameters": [ { "name": "key", "type": "string", "description": "" }, { "name": "value", "type": "string", "description": "" } ] } ] }, { "name": "DebugMonitor", "page": "DebugMonitor.html", "kind": "Object", "description": "DebugMonitor script object", "properties": [], "events": [], "methods": [ { "name": "DebugMonitor", "returns": "DebugMonitor", "description": "constructor for debug monitor", "parameters": [] }, { "name": "closeCategory", "returns": "boolean", "description": "removes category from opened category list", "parameters": [ { "name": "categoryId", "type": "string", "description": "" } ] }, { "name": "getDebugInformation", "returns": "string", "description": "Get debug information for an identifier", "parameters": [ { "name": "categoryId", "type": "string", "description": "" } ] }, { "name": "getDebugMonitorCategories", "returns": "any", "description": "Get all the debug categories", "parameters": [] }, { "name": "getOpenedListDebugInfo", "returns": "any", "description": "get debug info of opened category of debug monitor", "parameters": [] }, { "name": "openCategory", "returns": "boolean", "description": "inserts category in opened category list", "parameters": [ { "name": "categoryId", "type": "string", "description": "" } ] } ] }, { "name": "EmbeddingStorage", "page": "EmbeddingStorage.html", "kind": "Object", "description": "High level interface object that gives access to the EmbeddingStorage", "properties": [], "events": [], "methods": [ { "name": "closeScope", "returns": "any", "description": "Close the open index for the given scope node and return the number of closed indexes", "parameters": [ { "name": "node", "type": "Object", "description": "" } ] }, { "name": "getInstance", "returns": "Object", "static": true, "description": "Get an object representing the embedding storage", "parameters": [] } ] }, { "name": "EncoderHostScriptObject", "page": "EncoderHostScriptObject.html", "kind": "Object", "description": "Provides several utility methods including batch commands to run, pause or stop the batch.", "properties": [], "events": [], "methods": [ { "name": "createEncoderForFormat", "returns": "Object", "description": "Returns an 'EncoderWrapper' script object for the requested format.", "parameters": [ { "name": "inFormatName", "type": "string", "description": "" } ] }, { "name": "getBatchEncoderStatus", "returns": "any", "description": "Returns the current status of the batch encoder. The values are: invalid paused running stopped stopping (available since 23.3).", "parameters": [ { "name": "arg1", "type": "string", "description": "" } ] }, { "name": "getCurrentBatchPreview", "returns": "boolean", "description": "Writes out the current batch preview image (tiff format) to the given path.", "parameters": [ { "name": "inOutputPath", "type": "string", "description": "Path to store a 'tiff' file." } ] }, { "name": "getFormatList", "returns": "any", "description": "Returns a list of all available formats.", "parameters": [] }, { "name": "getSourceInfo", "returns": "SourceMediaInfo", "description": "Returns a 'SourceMediaInfo' script object which can give detailed info about the provided source.", "parameters": [ { "name": "sourcePath", "type": "string", "description": "Media path" } ] }, { "name": "getSupportedImportFileTypes", "returns": "any", "description": "Returns list of all available formats.", "parameters": [] }, { "name": "isBatchRunning", "returns": "boolean", "description": "Returns true if a batch job is running.", "parameters": [] }, { "name": "pauseBatch", "returns": "any", "description": "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?", "parameters": [ { "name": "arg1", "type": "boolean", "description": "" } ] }, { "name": "runBatch", "returns": "any", "description": "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?", "parameters": [ { "name": "arg1", "type": "boolean", "description": "" } ] }, { "name": "stopBatch", "returns": "any", "description": "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?", "parameters": [ { "name": "arg1", "type": "boolean", "description": "" } ] } ] }, { "name": "EncoderHostWrapperEvent", "page": "EncoderHostWrapperEvent.html", "kind": "Object", "description": "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.", "properties": [ { "name": "audioInfo", "type": "string", "description": "Returns the audio pre-encoding info for the event type onAudioPreEncodeProgress (available since 24.0).", "access": "readonly" }, { "name": "audioProgress", "type": "number", "description": "Returns the audio pre-encoding progress for the event type onAudioPreEncodeProgress (available since 24.0).", "access": "readonly" }, { "name": "batchEncoderStatus", "type": "any", "description": "", "access": "readonly" }, { "name": "onAudioPreEncodeProgress", "type": "string", "description": "Notify when the audio pre-encode progress changes (available since 24.0).", "access": "readonly", "static": true }, { "name": "onBatchEncoderStatusChanged", "type": "string", "description": "Notify when the batch encoder status has changed. Get the new status from the batchEncoderStatus property. (available since 23.3)", "access": "readonly", "static": true }, { "name": "onEncodingItemProgressUpdate", "type": "string", "description": "Notify of the batch item encoding progress (available since 23.1).", "access": "readonly", "static": true }, { "name": "onItemEncodeComplete", "type": "string", "description": "Notify when the batch item has been encoded.", "access": "readonly", "static": true }, { "name": "onItemEncodingStarted", "type": "string", "description": "Notify when the batch item encoding started (available since 23.1).", "access": "readonly", "static": true }, { "name": "outputFilePath", "type": "string", "description": "Returns the path of the output file. Can be called for onItemEncodingStarted and onItemEncodeComplete events.", "access": "readonly" }, { "name": "progress", "type": "number", "description": "Returns the encoding progress between 0 and 1. Can be called for onEncodingItemProgressUpdate event.", "access": "readonly" }, { "name": "result", "type": "string", "description": "Returns the encoding result 'True' or 'False'. Can be called for onItemEncodeComplete event.", "access": "readonly" }, { "name": "sourceFilePath", "type": "string", "description": "Returns the path of the source file. Can be called for onItemEncodingStarted and onItemEncodeComplete events.", "access": "readonly" } ], "events": [], "methods": [ { "name": "addEventListener", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "dispatchEvent", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "removeEventListener", "returns": "any", "static": true, "description": "", "parameters": [] } ] }, { "name": "EncoderWrapper", "page": "EncoderWrapper.html", "kind": "Object", "description": "Queue item object to set encode properties", "properties": [ { "name": "outputFiles", "type": "any", "description": "Gets the list of files the encode generated", "access": "readonly" }, { "name": "outputHeight", "type": "number", "description": "Gets the height of the encoded output file", "access": "readonly" }, { "name": "outputWidth", "type": "number", "description": "Gets the width of the encoded output file", "access": "readonly" } ], "events": [], "methods": [ { "name": "SetIncludeSourceXMP", "returns": "boolean", "description": "Toggle the inclusion of source XMP [boolean] input value required", "parameters": [ { "name": "includeSourceXMP", "type": "boolean", "description": "" } ] }, { "name": "getEncodeProgress", "returns": "number", "description": "Returns the encode progress as percentage", "parameters": [] }, { "name": "getEncodeTime", "returns": "number", "description": "Return the encode time in milliseconds", "parameters": [] }, { "name": "getLogOutput", "returns": "string", "description": "Returns the log output including possible warnings and errors (available since 23.2.).", "parameters": [] }, { "name": "getMissingAssets", "returns": "any", "description": "Returns a list of missing assets", "parameters": [ { "name": "includeSource", "type": "boolean", "description": "Get missing asset list from the source group if requested" }, { "name": "includeOutput", "type": "boolean", "description": "" } ] }, { "name": "getPresetList", "returns": "any", "description": "Returns the presets available for the assigned format", "parameters": [] }, { "name": "loadFormat", "returns": "boolean", "description": "Changes the format for the batch item", "parameters": [ { "name": "format", "type": "string", "description": "E.g. 'H.264' Loads all presets available for the assigned format" } ] }, { "name": "loadPreset", "returns": "boolean", "description": "Loads and assigns the preset to the batch item", "parameters": [ { "name": "presetPath", "type": "string", "description": "" } ] }, { "name": "setCropOffsets", "returns": "boolean", "description": "Sets the crop offsets", "parameters": [ { "name": "left", "type": "number", "description": "" }, { "name": "top", "type": "number", "description": "" }, { "name": "right", "type": "number", "description": "" }, { "name": "bottom", "type": "number", "description": "" } ] }, { "name": "setCropState", "returns": "boolean", "description": "Sets the crop state [boolean] input value required", "parameters": [ { "name": "cropState", "type": "boolean", "description": "" } ] }, { "name": "setCropType", "returns": "boolean", "description": "Sets the scale type", "parameters": [ { "name": "cropType", "type": "any", "description": "" }, { "name": "arg2", "type": "any", "description": "" }, { "name": "arg3", "type": "any", "description": "" }, { "name": "arg4", "type": "any", "description": "" }, { "name": "arg5", "type": "any", "description": "" }, { "name": "arg6", "type": "number", "description": "6 StretchToFillBeforeCrop" } ] }, { "name": "setCuePointData", "returns": "boolean", "description": "Sets the cue point data", "parameters": [ { "name": "inCuePointsFilePath", "type": "string", "description": "" } ] }, { "name": "setFrameRate", "returns": "boolean", "description": "Sets the frame rate for the batch item", "parameters": [ { "name": "framerate", "type": "string", "description": "E.g. '24' as string" } ] }, { "name": "setIncludeSourceCuePoints", "returns": "boolean", "description": "Toggle the inclusion of cue points [boolean] input value required", "parameters": [ { "name": "includeSourceCuePoints", "type": "boolean", "description": "" } ] }, { "name": "setOutputFrameSize", "returns": "boolean", "description": "Sets the output frame size", "parameters": [ { "name": "width", "type": "number", "description": "" }, { "name": "height", "type": "number", "description": "" } ] }, { "name": "setRotation", "returns": "boolean", "description": "Sets the rotation (in a 360 degree system)", "parameters": [ { "name": "rotationValue", "type": "number", "description": "E.g. 0.0 - 360.0" } ] }, { "name": "setScaleType", "returns": "boolean", "description": "Sets the scale type", "parameters": [ { "name": "scaleType", "type": "any", "description": "" }, { "name": "arg2", "type": "any", "description": "" }, { "name": "arg3", "type": "any", "description": "" }, { "name": "arg4", "type": "any", "description": "" }, { "name": "arg5", "type": "any", "description": "" }, { "name": "arg6", "type": "number", "description": "6 StretchToFillBeforeCrop" } ] }, { "name": "setTimeInterpolationType", "returns": "boolean", "description": "Set the time interpolation type", "parameters": [ { "name": "interpolationType", "type": "any", "description": "" }, { "name": "arg2", "type": "number", "description": "2 OpticalFlow" } ] }, { "name": "setUseFrameBlending", "returns": "boolean", "description": "Toggle the use of frame blending [boolean] input value required", "parameters": [ { "name": "useFrameBlending", "type": "boolean", "description": "" } ] }, { "name": "setUseMaximumRenderQuality", "returns": "boolean", "description": "Toggle the use of maximum render quality [boolean] input value required", "parameters": [ { "name": "useMaximumRenderQuality", "type": "boolean", "description": "" } ] }, { "name": "setUsePreviewFiles", "returns": "boolean", "description": "Toggle the use of previews files. [boolean] input value required", "parameters": [ { "name": "usePreviewFiles", "type": "boolean", "description": "" } ] }, { "name": "setWorkArea", "returns": "boolean", "description": "Sets the work area type start and end time for the batch item", "parameters": [ { "name": "workAreaType", "type": "any", "description": "" }, { "name": "arg2", "type": "any", "description": "" }, { "name": "arg3", "type": "any", "description": "" }, { "name": "arg4", "type": "number", "description": "4 UseDefault" }, { "name": "startTime", "type": "number", "description": "" }, { "name": "endTime", "type": "number", "description": "" } ] }, { "name": "setWorkAreaInTicks", "returns": "boolean", "description": "Sets the work area type start and end time in ticks for the batch item (available since 23.3)", "parameters": [ { "name": "workAreaType", "type": "any", "description": "" }, { "name": "arg2", "type": "any", "description": "" }, { "name": "arg3", "type": "any", "description": "" }, { "name": "arg4", "type": "number", "description": "4 UseDefault" }, { "name": "startTime", "type": "string", "description": "" }, { "name": "endTime", "type": "string", "description": "" } ] }, { "name": "setXMPData", "returns": "boolean", "description": "Sets XMP data to given template", "parameters": [ { "name": "templateXMPFilePath", "type": "string", "description": "" } ] } ] }, { "name": "EncoderWrapperEvent", "page": "EncoderWrapperEvent.html", "kind": "Object", "description": "An event to inform of encode progress and completion.", "properties": [ { "name": "audioInfo", "type": "string", "description": "Returns the audio pre-encoding info for the event type onAudioPreEncodeProgress (available since 24.0).", "access": "readonly" }, { "name": "audioProgress", "type": "string", "description": "Returns the audio pre-encoding progress for the event type onAudioPreEncodeProgress (available since 24.0).", "access": "readonly" }, { "name": "onAudioPreEncodeProgress", "type": "string", "description": "Notify when the audio pre-encode progress changes (available since 24.0).", "access": "readonly", "static": true }, { "name": "onEncodeFinished", "type": "string", "description": "Notify when the batch item has been encoded.", "access": "readonly", "static": true }, { "name": "onEncodeProgress", "type": "string", "description": "Notify when the batch item encode progress changes.", "access": "readonly", "static": true }, { "name": "result", "type": "string", "description": "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.", "access": "readonly" } ], "events": [], "methods": [ { "name": "addEventListener", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "dispatchEvent", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "removeEventListener", "returns": "any", "static": true, "description": "", "parameters": [] } ] }, { "name": "EssentialGraphicsUtils", "page": "EssentialGraphicsUtils.html", "kind": "Object", "description": "Supports installing and importing Motion Graphics Templates", "properties": [], "events": [], "methods": [ { "name": "installMOGRT", "returns": "string", "static": true, "description": "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.", "parameters": [ { "name": "sourcePath", "type": "string", "description": "" }, { "name": "subFolderPath", "type": "string", "description": "" } ] }, { "name": "isAEMogrt", "returns": "any", "static": true, "description": "Check if the input Mogrt was authored in AE", "parameters": [ { "name": "sourcePath", "type": "string", "description": "" } ] } ] }, { "name": "ExportFS", "page": "ExportFS.html", "kind": "Object", "description": "The Export Utilities object provides the main access for export utilities.", "properties": [ { "name": "getLastExportFolder", "type": "string", "description": "Return the last used export folder path.", "access": "readonly" }, { "name": "lastSelectedFolder", "type": "string", "description": "Return the last used folder path.", "access": "readonly" } ], "events": [], "methods": [ { "name": "ensureFilepathUniqueness", "returns": "string", "description": "If the file does not exist return filePath otherwise return modified filePath in order to avoid overwriting the existing file.", "parameters": [ { "name": "filePath", "type": "string", "description": "" } ] }, { "name": "parseFilePath", "returns": "string", "description": "Returns JSON containing significant elements of the path.", "parameters": [ { "name": "filePath", "type": "string", "description": "" } ] }, { "name": "pathJoin", "returns": "string", "description": "Returns the result of joining two path strings using the platform-dependent path separator.", "parameters": [ { "name": "pathString1", "type": "string", "description": "" }, { "name": "pathString2", "type": "string", "description": "" } ] }, { "name": "revealAndSelectFiles", "returns": "boolean", "description": "Deprecated: Use dvascripting.FileUtils.revealAndSelectFiles instead.", "parameters": [ { "name": "filePaths", "type": "any", "description": "" } ] }, { "name": "saveAsDialog", "returns": "string", "description": "Returns the full path to a selected file", "parameters": [ { "name": "defaultDir", "type": "string", "description": "" }, { "name": "defaultFileName", "type": "string", "description": "" }, { "name": "extension", "type": "string", "description": "" } ] }, { "name": "saveAsDialogWithFullPath", "returns": "string", "description": "Returns the full path to a selected file", "parameters": [ { "name": "fullPathWithExtension", "type": "string", "description": "" } ] }, { "name": "selectFolder", "returns": "string", "description": "Returns the full path to a selected folder", "parameters": [ { "name": "startFolder", "type": "string", "description": "" } ] }, { "name": "setlastExportFolder", "returns": "boolean", "description": "Set and store the last used export folder path.", "parameters": [ { "name": "exportFolder", "type": "string", "description": "" } ] }, { "name": "truncateString", "returns": "string", "description": "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", "parameters": [ { "name": "filePath", "type": "string", "description": "" }, { "name": "truncationWidth", "type": "number", "description": "" }, { "name": "truncationType", "type": "string", "description": "" } ] } ] }, { "name": "ExportMenuManager", "page": "ExportMenuManager.html", "kind": "Object", "description": "The ExportMenuManager object provides the main access for export menu (quick export) settings information and control.", "properties": [ { "name": "isExportMenuRunning", "type": "boolean", "description": "Returns if the app is running in Export Menu Mode and the Quick Export Settings are visible.", "access": "readonly" }, { "name": "isMatchSequenceFeatureEnabled", "type": "boolean", "description": "Returns true if the Match Sequence Preview Settings Feature has been enabled.", "access": "readonly" }, { "name": "transcoder", "type": "Transcoder", "description": "Get the current Transcoder.", "access": "readonly" } ], "events": [], "methods": [ { "name": "processExportMenuAction", "returns": "boolean", "description": "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.", "parameters": [ { "name": "exportMenuAction", "type": "number", "description": "" }, { "name": "inSdmContextGuid", "type": "string", "description": "" } ] } ] }, { "name": "ExportModeManager", "page": "ExportModeManager.html", "kind": "Object", "description": "The ExportModeManager object provides the main access for full export settings information and control.", "properties": [ { "name": "cropAspectRatioSelected", "type": "string", "description": "Returns a string representing aspect ratio currently selected for source crop.", "access": "readonly" }, { "name": "cropAspectRatiosList", "type": "string", "description": "Returns a JSON list of strings representing aspect ratio options to select for source crop.", "access": "readonly" }, { "name": "cropBoundariesList", "type": "string", "description": "Returns a JSON list of total 4 integer crop boundary values in the order representing left top right and bottom.", "access": "readonly" }, { "name": "cropCenter", "type": "string", "description": "Returns a JSON list of total 2 integers representing X and Y of current crop center position.", "access": "readonly" }, { "name": "destinationCategoriesCollapsedList", "type": "string", "description": "Returns a JSON list of destination categories that should be collapsed in the view.", "access": "readonly" }, { "name": "destinationCategoriesList", "type": "string", "description": "Returns a JSON list of destination categories to view categories in order.", "access": "readonly" }, { "name": "destinations", "type": "string", "description": "Returns a JSON list of all destinations for an export.", "access": "readonly" }, { "name": "isExportModeRunning", "type": "boolean", "description": "Returns if the app is running in Export Mode and the full Export Settings are visible.", "access": "readonly" }, { "name": "selectedDestinationIndex", "type": "number", "description": "Returns the index of the currently selected destination.", "access": "readonly" }, { "name": "sourceSelections", "type": "string", "description": "Returns a JSON list of all source selected objects that request an export.", "access": "readonly" }, { "name": "transcoder", "type": "Transcoder", "description": "Get the current Transcoder.", "access": "readonly" } ], "events": [], "methods": [ { "name": "addDestination", "returns": "boolean", "description": "Add a new destination of type destID with destName as custom display name.", "parameters": [ { "name": "destID", "type": "string", "description": "" }, { "name": "destName", "type": "string", "description": "" } ] }, { "name": "applyCropAspectRatio", "returns": "boolean", "description": "Apply source crop with the given aspect ratio.", "parameters": [ { "name": "inCropAspectRatioOptionStr", "type": "string", "description": "" } ] }, { "name": "applyCropBoundary", "returns": "boolean", "description": "Apply source crop with the given pixels for the given direction.", "parameters": [ { "name": "inDirection", "type": "number", "description": "" }, { "name": "inPixelsToCrop", "type": "number", "description": "" } ] }, { "name": "applyCropCenterX", "returns": "boolean", "description": "Adjust crop such that crop horizontal center is at the given center position.", "parameters": [ { "name": "inCenterX", "type": "number", "description": "" } ] }, { "name": "applyCropCenterY", "returns": "boolean", "description": "Adjust crop such that crop vertical center is at the given center position.", "parameters": [ { "name": "inCenterY", "type": "number", "description": "" } ] }, { "name": "deleteDestination", "returns": "boolean", "description": "Delete a destination.", "parameters": [ { "name": "destID", "type": "string", "description": "" }, { "name": "groupIndex", "type": "number", "description": "" } ] }, { "name": "disableAndResetCrop", "returns": "boolean", "description": "Disable crop and reset crop parameters in standard filter.", "parameters": [] }, { "name": "processExportModeAction", "returns": "boolean", "description": "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.", "parameters": [ { "name": "exportModeAction", "type": "number", "description": "" }, { "name": "inSdmContextGuid", "type": "string", "description": "" } ] }, { "name": "renameDestination", "returns": "boolean", "description": "Rename a destination.", "parameters": [ { "name": "destID", "type": "string", "description": "" }, { "name": "groupIndex", "type": "number", "description": "" }, { "name": "destDisplayName", "type": "string", "description": "" } ] }, { "name": "restoreDefaultDestinations", "returns": "boolean", "description": "Restore default destinations", "parameters": [] }, { "name": "selectDestination", "returns": "boolean", "description": "Select a new destination.", "parameters": [ { "name": "destID", "type": "string", "description": "" }, { "name": "groupIndex", "type": "number", "description": "" } ] }, { "name": "shouldExportDestination", "returns": "boolean", "description": "Should export a destination.", "parameters": [ { "name": "destID", "type": "string", "description": "" }, { "name": "groupIndex", "type": "number", "description": "" }, { "name": "shouldExport", "type": "boolean", "description": "" } ] }, { "name": "toggleDestinationCategory", "returns": "boolean", "description": "Toggle the given category as collapsed vs expanded in the local set that tracks collapsed export destination categories.", "parameters": [ { "name": "inDestinationCategory", "type": "string", "description": "" } ] } ] }, { "name": "ExportPreset", "page": "ExportPreset.html", "kind": "Object", "description": "The ExportPreset object provides the main access for export settings information in a export preset.", "properties": [ { "name": "displayName", "type": "string", "description": "The display name of the preset.", "access": "readonly" }, { "name": "filePath", "type": "string", "description": "The fullpath to the presetfile.", "access": "readonly" }, { "name": "folderDisplayPath", "type": "string", "description": "The folder display path of the preset.", "access": "readonly" }, { "name": "isIngestPreset", "type": "boolean", "description": "Returns true|false if the preset is an ingest preset.", "access": "readonly" }, { "name": "matchName", "type": "string", "description": "The search match name of the preset.", "access": "readonly" }, { "name": "presetSummaryJSON", "type": "string", "description": "Returns the Menu Preset summary for this preset.", "access": "readonly" }, { "name": "uniqueID", "type": "string", "description": "The unique ID of the preset.", "access": "readonly" }, { "name": "userComments", "type": "string", "description": "User-provided comments for the preset.", "access": "readonly" } ], "events": [], "methods": [ { "name": "comments", "returns": "string", "description": "The comments of the preset as loc string or resolved.", "parameters": [ { "name": "resolveZString", "type": "boolean", "description": "" } ] } ] }, { "name": "ExportPresetManager", "page": "ExportPresetManager.html", "kind": "Object", "description": "The ExportPresetManager object provides the main access for export settings information and control.", "properties": [ { "name": "favoritePresetList", "type": "any[]", "description": "Returns list of all presets that should be displayed in the preset menu list (Format independent).", "access": "readonly" }, { "name": "importPresets", "type": "Object", "description": "Import presets", "access": "readonly" }, { "name": "isPresetManagerEnabled", "type": "boolean", "description": "Returns true if the preset manager has been enabled by a debug console flag", "access": "readonly" }, { "name": "recentPresetList", "type": "any[]", "description": "Returns list of recent used presets that should be displayed in the preset menu list (Format independent).", "access": "readonly" }, { "name": "unsupportedFormatList", "type": "any", "description": "Returns list of all unsupported formats.", "access": "readonly" }, { "name": "unsupportedPresetNameList", "type": "any", "description": "Returns list of known unsupported preset names.", "access": "readonly" }, { "name": "userPresetList", "type": "Object", "description": "Returns list of all user presets.", "access": "readonly" } ], "events": [], "methods": [ { "name": "deletePresets", "returns": "Object", "description": "Deletes custom presets", "parameters": [ { "name": "presetIDs", "type": "any", "description": "" } ] }, { "name": "exportPresets", "returns": "boolean", "description": "Export presets", "parameters": [ { "name": "exportPresetsJSON", "type": "string", "description": "" } ] }, { "name": "presetSummaryJSON", "returns": "string", "description": "Returns the Menu Preset summary for this presetID.", "parameters": [ { "name": "presetID", "type": "string", "description": "" }, { "name": "filePath", "type": "string", "description": "" } ] }, { "name": "requestActivePresetChange", "returns": "boolean", "description": "Request active preset to be changed.", "parameters": [ { "name": "presetToBeSetAsActive", "type": "string", "description": "" } ] }, { "name": "saveFavoritePresetsJSON", "returns": "boolean", "description": "Save the favorite JSON string to a dva shared preference file.", "parameters": [ { "name": "presetsJSON", "type": "string", "description": "" } ] } ] }, { "name": "ExportSettings", "page": "ExportSettings.html", "kind": "Object", "description": "The ExportSettings object provides the main access for export settings information and control.", "properties": [ { "name": "CONST_POPUP_SEPARATOR", "type": "string", "description": "Export Settings popup separator identifier.", "access": "readonly", "static": true }, { "name": "exportMenuManager", "type": "ExportMenuManager", "description": "Get the Export Menu Manager that manages the Quick Export Settings.", "access": "readonly", "static": true }, { "name": "exportModeManager", "type": "ExportModeManager", "description": "Get the Export Mode Manager that manages the full Export Settings.", "access": "readonly", "static": true }, { "name": "formatNameList", "type": "any", "description": "Returns list of all available export formats.", "access": "readonly", "static": true }, { "name": "fs", "type": "ExportFS", "description": "Get the export filesystem to access export related file functionality.", "access": "readonly", "static": true }, { "name": "presetManager", "type": "ExportPresetManager", "description": "Get the Preset Manager that manages all the presets.", "access": "readonly", "static": true } ], "events": [], "methods": [ { "name": "presetFormatList", "returns": "any[]", "static": true, "description": "Returns list of all presets for one export format.", "parameters": [ { "name": "formatName", "type": "string", "description": "" } ] } ] }, { "name": "ExporterScriptObject", "page": "ExporterScriptObject.html", "kind": "Object", "description": "Contains several encoding methods. You can listen to different types of the AMEExportEvent: onEncodeComplete, onError, onMediaInfoCreated, onBatchItemStatusChanged, onItemEncodingStarted, onEncodingItemProgressUpdated, onAudioPreEncodeProgress, onPostProcessListInitialized", "properties": [ { "name": "elapsedMilliseconds", "type": "number", "description": "Returns the encode time in milliseconds.", "access": "readonly" }, { "name": "encodeID", "type": "any", "description": "", "access": "readonly" }, { "name": "encodeSuccess", "type": "any", "description": "", "access": "readonly" } ], "events": [], "methods": [ { "name": "exportGroup", "returns": "boolean", "description": "Export the source with the provided list of presets. Returns true in case of success.", "parameters": [ { "name": "sourcePath", "type": "string", "description": "Media path (Premiere Pro projects aren't supported)." }, { "name": "outputPath", "type": "string", "description": "If outputPath is empty, then the output file location will be generated based on the source location." }, { "name": "presetsPath", "type": "string", "description": "Multiple preset paths can be provided separated via a | (e.g. 'path1|path2|path3'" }, { "name": "matchSource", "type": "boolean", "description": "Optional. Default value is false", "optional": true } ] }, { "name": "exportItem", "returns": "EncoderWrapper", "description": "Export the source with the provided preset. Returns an EncoderWrapper object.", "parameters": [ { "name": "sourcePath", "type": "string", "description": "Media path or Premiere Pro project path (In case of a Premiere Pro project the last sequence will be used)." }, { "name": "outputPath", "type": "string", "description": "If outputPath is empty, then the output file location will be generated based on the source location." }, { "name": "presetPath", "type": "string", "description": "" }, { "name": "matchSource", "type": "boolean", "description": "Optional. Default value is false", "optional": true }, { "name": "writeFramesToDisk", "type": "any", "description": "Optional. Default value is false. True writes five frames at 0%", "optional": true }, { "name": "arg7", "type": "any", "description": "" }, { "name": "arg8", "type": "boolean", "description": "75% and 100% of the full duration. Known issue, Currently it only works with parallel encoding disabled." } ] }, { "name": "exportSequence", "returns": "boolean", "description": "Export the Premiere Pro sequence with the provided preset. Returns true in case of success.", "parameters": [ { "name": "projectPath", "type": "string", "description": "Premiere Pro project path." }, { "name": "outputPath", "type": "string", "description": "If outputPath is empty, then the output file location will be generated based on the source location." }, { "name": "presetPath", "type": "string", "description": "" }, { "name": "matchSource", "type": "boolean", "description": "Optional. Default value is false.", "optional": true }, { "name": "writeFramesToDisk", "type": "any", "description": "Optional. Default value is false. True writes five frames at 0%", "optional": true }, { "name": "arg7", "type": "any", "description": "" }, { "name": "arg8", "type": "boolean", "description": "75% and 100% of the full duration. Known issue, Currently it only works with parallel encoding disabled." }, { "name": "leadingFramesToTrim", "type": "number", "description": "Optional. Default value is 0.", "optional": true }, { "name": "trailingFramesToTrim", "type": "number", "description": "Optional. Default value is 0.", "optional": true }, { "name": "sequenceName", "type": "string", "description": "Optional. If sequence name is empty then we use the last sequence of the project.", "optional": true } ] }, { "name": "getSourceMediaInfo", "returns": "SourceMediaInfo", "description": "Returns a SourceMediaInfo object.", "parameters": [ { "name": "sourcePath", "type": "string", "description": "" } ] }, { "name": "removeAllBatchItems", "returns": "any", "description": "Remove all batch items from the queue. Returns true in case of success.", "parameters": [ { "name": "arg1", "type": "boolean", "description": "" } ] }, { "name": "trimExportForSR", "returns": "boolean", "description": "Smart render the source with the provided preset. Returns true in case of success.", "parameters": [ { "name": "sourcePath", "type": "string", "description": "Media path or Premiere Pro project path (In case of a Premiere Pro project the last sequence will be used)." }, { "name": "outputPath", "type": "string", "description": "If outputPath is empty, then the output file location will be generated based on the source location." }, { "name": "presetPath", "type": "string", "description": "" }, { "name": "matchSource", "type": "boolean", "description": "Optional. Default value is false.", "optional": true }, { "name": "writeFramesToDisk", "type": "any", "description": "Optional. Default value is false. True writes five frames at 0%", "optional": true }, { "name": "arg7", "type": "any", "description": "" }, { "name": "arg8", "type": "boolean", "description": "75% and 100% of the full duration. Known issue, Currently it only works with parallel encoding disabled." }, { "name": "leadingFramesToTrim", "type": "number", "description": "Optional. Default value is 0.", "optional": true }, { "name": "trailingFramesToTrim", "type": "number", "description": "Optional. Default value is 0.", "optional": true } ] } ] }, { "name": "FilterModule", "page": "FilterModule.html", "kind": "Object", "description": "A filter (audio/video) of a project", "properties": [ { "name": "displayName", "type": "string", "description": "Returns the display name for the filter", "access": "readonly" }, { "name": "matchName", "type": "string", "description": "Returns the internal matchname for the filter", "access": "readonly" }, { "name": "mediaType", "type": "Object", "description": "Returns the media type guid for the filter object", "access": "readonly" } ], "events": [], "methods": [ { "name": "castOrThrow", "returns": "FilterModule", "static": true, "description": "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.", "parameters": [ { "name": "object", "type": "Object", "description": "" } ] }, { "name": "queryCast", "returns": "FilterModule", "static": true, "description": "Cast an object to FilterModule. In case the provided object can be used as FilterModule a corresponding object is returned. Otherwise null is returned.", "parameters": [ { "name": "object", "type": "Object", "description": "" } ] } ] }, { "name": "FrameRate", "page": "FrameRate.html", "kind": "Object", "description": "FrameRate class", "properties": [ { "name": "ticksPerFrame", "type": "number", "description": "Read|Write property to get|set ticks per frame.", "access": "read/write" }, { "name": "value", "type": "number", "description": "Get the number of frames per second.", "access": "readonly" } ], "events": [], "methods": [ { "name": "FrameRate", "returns": "FrameRate", "description": "Constructs a FrameRateObject object", "parameters": [] }, { "name": "createWithValue", "returns": "FrameRate", "static": true, "description": "Create frame rate object with a value", "parameters": [ { "name": "value", "type": "number", "description": "" } ] }, { "name": "equals", "returns": "boolean", "description": "Returns true if the given FrameRate is equal to this FrameRate object", "parameters": [ { "name": "frameRate", "type": "FrameRate", "description": "" } ] } ] }, { "name": "FrontendScriptObject", "page": "FrontendScriptObject.html", "kind": "Object", "description": "Scripting methods to the frontend", "properties": [], "events": [], "methods": [ { "name": "addCompToBatch", "returns": "boolean", "description": "Adds the first comp of an After Effects project resp. the first sequence of a Premiere Pro project to the batch.", "parameters": [ { "name": "compPath", "type": "string", "description": "Path to e.g. an After Effects project or Premiere Pro project. The first comp resp. sequence will be used." }, { "name": "presetPath", "type": "string", "description": "Optional. If presetPath is empty, then the default preset will be applied.", "optional": true }, { "name": "outputPath", "type": "string", "description": "Optional. If outputPath is empty, then the output file name will be generated based on the comp path.", "optional": true } ] }, { "name": "addDLToBatch", "returns": "Object", "description": "Adds e.g. an After Effects comp or Premiere Pro sequence to the batch and returns an EncoderWrapper object.", "parameters": [ { "name": "projectPath", "type": "string", "description": "E.g. Premiere Pro or After Effects project path." }, { "name": "format", "type": "string", "description": "E.g. 'H.264'" }, { "name": "presetPath", "type": "string", "description": "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." }, { "name": "guid", "type": "string", "description": "The unique id of e.g. a Premiere Pro sequence or After Effects composition." }, { "name": "outputPath", "type": "string", "description": "Optional. If outputPath is empty, then the output file name will be generated based on the project path.", "optional": true } ] }, { "name": "addFileSequenceToBatch", "returns": "boolean", "description": "Adds an image sequence to the batch. The images will be sorted in alphabetical order.", "parameters": [ { "name": "containingFolder", "type": "string", "description": "The folder containing image files." }, { "name": "imagePath", "type": "string", "description": "All images from the containing folder with the same extension will be added to the output file." }, { "name": "presetPath", "type": "string", "description": "" }, { "name": "outputPath", "type": "string", "description": "Optional. If outputPath is empty, then the output file name will be generated based on the containingFolder name", "optional": true } ] }, { "name": "addFileToBatch", "returns": "Object", "description": "Adds a file to the batch and returns an EncoderWrapper object.", "parameters": [ { "name": "filePath", "type": "string", "description": "File path of a media source." }, { "name": "format", "type": "string", "description": "E.g. 'H.264'" }, { "name": "presetPath", "type": "string", "description": "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." }, { "name": "outputPath", "type": "string", "description": "Optional. If outputPath is empty, then the output file name will be generated based on the file path.", "optional": true } ] }, { "name": "addItemToBatch", "returns": "boolean", "description": "Adds a media source to the batch.", "parameters": [ { "name": "sourcePath", "type": "string", "description": "Path of the media source." } ] }, { "name": "addTeamProjectsItemToBatch", "returns": "Object", "description": "Adds a team project item to the batch and returns an EncoderWrapper object.", "parameters": [ { "name": "projectsURL", "type": "string", "description": "Team Projects URL or Team Projects Snap. You can create a tp2snap file in PPro for a ProjectItem via the scripting API saveProjectSnapshot." }, { "name": "format", "type": "string", "description": "E.g. 'H.264'" }, { "name": "presetPath", "type": "string", "description": "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." }, { "name": "outputPath", "type": "string", "description": "" } ] }, { "name": "addXMLToBatch", "returns": "boolean", "description": "Adds Final Cut Pro xml to the batch.", "parameters": [ { "name": "xmlPath", "type": "string", "description": "Path to a Final Cut Pro xml file." }, { "name": "presetPath", "type": "string", "description": "" }, { "name": "outputFolderPath", "type": "string", "description": "Optional. If outputFolderPath is empty, then the output file name will be generated based on the XML file path.", "optional": true } ] }, { "name": "getDLItemsAtRoot", "returns": "any", "description": "Returns the list of GUIDs for objects (sequences|comps) at the top|root level.", "parameters": [ { "name": "projectPath", "type": "string", "description": "E.g. Premiere Pro or After Effects project path." } ] }, { "name": "stitchFiles", "returns": "Object", "description": "Adds a batch item for the given media and returns an EncoderWrapper object.", "parameters": [ { "name": "mediaPaths", "type": "string", "description": "Semicolon delimited list of media paths." }, { "name": "format", "type": "string", "description": "E.g. 'H.264'" }, { "name": "presetPath", "type": "string", "description": "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." }, { "name": "outputPath", "type": "string", "description": "" } ] }, { "name": "stopBatch", "returns": "boolean", "description": "Stops the batch.", "parameters": [] } ] }, { "name": "GenExtend", "page": "GenExtend.html", "kind": "Object", "description": "This provides the utility to access Gen extend job", "properties": [], "events": [], "methods": [ { "name": "GenExtend", "returns": "GenExtend", "description": "Creates a GenExtend object", "parameters": [] }, { "name": "appendGenExtendTransitionDurationChangeMissingFramesAction", "returns": "Object", "static": true, "description": "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", "parameters": [ { "name": "sequence", "type": "Object", "description": "" }, { "name": "transitiontrackitem", "type": "Object", "description": "" }, { "name": "newstart", "type": "Object", "description": "" }, { "name": "newend", "type": "Object", "description": "" }, { "name": "compoundaction", "type": "Object", "description": "" } ] }, { "name": "appendGenExtendTransitionMissingFramesAction", "returns": "Object", "static": true, "description": "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", "parameters": [ { "name": "sequence", "type": "Object", "description": "" }, { "name": "mediatype", "type": "Object", "description": "" }, { "name": "trackindex", "type": "number", "description": "" }, { "name": "editpoint", "type": "Object", "description": "" }, { "name": "compoundaction", "type": "Object", "description": "" } ] }, { "name": "applyGenExtendTransitionMissingFrames", "returns": "any[]", "static": true, "description": "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)", "parameters": [ { "name": "transitiontrackitem", "type": "Object", "description": "" }, { "name": "sequence", "type": "Object", "description": "" } ] }, { "name": "canGenExtendTransition", "returns": "boolean", "static": true, "description": "Whether the given committed transition qualifies for GenExtend missing-frames generation", "parameters": [ { "name": "transitiontrackitem", "type": "Object", "description": "" }, { "name": "sequence", "type": "Object", "description": "" } ] }, { "name": "canGenExtendTransitionForDurationChange", "returns": "boolean", "static": true, "description": "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", "parameters": [ { "name": "transitiontrackitem", "type": "Object", "description": "" }, { "name": "sequence", "type": "Object", "description": "" }, { "name": "newstart", "type": "Object", "description": "" }, { "name": "newend", "type": "Object", "description": "" } ] }, { "name": "checkPrevalidation", "returns": "any", "static": true, "description": "Check for pre validation errors", "parameters": [ { "name": "audiotrackitem", "type": "Object", "description": "" }, { "name": "videotrackitem", "type": "Object", "description": "" }, { "name": "deltatime", "type": "Object", "description": "" }, { "name": "isbackwarddirection", "type": "boolean", "description": "" } ] }, { "name": "createGenExtendJob", "returns": "any[]", "static": true, "description": "Create Job for Generative Extend", "parameters": [ { "name": "sequence", "type": "Object", "description": "" }, { "name": "trackitem", "type": "Object", "description": "" }, { "name": "deltatime", "type": "Object", "description": "" }, { "name": "isbackwarddirection", "type": "boolean", "description": "" } ] }, { "name": "dispatchGenExtendExtensionsAsync", "returns": "any[]", "static": true, "description": "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)", "parameters": [ { "name": "genextendparams", "type": "Object", "description": "" } ] }, { "name": "regenerateExtension", "returns": "any[]", "static": true, "description": "Regenerate extension", "parameters": [ { "name": "sequence", "type": "Object", "description": "" }, { "name": "trackitem", "type": "Object", "description": "" }, { "name": "isbackwarddirection", "type": "boolean", "description": "" } ] }, { "name": "revertToOriginal", "returns": "boolean", "static": true, "description": "Revert To Original", "parameters": [ { "name": "sequence", "type": "Object", "description": "" }, { "name": "trackitem", "type": "Object", "description": "" } ] } ] }, { "name": "GenExtendJob", "page": "GenExtendJob.html", "kind": "Object", "description": "This provides the utility for Gen Extend Job", "properties": [], "events": [], "methods": [ { "name": "GenExtendJob", "returns": "GenExtendJob", "description": "Creates a GenExtend Job object", "parameters": [] }, { "name": "getGenExtendJobErrorMessage", "returns": "string", "description": "Gets the error message for Generative Extend job failure", "parameters": [] }, { "name": "getGenExtendJobProgress", "returns": "Object", "description": "Gets the progress item for Generative Extend Job", "parameters": [] } ] }, { "name": "GenExtendParams", "page": "GenExtendParams.html", "kind": "Object", "description": "Opaque handle for GenExtend params pending dispatch, produced by GenExtend.appendGenExtendTransitionMissingFramesAction", "properties": [], "events": [], "methods": [ { "name": "GenExtendParams", "returns": "GenExtendParams", "description": "Holds GenExtend params pending dispatch", "parameters": [] }, { "name": "isEmpty", "returns": "boolean", "description": "True when there was nothing to generate (neither side needed frames)", "parameters": [] } ] }, { "name": "GenMusic", "page": "GenMusic.html", "kind": "Object", "description": "Scripting bridge for Generative Music job submission and result inspection", "properties": [], "events": [], "methods": [ { "name": "GenMusic", "returns": "GenMusic", "description": "Creates a GenMusic object", "parameters": [] }, { "name": "createGenMusicJob", "returns": "boolean", "static": true, "description": "Trigger a Generative Music job for the given range on an audio track", "parameters": [ { "name": "sequence", "type": "Object", "description": "" }, { "name": "targettrack", "type": "Object", "description": "" }, { "name": "starttime", "type": "Object", "description": "" }, { "name": "durationseconds", "type": "number", "description": "" }, { "name": "prompt", "type": "string", "description": "" }, { "name": "beatsperminute", "type": "number", "description": "" }, { "name": "loop", "type": "boolean", "description": "" } ] }, { "name": "createGenMusicJobUnderVideo", "returns": "boolean", "static": true, "description": "Trigger a Generative Music job using the video clip above the range as reference (Beta)", "parameters": [ { "name": "sequence", "type": "Object", "description": "" }, { "name": "targettrack", "type": "Object", "description": "" }, { "name": "starttime", "type": "Object", "description": "" }, { "name": "durationseconds", "type": "number", "description": "" }, { "name": "prompt", "type": "string", "description": "" }, { "name": "beatsperminute", "type": "number", "description": "" }, { "name": "loop", "type": "boolean", "description": "" } ] }, { "name": "enhancePrompt", "returns": "string", "static": true, "description": "AI-enhance the prompt text (blocked: kGenMusic not yet in GenTypeHasPromptEnhance)", "parameters": [ { "name": "prompt", "type": "string", "description": "" }, { "name": "expansionenabled", "type": "boolean", "description": "" } ] }, { "name": "getActiveVariationIndex", "returns": "number", "static": true, "description": "Returns the active variation index (0-3) from TrackItemChainHistory", "parameters": [ { "name": "trackitem", "type": "Object", "description": "" } ] }, { "name": "getClipChannelFormat", "returns": "string", "static": true, "description": "Returns the channel format of the generated compound clip's audio (e.g. \"Stereo\")", "parameters": [ { "name": "trackitem", "type": "Object", "description": "" } ] }, { "name": "getClipLoopMode", "returns": "boolean", "static": true, "description": "Returns mLoop from the master clip's persisted MusicGenerationParams JSON", "parameters": [ { "name": "trackitem", "type": "Object", "description": "" } ] }, { "name": "getClipSampleRate", "returns": "number", "static": true, "description": "Returns the sample rate in Hz of the generated compound clip's audio", "parameters": [ { "name": "trackitem", "type": "Object", "description": "" } ] }, { "name": "getGeneratedTrackItem", "returns": "any[]", "static": true, "description": "Scans the audio track at starttime for an online compound clip; returns it when generation is complete", "parameters": [ { "name": "sequence", "type": "Object", "description": "" }, { "name": "targettrack", "type": "Object", "description": "" }, { "name": "starttime", "type": "Object", "description": "" } ] }, { "name": "getVariationCount", "returns": "number", "static": true, "description": "Returns the total variation count from VariationGroupMetadata", "parameters": [ { "name": "trackitem", "type": "Object", "description": "" } ] }, { "name": "getVideoPromptSuggestion", "returns": "string", "static": true, "description": "Generate a music prompt suggestion from a local video file path via Firefly |v3|prompts|suggest", "parameters": [ { "name": "videofilepath", "type": "string", "description": "" } ] }, { "name": "regenerateGenMusicJob", "returns": "boolean", "static": true, "description": "Re-submit a Generative Music job targeting an existing compound clip", "parameters": [ { "name": "sequence", "type": "Object", "description": "" }, { "name": "existingtrackitem", "type": "Object", "description": "" }, { "name": "prompt", "type": "string", "description": "" }, { "name": "beatsperminute", "type": "number", "description": "" }, { "name": "loop", "type": "boolean", "description": "" } ] }, { "name": "selectVariation", "returns": "boolean", "static": true, "description": "Swap the active variation (0-3) of the compound track item", "parameters": [ { "name": "sequence", "type": "Object", "description": "" }, { "name": "trackitem", "type": "Object", "description": "" }, { "name": "variationindex", "type": "number", "description": "" } ] } ] }, { "name": "GenSFx", "page": "GenSFx.html", "kind": "Object", "description": "Utility to invoke prompt-based Generate Sound Effects", "properties": [], "events": [], "methods": [ { "name": "GenSFx", "returns": "GenSFx", "description": "Creates a GenSFx object", "parameters": [] }, { "name": "generate", "returns": "string", "static": true, "description": "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.", "parameters": [ { "name": "inSequence", "type": "Sequence", "description": "" }, { "name": "inPrompt", "type": "string", "description": "" }, { "name": "inStartSeconds", "type": "number", "description": "" }, { "name": "inDurationSeconds", "type": "number", "description": "" } ] } ] }, { "name": "Guid", "page": "Guid.html", "kind": "Object", "description": "A random GUID", "properties": [], "events": [], "methods": [ { "name": "Guid", "returns": "Guid", "description": "constructor for empty guid", "parameters": [] }, { "name": "createUnique", "returns": "Guid", "static": true, "description": "Create a unique guid", "parameters": [] }, { "name": "equals", "returns": "boolean", "description": "Returnes true if the content of this GUID is equal to the given GUID object", "parameters": [ { "name": "Guid", "type": "Object", "description": "" } ] }, { "name": "fromString", "returns": "Guid", "static": true, "description": "Create a guid from a string", "parameters": [ { "name": "stringValue", "type": "string", "description": "" } ] }, { "name": "toString", "returns": "string", "description": "Return string representation of the GUID", "parameters": [] } ] }, { "name": "Matrix", "page": "Matrix.html", "kind": "Object", "description": "Algebra BLAS data class", "properties": [ { "name": "cols", "type": "number", "description": "Get number of columns in this data object.", "access": "readonly" }, { "name": "rows", "type": "number", "description": "Get number of rows in this data object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "Matrix", "returns": "Matrix", "description": "Constructs a new BLAS Matrix object.", "parameters": [ { "name": "rows", "type": "number", "description": "" }, { "name": "cols", "type": "number", "description": "" }, { "name": "data", "type": "any", "description": "" } ] }, { "name": "abs", "returns": "Object", "description": "Element-wise absolute value; returns a new vector or matrix.", "parameters": [] }, { "name": "add", "returns": "Object", "description": "Element-wise add another vector or matrix of the same shape; returns a new vector or matrix.", "parameters": [ { "name": "other", "type": "Object", "description": "" } ] }, { "name": "argMax", "returns": "number", "description": "Get the linear (column-major) index of the maximum element.", "parameters": [] }, { "name": "at", "returns": "number", "description": "Get the value at the given row and column index.", "parameters": [ { "name": "rowIdx", "type": "number", "description": "" }, { "name": "colIdx", "type": "number", "description": "" } ] }, { "name": "divide", "returns": "Object", "description": "Element-wise divide by another vector or matrix of the same shape; returns a new vector or matrix.", "parameters": [ { "name": "other", "type": "Object", "description": "" } ] }, { "name": "fromVectors", "returns": "Object", "static": true, "description": "Create a [vectors[0].length x vectors.length] matrix that contains the given vectors as columns. The vectors must all have the same length.", "parameters": [ { "name": "vectors", "type": "any[]", "description": "" } ] }, { "name": "max", "returns": "number", "description": "Get the maximum element value in this vector or matrix.", "parameters": [] }, { "name": "maximum", "returns": "Object", "description": "Element-wise maximum of each element and the given scalar; returns a new vector or matrix.", "parameters": [ { "name": "scalar", "type": "number", "description": "" } ] }, { "name": "multiply", "returns": "Object", "description": "Element-wise multiply by another vector or matrix of the same shape; returns a new vector or matrix.", "parameters": [ { "name": "other", "type": "Object", "description": "" } ] }, { "name": "norm", "returns": "number", "description": "Compute the norm of this vector or matrix.", "parameters": [] }, { "name": "pow", "returns": "Object", "description": "Element-wise power; returns a new vector or matrix.", "parameters": [ { "name": "exponent", "type": "number", "description": "" } ] }, { "name": "scale", "returns": "Object", "description": "Multiply each element by the given scalar; returns a new vector or matrix.", "parameters": [ { "name": "factor", "type": "number", "description": "" } ] }, { "name": "squaredNorm", "returns": "number", "description": "Compute the squared L2 norm of this vector or matrix.", "parameters": [] }, { "name": "subtract", "returns": "Object", "description": "Element-wise subtract another vector or matrix of the same shape; returns a new vector or matrix.", "parameters": [ { "name": "other", "type": "Object", "description": "" } ] }, { "name": "sum", "returns": "number", "description": "Compute the sum of all elements in this vector or matrix.", "parameters": [] } ] }, { "name": "MediaBrowser", "page": "MediaBrowser.html", "kind": "Object", "description": "Scripting interfaces to Media Browser. Can be used to make and/or cancel thumbnail and project item requests.", "properties": [], "events": [], "methods": [ { "name": "cancelProjectItemRequests", "returns": "number", "static": true, "description": "Cancel all outstanding project item requests. Typical use would be changing directories while metadata is still being retrieved for items in the previous directory.", "parameters": [] }, { "name": "cancelThumbnailRequests", "returns": "number", "static": true, "description": "Cancel all outstanding thumbnail requests. Typical use would be changing directories while thumbnails are still being retrieved for items in the previous directory.", "parameters": [] } ] }, { "name": "MedianFilter", "page": "MedianFilter.html", "kind": "Object", "description": "Stateless scripting object for the Median Filter algorithm", "properties": [], "events": [], "methods": [ { "name": "filter", "returns": "any", "static": true, "description": "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.", "parameters": [ { "name": "vector", "type": "Object", "description": "" }, { "name": "kernelSize", "type": "number", "description": "" } ] }, { "name": "filterND", "returns": "any", "static": true, "description": "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.", "parameters": [ { "name": "vector", "type": "Object", "description": "" }, { "name": "kernelSize", "type": "number", "description": "" } ] } ] }, { "name": "MultiTrackClustering", "page": "MultiTrackClustering.html", "kind": "Object", "description": "Runs MultiTrackClusterStrategy directly with configurable parameters.", "properties": [], "events": [], "methods": [ { "name": "cluster", "returns": "Object", "static": true, "description": "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.", "parameters": [ { "name": "embeddings", "type": "Vector[]", "description": "" }, { "name": "timeRanges", "type": "TimeRange[]", "description": "" }, { "name": "similarityThreshold", "type": "number", "description": "" } ] } ] }, { "name": "OSInfo", "page": "OSInfo.html", "kind": "Object", "description": "The OSInfo object provides information about the operating system.", "properties": [ { "name": "architecture", "type": "string", "description": "Operating system architecture arm64 or x64.", "access": "readonly" }, { "name": "emulation", "type": "boolean", "description": "Operating system emulation.", "access": "readonly" }, { "name": "name", "type": "string", "description": "Operating system name.", "access": "readonly" } ], "events": [], "methods": [] }, { "name": "ObjectReflection", "page": "ObjectReflection.html", "kind": "Object", "description": "The ObjectReflection object provides information about the behavior of an object.", "properties": [ { "name": "classProperties", "type": "any[]", "description": "The object class properties.", "access": "readonly" }, { "name": "description", "type": "string", "description": "The object class description.", "access": "readonly" }, { "name": "eventObject", "type": "boolean", "description": "true if the object is an event object.", "access": "readonly" }, { "name": "eventTarget", "type": "boolean", "description": "true if the object is an event target object.", "access": "readonly" }, { "name": "instanceProperties", "type": "any[]", "description": "The object instance properties.", "access": "readonly" }, { "name": "name", "type": "string", "description": "The object class name.", "access": "readonly" } ], "events": [], "methods": [ { "name": "ObjectReflection", "returns": "ObjectReflection", "description": "Construct ObjectReflection object for given object.", "parameters": [ { "name": "object", "type": "Object", "description": "object to inspect" } ] }, { "name": "getObjectReflections", "returns": "any[]", "static": true, "description": "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.", "parameters": [ { "name": "namespaces", "type": "Object", "description": "" } ] }, { "name": "getThirdPartyObjectReflections", "returns": "any[]", "static": true, "description": "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.", "parameters": [ { "name": "namespaces", "type": "Object", "description": "" } ] } ] }, { "name": "Panko", "page": "Panko.html", "kind": "Object", "description": "Panko class provides the ability to leave and read Panko breadcrumb trails in scripting.", "properties": [], "events": [], "methods": [ { "name": "getLog", "returns": "any[]", "static": true, "description": "Get all Panko trail checkpoints logged since the last call each as { data callstack }", "parameters": [] }, { "name": "leaveTrail", "returns": "boolean", "static": true, "description": "Leave a Panko breadcrumb trail with the given data", "parameters": [ { "name": "data", "type": "Object", "description": "" } ] }, { "name": "startLog", "returns": "boolean", "static": true, "description": "Start logging all Panko trail checkpoints hit during the receive period", "parameters": [] } ] }, { "name": "ParameterReflection", "page": "ParameterReflection.html", "kind": "Object", "description": "The ParameterReflection object provides information about the behavior of parameters of methods or constructors.", "properties": [ { "name": "dataType", "type": "Object", "description": "The data type of the parameter.", "access": "readonly" }, { "name": "description", "type": "any", "description": "", "access": "readonly" }, { "name": "name", "type": "string", "description": "The parameter name.", "access": "readonly" } ], "events": [], "methods": [] }, { "name": "Paywall", "page": "Paywall.html", "kind": "Object", "description": "Scripting surface for the in-product paywall. Dispatches EVENT_PURCHASE_COMPLETED when a credit purchase completes so an extension can refresh credit-dependent UI.", "properties": [], "events": [ { "name": "EVENT_PURCHASE_COMPLETED", "description": "Dispatched on a Paywall object when a paywall purchase completes so an extension can refresh credit-dependent UI such as a buy-credits banner." } ], "methods": [ { "name": "addEventListener", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "dispatchEvent", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "getInstance", "returns": "Paywall", "static": true, "description": "Get a Paywall event target. Call subscribeToEvent(Paywall.EVENT_PURCHASE_COMPLETED) then add a listener for it.", "parameters": [] }, { "name": "removeEventListener", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "showCreditBalance", "returns": "boolean", "static": true, "description": "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.", "parameters": [] }, { "name": "subscribeToEvent", "returns": "boolean", "description": "Propagates the given event on this object.", "parameters": [ { "name": "eventKey", "type": "string", "description": "" } ] } ] }, { "name": "PixelAspectRatio", "page": "PixelAspectRatio.html", "kind": "Object", "description": "Pixel aspect ratio has a numerator and a denominator.", "properties": [ { "name": "denominator", "type": "number", "description": "Pixel aspect ration denominator.", "access": "read/write" }, { "name": "numerator", "type": "number", "description": "Pixel aspect ratio numerator.", "access": "read/write" } ], "events": [], "methods": [ { "name": "PixelAspectRatio", "returns": "PixelAspectRatio", "description": "Construct a PixelAspectRatio Object with parameters", "parameters": [ { "name": "numerator", "type": "number", "description": "" }, { "name": "denominator", "type": "number", "description": "" } ] }, { "name": "equals", "returns": "boolean", "description": "Returns true if the given PixelAspectRatioObject is equal to this PixelAspectRatioObject", "parameters": [ { "name": "pixelAspectRatioObject", "type": "PixelAspectRatioObject", "description": "" } ] } ] }, { "name": "PixelCompareTestResults", "page": "PixelCompareTestResults.html", "kind": "Object", "description": "Results of a pixel-based comparison. Includes number of different pixels, percent variation, and an error message if necessary.", "properties": [ { "name": "avgVariance", "type": "number", "description": "Calculated average variance. Total variance | num diff pixels", "access": "readonly" }, { "name": "diffData", "type": "string", "description": "Image data for the diff image generated", "access": "readonly" }, { "name": "minVariance", "type": "number", "description": "Minimum variance.", "access": "readonly" }, { "name": "numDiffPixels", "type": "number", "description": "Number of pixels that were different between the 2 images", "access": "readonly" }, { "name": "psnr", "type": "number", "description": "Calculated peak signal-to-noise ratio.", "access": "readonly" }, { "name": "result", "type": "number", "description": "Error message if any for pixel comparison process. Or successful result", "access": "readonly" }, { "name": "variance", "type": "number", "description": "Calculated variance between images as a percent", "access": "readonly" } ], "events": [], "methods": [ { "name": "PixelCompareTestResults", "returns": "PixelCompareTestResults", "description": "Construct a pixelComparator test result object", "parameters": [] } ] }, { "name": "PixelComparison", "page": "PixelComparison.html", "kind": "Object", "description": "Performs pixel comparison between two video frames.", "properties": [], "events": [], "methods": [ { "name": "PixelComparison", "returns": "PixelComparison", "description": "Construct a pixelComparator object", "parameters": [] }, { "name": "pixelCompare", "returns": "any", "static": true, "description": "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.", "parameters": [ { "name": "inImagePath", "type": "string", "description": "" }, { "name": "compareImagePath", "type": "string", "description": "" }, { "name": "epsilon", "type": "number", "description": "" } ] }, { "name": "pixelCompareNonMaskRegion", "returns": "any", "static": true, "description": "Takes in 3 PNGs and performs pixel-based comparison on the non-mask region of the images", "parameters": [ { "name": "inOriginalImagePath", "type": "string", "description": "" }, { "name": "inCompareImagePath", "type": "string", "description": "" }, { "name": "inMaskOnlyPath", "type": "string", "description": "" } ] } ] }, { "name": "PluginSupport", "page": "PluginSupport.html", "kind": "Object", "description": "PluginSupport has various utility helper functions useful for runtime diagnosis of issues reported to the user from the plugin layer.", "properties": [], "events": [], "methods": [ { "name": "eventDateTime", "returns": "string", "static": true, "description": "The date and time when the event occurred", "parameters": [] }, { "name": "eventDescription", "returns": "string", "static": true, "description": "The description of the event - may be empty for some events", "parameters": [] }, { "name": "eventTitle", "returns": "string", "static": true, "description": "The title of the event", "parameters": [] }, { "name": "eventType", "returns": "number", "static": true, "description": "The type of event - 1=Informational 2=Warning 3=Error", "parameters": [] }, { "name": "eventsCount", "returns": "number", "static": true, "description": "Total Events available in Events panel", "parameters": [] } ] }, { "name": "PointF", "page": "PointF.html", "kind": "Object", "description": "Provides scripting env access to dvacore::geom::Point.", "properties": [ { "name": "x", "type": "number", "description": "Get|Set the x value of a point", "access": "read/write" }, { "name": "y", "type": "number", "description": "Get|Set the y value of a point", "access": "read/write" } ], "events": [], "methods": [ { "name": "PointF", "returns": "PointF", "description": "Construct a PointFloat Object.", "parameters": [ { "name": "inX", "type": "number", "description": "" }, { "name": "inY", "type": "number", "description": "" } ] }, { "name": "distanceTo", "returns": "number", "description": "Get the distance from one point to another point", "parameters": [ { "name": "point", "type": "PointF", "description": "" } ] } ] }, { "name": "PresetManagerEvent", "page": "PresetManagerEvent.html", "kind": "Object", "description": "Preset manager event object", "properties": [ { "name": "EVENT_ACTIVE_PRESET_CHANGE_REQUESTED", "type": "string", "description": "The active preset is requested to be changed.", "access": "readonly", "static": true }, { "name": "EVENT_FAVORITE_AND_RECENT_PRESETS_UPDATED", "type": "string", "description": "The favorite and recent preset lists have been updated.", "access": "readonly", "static": true }, { "name": "EVENT_FAVORITE_PRESETS_UPDATED", "type": "string", "description": "The favorite preset list has been updated.", "access": "readonly", "static": true }, { "name": "favoriteList", "type": "any[]", "description": "Returns the updated favorite preset list", "access": "readonly" }, { "name": "presetToBeSetAsActive", "type": "string", "description": "Returns the preset ID of the preset that should be set in transcoder as the currently selected active preset", "access": "readonly" }, { "name": "recentList", "type": "any[]", "description": "Returns the updated recent preset list", "access": "readonly" } ], "events": [], "methods": [ { "name": "addEventListener", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "dispatchEvent", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "removeEventListener", "returns": "any", "static": true, "description": "", "parameters": [] } ] }, { "name": "ProgressCategory", "page": "ProgressCategory.html", "kind": "Object", "description": "ProgressCategory class", "properties": [ { "name": "id", "type": "string", "description": "Get the unique category id of the progress category.", "access": "readonly" } ], "events": [], "methods": [ { "name": "cancelProgress", "returns": "boolean", "description": "Cancel all jobs being reported under this progress category.", "parameters": [] }, { "name": "createProgressItem", "returns": "Object", "description": "Create a new progress item with the given title.", "parameters": [ { "name": "title", "type": "string", "description": "" } ] }, { "name": "createProgressItemWithReferenceId", "returns": "Object", "description": "Create a new progress item with the given title and reference id.", "parameters": [ { "name": "title", "type": "string", "description": "" }, { "name": "referenceId", "type": "Object", "description": "" } ] }, { "name": "getIcon", "returns": "string", "description": "Get the icon of the progress category as base64 encoded svg.", "parameters": [] }, { "name": "getOverallProgressItem", "returns": "Object", "description": "Get a progress item that represents all the progress in this category encapsulated in a single item.", "parameters": [] }, { "name": "getProgressItemFromReferenceID", "returns": "Object", "description": "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.", "parameters": [ { "name": "referenceGuid", "type": "Object", "description": "" } ] }, { "name": "getProgressItems", "returns": "any[]", "description": "Get all the progress items in this progress category.", "parameters": [] }, { "name": "getTitle", "returns": "string", "description": "Get the title of the progress category.", "parameters": [] }, { "name": "getTotalJobs", "returns": "number", "description": "Counts all progress items registered in this category.", "parameters": [] }, { "name": "getValue", "returns": "number", "description": "Get the cumulative progress value of the progress category.", "parameters": [] }, { "name": "hasDoneJobs", "returns": "boolean", "description": "Check if the progress category has any completed progress items.", "parameters": [] }, { "name": "hasPendingJobs", "returns": "boolean", "description": "Check if the progress category has any pending jobs.", "parameters": [] }, { "name": "isIndeterminateProgress", "returns": "boolean", "description": "Check progress category has progress item that has been configured as unknown progress.", "parameters": [] }, { "name": "removeCancelledJobs", "returns": "boolean", "description": "Remove the cancelled and failed progress items from the progress category.", "parameters": [] }, { "name": "removeDoneJobs", "returns": "boolean", "description": "Remove the completed progress items from the progress category.", "parameters": [] }, { "name": "removeProgressItem", "returns": "boolean", "description": "Remove the specified progress item from the progress category.", "parameters": [ { "name": "inProgressItem", "type": "Object", "description": "" } ] }, { "name": "showInHeaderBar", "returns": "boolean", "description": "Indicates that this progress category will be shown in the header bar progress panel", "parameters": [] }, { "name": "showOnlyStatusColumn", "returns": "boolean", "description": "Indicates that this progress category will only show the status column.", "parameters": [] }, { "name": "supportsCancellation", "returns": "boolean", "description": "Check if the progress category can be cancelled.", "parameters": [] } ] }, { "name": "ProgressCategoryContainer", "page": "ProgressCategoryContainer.html", "kind": "Object", "description": "ProgressCategoryContainer class", "properties": [ { "name": "EVENT_PROGRESS_CATEGORY_ADDED", "type": "string", "description": "Event object for when a new progress category is added.", "access": "readonly", "static": true }, { "name": "EVENT_PROGRESS_CATEGORY_REMOVED", "type": "string", "description": "Event object for when a progress category is removed.", "access": "readonly", "static": true }, { "name": "EVENT_PROGRESS_ITEM_ADDED", "type": "string", "description": "Event object for when a new progress item is added.", "access": "readonly", "static": true }, { "name": "EVENT_PROGRESS_ITEM_REMOVED", "type": "string", "description": "Event object for when a progress item is removed from the category.", "access": "readonly", "static": true } ], "events": [], "methods": [ { "name": "addEventListener", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "dispatchEvent", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "getAllProgressCategories", "returns": "any[]", "description": "Get the list of all the Progress categories.", "parameters": [] }, { "name": "getContainer", "returns": "Object", "static": true, "description": "Get the Progress Category Container object.", "parameters": [] }, { "name": "getOrCreateProgressCategory", "returns": "Object", "description": "Gets or create the given progress category", "parameters": [ { "name": "inCategoryID", "type": "string", "description": "" }, { "name": "inTitle", "type": "string", "description": "" } ] }, { "name": "getProgressItemFromReferenceID", "returns": "Object", "description": "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.", "parameters": [ { "name": "referenceGuid", "type": "Object", "description": "" } ] }, { "name": "hasDoneJobs", "returns": "boolean", "description": "Check if it has any completed jobs", "parameters": [] }, { "name": "pauseAllProgressItems", "returns": "boolean", "description": "Pause all progress items.", "parameters": [] }, { "name": "removeDoneJobs", "returns": "boolean", "description": "Remove all the completed jobs", "parameters": [] }, { "name": "removeEventListener", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "removeProgressCategory", "returns": "boolean", "description": "Remove the progress category corresponding to the given ID", "parameters": [ { "name": "inProgressCategory", "type": "Object", "description": "" } ] }, { "name": "resumeAllProgressItems", "returns": "boolean", "description": "Resume all progress items.", "parameters": [] }, { "name": "subscribeToEvent", "returns": "boolean", "description": "Propagates the given event on this object.", "parameters": [ { "name": "eventKey", "type": "string", "description": "" } ] } ] }, { "name": "ProgressItem", "page": "ProgressItem.html", "kind": "Collection", "description": "Collection of Progress Item properties and methods to pause, resume and cancel progress items.", "properties": [ { "name": "EVENT_PROGRESS_ITEM_CANCELLED", "type": "string", "description": "Event object for progress item cancelled.", "access": "readonly", "static": true }, { "name": "EVENT_PROGRESS_ITEM_TITLE_CHANGED", "type": "string", "description": "Event object for progress item title changed.", "access": "readonly", "static": true }, { "name": "EVENT_PROGRESS_ITEM_VALUE_CHANGED", "type": "string", "description": "Event object for progress item value changed.", "access": "readonly", "static": true }, { "name": "PROGRESS_STATE_CANCELLED", "type": "number", "description": "Cancelled progress state.", "access": "readonly", "static": true }, { "name": "PROGRESS_STATE_FAILED", "type": "number", "description": "Failed progress state.", "access": "readonly", "static": true }, { "name": "PROGRESS_STATE_NORMAL", "type": "number", "description": "Normal progress state.", "access": "readonly", "static": true }, { "name": "PROGRESS_STATE_PAUSED", "type": "number", "description": "Paused progress state.", "access": "readonly", "static": true }, { "name": "PROGRESS_STATE_RESUMED", "type": "number", "description": "Resumed progress state.", "access": "readonly", "static": true }, { "name": "PROGRESS_STATE_WAITING", "type": "number", "description": "Waiting progress state.", "access": "readonly", "static": true }, { "name": "creationTime", "type": "any", "description": "", "access": "readonly" }, { "name": "referenceId", "type": "Object", "description": "Get the ID of the Progress Item.", "access": "readonly" } ], "events": [], "methods": [ { "name": "addEventListener", "returns": "any", "description": "", "parameters": [] }, { "name": "cancelProgress", "returns": "boolean", "description": "Cancel the job being reported by this progress item", "parameters": [] }, { "name": "dispatchEvent", "returns": "any", "description": "", "parameters": [] }, { "name": "getMaxValue", "returns": "number", "description": "Get the maximum progress value of the progress item.", "parameters": [] }, { "name": "getProgressState", "returns": "number", "description": "Get the progress state of the progress item.", "parameters": [] }, { "name": "getStatusMessage", "returns": "string", "description": "Get the status message of the progress item.", "parameters": [] }, { "name": "getTitle", "returns": "string", "description": "Get the title of the progress item.", "parameters": [] }, { "name": "getValue", "returns": "number", "description": "Get the progress value of the progress item.", "parameters": [] }, { "name": "isComplete", "returns": "boolean", "description": "Check whether the progress item has finished executing.", "parameters": [] }, { "name": "isInProgress", "returns": "boolean", "description": "Check if the progress item has started execution but not yet complete.", "parameters": [] }, { "name": "isIndeterminateProgress", "returns": "boolean", "description": "Check if the progress item has been configured as unknown progress.", "parameters": [] }, { "name": "isPending", "returns": "boolean", "description": "Check if the progress item is waiting to start or has started but not yet complete.", "parameters": [] }, { "name": "pauseOrResumeProgress", "returns": "boolean", "description": "Pause or resume the progress job based on the state provided.", "parameters": [ { "name": "inProgresState", "type": "number", "description": "" } ] }, { "name": "removeEventListener", "returns": "any", "description": "", "parameters": [] }, { "name": "setCancelToolTip", "returns": "boolean", "description": "Set the tooltip for the cancel button of the progress item.", "parameters": [ { "name": "toolTip", "type": "string", "description": "" } ] }, { "name": "setProgressState", "returns": "boolean", "description": "Set the progress state for the progress item.", "parameters": [ { "name": "state", "type": "number", "description": "" } ] }, { "name": "setProgressStatus", "returns": "boolean", "description": "Set the progress value and maximum value for the progress item.", "parameters": [ { "name": "value", "type": "number", "description": "" }, { "name": "maxValue", "type": "number", "description": "" } ] }, { "name": "setProgressStatusAndToolTip", "returns": "boolean", "description": "Set the progress value maximum value status message and tooltip for the progress item.", "parameters": [ { "name": "value", "type": "number", "description": "" }, { "name": "maxValue", "type": "number", "description": "" }, { "name": "statusMessage", "type": "string", "description": "" }, { "name": "toolTip", "type": "string", "description": "" } ] }, { "name": "setStatusMessage", "returns": "boolean", "description": "Set the status message for the progress item.", "parameters": [ { "name": "statusMessage", "type": "string", "description": "" } ] }, { "name": "setTitle", "returns": "boolean", "description": "Set the title for the progress item.", "parameters": [ { "name": "title", "type": "string", "description": "" } ] }, { "name": "setToolTip", "returns": "boolean", "description": "Set the tooltip for the progress item.", "parameters": [ { "name": "toolTip", "type": "string", "description": "" } ] }, { "name": "setType", "returns": "boolean", "description": "Set the type for the progress item.", "parameters": [ { "name": "type", "type": "Guid", "description": "" } ] }, { "name": "setUnknownProgress", "returns": "boolean", "description": "Set the progress item to unknown progress state.", "parameters": [ { "name": "statusMessage", "type": "string", "description": "" } ] }, { "name": "subscribeToEvent", "returns": "boolean", "description": "Propagates the given event on this object.", "parameters": [ { "name": "eventKey", "type": "string", "description": "" } ] }, { "name": "supportsCancellation", "returns": "boolean", "description": "Check if the progress item can be cancelled.", "parameters": [] }, { "name": "supportsPauseAndResume", "returns": "boolean", "description": "Check if the progress item can be paused|resumed.", "parameters": [] } ] }, { "name": "PropertyReflection", "page": "PropertyReflection.html", "kind": "Object", "description": "The PropertyReflection object provides information about the behavior of an property.", "properties": [ { "name": "async", "type": "boolean", "description": "true if it is an asynchronous property.", "access": "readonly" }, { "name": "dataType", "type": "Object", "description": "Output type.", "access": "readonly" }, { "name": "description", "type": "string", "description": "The property description.", "access": "readonly" }, { "name": "name", "type": "string", "description": "The property name.", "access": "readonly" }, { "name": "parameters", "type": "any[]", "description": "Parameters of method or constructor undefined for other property types", "access": "readonly" }, { "name": "type", "type": "any", "description": "", "access": "readonly" } ], "events": [], "methods": [] }, { "name": "RectF", "page": "RectF.html", "kind": "Object", "description": "RectFloatObject class provides scripting access to dvacore Rect.", "properties": [ { "name": "bottom", "type": "number", "description": "Get|Set the bottom point of a rect", "access": "read/write" }, { "name": "height", "type": "number", "description": "Get|Set the height of a rect", "access": "read/write" }, { "name": "left", "type": "number", "description": "Get|Set the left point of a rect", "access": "read/write" }, { "name": "right", "type": "number", "description": "Get|Set the right point of a rect", "access": "read/write" }, { "name": "size", "type": "any", "description": "Get|Set the size (width|height as a point) for a rect", "access": "read/write" }, { "name": "top", "type": "number", "description": "Get|Set the top point of a rect", "access": "read/write" }, { "name": "width", "type": "number", "description": "Get|Set the width of a rect", "access": "read/write" } ], "events": [], "methods": [ { "name": "RectF", "returns": "RectF", "description": "Construct a RectFloat Object.", "parameters": [ { "name": "inLeft", "type": "number", "description": "" }, { "name": "inTop", "type": "number", "description": "" }, { "name": "inWidth", "type": "number", "description": "" }, { "name": "inHeight", "type": "number", "description": "" } ] }, { "name": "center", "returns": "any", "description": "Get the center point of a rect", "parameters": [] }, { "name": "distanceTo", "returns": "any", "description": "Get distance from rect to another point", "parameters": [ { "name": "inPoint", "type": "Object", "description": "" } ] } ] }, { "name": "SequentialClustering", "page": "SequentialClustering.html", "kind": "Object", "description": "Static clustering object for Sequential Clustering algorithm", "properties": [ { "name": "CLUSTER_COMPARE_MODE_ALL_IN_CLUSTER", "type": "number", "description": "Compare all vectors in a cluster to the next cluster candidate", "access": "readonly", "static": true }, { "name": "CLUSTER_COMPARE_MODE_CENTROID", "type": "number", "description": "Compare the centroid of a cluster to the next cluster candidate", "access": "readonly", "static": true }, { "name": "CLUSTER_COMPARE_MODE_LAST_VECTOR", "type": "number", "description": "Compare the last vector of a cluster to the next cluster candidate", "access": "readonly", "static": true } ], "events": [], "methods": [ { "name": "cluster", "returns": "Clusters", "static": true, "description": "Performs sequential clustering on data points. The preferences parameter contains: threshold (float) compareMode (int32)", "parameters": [ { "name": "dataPointMatrix", "type": "Object", "description": "" }, { "name": "preferences", "type": "Object", "description": "" } ] } ] }, { "name": "SimplifySequenceParams", "page": "SimplifySequenceParams.html", "kind": "Object", "description": "SimplifySequenceParams is the collection of settings used to script SimplifySequence as a user would in the ui.", "properties": [ { "name": "LABEL_COLOR_0", "type": "number", "description": "Constant for label color 0", "access": "readonly", "static": true }, { "name": "LABEL_COLOR_1", "type": "number", "description": "Constant for label color 1", "access": "readonly", "static": true }, { "name": "LABEL_COLOR_10", "type": "number", "description": "Constant for label color 10", "access": "readonly", "static": true }, { "name": "LABEL_COLOR_11", "type": "number", "description": "Constant for label color 11", "access": "readonly", "static": true }, { "name": "LABEL_COLOR_12", "type": "number", "description": "Constant for label color 12", "access": "readonly", "static": true }, { "name": "LABEL_COLOR_13", "type": "number", "description": "Constant for label color 13", "access": "readonly", "static": true }, { "name": "LABEL_COLOR_14", "type": "number", "description": "Constant for label color 14", "access": "readonly", "static": true }, { "name": "LABEL_COLOR_15", "type": "number", "description": "Constant for label color 15", "access": "readonly", "static": true }, { "name": "LABEL_COLOR_2", "type": "number", "description": "Constant for label color 2", "access": "readonly", "static": true }, { "name": "LABEL_COLOR_3", "type": "number", "description": "Constant for label color 3", "access": "readonly", "static": true }, { "name": "LABEL_COLOR_4", "type": "number", "description": "Constant for label color 4", "access": "readonly", "static": true }, { "name": "LABEL_COLOR_5", "type": "number", "description": "Constant for label color 5", "access": "readonly", "static": true }, { "name": "LABEL_COLOR_6", "type": "number", "description": "Constant for label color 6", "access": "readonly", "static": true }, { "name": "LABEL_COLOR_7", "type": "number", "description": "Constant for label color 7", "access": "readonly", "static": true }, { "name": "LABEL_COLOR_8", "type": "number", "description": "Constant for label color 8", "access": "readonly", "static": true }, { "name": "LABEL_COLOR_9", "type": "number", "description": "Constant for label color 9", "access": "readonly", "static": true }, { "name": "MARKER_COLOR_BLUE", "type": "number", "description": "Constant for marker color blue", "access": "readonly", "static": true }, { "name": "MARKER_COLOR_CYAN", "type": "number", "description": "Constant for marker color cyan", "access": "readonly", "static": true }, { "name": "MARKER_COLOR_GREEN", "type": "number", "description": "Constant for marker color green", "access": "readonly", "static": true }, { "name": "MARKER_COLOR_MAGENTA", "type": "number", "description": "Constant for marker color magenta", "access": "readonly", "static": true }, { "name": "MARKER_COLOR_ORANGE", "type": "number", "description": "Constant for marker color orange", "access": "readonly", "static": true }, { "name": "MARKER_COLOR_RED", "type": "number", "description": "Constant for marker color red", "access": "readonly", "static": true }, { "name": "MARKER_COLOR_WHITE", "type": "number", "description": "Constant for marker color white", "access": "readonly", "static": true }, { "name": "MARKER_COLOR_YELLOW", "type": "number", "description": "Constant for marker color yellow", "access": "readonly", "static": true }, { "name": "applyToAudio", "type": "boolean", "description": "Set to apply options to Audio items", "access": "read/write" }, { "name": "applyToVideo", "type": "boolean", "description": "Set to apply options to video items", "access": "read/write" }, { "name": "closeVerticalGaps", "type": "boolean", "description": "Set to close vertical gaps on video tracks", "access": "read/write" }, { "name": "flattenMulticam", "type": "boolean", "description": "Set to flatten multicam clips", "access": "read/write" }, { "name": "parameters", "type": "Object", "description": "SimplifySequence parameters", "access": "readonly", "static": true }, { "name": "removeClipsWithLabelColors", "type": "any", "description": "Set to remove clips with label color(s) - set to an array of LABEL_COLOR_ constants", "access": "read/write" }, { "name": "removeDiabledClips", "type": "boolean", "description": "Set to remove disabled clips", "access": "read/write" }, { "name": "removeDiabledTracks", "type": "boolean", "description": "Set to remove disabled tracks", "access": "read/write" }, { "name": "removeEmptyTracks", "type": "boolean", "description": "Set to remove empty tracks", "access": "read/write" }, { "name": "removeGraphicClips", "type": "boolean", "description": "Set to remove graphics clips", "access": "read/write" }, { "name": "removeOfflineClips", "type": "boolean", "description": "Set to remove offline clips", "access": "read/write" }, { "name": "removeSequenceMarkerColors", "type": "any", "description": "Set to remove sequence markers with color(s) - set to an array of MARKER_COLOR_ constants", "access": "read/write" }, { "name": "removeThroughEdits", "type": "boolean", "description": "Set to join through edits", "access": "read/write" }, { "name": "removeTransitions", "type": "boolean", "description": "Set to remove transitions", "access": "read/write" } ], "events": [], "methods": [ { "name": "SimplifySequenceParams", "returns": "SimplifySequenceParams", "description": "Create a new SimplifySequenceParameterObject instance.", "parameters": [] }, { "name": "simplifySequenceOnActiveSequence", "returns": "boolean", "description": "Apply Simplify Sequence to a copied sequence from the currently active sequence", "parameters": [ { "name": "newSimplifiedSequenceName", "type": "string", "description": "" } ] } ] }, { "name": "SourceMediaInfo", "page": "SourceMediaInfo.html", "kind": "Object", "description": "Get the width, height, PAR, duration, etc about the imported source", "properties": [ { "name": "audioDuration", "type": "string", "description": "Returns the audio duration of the source", "access": "readonly" }, { "name": "description", "type": "string", "description": "Returns embedded description of the source", "access": "readonly" }, { "name": "dropFrameTimeCode", "type": "boolean", "description": "Returns true if the timecode is a drop frame timecode", "access": "readonly" }, { "name": "duration", "type": "string", "description": "Returns duration of the source", "access": "readonly" }, { "name": "durationInTicks", "type": "string", "description": "Returns duration of the source in ticks (available since 23.3)", "access": "readonly" }, { "name": "fieldType", "type": "string", "description": "Returns field type of the source", "access": "readonly" }, { "name": "frameRate", "type": "string", "description": "Returns frame rate of the source", "access": "readonly" }, { "name": "height", "type": "string", "description": "Returns height of the source", "access": "readonly" }, { "name": "importer", "type": "string", "description": "Returns the importer used to decode the source", "access": "readonly" }, { "name": "numChannels", "type": "string", "description": "Returns the number of audio channels of the source", "access": "readonly" }, { "name": "parX", "type": "string", "description": "Returns the X PAR of the source", "access": "readonly" }, { "name": "parY", "type": "string", "description": "Returns the Y PAR of the source", "access": "readonly" }, { "name": "sampleRate", "type": "string", "description": "Returns sample rate of the source", "access": "readonly" }, { "name": "width", "type": "string", "description": "Returns width of the source", "access": "readonly" }, { "name": "xmp", "type": "string", "description": "Returns xmp xml of the source", "access": "readonly" } ], "events": [], "methods": [] }, { "name": "SparseMatrix", "page": "SparseMatrix.html", "kind": "Object", "description": "Algebra BLAS data class", "properties": [ { "name": "cols", "type": "number", "description": "Get number of columns in this data object.", "access": "readonly" }, { "name": "rows", "type": "number", "description": "Get number of rows in this data object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "SparseMatrix", "returns": "SparseMatrix", "description": "Constructs a new BLAS Matrix object.", "parameters": [ { "name": "rows", "type": "number", "description": "" }, { "name": "cols", "type": "number", "description": "" }, { "name": "data", "type": "any", "description": "" } ] }, { "name": "abs", "returns": "Object", "description": "Element-wise absolute value; returns a new vector or matrix.", "parameters": [] }, { "name": "add", "returns": "Object", "description": "Element-wise add another vector or matrix of the same shape; returns a new vector or matrix.", "parameters": [ { "name": "other", "type": "Object", "description": "" } ] }, { "name": "at", "returns": "number", "description": "Get the value at the given row and column index.", "parameters": [ { "name": "rowIdx", "type": "number", "description": "" }, { "name": "colIdx", "type": "number", "description": "" } ] }, { "name": "fromVectors", "returns": "Object", "static": true, "description": "Create a [vectors[0].length x vectors.length] matrix that contains the given vectors as columns. The vectors must all have the same length.", "parameters": [ { "name": "vectors", "type": "any[]", "description": "" } ] }, { "name": "multiply", "returns": "Object", "description": "Element-wise multiply by another vector or matrix of the same shape; returns a new vector or matrix.", "parameters": [ { "name": "other", "type": "Object", "description": "" } ] }, { "name": "norm", "returns": "number", "description": "Compute the norm of this vector or matrix.", "parameters": [] }, { "name": "scale", "returns": "Object", "description": "Multiply each element by the given scalar; returns a new vector or matrix.", "parameters": [ { "name": "factor", "type": "number", "description": "" } ] }, { "name": "squaredNorm", "returns": "number", "description": "Compute the squared L2 norm of this vector or matrix.", "parameters": [] }, { "name": "subtract", "returns": "Object", "description": "Element-wise subtract another vector or matrix of the same shape; returns a new vector or matrix.", "parameters": [ { "name": "other", "type": "Object", "description": "" } ] }, { "name": "sum", "returns": "number", "description": "Compute the sum of all elements in this vector or matrix.", "parameters": [] } ] }, { "name": "SparseVector", "page": "SparseVector.html", "kind": "Object", "description": "Algebra BLAS data class", "properties": [ { "name": "cols", "type": "number", "description": "Get number of columns in this data object.", "access": "readonly" }, { "name": "length", "type": "number", "description": "Get the length of the vector.", "access": "readonly" }, { "name": "rows", "type": "number", "description": "Get number of rows in this data object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "SparseVector", "returns": "SparseVector", "description": "Constructs a new BLAS Vector object.", "parameters": [ { "name": "rows", "type": "number", "description": "" }, { "name": "data", "type": "any", "description": "" } ] }, { "name": "abs", "returns": "Object", "description": "Element-wise absolute value; returns a new vector or matrix.", "parameters": [] }, { "name": "add", "returns": "Object", "description": "Element-wise add another vector or matrix of the same shape; returns a new vector or matrix.", "parameters": [ { "name": "other", "type": "Object", "description": "" } ] }, { "name": "at", "returns": "number", "description": "Get the value at the given row index.", "parameters": [ { "name": "rowIdx", "type": "number", "description": "" } ] }, { "name": "dot", "returns": "number", "description": "Compute the dot product of this vector with another.", "parameters": [ { "name": "other", "type": "Object", "description": "" } ] }, { "name": "multiply", "returns": "Object", "description": "Element-wise multiply by another vector or matrix of the same shape; returns a new vector or matrix.", "parameters": [ { "name": "other", "type": "Object", "description": "" } ] }, { "name": "norm", "returns": "number", "description": "Compute the norm of this vector or matrix.", "parameters": [] }, { "name": "scale", "returns": "Object", "description": "Multiply each element by the given scalar; returns a new vector or matrix.", "parameters": [ { "name": "factor", "type": "number", "description": "" } ] }, { "name": "squaredNorm", "returns": "number", "description": "Compute the squared L2 norm of this vector or matrix.", "parameters": [] }, { "name": "subtract", "returns": "Object", "description": "Element-wise subtract another vector or matrix of the same shape; returns a new vector or matrix.", "parameters": [ { "name": "other", "type": "Object", "description": "" } ] }, { "name": "sum", "returns": "number", "description": "Compute the sum of all elements in this vector or matrix.", "parameters": [] } ] }, { "name": "SpeakerSeparation", "page": "SpeakerSeparation.html", "kind": "Object", "description": "Utility to invoke Speaker Separation", "properties": [], "events": [], "methods": [ { "name": "SpeakerSeparation", "returns": "SpeakerSeparation", "description": "Creates a SpeakerSeparation object", "parameters": [] }, { "name": "getBillableDurationSeconds", "returns": "number", "static": true, "description": "Returns the billable duration in seconds Separate() would submit for the track item. Does not submit a job.", "parameters": [ { "name": "inTrackItem", "type": "TrackItem", "description": "" } ] }, { "name": "getCostEstimate", "returns": "number", "static": true, "description": "Returns a promise that resolves to the estimated credit cost for the given audio duration (seconds). Does not submit a job.", "parameters": [ { "name": "inAudioDurationSeconds", "type": "number", "description": "" } ] }, { "name": "isEnabled", "returns": "boolean", "static": true, "description": "Returns whether Separate Crosstalk would be enabled for the given track-item selection. Does not submit a job.", "parameters": [ { "name": "inSelection", "type": "Object", "description": "" } ] }, { "name": "mapToastCode", "returns": "number", "static": true, "description": "Maps a service|backend dvacore::Result (int) to the user-facing toast result code (int). Does not submit a job.", "parameters": [ { "name": "inResult", "type": "number", "description": "" } ] }, { "name": "separate", "returns": "boolean", "static": true, "description": "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.", "parameters": [ { "name": "inTrackItems", "type": "any[]", "description": "" }, { "name": "inSequence", "type": "Object", "description": "" } ] }, { "name": "separateSpeakers", "returns": "boolean", "static": true, "description": "Runs the Speaker Separation command on the current timeline audio selection.", "parameters": [] }, { "name": "validate", "returns": "number", "static": true, "description": "Validates a track item's duration for Speaker Separation; returns the dvacore::Result as an int (0 == success). Does not submit a job.", "parameters": [ { "name": "inTrackItem", "type": "TrackItem", "description": "" } ] } ] }, { "name": "Spellcheck", "page": "Spellcheck.html", "kind": "Object", "description": "Interface to OS spellcheck operations", "properties": [], "events": [], "methods": [ { "name": "addWord", "returns": "boolean", "static": true, "description": "Add word to the specified language set", "parameters": [ { "name": "text", "type": "string", "description": "" }, { "name": "language", "type": "string", "description": "" } ] }, { "name": "checkSpelling", "returns": "Object", "static": true, "description": "Check spelling for a word. Returns a promise to the results.", "parameters": [ { "name": "text", "type": "string", "description": "" }, { "name": "language", "type": "string", "description": "" } ] }, { "name": "getCandidates", "returns": "any", "static": true, "description": "Return a list of candidate words to replace a given substring", "parameters": [ { "name": "text", "type": "string", "description": "" }, { "name": "startEnd", "type": "Object", "description": "" }, { "name": "language", "type": "string", "description": "" } ] }, { "name": "spellcheckSupported", "returns": "boolean", "static": true, "description": "Returns true if spell checking is supported on this OS and configuration.", "parameters": [] } ] }, { "name": "StockWrangler", "page": "StockWrangler.html", "kind": "Object", "description": "The stock wrangler object for testing stock audio.", "properties": [ { "name": "numResults", "type": "number", "description": "number of results from last time initiateSearch was called", "access": "readonly" }, { "name": "wrangler", "type": "Object", "description": "Current Stock Wrangler.", "access": "readonly", "static": true } ], "events": [], "methods": [ { "name": "initiateSFXSearch", "returns": "boolean", "description": "start an SFX search using the parameters in the Parameter object", "parameters": [ { "name": "params", "type": "StockWranglerParameter", "description": "" } ] }, { "name": "initiateSearch", "returns": "boolean", "description": "start a music search using the parameters in the Parameter object", "parameters": [ { "name": "params", "type": "StockWranglerParameter", "description": "" } ] } ] }, { "name": "StockWranglerParameter", "page": "StockWranglerParameter.html", "kind": "Object", "description": "Script object for stock wrangler search parameters.", "properties": [ { "name": "bpmMax", "type": "number", "description": "Set the max bpm .Next search will only have results below this tempo.", "access": "read/write" }, { "name": "bpmMin", "type": "number", "description": "Set the min bpm. Next search will only have results above this tempo", "access": "read/write" }, { "name": "categories", "type": "any", "description": "Set the categories.Next search will only have results that fall within the supplied categories", "access": "read/write" }, { "name": "durationMax", "type": "number", "description": "Set the max duration.Next search will only have results below this duration.", "access": "read/write" }, { "name": "durationMin", "type": "number", "description": "Set the min duration.Next search will only have results above this duration", "access": "read/write" }, { "name": "genres", "type": "any", "description": "Set the genres.Next search will only have results that fall within the supplied genres", "access": "read/write" }, { "name": "includeAssetsWithoutBPM", "type": "boolean", "description": "Set boolean to search for assets regardless of BPM.Next search will have results containing assets without BPM if true.", "access": "read/write" }, { "name": "moods", "type": "any", "description": "Set the moods.Next search will only have results that fall within the supplied moods", "access": "read/write" }, { "name": "params", "type": "Object", "description": "Stock Wrangler search parameters", "access": "readonly", "static": true } ], "events": [], "methods": [] }, { "name": "SystemCompatibilityReport", "page": "SystemCompatibilityReport.html", "kind": "Object", "description": "Provide system compatibility report generation", "properties": [], "events": [], "methods": [ { "name": "CreateReport", "returns": "boolean", "static": true, "description": "", "parameters": [ { "name": "filePath", "type": "string", "description": "" } ] } ] }, { "name": "SystemInfo", "page": "SystemInfo.html", "kind": "Object", "description": "The SystemInfo object provides information about the system.", "properties": [ { "name": "availablePhysicalMemory", "type": "number", "description": "Available physical memory (MB).", "access": "readonly", "static": true }, { "name": "deviceDescription", "type": "string", "description": "Decription of hardware device", "access": "readonly", "static": true }, { "name": "os", "type": "OSInfo", "description": "Operating system related information.", "access": "readonly", "static": true }, { "name": "totalPhysicalMemory", "type": "number", "description": "Total physical memory (MB).", "access": "readonly", "static": true }, { "name": "videoDevices", "type": "any", "description": "List of video devices.", "access": "readonly", "static": true } ], "events": [], "methods": [] }, { "name": "TabPanel", "page": "TabPanel.html", "kind": "Object", "description": "A workspace tab panel.", "properties": [], "events": [], "methods": [ { "name": "getAsUINode", "returns": "UINode", "description": "Return this tab panel as a UINode object.", "parameters": [] }, { "name": "getBounds", "returns": "RectF", "description": "Get the global bounds of the panel", "parameters": [] }, { "name": "getChildNodeByNodeID", "returns": "UINode", "description": "Get the first child UI node matching the given node ID.", "parameters": [ { "name": "nodeID", "type": "string", "description": "" } ] }, { "name": "getContentBounds", "returns": "RectF", "description": "Get the global bounds of the panel content area", "parameters": [] }, { "name": "getTopLevelWindow", "returns": "TopLevelWindow", "description": "Get the top-level window that contains this panel.", "parameters": [] } ] }, { "name": "TickTime", "page": "TickTime.html", "kind": "Object", "description": "TickTime class", "properties": [ { "name": "TIME_INVALID", "type": "TickTime", "description": "Invalid Tick Time Constant", "access": "readonly", "static": true }, { "name": "TIME_MAX", "type": "TickTime", "description": "Max Tick Time Constant", "access": "readonly", "static": true }, { "name": "TIME_MIN", "type": "TickTime", "description": "Min Tick Time Constant", "access": "readonly", "static": true }, { "name": "TIME_ONE_HOUR", "type": "TickTime", "description": "One Hour Tick Time Constant", "access": "readonly", "static": true }, { "name": "TIME_ONE_MINUTE", "type": "TickTime", "description": "One Second Tick Time Constant", "access": "readonly", "static": true }, { "name": "TIME_ONE_SECOND", "type": "TickTime", "description": "One Second Tick Time Constant", "access": "readonly", "static": true }, { "name": "TIME_ZERO", "type": "TickTime", "description": "Zero Tick Time Constant", "access": "readonly", "static": true }, { "name": "seconds", "type": "number", "description": "Get the TickTime in seconds", "access": "readonly" }, { "name": "ticks", "type": "string", "description": "Get the TickTime in ticks as a string", "access": "readonly" }, { "name": "ticksNumber", "type": "number", "description": "Get the TickTime in ticks as a number", "access": "readonly" } ], "events": [], "methods": [ { "name": "TickTime", "returns": "TickTime", "description": "Constructs a TickTime object", "parameters": [] }, { "name": "add", "returns": "TickTime", "description": "Add another TickTime to this one and return it. This TickTime is not modified.", "parameters": [ { "name": "tickTime", "type": "TickTime", "description": "" } ] }, { "name": "alignToFrame", "returns": "TickTime", "description": "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.", "parameters": [ { "name": "frameRate", "type": "FrameRate", "description": "" } ] }, { "name": "alignToNearestFrame", "returns": "TickTime", "description": "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.", "parameters": [ { "name": "frameRate", "type": "FrameRate", "description": "" } ] }, { "name": "createWithFrameAndFrameRate", "returns": "TickTime", "static": true, "description": "Constructs a TickTime object with a frame and a frame rate.", "parameters": [ { "name": "frameCount", "type": "number", "description": "" }, { "name": "frameRate", "type": "FrameRate", "description": "" } ] }, { "name": "createWithSeconds", "returns": "TickTime", "static": true, "description": "Constructs a TickTime object with seconds.", "parameters": [ { "name": "seconds", "type": "number", "description": "" } ] }, { "name": "createWithTicks", "returns": "TickTime", "static": true, "description": "Constructs a TickTime object with ticks as a string.", "parameters": [ { "name": "ticks", "type": "string", "description": "" } ] }, { "name": "createWithTicksNumber", "returns": "TickTime", "static": true, "description": "Constructs a TickTime object with ticks as a number.", "parameters": [ { "name": "ticksNumber", "type": "number", "description": "" } ] }, { "name": "divide", "returns": "TickTime", "description": "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.", "parameters": [ { "name": "divisor", "type": "number", "description": "" } ] }, { "name": "equals", "returns": "boolean", "description": "Returns true if the given TickTime is equal to the TickTime object", "parameters": [ { "name": "tickTime", "type": "TickTime", "description": "" } ] }, { "name": "multiply", "returns": "TickTime", "description": "Multiply this TickTime with a factor and return it. This TickTime is not modified.", "parameters": [ { "name": "factor", "type": "number", "description": "" } ] }, { "name": "subtract", "returns": "TickTime", "description": "Subtract another TickTime from this one and return it. This TickTime is not modified.", "parameters": [ { "name": "tickTime", "type": "TickTime", "description": "" } ] }, { "name": "timeToTimecode", "returns": "string", "static": true, "description": "Convert a TickTime to a string using the current display format", "parameters": [ { "name": "tickTime", "type": "TickTime", "description": "" }, { "name": "frameRate", "type": "FrameRate", "description": "" }, { "name": "timeDisplay", "type": "TimeDisplay", "description": "" } ] }, { "name": "timecodeToTime", "returns": "TickTime", "static": true, "description": "Convert a timecode string to a TickTime using the current display format", "parameters": [ { "name": "timecode", "type": "string", "description": "" }, { "name": "frameRate", "type": "FrameRate", "description": "" }, { "name": "timeDisplay", "type": "TimeDisplay", "description": "" } ] }, { "name": "toFrame", "returns": "number", "description": "Convert the TickTime to a frame number with respect to the provided frame rate.", "parameters": [ { "name": "frameRate", "type": "FrameRate", "description": "" } ] } ] }, { "name": "TimeDisplay", "page": "TimeDisplay.html", "kind": "Object", "description": "TimeDisplay class", "properties": [ { "name": "customFPS", "type": "number", "description": "Read|Write property to get|set the time display custom frames per second value", "access": "read/write" }, { "name": "type", "type": "number", "description": "Read|Write property to get|set the time display type numeric code", "access": "read/write" } ], "events": [], "methods": [ { "name": "TimeDisplay", "returns": "TimeDisplay", "description": "Constructs a TimeDisplay object", "parameters": [] }, { "name": "equals", "returns": "boolean", "description": "Returns true if the given TimeDisplay is equal to this TimeDisplay object", "parameters": [ { "name": "timeDisplay", "type": "TimeDisplay", "description": "" } ] } ] }, { "name": "TimeRange", "page": "TimeRange.html", "kind": "Object", "description": "TimeRange class", "properties": [], "events": [], "methods": [ { "name": "TimeRange", "returns": "TimeRange", "description": "Constructs a TimeRange object", "parameters": [] }, { "name": "alignToFrame", "returns": "TimeRange", "description": "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.", "parameters": [ { "name": "frameRate", "type": "FrameRate", "description": "" } ] }, { "name": "contains", "returns": "boolean", "description": "Returns true if the given point in time is within the TimeRange.", "parameters": [ { "name": "time", "type": "TickTime", "description": "" } ] }, { "name": "createWithStartAndEnd", "returns": "TimeRange", "static": true, "description": "Constructs a TimeRange object from start and end TickTime objects.", "parameters": [ { "name": "startTime", "type": "TickTime", "description": "" }, { "name": "endTime", "type": "TickTime", "description": "" } ] }, { "name": "equals", "returns": "boolean", "description": "Returns true if the given TimeRange is equal to this TimeRange.", "parameters": [ { "name": "other", "type": "TimeRange", "description": "" } ] }, { "name": "extend", "returns": "TimeRange", "description": "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.", "parameters": [ { "name": "time", "type": "TickTime", "description": "" } ] }, { "name": "getDuration", "returns": "Object", "description": "Returns the duration of the TimeRange object", "parameters": [] }, { "name": "getEndTime", "returns": "Object", "description": "Returns the end time of the TimeRange object", "parameters": [] }, { "name": "getStartTime", "returns": "Object", "description": "Returns the start time of the TimeRange object", "parameters": [] }, { "name": "intersection", "returns": "TimeRange", "description": "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.", "parameters": [ { "name": "other", "type": "TimeRange", "description": "" } ] } ] }, { "name": "Timecode", "page": "Timecode.html", "kind": "Object", "description": "Mezzanine Timecode Object", "properties": [ { "name": "preferDropFrame", "type": "boolean", "description": "Read|Write property to get|set prefer drop frame of timecode object", "access": "read/write" }, { "name": "startTime", "type": "Object", "description": "Read|Write property to get|set start time of timecode object", "access": "read/write" } ], "events": [], "methods": [ { "name": "Timecode", "returns": "Timecode", "description": "Construct a Timecode Object with parameters for StartTime and PreferDropFrame", "parameters": [ { "name": "StartTime", "type": "Object", "description": "" }, { "name": "PreferDropFrame", "type": "boolean", "description": "" } ] }, { "name": "equals", "returns": "boolean", "description": "Returns true if the given TimecodeObject is equal to this TimecodeObject", "parameters": [ { "name": "TimecodeObject", "type": "TimecodeObject", "description": "" } ] } ] }, { "name": "TrackIndex", "page": "TrackIndex.html", "kind": "Object", "description": "Constants for dvamediatypes::TrackIndex", "properties": [ { "name": "ALWAYS_ON_TOP", "type": "number", "description": "Constant meaning the topmost video track.", "access": "readonly", "static": true }, { "name": "INVALID", "type": "number", "description": "Constant meaning unset track index.", "access": "readonly", "static": true } ], "events": [], "methods": [] }, { "name": "Transcoder", "page": "Transcoder.html", "kind": "Object", "description": "The Transcoder object provides the main access for full export settings information and control.", "properties": [ { "name": "colorManagementInfo", "type": "string", "description": "Returns color management info.", "access": "readonly" }, { "name": "currentDestination", "type": "string", "description": "Returns the JSON for the current selected destination.", "access": "readonly" }, { "name": "currentDestinationIsLoggedIn", "type": "boolean", "description": "Returns the logged-in state of the current selected destination. Returns 'false' if we can't determine logged-in state (MediaFile CreativeCloud FTP).", "access": "readonly" }, { "name": "currentPresetSettingsGroups", "type": "string", "description": "Returns the list and names of the current Preset Setting Groups.", "access": "readonly" }, { "name": "currentSourceMasterClips", "type": "any[]", "description": "Get the currently selected source masterclip(s).", "access": "readonly" }, { "name": "currentSourceSequence", "type": "Sequence", "description": "Get the currently selected source sequence.", "access": "readonly" }, { "name": "destinations", "type": "string", "description": "Returns a JSON list of all destinations for an export.", "access": "readonly" }, { "name": "estimatedFileSize", "type": "string", "description": "Returns the calculated file size information for the current source with the selected Preset.", "access": "readonly" }, { "name": "exportDestinationsDirect", "type": "boolean", "description": "Start a direct modal Export with all for export marked destinations of the current Transcoder settings.", "access": "readonly" }, { "name": "exportDirect", "type": "boolean", "description": "Start a direct modal Export with the current Transcoder settings.", "access": "readonly" }, { "name": "getJSONConvertOptionIncludeHiddenParams", "type": "boolean", "description": "Returns the current JSON convert option for hide hidden params.", "access": "readonly" }, { "name": "getJSONConvertOptionIncludeUnsetValues", "type": "boolean", "description": "Returns the current JSON convert option for hide unset values.", "access": "readonly" }, { "name": "importIntoProject", "type": "boolean", "description": "Returns the import into Project preference value.", "access": "readonly" }, { "name": "isMatchSequenceSettingsAllowed", "type": "boolean", "description": "Check if match Sequence settings are allowed.", "access": "readonly" }, { "name": "isOutputFilePathLocked", "type": "boolean", "description": "Returns the locked status of the output file.", "access": "readonly" }, { "name": "matchSequenceSettings", "type": "boolean", "description": "Returns the match Sequence settings value.", "access": "readonly" }, { "name": "matchSourceAudioChannelMismatch", "type": "string", "description": "Returns JSON describing whether the selected format cannot match the source audio channelization plus source|output channel counts.", "access": "readonly" }, { "name": "originPresetHasEnabledPublishGroups", "type": "boolean", "description": "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.", "access": "readonly" }, { "name": "outputFilePath", "type": "string", "description": "Returns the path to the output file.", "access": "readonly" }, { "name": "presetActionsGroupSettings", "type": "string", "description": "Returns the current selected Preset Actions Settings.", "access": "readonly" }, { "name": "presetAudioGroupSettings", "type": "string", "description": "Returns the current selected Preset Audio Settings.", "access": "readonly" }, { "name": "presetCaptionGroupSettings", "type": "string", "description": "Returns the current selected Preset Caption Settings.", "access": "readonly" }, { "name": "presetEffectsGroupSettings", "type": "string", "description": "Returns the current selected Preset Effects Settings.", "access": "readonly" }, { "name": "presetIngestGroupSettings", "type": "string", "description": "Returns the current selected Preset Ingest Settings.", "access": "readonly" }, { "name": "presetMetadataGroupSettings", "type": "string", "description": "Returns the current selected Preset Metadata Settings.", "access": "readonly" }, { "name": "presetPublishGroupSettings", "type": "string", "description": "Returns the current selected Preset Publish Settings.", "access": "readonly" }, { "name": "presetVideoGroupSettings", "type": "string", "description": "Returns the current selected Preset Video Settings.", "access": "readonly" }, { "name": "rangeOption", "type": "any", "description": "", "access": "readonly" }, { "name": "scalingOption", "type": "any", "description": "", "access": "readonly" }, { "name": "sourceSelection", "type": "string", "description": "Returns a JSON list of the currently selected source object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "changeFormat", "returns": "boolean", "description": "Change the export format selected preset will be reset to the default preset for a given format.", "parameters": [ { "name": "newFormat", "type": "string", "description": "" } ] }, { "name": "changeMatchSource", "returns": "boolean", "description": "Change match source state for the given Parameter.", "parameters": [ { "name": "id", "type": "string", "description": "" }, { "name": "value", "type": "boolean", "description": "" } ] }, { "name": "changeParameter", "returns": "boolean", "description": "Change an existing Parameter.", "parameters": [ { "name": "group", "type": "string", "description": "" }, { "name": "id", "type": "string", "description": "" }, { "name": "value", "type": "string", "description": "" } ] }, { "name": "currentPresetInfo", "returns": "string", "description": "Returns the information about the current selected Preset.", "parameters": [ { "name": "includeSettings", "type": "boolean", "description": "" } ] }, { "name": "currentPresetSettingsForGroup", "returns": "string", "description": "Returns the current selected Preset settings from a special group.", "parameters": [ { "name": "groupKey", "type": "string", "description": "" } ] }, { "name": "exportCurrentPresetTo", "returns": "boolean", "description": "Export the current Preset.", "parameters": [ { "name": "filePath", "type": "string", "description": "" }, { "name": "presetComments", "type": "string", "description": "" } ] }, { "name": "getAspectRatioLock", "returns": "boolean", "description": "Get the aspect ratio lock state.", "parameters": [] }, { "name": "getContentCredentialsApplyDisplayString", "returns": "string", "description": "Returns the localized display string for Output Summary when content credentials are applied.", "parameters": [] }, { "name": "hasContentCredentials", "returns": "boolean", "description": "Returns true if the current selection (sequence or project items) contains content credentials.", "parameters": [] }, { "name": "isExportCRActivated", "returns": "boolean", "description": "Returns true if the export of content credentials (cr) is activated", "parameters": [] }, { "name": "isFormatSupportedByCR", "returns": "boolean", "description": "Returns true if the export format is supported by content credentials (cr)", "parameters": [] }, { "name": "saveAsDialog", "returns": "string", "description": "Returns the full path to a selected file", "parameters": [ { "name": "defaultDir", "type": "string", "description": "" }, { "name": "defaultFileName", "type": "string", "description": "" }, { "name": "extension", "type": "string", "description": "" } ] }, { "name": "saveAsDialogWithFullPath", "returns": "string", "description": "Returns the full path to a selected file", "parameters": [ { "name": "fullPathWithExtension", "type": "string", "description": "" } ] }, { "name": "saveCustomPreset", "returns": "boolean", "description": "Save a custom preset.", "parameters": [ { "name": "presetName", "type": "string", "description": "" }, { "name": "saveEffectSettings", "type": "boolean", "description": "" }, { "name": "savePublishSettings", "type": "boolean", "description": "" } ] }, { "name": "selectDestination", "returns": "boolean", "description": "Select a new destination.", "parameters": [ { "name": "destID", "type": "string", "description": "" }, { "name": "groupIndex", "type": "number", "description": "" } ] }, { "name": "setAspectRatioLock", "returns": "boolean", "description": "Set the aspect ratio lock state.", "parameters": [ { "name": "value", "type": "boolean", "description": "" } ] }, { "name": "setCurrentPreset", "returns": "boolean", "description": "Set currently selected Preset.", "parameters": [ { "name": "presetID", "type": "string", "description": "" } ] }, { "name": "setDestinationCustomData", "returns": "boolean", "description": "Set new Custom Data to the destination to store plugin or UI related information for this destination as JSON.", "parameters": [ { "name": "destID", "type": "string", "description": "" }, { "name": "groupIndex", "type": "number", "description": "" }, { "name": "customData", "type": "string", "description": "" } ] }, { "name": "setImportIntoProject", "returns": "boolean", "description": "Set the import into Project preference value.", "parameters": [ { "name": "importExportedFile", "type": "boolean", "description": "" } ] }, { "name": "setJSONConvertOptions", "returns": "boolean", "description": "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.", "parameters": [ { "name": "includeHiddenParams", "type": "boolean", "description": "" }, { "name": "includeUnsetValues", "type": "boolean", "description": "" } ] }, { "name": "setMatchSequenceSettings", "returns": "boolean", "description": "Set the Sequence settings as Preset.", "parameters": [ { "name": "matchSequenceSettings", "type": "boolean", "description": "" } ] }, { "name": "setOutputFilePath", "returns": "boolean", "description": "Set the new path to the output file. The filename can be made unique based on other files already on disk.", "parameters": [ { "name": "filePath", "type": "string", "description": "" }, { "name": "createUniqueFilename", "type": "boolean", "description": "" } ] }, { "name": "setRangeOption", "returns": "boolean", "description": "Set the current Range Option: Entire(0) InToOut(1) WorkArea(2) Custom(3) Default(4).", "parameters": [ { "name": "rangeOption", "type": "number", "description": "" } ] }, { "name": "setScalingOption", "returns": "boolean", "description": "Set the current Scaling Option: Scale to fit(0) Scale to fill(3) Stretch to fill(5).", "parameters": [ { "name": "scalingOption", "type": "number", "description": "" } ] }, { "name": "validateOutputFilePathCollisions", "returns": "number", "description": "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.", "parameters": [ { "name": "filePath", "type": "string", "description": "" } ] }, { "name": "willSignWithContentCredentials", "returns": "boolean", "description": "Returns true if the current selection (sequence or project items) will be signed with content credentials.", "parameters": [] } ] }, { "name": "TranscoderEvent", "page": "TranscoderEvent.html", "kind": "Object", "description": "Transcoder event object", "properties": [ { "name": "EVENT_DESTINATIONSELECTED", "type": "string", "description": "A new (publish) destination was selected.", "access": "readonly", "static": true }, { "name": "EVENT_DISKSPACEREQUIREMENTCHANGED", "type": "string", "description": "Exported File size needs an update.", "access": "readonly", "static": true }, { "name": "EVENT_EXPORTWORKAREACHANGED", "type": "string", "description": "The export range option changed.", "access": "readonly", "static": true }, { "name": "EVENT_FORMATCHANGED", "type": "string", "description": "The export format has changed.", "access": "readonly", "static": true }, { "name": "EVENT_NEWEVENTGENERATED", "type": "string", "description": "A new event is generated", "access": "readonly", "static": true }, { "name": "EVENT_OUTPUTFILENAMECHANGED", "type": "string", "description": "The output filename has changed and needs to be updated.", "access": "readonly", "static": true }, { "name": "EVENT_SELECTNEWPRESET", "type": "string", "description": "A new preset is selected.", "access": "readonly", "static": true }, { "name": "EVENT_SHOWEXPORTWARNING", "type": "string", "description": "Export Warning should be displayed. EventInfo contains the warning message.", "access": "readonly", "static": true }, { "name": "EVENT_UPDATEALLSETTINGS", "type": "string", "description": "Settings changed and all settings needs to be updated.", "access": "readonly", "static": true }, { "name": "EVENT_UPDATEDEPENDENCIES", "type": "string", "description": "One Parameter or Parameter Group changed. EventInfo contains the changed parameter ID.", "access": "readonly", "static": true }, { "name": "eventInfo", "type": "string", "description": "Additional info as string or JSON if required by this event. Otherwise empty.", "access": "readonly" } ], "events": [], "methods": [ { "name": "addEventListener", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "dispatchEvent", "returns": "any", "static": true, "description": "", "parameters": [] }, { "name": "removeEventListener", "returns": "any", "static": true, "description": "", "parameters": [] } ] }, { "name": "TypeReflection", "page": "TypeReflection.html", "kind": "Object", "description": "The TypeReflection object provides information about the behavior of type of a property.", "properties": [ { "name": "arrayType", "type": "boolean", "description": "true if it is an array type.", "access": "readonly" }, { "name": "name", "type": "string", "description": "The type name.", "access": "readonly" }, { "name": "optionalType", "type": "boolean", "description": "true if the value could be undefined.", "access": "readonly" } ], "events": [], "methods": [] }, { "name": "UXPHost", "page": "UXPHost.html", "kind": "Object", "description": "UPXHost class provides private functionality to interact with the host from the plugin", "properties": [], "events": [], "methods": [ { "name": "getNamespacesForPluginId", "returns": "any", "static": true, "description": "Returns a vector of namespaces - a union of those provided as default by the host and defined in the manifest of the plugin", "parameters": [ { "name": "pluginId", "type": "string", "description": "" } ] }, { "name": "getPathFromPluginId", "returns": "string", "static": true, "description": "Returns the file system path of a UXP plugin given its plugin ID", "parameters": [ { "name": "pluginId", "type": "string", "description": "" } ] } ] }, { "name": "UniversalSearchAPI", "page": "UniversalSearchAPI.html", "kind": "Object", "description": "High level interface object that gives access to the UniversalSearchAPI Layer", "properties": [ { "name": "ORDER_ASCENDING", "type": "number", "description": "Sort result values in ascending order.", "access": "readonly", "static": true }, { "name": "ORDER_DESCENDING", "type": "number", "description": "Sort result values in descending order.", "access": "readonly", "static": true }, { "name": "SORT_DURATION", "type": "number", "description": "Sort result values by duration.", "access": "readonly", "static": true }, { "name": "SORT_NAME", "type": "number", "description": "Sort result values by name.", "access": "readonly", "static": true }, { "name": "SORT_SCORE", "type": "number", "description": "Sort result values by score.", "access": "readonly", "static": true }, { "name": "SORT_TIME", "type": "number", "description": "Sort result values by time.", "access": "readonly", "static": true } ], "events": [], "methods": [ { "name": "findAll", "returns": "Object", "description": "Return the facets that are provided by this set of search results.", "parameters": [ { "name": "query", "type": "Object", "description": "" }, { "name": "pageOptions", "type": "Object", "description": "" }, { "name": "searchOptions", "type": "any", "description": "" } ] }, { "name": "getInstance", "returns": "Object", "static": true, "description": "Get an object representing the universal search API backend", "parameters": [] } ] }, { "name": "UniversalSearchQuery", "page": "UniversalSearchQuery.html", "kind": "Object", "description": "Query that can be used in connection with the universal search API", "properties": [ { "name": "BOOLEAN_FIELD_OPERATOR_AND", "type": "number", "description": "AND operator for field queries.", "access": "readonly", "static": true }, { "name": "BOOLEAN_FIELD_OPERATOR_OR", "type": "number", "description": "OR operator for field queries.", "access": "readonly", "static": true }, { "name": "FIELD_QUERY_CONTAINS", "type": "number", "description": "Find fields that contain the given content.", "access": "readonly", "static": true }, { "name": "FIELD_QUERY_ENDS_WITH", "type": "number", "description": "Find fields that end with the given content.", "access": "readonly", "static": true }, { "name": "FIELD_QUERY_EQUALS", "type": "number", "description": "Find fields that equal the given content.", "access": "readonly", "static": true }, { "name": "FIELD_QUERY_STARTS_WITH", "type": "number", "description": "Find fields that start with the given content.", "access": "readonly", "static": true }, { "name": "description", "type": "string", "description": "", "access": "readonly" } ], "events": [], "methods": [ { "name": "createAgentDisallowFilterQuery", "returns": "Object", "static": true, "description": "Constructs a filter query that only enables agents other then the given agents.", "parameters": [ { "name": "disallowedAgents", "type": "any", "description": "" }, { "name": "subQuery", "type": "Object", "description": "" } ] }, { "name": "createAgentFilterQuery", "returns": "Object", "static": true, "description": "Constructs a filter query that only enables the given agents.", "parameters": [ { "name": "agents", "type": "any", "description": "" }, { "name": "subQuery", "type": "Object", "description": "" } ] }, { "name": "createAgentTextQuery", "returns": "Object", "static": true, "description": "Constructs a text query that searches on agents for the given text.", "parameters": [ { "name": "queryText", "type": "string", "description": "" } ] }, { "name": "createFieldQuery", "returns": "Object", "static": true, "description": "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", "parameters": [ { "name": "fieldSpecs", "type": "any[]", "description": "" }, { "name": "operator", "type": "number", "description": "" } ] }, { "name": "createMergeQuery", "returns": "Object", "static": true, "description": "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.", "parameters": [ { "name": "subQueries", "type": "any[]", "description": "" } ] }, { "name": "createPathJoinQuery", "returns": "Object", "static": true, "description": "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", "parameters": [ { "name": "leftQuery", "type": "Object", "description": "" }, { "name": "rightQuery", "type": "Object", "description": "" }, { "name": "keyPaths", "type": "any", "description": "" } ] }, { "name": "createQueryFromJSON", "returns": "Object", "static": true, "description": "Constructs a query from a valid query JSON file.", "parameters": [ { "name": "jsonString", "type": "string", "description": "" } ] }, { "name": "createUniversalJoinQuery", "returns": "Object", "static": true, "description": "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", "parameters": [ { "name": "leftQuery", "type": "Object", "description": "" }, { "name": "rightQuery", "type": "Object", "description": "" } ] } ] }, { "name": "UniversalSearchResult", "page": "UniversalSearchResult.html", "kind": "Object", "description": "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.", "properties": [ { "name": "agent", "type": "string", "description": "The identifier of the search agent that was used to create this result.", "access": "readonly" }, { "name": "facets", "type": "Object", "description": "Return the facets that are provided by this search result.", "access": "readonly" }, { "name": "hash", "type": "Object", "description": "The hash of this search results. Identical hashes lead to the exact same rendition of an item in the UI.", "access": "readonly" }, { "name": "payload", "type": "string", "description": "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.", "access": "readonly" }, { "name": "score", "type": "number", "description": "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.", "access": "readonly" }, { "name": "type", "type": "string", "description": "The type of this search result. This can be e.g. 'MasterClip' 'Marker'...", "access": "readonly" }, { "name": "universalJoinHash", "type": "Object", "description": "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.", "access": "readonly" } ], "events": [], "methods": [] }, { "name": "UniversalSearchResults", "page": "UniversalSearchResults.html", "kind": "Collection", "description": "A collection of universal search results", "elementType": "UniversalSearchResult", "properties": [ { "name": "facets", "type": "Object", "description": "Return the facets that are provided by this set of search results.", "access": "readonly" }, { "name": "results", "type": "any[]", "description": "The individual results provided by this results object that match the given facet.", "access": "readonly" } ], "events": [], "methods": [ { "name": "getErrors", "returns": "Object", "description": "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.", "parameters": [] }, { "name": "getFacetedResults", "returns": "any[]", "description": "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.", "parameters": [ { "name": "facets", "type": "any", "description": "" } ] }, { "name": "getLocalizedErrorMessageForAgent", "returns": "string", "description": "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: \"", "parameters": [ { "name": "agentIdentifier", "type": "string", "description": "" } ] } ] }, { "name": "Vector", "page": "Vector.html", "kind": "Object", "description": "Algebra BLAS data class", "properties": [ { "name": "cols", "type": "number", "description": "Get number of columns in this data object.", "access": "readonly" }, { "name": "length", "type": "number", "description": "Get the length of the vector.", "access": "readonly" }, { "name": "rows", "type": "number", "description": "Get number of rows in this data object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "Vector", "returns": "Vector", "description": "Constructs a new BLAS Vector object.", "parameters": [ { "name": "rows", "type": "number", "description": "" }, { "name": "data", "type": "any", "description": "" } ] }, { "name": "abs", "returns": "Object", "description": "Element-wise absolute value; returns a new vector or matrix.", "parameters": [] }, { "name": "add", "returns": "Object", "description": "Element-wise add another vector or matrix of the same shape; returns a new vector or matrix.", "parameters": [ { "name": "other", "type": "Object", "description": "" } ] }, { "name": "argMax", "returns": "number", "description": "Get the linear (column-major) index of the maximum element.", "parameters": [] }, { "name": "at", "returns": "number", "description": "Get the value at the given row index.", "parameters": [ { "name": "rowIdx", "type": "number", "description": "" } ] }, { "name": "divide", "returns": "Object", "description": "Element-wise divide by another vector or matrix of the same shape; returns a new vector or matrix.", "parameters": [ { "name": "other", "type": "Object", "description": "" } ] }, { "name": "dot", "returns": "number", "description": "Compute the dot product of this vector with another.", "parameters": [ { "name": "other", "type": "Object", "description": "" } ] }, { "name": "max", "returns": "number", "description": "Get the maximum element value in this vector or matrix.", "parameters": [] }, { "name": "maximum", "returns": "Object", "description": "Element-wise maximum of each element and the given scalar; returns a new vector or matrix.", "parameters": [ { "name": "scalar", "type": "number", "description": "" } ] }, { "name": "multiply", "returns": "Object", "description": "Element-wise multiply by another vector or matrix of the same shape; returns a new vector or matrix.", "parameters": [ { "name": "other", "type": "Object", "description": "" } ] }, { "name": "norm", "returns": "number", "description": "Compute the norm of this vector or matrix.", "parameters": [] }, { "name": "pow", "returns": "Object", "description": "Element-wise power; returns a new vector or matrix.", "parameters": [ { "name": "exponent", "type": "number", "description": "" } ] }, { "name": "scale", "returns": "Object", "description": "Multiply each element by the given scalar; returns a new vector or matrix.", "parameters": [ { "name": "factor", "type": "number", "description": "" } ] }, { "name": "squaredNorm", "returns": "number", "description": "Compute the squared L2 norm of this vector or matrix.", "parameters": [] }, { "name": "subtract", "returns": "Object", "description": "Element-wise subtract another vector or matrix of the same shape; returns a new vector or matrix.", "parameters": [ { "name": "other", "type": "Object", "description": "" } ] }, { "name": "sum", "returns": "number", "description": "Compute the sum of all elements in this vector or matrix.", "parameters": [] } ] }, { "name": "WaveFile", "page": "WaveFile.html", "kind": "Object", "description": "Represents a wave file on disk and can be used to retrieve basic metadata.", "properties": [ { "name": "bitDepth", "type": "number", "description": "The bit depth of the referenced wave file.", "access": "readonly" }, { "name": "channelLayout", "type": "Object", "description": "The channel layout of the referenced wave file.", "access": "readonly" }, { "name": "filePath", "type": "string", "description": "The file path of the referenced wave file.", "access": "readonly" }, { "name": "sampleCount", "type": "number", "description": "The sample count of the referenced wave file.", "access": "readonly" }, { "name": "sampleRate", "type": "number", "description": "The sample rate of the referenced wave file.", "access": "readonly" } ], "events": [], "methods": [ { "name": "WaveFile", "returns": "WaveFile", "description": "Create a new wave file object referencing a file on disk.", "parameters": [ { "name": "filePath", "type": "string", "description": "" } ] } ] }, { "name": "ZString", "page": "ZString.html", "kind": "Object", "description": "ZString class provides access to localized version of a string.", "properties": [], "events": [], "methods": [ { "name": "getZString", "returns": "string", "static": true, "description": "Get localized value for a loc-key.", "parameters": [ { "name": "locKey", "type": "string", "description": "" } ] }, { "name": "getZStringAndReplace", "returns": "string", "static": true, "description": "Get localized value for a loc-key.", "parameters": [ { "name": "locKey", "type": "string", "description": "" }, { "name": "stringSubstitutions", "type": "any", "description": "" } ] } ] } ] }