Skip to content
ConsoleMonster
Class

SessionRecording

ConsoleMonster.Sessions

Namespace
ConsoleMonster.Sessions
Assembly
ConsoleMonster
Modifiers
sealed

Reads asciicast v2 sessions and replays their VT output through ConsoleMonster's cell renderer.

Inheritance

  • object
  • SessionRecording

Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Constructors

public SessionRecording() #

Methods

public string Export(ExportFormat format, RecordingExportOptions? options = null) #

Exports an HTML player, animated SVG, v2 asciicast, or scrollback as text or fenced Markdown.

Parameters

format ConsoleMonster.Export.ExportFormat required
options ConsoleMonster.Export.RecordingExportOptions? = null optional

Returns

string
public string ExportFinalSvg(ExportOptions? options = null) #

Exports a static final-frame SVG with the same theme and cell geometry as the player.

Parameters

options ConsoleMonster.Export.ExportOptions? = null optional

Returns

string
public string ExportPlayerData(RecordingExportOptions? options = null) #

Exports the existing native player's data format, including chapter markers.

Parameters

options ConsoleMonster.Export.RecordingExportOptions? = null optional

Returns

string
public CellBuffer FinalFrame() #

Reconstructs the last visible frame, including cursor movement, colour and resizes.

Returns

CellBuffer
Read 2 overloads
public static SessionRecording Read(string path) #

Reads a local cast. No companion file or remote resource is needed for playback.

Parameters

path string required
public static SessionRecording Read(TextReader reader) #

Reads a v2 cast, rejecting invalid headers, dimensions and non-monotonic event times.

Parameters

reader System.IO.TextReader required
public string ToAsciicast() #

Returns an interoperable v2 cast without input events.

Returns

string
public CellBuffer Transcript() #

Reconstructs print-once terminal scrollback and the final main screen.

Returns

CellBuffer

Properties

public int Width { get; private set; } #

Initial terminal columns.

public int Height { get; private set; } #

Initial terminal rows.

public string Title { get; private set; } #

Recording title.

public string Mode { get; private set; } #

Capture mode stated in the file, or external for third-party casts.