Setup guide

description A string that describes the video preview timing, as listed in the init.cfg file. For example,
1920x1080@5994i_free.
width An integer that specifies the width of the preview timing. For example, 1920.
height An integer that specifies the width of the preview timing. For example, 1080.
bitDepth An integer that specifies the bit depth of the preview timing. For example, 12.
rateString A string that specifies the refresh rate of the preview timing. For example, 6000i.
syncString A string that specifies the sync source of the preview timing. For example, freesync.
Usage example:
def
previewWindowConfigChanged(description,width,height,bitDepth,rateString,syncString):
print os.system(“/usr/bin/mySyncChangeScript --sync=”+syncString)
When the video preview timing is changed in the application, this example function calls a custom external
script, mySyncChangeScript, and passes the sync value to it. That external script could use the sync value,
for example, to trigger a sync change on the sync generator. The output of the external script is displayed
in the application terminal.
void archiveSegmentComplete(string segmentPath, string archiveName, string archivePath, int status,
string statusMessage, bool archiveComplete)
This hook called when Creative Finishing Software completes writing an archive segment.
segmentPath Path to the file segment that just completed, an empty string for non-file archives.
archiveName Name of the archive that was entered when formatting the archive.
archivePath Path to the archive that was entered when formatting the archive.
status Zero if successful, non-zero if there was an error.
statusMessage Description of the error. Empty string if status is 0.
archiveComplete True if all segments of the archive are complete.
void batchExportBegin(string nodeName, string exportPath, string namingPattern, string resolvedPattern,
int firstFrame, int lastFrame )
This hook is called before an export begins. The export is blocked until this function returns.
NOTE For stereo export this function is called twice (once for the left channel, and then once for the right channel).
If the function returns a valid path, the exported files are exported to that path.
nodeName Name of the export node.
exportPath Export path as entered in the application UI.
namingPattern List of optional naming tokens as entered in the application UI.
resolvedPattern Full path to the first frame that will be exported with all the tokens resolved.
firstFrame Frame number of the first frame that will be exported
lastFrame Frame number of the last frame that will be exported.
58 | Chapter 6 Software configuration