gatos.schedule_control

tool Scheduling

Inspect and control schedule and camera players.

Use when: Pausing, resuming, seeking, retiming, looping, stopping, or removing a timed sequence.
Availability: schedule_enabled; camera players additionally require camera_enabled.

Input

Field	Type	Requirement	Description
`operation`	`string`	Required	list, get, pause, resume, scrub, rate, loop, stop, remove, or clear.
`id`	`string \| null`	Optional · null	Player id; omitted for list and normally clear.
`value`	`number`	Optional · 0	Pause flag, position ms, playback rate, or loop flag as appropriate.
`token`	`string \| null`	Optional · null	Fallback id token for control actions.

Operation call shapes

Choose an operation below. Its required payload and a complete call stay together—there is no second table to cross-reference.

`list`

Read all players.

Arguments for this operation

{ operation: "list" }

Example

gatos.schedule_control({"operation":"list"})

`get`

Read one player.

Arguments for this operation

{ operation: "get", id }

Example

gatos.schedule_control({"operation":"get","id":"launch-seq"})

`pause / resume`

Canonical action: schedule.pause

Set paused state; resume maps to pause value 0 automatically.

Arguments for this operation

{ operation, id, value?: 0 | 1 }

Example

gatos.schedule_control({"operation":"pause","id":"launch-seq","value":1})

`scrub`

Canonical action: schedule.scrub

Seek without firing skipped entries.

Arguments for this operation

{ operation: "scrub", id, value: position_ms }

Example

gatos.schedule_control({"operation":"scrub","id":"launch-seq","value":3500})

`rate`

Canonical action: schedule.rate

Set playback rate; 0 is a legal frozen state.

Arguments for this operation

{ operation: "rate", id, value: number  // 0..100 }

Example

gatos.schedule_control({"operation":"rate","id":"launch-seq","value":0.5})

`loop`

Canonical action: schedule.*

Enable or disable looping.

Arguments for this operation

{ operation: "loop", id, value: 0 | 1 }

Example

gatos.schedule_control({"operation":"loop","id":"launch-seq","value":1})

`stop | remove`

Canonical action: schedule.*

Stop execution while keeping the player, or remove it from the registry.

Arguments for this operation

{ operation, id }

Example

gatos.schedule_control({"operation":"stop","id":"launch-seq"})

`clear`

Canonical action: schedule.clear

Remove every live and committed-but-not-activated player.

Arguments for this operation

{ operation: "clear" }

Example

gatos.schedule_control({"operation":"clear"})

Call example

gatos.schedule_control({"operation":"scrub","id":"launch-seq","value":3500})

Result

Player state for reads or command outcome for controls.

Errors

ENOENT for a missing player; EOPNOTSUPP when scheduling is disabled; EINVAL for invalid state/value.