Utility classes

For an introduction, see the Datatypes overview.

AdvancedColorPicker

Advanced colour-picker control surface — exposes four named numeric properties (Red, Green, Blue, optional Alpha) on a target object as a single colour value the property panel renders with a colour wheel, RGBA sliders, and a hex readout. Used by components that need a richer picker than the simple System.Drawing.Color type. Wires colour changes through to the four underlying properties on Owner and raises ColorChangedCallBack for ad-hoc subscribers.

AudioMeter

Audio level meter readout — used by operators that expose a live audio level (e.g. Sidechain Ducking, EBU R128) and by the Audio Mixer for VU display. Holds left/right channel peak levels in decibels, optional peak-hold values, clip warnings, and a pre-formatted display string. All values are populated by the engine — typically read-only from a script.

Command

A button-style action exposed by a component to the property panel and the Script Engine. Wraps a target object plus a MethodInfo reflection handle to the method to invoke; the property panel renders one labelled button per Command property and calls Execute() on click. From a script, call the named command via ExecuteCommand() / ExecuteCommandById(). Multiple related commands can be grouped horizontally via CommandGroup.

CommandGroup

Groups 2–4 Command objects so the property system can render them as a single compact, horizontal button strip instead of stacking each command on its own row.

ComponentLog

Per-component log buffer — a bounded ring of recent FormattedMessage entries (info / warning / error) that the property panel renders below a component's normal property table. Components expose one as a property to surface short diagnostic messages without flooding the application log; consecutive duplicate lines are suppressed and the oldest entry is dropped when the buffer reaches its Capacity (default 10).

DecklinkCaptureChannel

A single SDI / HDMI channel on a Blackmagic Decklink capture card, identified by its zero-based driver-side index and the human-readable label the driver assigns it. Used wherever a Decklink-related property (input source, output channel) needs to round-trip a stable channel identity across project saves.

DynamicIntSlider

An integer slider whose min/max bounds can be changed at runtime. Use this instead of EditorSliderAttribute when the range is not known at compile time (e.g. frame count of a loaded file).

Font

Lightweight font handle — a single named font family (e.g. "Arial", "Inter") used by text-rendering components to refer to a font without embedding the full System.Drawing.FontFamily object. The rendering layer resolves the name against the host's installed fonts at render time.

FormattedMessage

A timestamped log line with a severity tag — the basic unit stored in a component's ComponentLog ring buffer and surfaced in the property panel's per-component log readout. Captures the message text, the moment it was created, and a FormattedMessageType hint that drives styling (e.g. red for error, yellow for warning).

GainReductionMeterData

Read-out for a gain-reduction meter — used by dynamics-shaping operators (Compressor, Limiter, Sidechain Ducking) to expose the amount of gain the processor is currently subtracting from the signal. The property panel renders this as a downward-pointing meter; 0 dB is the resting position (no reduction), and the bar grows downward as the processor clamps harder.

HttpString

Wraps a single HTTP / HTTPS URL string. Used in component properties where a URL is the natural value (webhook endpoint, asset URL, remote config) so the property panel can render it with URL-aware validation and an "open in browser" affordance instead of treating it as a plain string. IsValidUrl() performs a cheap sanity check (non-empty and contains http); fuller validation is the consumer's responsibility.

JoystickControl

A 2D joystick data type for the property system. When a component exposes a property of this type, the property panel renders a circular joystick pad control. X and Y each range from -1.0 to +1.0 with (0, 0) at centre (rest position); the joystick snaps back to centre when the user releases the mouse and raises Released.

LayerRenderInfo

Represents rendering information for a specific layer.

PropertyNote

Represents a property type that displays additional informational text, optionally with an icon and a hyperlink, to provide clarification or context for another property. Supports configurable visibility and layout margins.

StringCollectionEnum

A "dynamic enum" — a single selected string drawn from a collection of allowed values that's populated at runtime rather than fixed at compile time. The property panel renders this as a dropdown bound to SourceCollection; useful when the available choices depend on runtime state (loaded fonts, attached devices, scenes in the project, etc.) and a true C# enum won't work because the values aren't known until the project is loaded.

TimeCode

A frame-accurate timecode — hours / minutes / seconds / frames — used to express a position or duration that's tied to a project frame rate rather than wall-clock time. Round-trips to and from a "H:MM:SS:FFf" string via ToString() / Parse; convenience constructors create a TimeCode from milliseconds or FFmpeg AVRational time values for a given frame rate.

TimeStamp

A presentation timestamp expressed as a count plus a time base — the FFmpeg-native way of representing time without floating-point drift. The actual time in seconds is Index × TimeBase.num / TimeBase.den; ToString() renders it as "hh:mm:ss:fff". Used wherever the engine needs to round-trip a precise position from libav into a component property without losing precision through a double.