API Reference
TerminalStoryAnimationOptions
Configures animated raster export for a terminal story.
Inheritance
- Object
- TerminalStoryAnimationOptions
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 6
Accepted by parameters 8
- Extension method TerminalStory.SaveApng
- Extension method TerminalStory.SaveGif
- Extension method TerminalStory.ToApng
- Extension method TerminalStory.ToGif
- Method TerminalStoryExtensions.SaveApng
- Method TerminalStoryExtensions.SaveGif
- Method TerminalStoryExtensions.ToApng
- Method TerminalStoryExtensions.ToGif
Constructors
public TerminalStoryAnimationOptions() #Methods
public static TerminalStoryAnimationOptions Create() #TerminalStoryAnimationOptionsCreates animation options with Discord-friendly defaults.
public TerminalStoryAnimationOptions WithEndHold(Double seconds) #TerminalStoryAnimationOptionsSets how long the completed state remains visible from the first completed sample.
Parameters
- seconds System.Double
public TerminalStoryAnimationOptions WithFramesPerSecond(Int32 framesPerSecond) #TerminalStoryAnimationOptionsSets the maximum sampling frame rate.
Parameters
- framesPerSecond System.Int32
public TerminalStoryAnimationOptions WithLoop(Boolean loop = true) #TerminalStoryAnimationOptionsConfigures whether the animation repeats.
Parameters
- loop System.Boolean = true
public TerminalStoryAnimationOptions WithMaximumFrames(Int32 maximumFrames) #TerminalStoryAnimationOptionsSets the frame budget used to bound memory and file size.
Parameters
- maximumFrames System.Int32
public TerminalStoryAnimationOptions WithOutputScale(Int32 scale) #TerminalStoryAnimationOptionsSets the raster output density multiplier.
Parameters
- scale System.Int32
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public Int32 FramesPerSecond { get; private set; } #Gets the maximum sampling frame rate. GIF and APNG round the regular interval up to a whole centisecond.
public Boolean Loop { get; private set; } #Gets whether the animation repeats.
public Double EndHoldSeconds { get; private set; } #Gets the completed-state hold time before the animation repeats or ends, measured from the first completed sample.
public Int32 OutputScale { get; private set; } #Gets the raster output density multiplier.
public Int32 MaximumFrames { get; private set; } #Gets the maximum number of rendered frames.