Playback Group#
Note
The endpoints listed on this page require a project to be loaded on the controller.
Methods#
GET#
Returns data about the playback groups in the project on the controller.
Playback groups are a method of grouping timelines or scenes.
GET /api/playback_group[?num=playbackGroupNumbers]
num can be used to filter which scenes are returned and is expected to be either a single number or a string expressing the required playback groups, e.g. "1,2,5-9".
Returns a JSON object with a single playback_groups attribute, which has an array value. Each item in the array is a Playback group object with the following attributes:
Attribute |
Value Type |
Description |
Value Example |
|---|---|---|---|
|
integer |
Playback Group number |
|
|
string |
Playback Group name |
|