Interface: UseRecordingResult
@roomful/vue / UseRecordingResult
Interface: UseRecordingResult
Section titled “Interface: UseRecordingResult”Defined in: vue/src/index.ts:509
Describes the return value of useRecording.
Properties
Section titled “Properties”durationMs
Section titled “durationMs”durationMs:
ReadonlyRef<number>
Defined in: vue/src/index.ts:524
Reports the elapsed duration of the active recording in milliseconds. Reactive.
exportRecording()
Section titled “exportRecording()”exportRecording: () =>
RoomfulRecording
Defined in: vue/src/index.ts:544
Exports the captured recording as a serializable payload.
Serializes the current take into a portable RoomfulRecording.
Returns
Section titled “Returns”frameCount
Section titled “frameCount”frameCount:
ReadonlyRef<number>
Defined in: vue/src/index.ts:518
Reports how many frames the active recording has captured. Reactive.
isRecording
Section titled “isRecording”isRecording:
ReadonlyRef<boolean>
Defined in: vue/src/index.ts:513
Reports whether a recording is currently capturing frames. Reactive.
replay()
Section titled “replay()”replay: (
recording?) =>ReplaySession
Defined in: vue/src/index.ts:539
Replays a recording, defaulting to the most recent capture.
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: vue/src/index.ts:529
Begins capturing room activity into a new recording.
Begins capturing wire signals, discarding any previous take.
Returns
Section titled “Returns”void
stop()
Section titled “stop()”stop: () =>
void
Defined in: vue/src/index.ts:534
Stops the active recording.
Stops capturing. The captured frames remain available.
Returns
Section titled “Returns”void