Skip to main content

Module commands

Module commands 

Source

Structs§

AcceptTake
Mark a delivered Take’s Capture as operator-accepted without mutating its integrity or QC evidence. Later recorder status republishes preserve review.
AcceptTakeArgs
AcquireControl
Take the wheel (SET overwrites any current holder — takeover).
AcquireControlArgs
AddShotEntry
Add one shot to a timeline, optionally at a position rather than the end.
AddShotEntryArgs
AutoAssignControl
Server-internal command emitted by the leave-reassign saga (server crate): reconcile a stream’s control lock against live presence. Exposed so the saga can emit it.
AutoAssignControlArgs
ControlRecordingJob
Create, resume, or cancel a durable recorder-controller-owned RecordingJob.
ControlRecordingJobArgs
DiscoverShots
Reconcile live camera targets into a persistent shot library. This command is create-only by (library, kind, target_name): discovery can add a new rail or preset, but can never overwrite an operator’s tuned Shot values.
DiscoverShotsArgs
ImportCollectionOtio
Atomically import a generic OTIO SerializableCollection subtree, including nested bins, reusable timeline placements, timelines, and shot definitions.
ImportCollectionOtioArgs
ImportTimelineOtio
Atomically import a Pulse-profile OTIO document into the shared definition library. Camera execution remains untouched; this command only persists Shot and Timeline definitions.
ImportTimelineOtioArgs
JoinStream
Register (or refresh) my presence on a stream.
JoinStreamArgs
LeaveStream
Remove this connection’s presence from a stream during in-page navigation.
LeaveStreamArgs
MigrateOtioTimelines
Idempotent persisted-data migration invoked by OTIO-native clients when they connect. This is deliberately explicit and observable rather than a hidden database rewrite during server startup.
MigrateOtioTimelinesArgs
MoveShotEntry
Move one entry to a position in the program.
MoveShotEntryArgs
ReleaseControl
Release the wheel — held by a PERSON (viewer_id), so any of their tabs may release it (the request carries the caller’s viewer_id).
ReleaseControlArgs
RemoveCollection
Remove an empty collection. Memberships directly inside it are removed, while child collections must be deliberately handled first so a broad tree cannot disappear from one accidental click.
RemoveCollectionArgs
RemoveShotEntry
Remove one entry. Naming the entry means a concurrent add elsewhere in the timeline survives.
RemoveShotEntryArgs
RemoveTimeline
Delete one timeline and all of its organizational placements without deleting any reusable shot definitions.
RemoveTimelineArgs
SetCamPref
Upsert the durable global camera settings. The client sends this whenever the operator changes a control, and reads them back (GetCamPrefsByQuery) on connect to restore the panel + re-apply to the freshly-launched pawn. Full struct each time (last-write-wins) — simplest and the payload is tiny.
SetCamPrefArgs
SetCameraHome
Persist one stream’s authored Home camera pose and lens. The command only updates server state; moving the live camera remains an explicit client action.
SetCameraHomeArgs
SetCollection
Create or update a generic organizational bin. Collection names and depth are user-defined; the server enforces only tree integrity and sibling-name uniqueness.
SetCollectionArgs
SetCollectionMembership
Add or remove one many-to-many timeline placement.
SetCollectionMembershipArgs
SetFrameCaptureStatus
Bridge-owned authoritative status for one stream’s frame capture.
SetFrameCaptureStatusArgs
SetFrameCaptureTargetSummary
Bridge-mirrored summary of a cluster the operator may capture on. The browser never queries Pulse Cluster, so these summaries are how the UI learns valid targets at all.
SetFrameCaptureTargetSummaryArgs
SetPrevisDlss
SetPrevisDlssArgs
SetPrevisDlssStatus
SetPrevisDlssStatusArgs
SetRecording
Client-side record trigger: set the intent to record streamer_id (active on/off) + camera metadata. The recorder service watches RecordingRequest, chooses the active rig (rail/crane) or preset/shot as its human artifact label, and starts/stops the server-side no-transcode capture. Keyed by streamer_id (one active recording per stream).
SetRecordingArgs
SetRecordingJobStatus
Recorder-side authoritative RecordingJob progress report.
SetRecordingJobStatusArgs
SetRecordingStatus
Recorder-side status report for capture, finalization, and NAS delivery readiness.
SetRecordingStatusArgs
SetShot
Upsert one persistent shot definition. The stable shot ID is supplied by the client so reconnects cannot create duplicate definitions for the same target.
SetShotArgs
SetShotEntryDirection
Set one entry’s capture direction.
SetShotEntryDirectionArgs
SetStreamName
Set a stream’s friendly DISPLAY name (from the cluster def’s previs.stream_name, written on previs launch, keyed by the StreamerId). Upsert / last-write-wins. The StreamerId is unchanged, so duplicate names never collide.
SetStreamNameArgs
SetTimeline
Create or update one named reusable timeline. Every entry persists a complete parameter snapshot; Shot values are defaults used only when adding or migrating an entry.
SetTimelineArgs
SubmitFrameCapture
Submit a synchronized nDisplay frame capture.
SubmitFrameCaptureArgs
UpdateCursor
Move my cursor (frequent, cheap).
UpdateCursorArgs