The FXScript Reference

For Final Cut Pro created by Joe Maller

debugtext

debugtext(["label"|float_variable],[...])

Additional Notes

Float

This command writes information to console.log while an FXScript effect is being processed. The Console Utility can view the information while the filter is executing.

Any number of quoted strings or float variables can be sent as a comma-delimited list of arguments.

When it says a float variable, it means a float variable. Even something as mundane as a numeric constant (plain old numbers) throws an"Expected a Variable" error.

Watch out for bloated logs

There doesn't appear to be a limit on how many of these commands can appear in a script. Use caution however, even though a single line may be about 50-80 bytes, that line is written everytime the effect is rendered. For 30fps interlaced effects, that's 60 times a second. Those lines can add up quickly.

I let FXBuilder run for one minute with a simple script containing one debugText call resulting in a 44 byte log entry. FXBuilder runs at 30fps (a 10 second loop), after 1 minute I'd added 77k to my logs. Not much, but 15 minutes would add 1 mb. After a few days of heavy FXScripting without a restart, the console log could be substantially inflated.