Interface: RecordingEngine
@roomful/vue / RecordingEngine
Interface: RecordingEngine
Section titled “Interface: RecordingEngine”Defined in: core/dist/types.d.ts:2115
Records a room’s wire signals for later inspection and timed replay.
A recording is local: it logs the signals this peer sends and receives,
never touching the shared document and never syncing to other peers. Capture
is gated by start()/stop(); replay re-emits the captured frames at their
original tempo without re-applying them to a room.
Methods
Section titled “Methods”export()
Section titled “export()”export():
RoomfulRecording
Defined in: core/dist/types.d.ts:2125
Serializes the current take into a portable RoomfulRecording.
Returns
Section titled “Returns”getFrames()
Section titled “getFrames()”getFrames():
RecordingFrame[]
Defined in: core/dist/types.d.ts:2123
Returns a copy of the frames captured so far.
Returns
Section titled “Returns”RecordingFrame[]
getState()
Section titled “getState()”getState():
RecordingState
Defined in: core/dist/types.d.ts:2121
Returns the current recorder state (recording flag, frame count, span).
Returns
Section titled “Returns”ingest()
Section titled “ingest()”ingest(
direction,signal):void
Defined in: core/dist/types.d.ts:2150
Ingests a wire signal from the room runtime. The room calls this at its transport boundary; it is a no-op unless recording. Not for application use.
Parameters
Section titled “Parameters”direction
Section titled “direction”RecordingDirection
Whether the signal was received or sent.
signal
Section titled “signal”PeerWireMessage
The wire signal captured at the boundary.
Returns
Section titled “Returns”void
Nothing.
replay()
Section titled “replay()”replay(
recording?):ReplaySession
Defined in: core/dist/types.d.ts:2133
Builds a timed playback session for a recording, or for the current take when none is given.
Parameters
Section titled “Parameters”recording?
Section titled “recording?”The recording to replay; defaults to the current take.
Returns
Section titled “Returns”ReplaySession
A playback session.
start()
Section titled “start()”start():
void
Defined in: core/dist/types.d.ts:2117
Begins capturing wire signals, discarding any previous take.
Returns
Section titled “Returns”void
stop()
Section titled “stop()”stop():
void
Defined in: core/dist/types.d.ts:2119
Stops capturing. The captured frames remain available.
Returns
Section titled “Returns”void
subscribe()
Section titled “subscribe()”subscribe(
callback):Unsubscribe
Defined in: core/dist/types.d.ts:2141
Subscribes to recorder state changes (start/stop and each captured frame). Fires immediately with the current state.
Parameters
Section titled “Parameters”callback
Section titled “callback”(state) => void
The callback invoked with the latest state.
Returns
Section titled “Returns”Unsubscribe
A function that removes the listener.