API Reference
StoryReplay
Bounded, resolved terminal events supplied by a capture host or an author.
Inheritance
- Object
- StoryReplay
Remarks
Commands are submitted observations rather than simulated keystrokes. ANSI controls are stripped; hosts resolve screen operations into explicit events.
Usage
Explore 14 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 13
- Method StoryReplay.ChangeDirectory
- Method StoryReplay.Clear
- Method StoryReplay.Command
- Method StoryReplay.CompressPauses
- Method StoryReplay.Create
- Method StoryReplay.Explain
- Method StoryReplay.Marker
- Method StoryReplay.OpenTab
- Method StoryReplay.Output
- Method StoryReplay.ReplaceLine
- Method StoryReplay.SelectTab
- Method StoryReplay.Trim
- Property VisualStoryReplaySurface.Replay
Accepted by parameters 1
Methods
public StoryReplay ChangeDirectory(TimeSpan at, String directory) #StoryReplayChanges the active tab's prompt directory.
Parameters
- at System.TimeSpan
- directory System.String
public StoryReplay Clear(TimeSpan at) #StoryReplayClears displayed lines in the active tab without discarding recorded transcript events.
Parameters
- at System.TimeSpan
public StoryReplay Command(TimeSpan at, String command) #StoryReplayAdds a submitted command at its recorded timestamp.
Parameters
- at System.TimeSpan
- command System.String
public StoryReplay CompressPauses(TimeSpan maximumGap) #StoryReplayReturns a detached presentation with every idle gap, including leading and trailing gaps, capped explicitly.
Parameters
- maximumGap System.TimeSpan
public static StoryReplay Create(TimeSpan duration, TerminalDialect dialect = PowerShell, String workingDirectory = ".", String title = "PowerShell", String? customPrompt = null) #StoryReplayCreates a recording with an explicit endpoint and initial session.
Parameters
- duration System.TimeSpan
- dialect ChartForgeX.Terminal.TerminalDialect = PowerShell
- workingDirectory System.String = "."
- title System.String = "PowerShell"
- customPrompt System.String? = null
public StoryReplay Explain(TimeSpan at, String label) #StoryReplayReturns a detached replay with an explanation inserted on the presentation clock, without inventing a recorded timestamp.
Parameters
- at System.TimeSpan
- label System.String
public StoryReplay Marker(TimeSpan at, String label) #StoryReplayAdds an explanation or chapter marker at a recorded timestamp.
Parameters
- at System.TimeSpan
- label System.String
public StoryReplay OpenTab(TimeSpan at, String id, String title, TerminalDialect dialect = PowerShell, String workingDirectory = ".", String? customPrompt = null) #StoryReplayOpens and activates a persistent session.
Parameters
- at System.TimeSpan
- id System.String
- title System.String
- dialect ChartForgeX.Terminal.TerminalDialect = PowerShell
- workingDirectory System.String = "."
- customPrompt System.String? = null
public StoryReplay Output(TimeSpan at, String text, TerminalTextTone tone = Default) #StoryReplayAdds completed, newline-separated output. Use ReplaceLine for a carriage-return update.
Parameters
- at System.TimeSpan
- text System.String
- tone ChartForgeX.Terminal.TerminalTextTone = Default
public StoryReplay ReplaceLine(TimeSpan at, String text, TerminalTextTone tone = Default) #StoryReplayReplaces the active tab's last line with resolved progress text.
Parameters
- at System.TimeSpan
- text System.String
- tone ChartForgeX.Terminal.TerminalTextTone = Default
public StoryReplay SelectTab(TimeSpan at, String id) #StoryReplayActivates a previously opened session.
Parameters
- at System.TimeSpan
- id System.String
public String ToTranscript() #StringGets sanitized chronological output, including cleared lines and both timestamps.
Exceptions
InvalidOperationException– The expanded transcript exceeds 16 Mi UTF-16 characters.
public StoryReplay Trim(TimeSpan start, TimeSpan end) #StoryReplayReturns a detached presentation interval. Earlier events are retained at zero to reconstruct tab and screen state.
Parameters
- start System.TimeSpan
- end System.TimeSpan
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public TimeSpan Duration { get; private set; } #Gets the presentation duration, including recorded idle time.
public TimeSpan OriginalDuration { get; private set; } #Gets the original duration before trimming or pause compression.
public TerminalDialect Dialect { get; } #Gets the initial recording dialect.
public String Title { get; } #Gets the initial tab title.
public String WorkingDirectory { get; } #Gets the initial prompt directory.
public String CustomPrompt { get; } #Gets the initial custom prompt.
public IReadOnlyList<StoryReplayEvent> Events { get; } #Gets immutable events in stable timestamp order.