API Reference
VisualStoryAnimationOptions
Configures animated raster export for a generic visual story.
Inheritance
- Object
- VisualStoryAnimationOptions
Usage
Explore 15 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 7
- Method VisualStoryAnimationOptions.Create
- Method VisualStoryAnimationOptions.WithEndHold
- Method VisualStoryAnimationOptions.WithFramesPerSecond
- Method VisualStoryAnimationOptions.WithLoop
- Method VisualStoryAnimationOptions.WithMaximumFrames
- Method VisualStoryAnimationOptions.WithOutputScale
- Method VisualStoryAnimationOptions.WithTransition
Accepted by parameters 8
- Extension method VisualStory.SaveApng
- Extension method VisualStory.SaveGif
- Extension method VisualStory.ToApng
- Extension method VisualStory.ToGif
- Method VisualStoryExtensions.SaveApng
- Method VisualStoryExtensions.SaveGif
- Method VisualStoryExtensions.ToApng
- Method VisualStoryExtensions.ToGif
Constructors
public VisualStoryAnimationOptions() #Methods
public static VisualStoryAnimationOptions Create() #VisualStoryAnimationOptionsCreates options with documentation and Discord-friendly defaults.
public VisualStoryAnimationOptions WithEndHold(Double seconds) #VisualStoryAnimationOptionsSets how long the completed scene remains visible.
Parameters
- seconds System.Double
public VisualStoryAnimationOptions WithFramesPerSecond(Int32 framesPerSecond) #VisualStoryAnimationOptionsSets the requested frame rate.
Parameters
- framesPerSecond System.Int32
public VisualStoryAnimationOptions WithLoop(Boolean loop = true) #VisualStoryAnimationOptionsConfigures whether the animation repeats.
Parameters
- loop System.Boolean = true
public VisualStoryAnimationOptions WithMaximumFrames(Int32 maximumFrames) #VisualStoryAnimationOptionsSets the maximum sampled frame count.
Parameters
- maximumFrames System.Int32
public VisualStoryAnimationOptions WithOutputScale(Int32 scale) #VisualStoryAnimationOptionsSets the raster output density multiplier.
Parameters
- scale System.Int32
public VisualStoryAnimationOptions WithTransition(Double seconds) #VisualStoryAnimationOptionsSets the cross-fade duration between scenes.
Parameters
- seconds System.Double
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public Int32 FramesPerSecond { get; private set; } #Gets the requested frame rate.
public Boolean Loop { get; private set; } #Gets whether the animation repeats.
public Double EndHoldSeconds { get; private set; } #Gets the completed-state hold time.
public Int32 OutputScale { get; private set; } #Gets the raster output density multiplier.
public Int32 MaximumFrames { get; private set; } #Gets the maximum sampled frame count; export produces frames one at a time.
public Double TransitionSeconds { get; private set; } #Gets the cross-fade duration between scenes.