Skip to content
ConsoleMonster

API Reference

Class

ReplayPlayer

Edit on GitHub
Namespace ConsoleMonster.Replay
Assembly ConsoleMonster
Source ReplayPlayer.cs:72
Modifiers static

Rewinds runs: an in-terminal player for recordings (the JSON-lines files written with LiveSessionOptions.RecordPath or LiveSessionOptions.AutoRecord). The recording is played into the same dashboard definition, then shown with play/pause, speed, frame stepping, a timeline to scrub, jumps to markers, failures, warnings and log entries, and a search over the log. Without an interactive console it prints the markers as lines instead.

Inheritance

  • Object
  • ReplayPlayer

Methods

public static String FormatTime(TimeSpan time) #
ReplayPlayer.cs:133
Returns: String

Formats a timeline position as m:ss.f (or h:mm:ss past an hour).

Parameters

time System.TimeSpan requiredposition: 0
The position.

Returns

The text.

Play 2 overloads
public static Void Play(IWidget root, TextReader jsonLines, ReplayOptions? options = null, CancellationToken cancellationToken = default) #
ReplayPlayer.cs:72
Returns: Void

Plays a recording.

Parameters

root ConsoleMonster.Layout.IWidget requiredposition: 0
The dashboard (or any widget tree) whose widget names match the recording.
jsonLines System.IO.TextReader requiredposition: 1
The recording.
options ConsoleMonster.Replay.ReplayOptions? = null optionalposition: 2
Options, or null.
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
Ends the player.
public static Void Play(IWidget root, IReadOnlyList<LiveEvent> events, ReplayOptions? options = null, CancellationToken cancellationToken = default) #
ReplayPlayer.cs:84
Returns: Void

Plays recorded events.

Parameters

root ConsoleMonster.Layout.IWidget requiredposition: 0
The dashboard (or any widget tree) whose widget names match the recording.
events System.Collections.Generic.IReadOnlyList<ConsoleMonster.Live.LiveEvent> requiredposition: 1
The events in recording order.
options ConsoleMonster.Replay.ReplayOptions? = null optionalposition: 2
Options, or null.
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
Ends the player.