Animate sub-compositions In/Out
singular_animate_stateTrigger animation state transitions to take sub-compositions on or off air. Coordinates multiple targets in one call.
Instructions
Trigger animation state transitions to take sub-compositions on or off air. Accepts multiple targets for a coordinated transition in one call. This does NOT change content — combine with update_content first, or use update_and_animate to do both atomically.
Args: app/appToken; targets: [{ subCompositionName | subCompositionId, state: In|Out|Out1|Out2 }]; response_format. Returns { success, count }.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| app | No | Alias of a registered app instance (see register_app / list_apps). Preferred over a raw token. | |
| targets | Yes | One entry per sub-composition to transition. | |
| appToken | No | Raw Singular control-app token for a one-off/unregistered instance. If both 'app' and 'appToken' are given, 'appToken' wins. | |
| response_format | No | Output format: 'markdown' (human-readable) or 'json' (machine-readable). Default 'markdown'. | markdown |