Scripting Reference ​

This section contains reference material relevant to those writing profile scripts. We cover the scripting API, including objects and functions that are available to script authors.

Scripts are written using Lua: a scripting language that is simple enough to be learned quickly, but expressive enough to support advanced logic used by more complex projects. See the official Lua documentation for a comprehensive list of learning resources. We also strive to provide enough examples in this reference guide that someone with basic programming experience should be able to pick up Lua by example.

When using this reference to write a profile script, the best place to start is the profile object. If you are familiar with other scripting languages but are new to Lua, the Lua primer might be helpful.

• Glossary
• Lua Primer
• Logging
• Process Helpers
• Object: profile
• Object: server
• Object: output
• Object: surface
• Object: visual
• Object: view
• Object: media_player
• Object: group
• Object: canvas
• Object: process
• Object: timer
• Object: stream
• Object: serial