2017

Table Of Contents
archiveSelectionUpdated
Called when the user updates the information on the currently selected element in an opened archive (either
through the U keyboard shortcut, or through the Gear menuUpdate selection information.) Update
selection information tells the user which segments are needed to bring the selection back online.
def archiveSelectionUpdated( segmentInfo, numFrames, numClips,
dataSize, metadataSize ):
pass
segmentInfo Dictionary{ Integer, String }. Map of segment ID to file path . If this is a non-file based archive,
indicates the device type.
numFrames Long. Number of frames of the selection.
numClips Integer. Number of clips in the selection.
dataSize Float. Size of the selection, in MB.
metadataSize Float. Size of the metadata for the selection, in MB.
Batch Hooks
batchSetupLoaded
Called whenever a batch setup is successfully loaded.
def batchSetupLoaded( setupPath ):
pass
setupPath String. File path to the location of the loaded setup.
batchSetupSaved
Called whenever a batch setup is successfully saved.
def batchSetupSaved( setupPath ):
pass
setupPath String. File path to the location of the saved setup.
batchExportBegin
This hook is called before the Write File node starts rendering and writing files to disk.
NOTE In case of stereoscopic renders, batchExportBegin is called twice, first for the left eye, then for the right
eye.
def batchExportBegin( info, userData ):
pass
info Dictionary. Information about the export. Some of this information can be modified by the script as
it executes.
Data TypeDescriptionKey
StringName of the export nodenodeName
StringEditable. Export path as entered in the
export node from within application.
exportPath
198 | Chapter 6 Importing and Exporting Media