playbar
Read or set the current Houdini session frame, scene range, and playback controls so time-dependent SOP geometry cooks at the frame you need.
Instructions
Read or set the time of the session.
Use it before you read geometry that changes over time: a SOP cooks at the
current frame, so the frame decides what you see.
Do not use it only to read another frame: geometry_inspect, node_inspect
and stage_inspect take `frames` and put the playbar back after. A frame
that you set here stays for the person and for every later call, and
"range" also changes what a flipbook covers, and a ROP whose range
follows $FSTART and $FEND.
mode:
"get" — the current frame and time.
"frame" — go to `frame`.
"range" — set the scene frame range to `start` and `end`.
"playback" — set the playback range inside the scene range.
"play" — `action` is "play", "stop", "next", "previous", "start"
or "end". Playback needs a GUI.
Returns JSON.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | range and playback: the last frame. | |
| mode | No | One of "get", "frame", "range", "playback", "play". | get |
| frame | No | frame: the frame to go to. | |
| start | No | range and playback: the first frame. | |
| action | No | play: "play", "stop", "next", "previous", "start" or "end". |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |