Interface: UseRecordingResult
@roomful/react / UseRecordingResult
Interface: UseRecordingResult
Section titled “Interface: UseRecordingResult”Defined in: react/src/index.ts:470
Describes the return value of useRecording.
Properties
Section titled “Properties”durationMs
Section titled “durationMs”durationMs:
number
Defined in: react/src/index.ts:485
The span of the current take in milliseconds. Reactive.
exportRecording()
Section titled “exportRecording()”exportRecording: () =>
RoomfulRecording
Defined in: react/src/index.ts:506
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”RoomfulRecording
frameCount
Section titled “frameCount”frameCount:
number
Defined in: react/src/index.ts:480
How many signals the current take has captured. Reactive: increments as traffic flows while recording.
isRecording
Section titled “isRecording”isRecording:
boolean
Defined in: react/src/index.ts:474
Whether the recorder is currently capturing wire signals. Reactive.
replay()
Section titled “replay()”replay: (
recording?) =>ReplaySession
Defined in: react/src/index.ts:500
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?”RoomfulRecording
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: react/src/index.ts:490
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: react/src/index.ts:495
Stops capturing; the captured frames remain available.
Stops capturing. The captured frames remain available.
Returns
Section titled “Returns”void