API Reference
RecordingExportOptions
How a recording is exported: screen size, frame rate, speed, theme, font and window frame.
Inheritance
- Object
- RecordingExportOptions
Usage
Explore 6 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.
Accepted by parameters 6
- Method Recording.Export
- Method Recording.ExportAsciicast
- Method Recording.ExportHtml
- Method Recording.ExportPlayerData
- Method Recording.ExportSvg
- Method Recording.Save
Constructors
public RecordingExportOptions() #Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public ExportTheme Theme { get; set; } #Dark (default) or Light. Auto is treated as Dark: a recording is played in one scheme.
public ITheme? CustomTheme { get; set; } #A custom theme to render with (default: the built-in dark or light theme).
public String? Title { get; set; } #The title (page title, title bar, asciicast title).
public Boolean WindowChrome { get; set; } #Draws a window frame with a title bar (HTML and SVG).
public String FontFamily { get; set; } #The font stack (see ExportOptions.DefaultFontFamily).
public Double LineHeight { get; set; } #The cell height as a multiple of the font size (default 1.2).
public Double FramesPerSecond { get; set; } #Frames per second sampled from the recording (default 10; identical frames are merged).
public Int32 MaxFrames { get; set; } #The most frames kept; a longer recording is sampled less often (default 900).
public Double Speed { get; set; } #Playback speed multiplier baked into the export (default 1).
public TimeSpan HoldLastFrame { get; set; } #How long the last frame stays before the animation loops or ends (default 2 seconds).
public Boolean Loop { get; set; } #SVG only: loops the animation (default true).
public GlyphTier Glyphs { get; set; } #The glyph tier (default GlyphTier.Full).
public CultureInfo? Culture { get; set; } #The culture for numbers and dates (default: the current culture).
public Int32 Padding { get; set; } #Space around the screen in pixels (default 12).
public DateTimeOffset? Timestamp { get; set; } #Asciicast only: the recording time written to the header (default: none).