Interface: RecordingStore
@roomful/svelte / RecordingStore
Interface: RecordingStore
Section titled “Interface: RecordingStore”Defined in: packages/svelte/src/index.ts:595
Store of the session recorder exposing reactive isRecording, frameCount,
and durationMs sub-stores plus the start/stop/replay/export controls.
Capture is local to this peer; replay re-emits the captured frames at their
original tempo without re-applying them to a room.
Properties
Section titled “Properties”durationMs
Section titled “durationMs”durationMs:
Readable<number>
Defined in: packages/svelte/src/index.ts:610
A readable store reporting the span of the current take in milliseconds.
exportRecording()
Section titled “exportRecording()”exportRecording: () =>
RoomfulRecording
Defined in: packages/svelte/src/index.ts:631
Serializes the current take into a portable recording (named to stay a
valid identifier, since export is a reserved word).
Serializes the current take into a portable RoomfulRecording.
Returns
Section titled “Returns”frameCount
Section titled “frameCount”frameCount:
Readable<number>
Defined in: packages/svelte/src/index.ts:605
A readable store reporting how many frames the current take has captured.
isRecording
Section titled “isRecording”isRecording:
Readable<boolean>
Defined in: packages/svelte/src/index.ts:600
A readable store reporting whether the recorder is currently capturing wire signals.
start()
Section titled “start()”start: () =>
void
Defined in: packages/svelte/src/index.ts:615
Begins capturing wire signals, discarding any previous take.
Begins capturing wire signals, discarding any previous take.
Returns
Section titled “Returns”void
stop()
Section titled “stop()”stop: () =>
void
Defined in: packages/svelte/src/index.ts:620
Stops capturing; the captured frames remain available.
Stops capturing. The captured frames remain available.
Returns
Section titled “Returns”void
Methods
Section titled “Methods”replay()
Section titled “replay()”replay(
recording?):ReplaySession
Defined in: packages/svelte/src/index.ts:625
Builds a timed playback session for a recording, or the current take.