API Reference
PreparedVisualStory
A detached story observation with one clock for seeking, playback and export.
Inheritance
- Object
- PreparedVisualStory
Remarks
Rendering clamps to one play. Repetition is an export or player policy; the endpoint remains the completed scene.
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
- Method VisualStory.Prepare
Methods
public IEnumerable<RasterAnimationFrame> Frames(VisualStoryFrameOptions? options = null, CancellationToken cancellationToken = default) #IEnumerable<RasterAnimationFrame>Produces owning frames lazily, using rational cadence and exact tick durations.
Parameters
- options ChartForgeX.Stories.VisualStoryFrameOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public IEnumerable<RasterAnimationFrame> Frames(RasterAnimationFormat format, VisualStoryFrameOptions? options = null, CancellationToken cancellationToken = default) #IEnumerable<RasterAnimationFrame>Produces owning frames with the selected container's timing and Stories readability policy.
Parameters
- format ChartForgeX.Raster.RasterAnimationFormat
- options ChartForgeX.Stories.VisualStoryFrameOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public RasterAnimationSource FrameSource(RasterAnimationFormat format, VisualStoryFrameOptions? options = null) #RasterAnimationSourceCreates a repeatable producer with container-specific timing, including GIF visibility and viewer delay limits.
Parameters
- format ChartForgeX.Raster.RasterAnimationFormat
- options ChartForgeX.Stories.VisualStoryFrameOptions? = null
public RasterAnimationSource FrameSource(VisualStoryFrameOptions? options = null) #RasterAnimationSourceCreates a repeatable frame source on the exact tick clock, suitable for timestamp observations and optional video encoders.
Parameters
- options ChartForgeX.Stories.VisualStoryFrameOptions? = null
public PreparedVisual PrepareFrame(TimeSpan timestamp) #PreparedVisualPrepares a timestamp as native geometry shared by SVG and PNG backends.
Parameters
- timestamp System.TimeSpan
public RgbaImage RenderAt(TimeSpan timestamp, Int32 outputScale = 1) #RgbaImageRenders an independently owned RGBA frame at a timestamp within one play.
Parameters
- timestamp System.TimeSpan
- outputScale System.Int32 = 1
public String ToAnimatedSvg(VisualStoryFrameOptions? options = null, String idScope = "", CancellationToken cancellationToken = default) #StringExports sampled native frames as a self-contained, script-free SVG animation using the prepared playback clock.
Parameters
- options ChartForgeX.Stories.VisualStoryFrameOptions? = null
- idScope System.String = ""
- cancellationToken System.Threading.CancellationToken = default
Exceptions
InvalidOperationException– Sampling exceeds its frame budget, misses a readable chapter, or exceeds the document budget.
public Byte[] ToApng(VisualStoryFrameOptions? options = null, CancellationToken cancellationToken = default) #Byte[]Encodes APNG while producing and releasing one frame at a time.
Parameters
- options ChartForgeX.Stories.VisualStoryFrameOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public Byte[] ToGif(VisualStoryFrameOptions? options = null, CancellationToken cancellationToken = default) #Byte[]Encodes GIF with a global palette and bounded two-pass frame production.
Parameters
- options ChartForgeX.Stories.VisualStoryFrameOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public String ToHtmlPage(VisualStoryFrameOptions? options = null, CancellationToken cancellationToken = default) #StringExports a script-free HTML page using the captured story and prepared playback clock.
Parameters
- options ChartForgeX.Stories.VisualStoryFrameOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public Byte[] ToPng(TimeSpan? timestamp = null, Int32 outputScale = 1) #Byte[]Renders a PNG at a timestamp; omission selects the completed poster.
Parameters
- timestamp System.TimeSpan? = null
- outputScale System.Int32 = 1
public String ToSvg(TimeSpan? timestamp = null) #StringExports a static vector frame at a timestamp; omission selects the completed poster.
Parameters
- timestamp System.TimeSpan? = null
public String ToTranscript() #StringGets the captured accessible transcript, including complete source and terminal output.
public Void WriteAnimation(Stream stream, RasterAnimationFormat format, VisualStoryFrameOptions? options = null, CancellationToken cancellationToken = default) #VoidWrites an animation directly to a caller-owned stream without retaining the encoded file.
Parameters
- stream System.IO.Stream
- format ChartForgeX.Raster.RasterAnimationFormat
- options ChartForgeX.Stories.VisualStoryFrameOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public String Title { get; } #Gets the title captured during preparation.
public Int32 Width { get; } #Gets the logical width.
public Int32 Height { get; } #Gets the logical height.
public TimeSpan ContentDuration { get; } #Gets the authored duration before the completed-state hold.
public TimeSpan Duration { get; } #Gets one complete play, including the completed-state hold.
public VisualStoryPlaybackOptions Playback { get; } #Gets immutable playback timing.
public IReadOnlyList<VisualStoryChapter> Chapters { get; } #Gets detached scene boundaries for seeking.