Batch Processor

Batch Processor input properties for Script Engine. Lets you show or hide multiple layers at once based on the layers' Batch name. Each layer in a project can be tagged with one or more Batch names; this input runs a single command (show, hide, solo) against every layer whose Batch name matches a value you specify. Useful for switching between groups of graphics, lower thirds, or scenes without wiring up individual triggers per layer. The match can be limited to a single scene, and you can choose whether names must match exactly or just contain / start with the given text.

Property	Type	Access	Description
`BatchCommand`	`BatchCommand`	`get/set`	What to do with the layers that match `BatchName`. [default=SHOWLAYERSOLO]. `SHOWLAYER` makes matching layers visible without touching the others. `HIDELAYER` hides matching layers. `SHOWLAYERSOLO` shows the matching layers and hides every other layer in the affected scene(s) — handy for "switch to this group" style transitions.
`BatchName`	`string`	`get/set`	The Batch name to match against the layers in the project. When the command runs, every layer whose Batch tag matches this text is affected, using the rule chosen in `BatchComparisonType` (Contains, Equals, etc.). Set this from a script to switch which group of layers the next command will act on.
`SceneName`	`string`	`get/set`	Optional scene name to limit the command to a single scene. When set, only layers belonging to the named scene are considered. Leave blank to apply the command across every scene in the project. Useful when the same Batch names exist in multiple scenes and you only want to switch one of them.
`BatchComparisonType`	`BatchComparisonType`	`get/set`	How `BatchName` is matched against each layer's Batch tag. [default=Contains]. `Contains` matches when the layer's Batch tag contains the text (forgiving — good default). `Equals` requires an exact match. `BeginsWith` matches when the tag starts with the text. Pick a stricter rule to avoid accidentally affecting layers whose names happen to share a substring.
`ExecuteBatchCommand`	`Command`	`get/set`	Run the configured batch command against the project. Invokable command. Applies the chosen `BatchCommand` to every layer whose Batch tag matches `BatchName` according to `BatchComparisonType`, restricted to `SceneName` if one is given. This is the action you'd typically trigger from a script or hotkey.
`TestBatchCommand`	`Command`	`get/set`	Try the batch command from the editor without wiring it up to a trigger. Invokable command. Runs the same command as `ExecuteBatchCommand` (via the local HTTP API) so you can verify the Batch name, comparison rule, and scene selection are correct before hooking the input into a live workflow.

Inherits from: AbstractInput, AbstractAudioProcessing, AbstractAudioMetering.

See also: Batch Processor in Inputs — user-facing introduction, screenshots, and section summaries.