Interface: InjectRecordingResult
@roomful/angular / InjectRecordingResult
Interface: InjectRecordingResult
Section titled “Interface: InjectRecordingResult”Defined in: angular/src/index.ts:498
Describes the return value of injectRecording.
Properties
Section titled “Properties”durationMs
Section titled “durationMs”durationMs:
Signal<number>
Defined in: angular/src/index.ts:513
Reports the span of the current take in milliseconds. Reactive.
exportRecording()
Section titled “exportRecording()”exportRecording: () =>
RoomfulRecording
Defined in: angular/src/index.ts:534
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:
Signal<number>
Defined in: angular/src/index.ts:508
Reports how many signals the current take has captured. Reactive: increments as traffic flows while recording.
isRecording
Section titled “isRecording”isRecording:
Signal<boolean>
Defined in: angular/src/index.ts:502
Reports whether the recorder is currently capturing wire signals. Reactive.
replay()
Section titled “replay()”replay: (
recording?) =>ReplaySession
Defined in: angular/src/index.ts:528
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: angular/src/index.ts:518
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: angular/src/index.ts:523
Stops capturing; the captured frames remain available.
Stops capturing. The captured frames remain available.
Returns
Section titled “Returns”void