Variables

All of Dashboard's interactions with Companion center around variables.

If you're not familiar, most Companion connections offer variables. Titles, file names, timecode, status, etc. are usually available as a variable.

Learn more about variables in the official Companion documentation here.

Using variables in Dashboard

Dashboard uses the exact same variable notation as Companion, such as $(connection:variable), $(internal:variable), $(custom:variable), or $(expression:variable) so if it works in Companion it should work in Dashboard.

NOTE: Although Dashboard supports Expression Variables, it does not support Expressions themselves. If you need an Expression to calculate a value you want to display in Dashboard, you need to use an Expression Variable or a Custom Variable paired with a Trigger.

Variables with multiple connections

Companion Dashboard can connect to multiple instances of Companion at the same time. If you have multiple connections, variables will use the Default Connection unless you include a [x] right before the variable.

When you add multiple connections in the settings pane, they are labeled Connection [1], Connection [2], etc. To direct Dashboard as to which connection to use for a particular variable, add the corresponding [x] immediately before the variable: [1]$(connection:variable), [2]$(connection:variable), etc. Without a [x] Dashboard will use the default connection.