Batch Operations
What is a "batch"?
In Composer, a batch is a free-form tag on a layer (set via the layer's Batch property — one or more space-separated tag words). Batches let you treat a group of layers as one named bundle so a single API call can show, hide, or solo every layer carrying that tag at once.
Typical uses:
- Camera-angle switching — tag every overlay for "front camera" with
FrontCamand every overlay for "back camera" withBackCam, then flip between angles with one call per cut. - Graphics packages — tag a lower-third + bug + ticker as
lower3, then bring the whole package on or off with one call. - Programme segments — tag the layers that belong to a sponsor break, news intro, or commercial bumper.
GET /api/batch/
Show, hide, or solo every layer whose Batch tag matches the given name. The match runs across all scenes by default and is applied asynchronously by the runtime — the request is queued the moment the call arrives and processed on the next frame while playback is Running.
URL form: /api/batch/<command> — replace <command> with one of:
| Command | Effect |
|---|---|
showlayer |
Set IsVisible = true on every layer whose Batch tag matches. |
hidelayer |
Set IsVisible = false on every layer whose Batch tag matches. |
showlayersolo |
Show every matching layer and hide every other layer in the same scene that has any batch tag — useful for "switch to this camera angle, hide all others". |
Query parameters:
| Parameter | Required | Description |
|---|---|---|
batch |
Yes | The tag to match against the layer's Batch property. |
scene |
No | Limit the operation to a single scene (matched by scene name, case-insensitive). When omitted, all scenes are processed. |
comparison |
No | How batch is matched against each layer's tag. One of EQUALS, STARTSWITH, ENDSWITH, or CONTAINS. Default: CONTAINS. |
Examples:
GET /api/batch/showlayer?batch=FrontCam
GET /api/batch/showlayersolo?batch=FrontCam&scene=Main
GET /api/batch/hidelayer?batch=overlay&comparison=startswith
Response:
200 OK—New batch item registered(request queued; the actual show/hide happens on the next frame).400 Bad Request— Missing or invalidbatchparameter, unknown command, or malformed URL.