LiveRecording class

One playbook run being recorded: starts the recorder, timestamps the run's events, and saves the video with ffmpeg.

Constructors

LiveRecording({required LiveRecorder recorder, required String ffmpeg, required String output, bool captions = true})
Creates a LiveRecording saved to output (.mp4 or .gif).

Properties

captions → bool
Whether to save step captions and chapters.
final
elapsed → Duration
How long it has been recording.
no setter
ffmpeg → String
The path of ffmpeg.
final
hashCode → int
The hash code for this object.
no setterinherited
isRecording → bool
Whether the recorder is running.
no setter
output → String
Where the video is saved.
final
recorder → LiveRecorder
Records the screen.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

cues([Duration? length]) → List<LiveCue>
The step captions so far, each lasting until the next step begins.
finish() → Future<LiveRecordingSaved>
Stops recording and saves the video, converting it with ffmpeg.
mark(Map<String, Object?> event, Duration at) → void
Notes a nylo.playbook event that arrived at into the recording.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
start() → Future<void>
Starts recording, and completes once the first frame is captured.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited