2017

Data TypeDescriptionKey
LongFrame height of the exported asset.height
LongFrame width of the exported asset.width
DoubleFrame aspect ratio of the exported asset.aspectRatio
StringList of the tokens used in the UI to name
the Open Clip XML that was created by
the export node.
Only available if Clip Version (version-
ning) is enabled in the UI.
openClipNamePattern
StringFull path to the open clip that was cre-
ated, with all the tokens resolved.
Only available if Clip Version (version-
ning) is enabled in the UI.
openClipResolvedPath
StringList of the tokens used in the UI to name
the batch setup that was created by the
export node.
Only available if Clip Version (version-
ning) is enabled in the UI.
setupNamePattern
StringFull path to the batch setup that was
created, with all the tokens resolved.
Only available if Clip Version (version-
ning) is enabled in the UI.
setupResolvedPath
userData Dictionary. User-defined. Empty Dictionary that is carried over from the batchExportBegin hook.
This can be used by the hook to pass black box data around.
batchDefaultIterationName
Called at application startup, and whenever the user switches project. Use it to define the default name
given to new Batches created by the user in the Media Panel. Overrides the preferences defined in Timeline
FX/Batch/Batch FX ➤ Default Batch Iteration Name. The returned value can use any of the tokens
available in the UI such as <user nickname> (note the lack of underscore).
IMPORTANT The returned string must contain the two mandatory tokens <batch name> and <iteration>.
def batchDefaultIterationName( project ):
return ""
project String. Usually called with the current project. If a project name is specified, the default batch
iteration name for this project will be returned. For example:
if project == "project_name":
return "<batch name>_<iteration###>_project"
return "<batch name>_<iteration###>_global"
Python Hooks Reference | 201