Class

RecordingExportOptionsFluent

ConsoleMonster.Export

Namespace: ConsoleMonster.Export
Assembly: ConsoleMonster
Modifiers: static
Attributes: GeneratedCode("ConsoleMonster.Generators", "1.0.0")

The fluent methods of RecordingExportOptions, generated from its public properties: A property-named method sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

object
RecordingExportOptionsFluent

Methods

public static RecordingExportOptions AddMarker(RecordingExportOptions recordingExportOptions, RecordingMarker item) #

Adds an item to RecordingExportOptions.Markers: Chapters and export instructions at source recording times.

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
item ConsoleMonster.Export.RecordingMarker required: The item.

Returns

RecordingExportOptions The same instance.

AddMarkers 2 overloads

public static RecordingExportOptions AddMarkers(RecordingExportOptions recordingExportOptions, params RecordingMarker[] items)

Adds items to RecordingExportOptions.Markers: Chapters and export instructions at source recording times.

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
items ConsoleMonster.Export.RecordingMarker[] required: The items, in order.

Returns

RecordingExportOptions The same instance.

public static RecordingExportOptions AddMarkers(RecordingExportOptions recordingExportOptions, IEnumerable<RecordingMarker> items)

Adds items to RecordingExportOptions.Markers: Chapters and export instructions at source recording times.

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Export.RecordingMarker> required: The items, in order.

Returns

RecordingExportOptions The same instance.

public static RecordingExportOptions ChapterHold(RecordingExportOptions recordingExportOptions, TimeSpan value) #

Sets RecordingExportOptions.ChapterHold: Extra time to freeze the screen at each chapter marker (default zero).

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value System.TimeSpan required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                        // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { ChapterHold = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().ChapterHold(value);

public static RecordingExportOptions ChromeStyle(RecordingExportOptions recordingExportOptions, WindowChromeStyle value) #

Sets RecordingExportOptions.ChromeStyle: The title bar style when WindowChrome is true (default MacOS). None hides chrome.

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value ConsoleMonster.Export.WindowChromeStyle required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                        // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { ChromeStyle = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().ChromeStyle(value);

public static RecordingExportOptions Culture(RecordingExportOptions recordingExportOptions, CultureInfo? value) #

Sets RecordingExportOptions.Culture: The culture for numbers and dates (default: the current culture).

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value System.Globalization.CultureInfo? required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                    // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Culture = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().Culture(value);

public static RecordingExportOptions CustomTheme(RecordingExportOptions recordingExportOptions, ITheme? value) #

Sets RecordingExportOptions.CustomTheme: A custom theme to render with (default: the built-in dark or light theme).

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value ConsoleMonster.Styling.ITheme? required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                        // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { CustomTheme = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().CustomTheme(value);

public static RecordingExportOptions FontFamily(RecordingExportOptions recordingExportOptions, string value) #

Sets RecordingExportOptions.FontFamily: The font stack (see ExportOptions.DefaultFontFamily).

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value string required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                       // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { FontFamily = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().FontFamily(value);

public static RecordingExportOptions FontSize(RecordingExportOptions recordingExportOptions, double value) #

Sets RecordingExportOptions.FontSize: The font size in pixels (default 14).

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value double required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                     // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { FontSize = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().FontSize(value);

public static RecordingExportOptions FramesPerSecond(RecordingExportOptions recordingExportOptions, double value) #

Sets RecordingExportOptions.FramesPerSecond: Frames per second sampled from the recording (default 10; identical frames are merged).

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value double required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                            // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { FramesPerSecond = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().FramesPerSecond(value);

public static RecordingExportOptions Glyphs(RecordingExportOptions recordingExportOptions, GlyphTier value) #

Sets RecordingExportOptions.Glyphs: The glyph tier (default GlyphTier.Full).

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value ConsoleMonster.Capabilities.GlyphTier required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                   // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Glyphs = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().Glyphs(value);

public static RecordingExportOptions Height(RecordingExportOptions recordingExportOptions, int value) #

Sets RecordingExportOptions.Height: Screen height in cells (default 30).

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value int required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                   // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Height = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().Height(value);

public static RecordingExportOptions HoldLastFrame(RecordingExportOptions recordingExportOptions, TimeSpan value) #

Sets RecordingExportOptions.HoldLastFrame: How long the last frame stays before the animation loops or ends (default 2 seconds).

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value System.TimeSpan required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                          // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { HoldLastFrame = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().HoldLastFrame(value);

public static RecordingExportOptions IdleLimit(RecordingExportOptions recordingExportOptions, TimeSpan value) #

Sets RecordingExportOptions.IdleLimit: Maximum source delay on an unchanged screen after speed scaling; zero disables capping (default 2 seconds). Reading and explicit holds are never capped.

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value System.TimeSpan required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { IdleLimit = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().IdleLimit(value);

public static RecordingExportOptions LineHeight(RecordingExportOptions recordingExportOptions, double value) #

Sets RecordingExportOptions.LineHeight: The cell height as a multiple of the font size (default 1.2).

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value double required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                       // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { LineHeight = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().LineHeight(value);

Loop 2 overloads

public static RecordingExportOptions Loop(RecordingExportOptions recordingExportOptions, bool value) #

Sets RecordingExportOptions.Loop: SVG only: loops the animation (default true).

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value bool required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Loop = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().Loop(value);

public static RecordingExportOptions Loop(RecordingExportOptions recordingExportOptions) #

Sets RecordingExportOptions.Loop to true.

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance to configure.

Returns

RecordingExportOptions The same instance.

public static RecordingExportOptions MaxFrames(RecordingExportOptions recordingExportOptions, int value) #

Sets RecordingExportOptions.MaxFrames: Regular sample limit; longer recordings are sampled less often (default 900). Exact marker and trim boundaries are also kept.

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value int required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { MaxFrames = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().MaxFrames(value);

public static RecordingExportOptions Pace(RecordingExportOptions recordingExportOptions, RecordingPace value) #

Sets RecordingExportOptions.Pace: Reading pace. An explicitly assigned value overrides recorded pace directives.

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value ConsoleMonster.Export.RecordingPace required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Pace = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().Pace(value);

public static RecordingExportOptions Padding(RecordingExportOptions recordingExportOptions, int value) #

Sets RecordingExportOptions.Padding: Space around the screen in pixels (default 12).

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value int required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                    // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Padding = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().Padding(value);

public static RecordingExportOptions Speed(RecordingExportOptions recordingExportOptions, double value) #

Sets RecordingExportOptions.Speed: Playback speed multiplier baked into the export (default 1).

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value double required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Speed = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().Speed(value);

public static RecordingExportOptions Theme(RecordingExportOptions recordingExportOptions, ExportTheme value) #

Sets RecordingExportOptions.Theme: Dark (default) or Light. Auto is treated as Dark: a recording is played in one scheme.

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value ConsoleMonster.Export.ExportTheme required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Theme = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().Theme(value);

public static RecordingExportOptions Timestamp(RecordingExportOptions recordingExportOptions, DateTimeOffset? value) #

Sets RecordingExportOptions.Timestamp: Asciicast only: the recording time written to the header (default: none).

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value System.DateTimeOffset? required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Timestamp = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().Timestamp(value);

public static RecordingExportOptions Title(RecordingExportOptions recordingExportOptions, string? value) #

Sets RecordingExportOptions.Title: The title (page title, title bar, asciicast title).

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value string? required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Title = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().Title(value);

public static RecordingExportOptions TrimEnd(RecordingExportOptions recordingExportOptions, TimeSpan? value) #

Sets RecordingExportOptions.TrimEnd: Exclusive source time at which to end; null includes the final screen.

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value System.TimeSpan? required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                    // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { TrimEnd = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().TrimEnd(value);

public static RecordingExportOptions TrimEndChapter(RecordingExportOptions recordingExportOptions, string? value) #

Sets RecordingExportOptions.TrimEndChapter: End before this chapter's marker. Cannot be combined with TrimEnd.

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value string? required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                           // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { TrimEndChapter = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().TrimEndChapter(value);

public static RecordingExportOptions TrimStart(RecordingExportOptions recordingExportOptions, TimeSpan? value) #

Sets RecordingExportOptions.TrimStart: Inclusive source time at which to begin; null begins at zero.

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value System.TimeSpan? required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { TrimStart = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().TrimStart(value);

public static RecordingExportOptions TrimStartChapter(RecordingExportOptions recordingExportOptions, string? value) #

Sets RecordingExportOptions.TrimStartChapter: Begin at this chapter's marker. Cannot be combined with TrimStart.

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value string? required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                             // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { TrimStartChapter = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().TrimStartChapter(value);

public static RecordingExportOptions Width(RecordingExportOptions recordingExportOptions, int value) #

Sets RecordingExportOptions.Width: Screen width in cells (zero detects, fallback 100).

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value int required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Width = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().Width(value);

WindowChrome 2 overloads

public static RecordingExportOptions WindowChrome(RecordingExportOptions recordingExportOptions, bool value) #

Sets RecordingExportOptions.WindowChrome: Enables the chosen RecordingExportOptions.ChromeStyle. False always hides chrome; style None also hides it.

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance.
value bool required: The value.

Returns

RecordingExportOptions The same instance.

Examples

// C# initializer or property                                                         // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { WindowChrome = value };    Ui.Options<global::ConsoleMonster.Export.RecordingExportOptions>().WindowChrome(value);

public static RecordingExportOptions WindowChrome(RecordingExportOptions recordingExportOptions) #

Sets RecordingExportOptions.WindowChrome to true.

Parameters

recordingExportOptions ConsoleMonster.Export.RecordingExportOptions required: The instance to configure.

Returns

RecordingExportOptions The same instance.

Inheritance

Methods

Inherited Methods