Interface: UseRecordingResult
@roomful/solid / UseRecordingResult
Interface: UseRecordingResult
Section titled “Interface: UseRecordingResult”Defined in: solid/src/index.ts:516
Describes the return value of useRecording.
Properties
Section titled “Properties”durationMs
Section titled “durationMs”durationMs:
Accessor<number>
Defined in: solid/src/index.ts:531
Reports the elapsed duration of the active recording in milliseconds. Reactive.
exportRecording()
Section titled “exportRecording()”exportRecording: () =>
RoomfulRecording
Defined in: solid/src/index.ts:552
Serializes the current take into a portable recording (named to stay
destructurable, since export is a reserved word).
Serializes the current take into a portable RoomfulRecording.
Returns
Section titled “Returns”frameCount
Section titled “frameCount”frameCount:
Accessor<number>
Defined in: solid/src/index.ts:525
Reports how many frames the active recording has captured. Reactive.
isRecording
Section titled “isRecording”isRecording:
Accessor<boolean>
Defined in: solid/src/index.ts:520
Reports whether a recording is currently capturing frames. Reactive.
replay()
Section titled “replay()”replay: (
recording?) =>ReplaySession
Defined in: solid/src/index.ts:546
Builds a timed playback session for a recording, or the current take.
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”A playback session.
start()
Section titled “start()”start: () =>
void
Defined in: solid/src/index.ts:536
Begins capturing, 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: solid/src/index.ts:541
Stops capturing; the captured frames remain available.
Stops capturing. The captured frames remain available.
Returns
Section titled “Returns”void