WhiteCap Documentation Scripting

	Documentation

	Basic
	Introduction FAQ Troubleshooting How WhiteCap Works License Agreement Contact

	Advanced
	Standalone Use Customizing Scripting Config Programming Version History

	Scripting WhiteCap
	WhiteCap has scripting services that allow you to automate or design WhiteCap performances. WhiteCap Scripts use a timeline (or "timecode") scheme in order to synchronize WhiteCap events with events that occur at preset times. Several sample scripts come with WhiteCap. If you look inside the folder named "Scripts" and view the files found inside it, you can follow along with what you're seeing when you run the script in WhiteCap. Studying the scripts that come with WhiteCap will teach you how to create your own scripts. See the customizing section for more. The 2 ways a script can be started: A script has the name "CTRL O.py" and CTRL O is pressed. The command Run( "ScriptName" ) is used (extensions are optional).
	Getting Started with Scripting
	In order to write your own scripts, you'll need to know what commands are available and how to invoke them. In the Scripts folder, you'll find the file "Script Command Reference.py", which documents and describes common script commands. Note: the scripting documentation is under construction and is evolving as WhiteCap develops. It's recommended you study the example script files to get a basic understanding of scripting and command usage.