Overlay Type Definitions

Use this page when you need the exact overlay event shapes. If you are working on chat or alerts specifically, start with the guides below, then use the full type files only when you need the raw declarations.

Best path for common overlay events

The easiest way to work with overlay events is:

1. Use this page to understand the base ChatEvent and AlertEvent shapes.
2. Use the alert explorer to inspect what each alert returns.
3. Use the raw type files below only when you need full TypeScript detail.

ChatEvent

Overview

At a glance

Every simple chat handler receives the flattened chat message payload. In other words,

Overlay.on('chat')

receives the fields from Lumia's internal chat

info

object plus

origin .

data
|- origin
|- id
|- username
|- displayname
|- channel
|- avatar
|- message
|- color
|- badges
|- badgesLookup
|- badgesRaw
|- emotesRaw
|- emotesPack
|- isCheer
|- reply
|- isPowerup
|- powerupType
|- powerupName
|- sharedMessage
|- lumiauserlevels
|- userLevels
|  |- isSelf
|  |- broadcaster
|  |- mod
|  |- vip
|  |- tier3
|  |- tier2
|  |- subscriber
|  |- regular
|  |- follower
|  '- anyone
|- time
'- timestamp

Common fields

Field	What it means	Example
data.origin	Platform that sent the message.	twitch
data.id	Platform message ID when available.	9f9b8e50-...
data.username	Account username or login.	lumiastream
data.displayname	Display name when the platform provides one.	LumiaStream
data.channel	Channel or room where the message was sent.	#lumiastream
data.avatar	User avatar URL when available.	https://...
data.message	Chat message text after Lumia filtering.	!count
data.color	User chat color when available.	#6441a5
data.badges	Badge IDs or image URLs used by chatbox rendering.	['broadcaster/1']
data.badgesLookup	Platform badge lookup map for resolving badge IDs.	{ broadcaster: 'https://...' }
data.badgesRaw	Raw badge string from the platform.	broadcaster/1,subscriber/12
data.emotesRaw	Raw emote string from the platform.	25:0-4
data.emotesPack	Platform-specific emote metadata used by emote parsers.	{ '25': ['0-4'] }
data.reply	Reply metadata when this message replies to another chat message.	{ username: 'viewer', body: 'hello' }
data.isPowerup	Whether the chat message is a Twitch Power-up.	true
data.powerupType	Twitch Power-up type when present.	animated-message
data.powerupName	Twitch Power-up animation name when present.	simmer
data.sharedMessage	Shared chat source metadata when Twitch shared chat provides it.	{ displayname, avatar, userId }
data.lumiauserlevels	Numeric Lumia user level IDs for the chatter.	[0, 2]
data.userLevels	Boolean user level map for role checks.	{ mod: true, anyone: true, ... }
data.time	Local HH:mm:ss time generated by Lumia.	14:30:05
data.timestamp	Millisecond timestamp generated by Lumia.	1773257405123

How to use it

Prefer

data.displayname || data.username

for names, and check optional platform-specific fields before using them.

Overlay.on('chat')

Overlay.on('chat', (data) => {
  const name = data.displayname || data.username || 'Unknown';
  const platform = data.origin;

  console.log(`[${platform}] ${name}: ${data.message}`);

  if (data.reply) {
    console.log(`Replying to ${data.reply.username}: ${data.reply.body}`);
  }

  if (data.isPowerup) {
    console.log(`Power-up: ${data.powerupType} / ${data.powerupName}`);
  }
});

Tips

What trips people up

• Not every platform provides avatar, color, badges, reply, or emote fields.
• data.message is the chat message string to display or match commands against.
• data.origin is the platform value to use for platform-specific behavior.
• data.userLevels is best for boolean checks like data.userLevels?.mod; data.lumiauserlevels is the numeric Lumia level list.
• Twitch-only fields such as isPowerup, powerupType, powerupName, and sharedMessage should be treated as optional.

AlertEvent

Overview

At a glance

Every overlay alert handler receives the same high-level object shape. The exact fields inside

data.dynamic

and

data.extraSettings

depend on

data.alert.

data
|- alert: LumiaAlertValues
|- dynamic
|  '- value: number | string
|- extraSettings
|  |- username
|  |- displayname
|  |- userId
|  |- avatar
|  |- timestamp
|  |- site
|  |- checkTimingType
|  |- timingType
|  '- duration
'- fromLumia

How template variables map to alert payload

The same alert variables you use in Lumia templates are usually exposed to overlays under

data.extraSettings.

In alert templates	In Overlay.on('alert')	Notes
{{username}}	data.extraSettings.username	Template alert variable and overlay payload field for the same value.
{{message}}	data.extraSettings.message	Only present on alerts that include a message.
{{amount}}	data.extraSettings.amount	Common on donations, bits, super chats, and other paid events.
{{currencySymbol}}	data.extraSettings.currencySymbol	Useful for overlay display formatting.
{{stickerId}}	data.extraSettings.stickerId	Example: YouTube Super Sticker payloads.
{{stickerName}}	data.extraSettings.stickerName	Human-readable label that matches the alert variable name.
variation value	data.dynamic.value	Use for alert variation logic, not the main payload bridge.

Rule: alert variables like {{username}} map to data.extraSettings.username. Use data.dynamic only for variation-matching values.

Common fields

Field	What it means	Example
data.alert	The alert identifier, such as twitch follower or youtube superchat.	LumiaAlertValues.TWITCH_FOLLOWER
data.dynamic	The alert's dynamic matching payload. This changes by alert type.	{ value: 5 }
data.extraSettings	The main payload object overlays usually read from.	{ username, amount, currency, ... }
data.extraSettings.username	Origin username when the platform provides it.	lumiastream
data.extraSettings.displayname	Display name when available.	LumiaStream
data.extraSettings.site	Origin platform for the alert.	twitch
data.extraSettings.timestamp	When the alert happened.	2026-03-15T14:30:00.000Z
data.fromLumia	Whether the event came through Lumia's internal pipeline.	true

How to use it

Narrow by

data.alert

first, then read the fields that belong to that alert from

data.extraSettings.

Overlay.on('alert')

Overlay.on('alert', (data) => {
  switch (data.alert) {
    case LumiaAlertValues.TWITCH_FOLLOWER:
      console.log(`New follower: ${data.extraSettings.username}`);
      break;

    case LumiaAlertValues.YOUTUBE_SUPERCHAT:
      console.log(
        `${data.extraSettings.username} sent ${data.extraSettings.currencySymbol}${data.extraSettings.amount}`
      );
      break;

    default:
      console.log('Alert type:', data.alert);
      console.log('Returned fields:', data.extraSettings);
  }
});

Tips

What trips people up

• Do not assume every alert has message, amount, or avatar.
• Use data.alert to decide which fields are safe to read.
• Alert template variables like {{username}} map to overlay payload fields like data.extraSettings.username.
• Most overlay code should read from data.extraSettings, not from guessed field names.
• Use the alert explorer to inspect the exact fields for each alert.

When to use each doc

Need	Best place
See which fields a specific alert returns	Platform Variables: Alert Explorer
Understand the base overlay event shapes	This page
Read the full generated TypeScript declarations	Raw type tabs below

Raw Type Files

These are sourced directly from the published package and kept here for full reference.

Overlay Types

Full file

Source:

@lumiastream/lumia-types/dist/custom-overlays/custom-overlays.d.ts

custom-overlays.d.ts

// -----------------------------------------------------------------------------
//  Lumia Stream - Custom Overlay typings
// -----------------------------------------------------------------------------

/**
 * Available tabs in the custom overlay editor interface
 */
export enum CustomTabs {
	/** HTML content tab */
	HTML = 'html',
	/** JavaScript code tab */
	JS = 'js',
	/** CSS styling tab */
	CSS = 'css',
	/** Configuration settings tab */
	CONFIGS = 'configs',
	/** Data storage tab */
	DATA = 'data',
}

/**
 * Field types available for the overlay configuration tab.
 * These determine the UI controls shown for each config option.
 */
export enum ConfigsFieldType {
	/** Text input field */
	INPUT = 'input',
	/** Multi-line text area for long-form content. */
	TEXTAREA = 'textarea',
	/** Numeric input field */
	NUMBER = 'number',
	/** Boolean checkbox */
	CHECKBOX = 'checkbox',
	/** Single-select dropdown menu */
	DROPDOWN = 'dropdown',
	/** Multi-select dropdown menu */
	MULTISELECT = 'multiselect',
	/** Color picker widget */
	COLORPICKER = 'colorpicker',
	/** Font selection widget */
	FONTPICKER = 'fontpicker',
	/** Number Slider widget */
	SLIDER = 'slider',
	/** Image upload picker. Value is the uploaded asset URL. */
	IMAGEUPLOAD = 'imageupload',
	/** Audio upload picker. Value is the uploaded asset URL. */
	SOUNDUPLOAD = 'soundupload',
	/** Video upload picker. Value is the uploaded asset URL. */
	VIDEOUPLOAD = 'videoupload',
	/** Action trigger button. No persisted value; renders a clickable
	 *  control that custom JS can bind to via `Overlay.on('configAction', …)`. */
	ACTIONBUTTON = 'actionbutton',
}

/**
 * A single conditional render rule for a config field.
 * The field is shown only when `Overlay.data[key]` strictly equals one of `equals`
 * (scalar) or intersects with `equals` (when either side is an array).
 *
 * @example
 * { key: 'mode', equals: 'advanced' }
 * { key: 'platform', equals: ['twitch', 'kick'] }
 */
export interface ConfigVisibleIf {
	/** Key of another config field to read from `Overlay.data`. */
	key: string;
	/** Value (or list of values) that triggers visibility. */
	equals: string | number | boolean | Array<string | number | boolean>;
}

/**
 * Conditional render rule, or a list of rules. When an array is supplied, the
 * field is shown only when **every** rule matches (logical AND), letting you
 * gate a field on several keys at once.
 *
 * @example
 * // single key
 * { key: 'mode', equals: 'advanced' }
 * @example
 * // multiple keys — all must match
 * [
 *   { key: 'color', equals: ['red', 'blue', 'green'] },
 *   { key: 'alerts', equals: ['red', 'blue', 'green'] },
 * ]
 */
export type ConfigVisibleIfRule = ConfigVisibleIf | ConfigVisibleIf[];

/** Properties common to every config field, regardless of `type`. */
export interface BaseConfigField {
	/** Human-readable name shown next to the control in the Configs sidebar. */
	label: string;
	/**
	 * Display order priority. Lower numbers appear first.
	 * Fields without `order` render after ordered fields, sorted alphabetically by key.
	 */
	order?: number;
	/**
	 * Conditional render rule. When set, the field renders only when
	 * `Overlay.data[visibleIf.key]` matches `visibleIf.equals`. Pass an array of
	 * rules to require that **every** rule matches (logical AND across keys).
	 */
	visibleIf?: ConfigVisibleIfRule;
	/**
	 * Hard-hide rule. When `true`, the field is never displayed in the Configs
	 * sidebar, but its `value` still flows into `Overlay.data` for internal use.
	 * Useful for locking event subscriptions or advanced settings.
	 */
	hidden?: boolean;
}

/** Single-line text input. Supports Lumia variable insertion. */
export interface InputConfigField extends BaseConfigField {
	type: ConfigsFieldType.INPUT | 'input';
	/** Default text value. Omit to leave blank on first load. */
	value?: string;
	/** Placeholder text shown when the input is empty. */
	placeholder?: string;
	/**
	 * When `true`, renders a variable-enabled input. Users can insert Lumia
	 * variables (e.g. `{{username}}`) via a picker triggered by a `{}` adornment.
	 */
	enableVariables?: boolean;
	/**
	 * Curated variable list to surface at the top of the picker.
	 * System/function variables remain available below. Has no effect unless
	 * `enableVariables` is also `true`.
	 */
	allowedVariables?: string[];
}

/** Numeric input spinner. */
export interface NumberConfigField extends BaseConfigField {
	type: ConfigsFieldType.NUMBER | 'number';
	/** Default numeric value. */
	value?: number;
}

/** Checkbox toggle. */
export interface CheckboxConfigField extends BaseConfigField {
	type: ConfigsFieldType.CHECKBOX | 'checkbox';
	/** Default checked state. */
	value?: boolean;
}

/** Single-select dropdown menu. */
export interface DropdownConfigField extends BaseConfigField {
	type: ConfigsFieldType.DROPDOWN | 'dropdown';
	/** Default selected option key. */
	value?: string;
	/** Map of option keys to display labels. */
	options: Record<string, string>;
}

/** Multi-select dropdown. */
export interface MultiselectConfigField extends BaseConfigField {
	type: ConfigsFieldType.MULTISELECT | 'multiselect';
	/** Default selected option keys. */
	value?: string[];
	/** Map of option keys to display labels. */
	options: Record<string, string>;
}

/** Color picker widget. Value is a hex/rgba string. */
export interface ColorpickerConfigField extends BaseConfigField {
	type: ConfigsFieldType.COLORPICKER | 'colorpicker';
	/** Default color (hex like `#ff4076` or rgba). */
	value?: string;
}

/** Font picker that loads Google fonts on demand. Value is the font family name. */
export interface FontpickerConfigField extends BaseConfigField {
	type: ConfigsFieldType.FONTPICKER | 'fontpicker';
	/** Default font family name (e.g. `Roboto`). */
	value?: string;
}

/** Slider numeric-range options. */
export interface SliderOptions {
	/** Minimum value. */
	min?: number;
	/** Maximum value. */
	max?: number;
	/** Step increment between values. */
	step?: number;
	/** String prefixed to the displayed value (e.g. `$`). */
	prefix?: string;
	/** String suffixed to the displayed value (e.g. `px`). */
	suffix?: string;
}

/** Number slider with min/max/step and optional value adornments. */
export interface SliderConfigField extends BaseConfigField {
	type: ConfigsFieldType.SLIDER | 'slider';
	/** Default numeric value. */
	value?: number;
	/** Range and adornment options. */
	options: SliderOptions;
}

/** Multi-line textarea for long-form text input. Supports variables. */
export interface TextareaConfigField extends BaseConfigField {
	type: ConfigsFieldType.TEXTAREA | 'textarea';
	/** Default text value. Omit to leave blank on first load. */
	value?: string;
	/** Placeholder text shown when the textarea is empty. */
	placeholder?: string;
	/** Visible row count for the textarea. Defaults to 4 in the renderer. */
	rows?: number;
	/**
	 * When `true`, renders a variable-enabled textarea. Users can insert Lumia
	 * variables (e.g. `{{username}}`) via a picker triggered by a `{}` adornment.
	 */
	enableVariables?: boolean;
	/**
	 * Curated variable list to surface at the top of the picker. Has no effect
	 * unless `enableVariables` is also `true`.
	 */
	allowedVariables?: string[];
}

/** Image upload picker. Value is the uploaded asset's URL. */
export interface ImageuploadConfigField extends BaseConfigField {
	type: ConfigsFieldType.IMAGEUPLOAD | 'imageupload';
	/** Default image URL. */
	value?: string;
	/** Optional comma-separated accept hint, e.g. `image/png,image/jpeg`. */
	accept?: string;
}

/** Audio clip upload picker. Value is the uploaded asset's URL. */
export interface SounduploadConfigField extends BaseConfigField {
	type: ConfigsFieldType.SOUNDUPLOAD | 'soundupload';
	/** Default audio URL. */
	value?: string;
	/** Optional comma-separated accept hint, e.g. `audio/mpeg,audio/ogg`. */
	accept?: string;
}

/** Video upload picker. Value is the uploaded asset's URL. */
export interface VideouploadConfigField extends BaseConfigField {
	type: ConfigsFieldType.VIDEOUPLOAD | 'videoupload';
	/** Default video URL. */
	value?: string;
	/** Optional comma-separated accept hint, e.g. `video/mp4,video/webm`. */
	accept?: string;
}

/**
 * Action trigger button. The control surface is a labelled button; clicking it
 * dispatches an event the overlay's custom JS can subscribe to via
 * `Overlay.on('configAction', ({ key }) => …)`. No persisted value.
 */
export interface ActionbuttonConfigField extends BaseConfigField {
	type: ConfigsFieldType.ACTIONBUTTON | 'actionbutton';
	/** Optional button-text override. Defaults to the field `label`. */
	buttonLabel?: string;
}

/**
 * Discriminated union of every config-field shape the renderer accepts.
 * Use this when typing the `configs` map for a Lumia custom overlay.
 *
 * @example
 * const configs: ConfigsSchema = {
 *   font: { type: 'fontpicker', label: 'Font', value: 'Roboto' },
 *   size: {
 *     type: 'slider',
 *     label: 'Font size',
 *     value: 48,
 *     options: { min: 10, max: 120, step: 2, suffix: 'px' },
 *   },
 * };
 */
export type ConfigField =
	| InputConfigField
	| TextareaConfigField
	| NumberConfigField
	| CheckboxConfigField
	| DropdownConfigField
	| MultiselectConfigField
	| ColorpickerConfigField
	| FontpickerConfigField
	| SliderConfigField
	| ImageuploadConfigField
	| SounduploadConfigField
	| VideouploadConfigField
	| ActionbuttonConfigField;

/**
 * The configs map a custom overlay declares in its Configs tab.
 * Keys become accessible at runtime as `Overlay.data[key]`.
 */
export type ConfigsSchema = Record<string, ConfigField>;

/**
 * Core event types that overlays can listen to.
 * Used as discriminants for the overlay event system.
 */
export type OverlayListener = 'chat' | 'alert' | 'hfx' | 'virtuallight' | 'overlaycontent';

export type ChatUserLevelKey = 'isSelf' | 'broadcaster' | 'mod' | 'vip' | 'tier3' | 'tier2' | 'subscriber' | 'regular' | 'follower' | 'anyone';

export type ChatUserLevels = Record<ChatUserLevelKey, boolean>;

export interface ChatReply {
	/** Username of the message being replied to */
	username: string;
	/** Body of the message being replied to */
	body: string;
}

export interface ChatSharedMessage {
	/** Avatar for the source user/channel of the shared message */
	avatar: string;
	/** Display name for the source user/channel of the shared message */
	displayname: string;
	/** User ID for the source user/channel of the shared message */
	userId: string;
}

/**
 * Chat message event data structure.
 * Fired when a chat message is received from any connected platform.
 */
export interface ChatEvent {
	/** Platform origin (e.g., "twitch", "kick", "youtube", "tiktok") */
	origin: string;
	/** Unique message identifier when the platform provides one */
	id?: string;
	/** User's account username/login */
	username?: string;
	/** User's display name (may differ from username) */
	displayname?: string;
	/** Channel name where the message was sent */
	channel?: string;
	/** URL to the user's avatar image */
	avatar?: string | null;
	/** The chat message content */
	message?: string;
	/** User's chat color as hex code (e.g., "#00FF7F") */
	color?: string;
	/** Badge identifiers or badge image URLs */
	badges?: string[];
	/** Lookup map used by some platforms to resolve badge identifiers to image URLs */
	badgesLookup?: Record<string, string>;
	/** Raw badge data string (e.g., "broadcaster/1,subscriber/12,vip/1") */
	badgesRaw?: string;
	/** Raw emotes data string from the platform */
	emotesRaw?: string;
	/** Emote pack data structure; shape varies by platform */
	emotesPack?: Record<string, unknown>;
	/** Whether the message contains a cheer/bits event */
	isCheer?: boolean;
	/** Reply data if this message is a reply to another */
	reply?: ChatReply | null;
	/** Whether this is a Twitch Power-up message */
	isPowerup?: boolean;
	/** Twitch Power-up message type */
	powerupType?: 'animated-message' | 'gigantified-emote-message' | string | false;
	/** Twitch Power-up animation name */
	powerupName?: 'simmer' | 'rainbow-eclipse' | 'cosmic-abyss' | string | false;
	/** Shared chat source metadata when Twitch shared chat provides it */
	sharedMessage?: ChatSharedMessage;
	/** Lumia-specific user level identifiers */
	lumiauserlevels?: number[];
	/** User permission levels and roles */
	userLevels?: ChatUserLevels;
	/** Local HH:mm:ss time string generated by Lumia */
	time?: string;
	/** Millisecond timestamp generated by Lumia */
	timestamp?: number;
}

/**
 * Alert event data structure.
 * Fired when stream alerts occur (follows, subs, donations, etc).
 */
export interface AlertEvent {
	/** Type of alert from LumiaAlertValues enum */
	alert: LumiaAlertValues;
	/**
	 * Event-specific mutable values. `value` is the common amount (bits, raid
	 * viewers, sub tier, donation amount, …) but most alerts add their own fields —
	 * e.g. subs carry `isGift`, `giftAmount`, `isResub`, `subMonths`. For the exact
	 * per-alert shape see `AlertDynamic<T>` in `custom-overlays-alerts.d.ts`.
	 */
	dynamic: { value?: number | string; [key: string]: unknown };
	/**
	 * Additional metadata about the alert. The fields below are common to most
	 * alerts; alert-specific fields are merged in too — see `AlertExtra<T>` in
	 * `custom-overlays-alerts.d.ts`.
	 */
	extraSettings: {
		/** Username of the person triggering the alert */
		username: string;
		/** Display name of the person triggering the alert */
		displayname: string;
		/** User's unique identifier */
		userId: number;
		/** URL to the user's avatar image (if available) */
		avatar: string | null;
		/** ISO timestamp when the alert occurred */
		timestamp: string;
		/** Platform where the alert originated */
		site: 'twitch' | 'kick' | 'youtube' | 'tiktok' | 'facebook' | string;
		/** Lumia queue/activity origin type (e.g., "alert", "chat", "chatbot", "system") */
		originType?: 'system' | 'alert' | 'chat' | 'chatbot' | 'twitch-points' | 'twitch-extension' | 'kick-points' | 'api' | 'lumiastreamlink' | 'streamdeck' | 'touchportal' | 'avermedia' | 'loupedeck' | string;
		/** Whether timing type should be checked */
		checkTimingType: boolean;
		/** Type of timing for the alert */
		timingType: string;
		/** Alert display duration in milliseconds */
		duration: number;
		/** Alert-specific extra fields (e.g. subPlan, gifter, recipients, message). */
		[key: string]: unknown;
	};
	/** Whether this alert was triggered from Lumia itself */
	fromLumia: boolean;
}

/**
 * HFX (Heads-up Effects) event data structure.
 * Fired when visual/audio effects are triggered.
 */
export interface HfxEvent {
	/** Effect layer identifier */
	layer: string;
	/** Asset UUID for the effect content */
	content: string;
	/** Command that triggered the effect */
	command: string;
	/** Origin of the effect (e.g., "hudfx", "command") */
	origin: string;
	/** Whether to play audio with the effect */
	playAudio: boolean;
	/** Audio volume (0-1 range) */
	volume: number;
	/** Effect duration in milliseconds */
	duration: number;
	/** Username of the person who triggered the effect */
	username: string;
	/** Associated message (if any) */
	message: string;
	/** URL to the user's avatar image */
	avatar: string;
	/** Command duration in milliseconds (usually same as duration) */
	commandDuration: number;
}

/**
 * Virtual light control event data structure.
 * Fired when smart lights are controlled through Lumia.
 */
export interface VirtualLightEvent {
	/** Unique identifier for the light */
	uuid: string;
	/** Brightness level (0-100) */
	brightness: number;
	/** RGB color values */
	color: {
		/** Red component (0-255) */
		r: number;
		/** Green component (0-255) */
		g: number;
		/** Blue component (0-255) */
		b: number;
	};
	/** Power state (true = on, false = off) */
	power?: boolean;
	/** Transition time in milliseconds */
	transition: number;
	/** Delay before applying changes in milliseconds */
	delay: number;
	/** How long to maintain the state in milliseconds */
	duration: number;
}

/**
 * Custom overlay content event data structure.
 * Used for sending custom data to specific overlays.
 */
export interface CustomOverlayContentEvent {
	/** Identifier for the target overlay */
	codeId: string;
	/** Arbitrary JSON/string payload for the overlay */
	content: string;
}

/**
 * Union type of all possible overlay events
 */
export type OverlayEvent = ChatEvent | AlertEvent | HfxEvent | VirtualLightEvent | CustomOverlayContentEvent;

/**
 * Type definition for overlay event handlers.
 * @example
 * const handler: OverlayEventHandler = (data) => {
 *   console.log('Event received:', data);
 * };
 */
export type OverlayEventHandler = (data: OverlayEvent) => void;

/**
 * Main Overlay API interface.
 * Available globally as `window.Overlay` in custom overlays.
 */
export interface Overlay {
	/**
	 * Current values from the Data tab (defaults seeded from Configs `value`s,
	 * then overridden by what the user set). Read Config/Data values from here,
	 * e.g. `Overlay.data.fontSize`. There is no bare top-level `data` variable.
	 */
	data: Record<string, any>;

	/**
	 * This overlay's `codeId` (letters, numbers, hyphens, underscores; max 25 chars).
	 * Scopes `saveStorage`/`getStorage` and targets `overlaycontent` messages.
	 */
	codeId: string;

	/**
	 * Register an event listener for chat messages
	 * @param event - Event type "chat"
	 * @param handler - Callback function to handle chat events
	 * @example
	 * window.Overlay.on('chat', (data) => {
	 *   console.log(`${data.displayname}: ${data.message}`);
	 * });
	 */
	on(event: 'chat', handler: (data: ChatEvent) => void): void;

	/**
	 * Register an event listener for alerts
	 * @param event - Event type "alert"
	 * @param handler - Callback function to handle alert events
	 * @example
	 * window.Overlay.on('alert', (data) => {
	 *   if (data.alert === LumiaAlertValues.TWITCH_FOLLOWER) {
	 *     console.log(`New follower: ${data.extraSettings.username}`);
	 *   }
	 * });
	 */
	on(event: 'alert', handler: (data: AlertEvent) => void): void;

	/**
	 * Register an event listener for HFX effects
	 * @param event - Event type "hfx"
	 * @param handler - Callback function to handle HFX events
	 */
	on(event: 'hfx', handler: (data: HfxEvent) => void): void;

	/**
	 * Register an event listener for virtual light controls
	 * @param event - Event type "virtuallight"
	 * @param handler - Callback function to handle virtual light events
	 */
	on(event: 'virtuallight', handler: (data: VirtualLightEvent) => void): void;

	/**
	 * Register an event listener for custom overlay content
	 * @param event - Event type "overlaycontent"
	 * @param handler - Callback function to handle custom content events
	 */
	on(event: 'overlaycontent', handler: (data: CustomOverlayContentEvent) => void): void;

	/**
	 * Register a handler for Configs `actionbutton` clicks. Not a platform event —
	 * it's Configs-driven, needs no `events` declaration, and is independent of the
	 * `OverlayListener` subscriptions. `key` is the field's JSON key; `value` is its
	 * optional `value`.
	 * @param event - Event type "configAction"
	 * @example
	 * window.Overlay.on('configAction', ({ key }) => {
	 *   if (key === 'resetGame') resetGame();
	 * });
	 */
	on(event: 'configAction', handler: (data: { key: string; value?: unknown }) => void): void;

	/**
	 * Execute a Lumia Stream command
	 * @param command - Name of the command to execute
	 * @param extraSettings - Optional parameters for the command
	 * @example
	 * await window.Overlay.callCommand('lights-on', { brightness: 75 });
	 */
	callCommand(command: string, extraSettings?: Record<string, unknown>): Promise<unknown>;

	/**
	 * Send a message to chat through the bot
	 * @param args - Chat message configuration
	 * @returns Promise that resolves when the message is sent
	 * @example
	 * await window.Overlay.chatbot({
	 *   message: 'Thanks for the follow!',
	 *   platform: 'twitch',
	 *   chatAsSelf: false
	 * });
	 */
	chatbot(args: {
		/** The message to send */
		message: string;
		/** Target platform (optional) */
		platform?: string;
		/** Whether to send as the streamer (true) or bot (false) */
		chatAsSelf?: boolean;
	}): Promise<void>;

	/**
	 * Add loyalty points to a user
	 * @param args - User and points configuration
	 * @returns Promise resolving to the user's new total points
	 * @example
	 * const newTotal = await window.Overlay.addLoyaltyPoints({
	 *   value: 100,
	 *   username: 'viewer123',
	 *   platform: 'twitch'
	 * });
	 */
	addLoyaltyPoints(args: {
		/** Number of points to add */
		value: number;
		/** Target username */
		username: string;
		/** User's platform */
		platform: string;
	}): Promise<number>;

	/**
	 * Get a user's current loyalty points balance
	 * @param args - User identification
	 * @returns Promise resolving to the user's current points
	 * @example
	 * const points = await window.Overlay.getLoyaltyPoints({
	 *   username: 'viewer123',
	 *   platform: 'twitch'
	 * });
	 */
	getLoyaltyPoints(args: {
		/** Target username */
		username: string;
		/** User's platform */
		platform: string;
	}): Promise<number>;

	/**
	 * Set a Lumia variable value
	 * @param variable - Variable name
	 * @param value - Value to set
	 * @example
	 * await window.Overlay.setVariable('alertCount', 42);
	 */
	setVariable(variable: string, value: unknown): Promise<unknown>;

	/**
	 * Get a Lumia variable value
	 * @param variable - Variable name
	 * @returns The variable value or undefined if not set
	 * @example
	 * const count = await window.Overlay.getVariable('alertCount');
	 */
	getVariable(variable: string): Promise<unknown | undefined>;

	/**
	 * Save data to persistent overlay storage scoped to this overlay's codeId
	 * @param key - Storage key
	 * @param value - Value to store (will be stringified)
	 * @example
	 * await window.Overlay.saveStorage('theme', 'dark');
	 */
	saveStorage(key: string, value: unknown): Promise<unknown>;

	/**
	 * Retrieve data from persistent overlay storage scoped to this overlay's codeId
	 * @param key - Storage key
	 * @returns The stored value or null if not found
	 * @example
	 * const theme = await window.Overlay.getStorage('theme');
	 */
	getStorage(key: string): Promise<unknown | null>;

	/**
	 * Delete data from persistent overlay storage scoped to this overlay's codeId
	 * @param key - Storage key to remove
	 * @example
	 * await window.Overlay.deleteStorage('theme');
	 */
	deleteStorage(key: string): Promise<unknown>;
}

// -----------------------------------------------------------------------------
// Comprehensive enum of all Lumia alert types.
// Used to identify specific events in AlertEvent.alert field.
// -----------------------------------------------------------------------------

// <auto-generated-start name="LumiaAlertValues" />
export declare enum LumiaAlertValues {
    /** Lumia Stream donation received */
    LUMIASTREAM_DONATION = "lumiastream-donation",
    /** Lumia application opened */
    LUMIASTREAM_LUMIA_OPENED = "lumiastream-lumiaOpened",
    /** Lumia application closed */
    LUMIASTREAM_LUMIA_CLOSED = "lumiastream-lumiaClosed",
    /** Stream mode activated */
    LUMIASTREAM_STREAMMODE_ON = "lumiastream-streammodeOn",
    /** Stream mode deactivated */
    LUMIASTREAM_STREAMMODE_OFF = "lumiastream-streammodeOff",
    /** Raffle started */
    LUMIASTREAM_RAFFLE_START = "lumiastream-raffleStart",
    /** Raffle stopped */
    LUMIASTREAM_RAFFLE_STOP = "lumiastream-raffleStop",
    /** Raffle winner selected */
    LUMIASTREAM_RAFFLE_WINNER = "lumiastream-raffleWinner",
    /** Tournament started */
    LUMIASTREAM_TOURNAMENT_START = "lumiastream-tournamentStart",
    /** Tournament ended */
    LUMIASTREAM_TOURNAMENT_END = "lumiastream-tournamentEnd",
    /** Tournament winner selected */
    LUMIASTREAM_TOURNAMENT_WINNER = "lumiastream-tournamentWinner",
    /** Spin wheel winner selected */
    LUMIASTREAM_SPINWHEEL_WINNER = "lumiastream-spinwheelWinner",
    /** Poll started */
    LUMIASTREAM_POLL_STARTED = "lumiastream-pollStarted",
    /** Poll progress update */
    LUMIASTREAM_POLL_PROGRESSED = "lumiastream-pollProgressed",
    /** Poll ended */
    LUMIASTREAM_POLL_ENDED = "lumiastream-pollEnded",
    /** Viewer queue started */
    LUMIASTREAM_VIEWERQUEUE_STARTED = "lumiastream-viewerqueueStarted",
    /** Viewer queue ended */
    LUMIASTREAM_VIEWERQUEUE_ENDED = "lumiastream-viewerqueueEnded",
    /** Viewer achievement unlocked */
    LUMIASTREAM_VIEWER_ACHIEVEMENT = "lumiastream-viewerAchievement",
    /** Template variable value changed */
    LUMIASTREAM_VARIABLE_CHANGED = "lumiastream-variableChanged",
    /** Roulette winner selected */
    LUMIASTREAM_ROULETTE_WINNER = "lumiastream-rouletteWinner",
    /** Slots winner */
    LUMIASTREAM_SLOTS_WINNER = "lumiastream-slotsWinner",
    /** Twitch extension interaction */
    TWITCH_EXTENSION = "twitch-extension",
    /** Twitch channel points redemption */
    TWITCH_POINTS = "twitch-points",
    /** Twitch stream went live */
    TWITCH_STREAM_LIVE = "twitch-streamLive",
    /** Twitch stream went offline */
    TWITCH_STREAM_OFFLINE = "twitch-streamOffline",
    /** First chat message in stream */
    TWITCH_FIRST_CHATTER = "twitch-firstChatter",
    /** User entered the stream */
    TWITCH_ENTRANCE = "twitch-entrance",
    /** New follower */
    TWITCH_FOLLOWER = "twitch-follower",
    /** Total Session followers count */
    TWITCH_SESSION_FOLLOWERS = "twitch-sessionFollowers",
    /** New subscription */
    TWITCH_SUBSCRIBER = "twitch-subscriber",
    /** Total Session subs count */
    TWITCH_SESSION_SUBS = "twitch-sessionSubs",
    /** Gift subscription given */
    TWITCH_GIFT_SUBSCRIPTION = "twitch-giftSubscription",
    /** Total Session gifts count */
    TWITCH_SESSION_GIFT_SUBSCRIPTIONS = "twitch-sessionGiftSubscriptions",
    /** Incoming raid */
    TWITCH_RAID = "twitch-raid",
    /** Outgoing raid */
    TWITCH_RAID_OUT = "twitch-raidOut",
    /** Bits cheered */
    TWITCH_BITS = "twitch-bits",
    /** Bits combo completed */
    TWITCH_BITS_COMBO = "twitch-bitsCombo",
    /** Total Session bits count */
    TWITCH_SESSION_BITS = "twitch-sessionBits",
    /** Channel points redemption */
    TWITCH_REDEMPTION = "twitch-redemption",
    /** Hype train started */
    TWITCH_HYPETRAIN_STARTED = "twitch-hypetrainStarted",
    /** Hype train progress */
    TWITCH_HYPETRAIN_PROGRESSED = "twitch-hypetrainProgressed",
    /** Hype train level increased */
    TWITCH_HYPETRAIN_LEVEL_PROGRESSED = "twitch-hypetrainLevelProgressed",
    /** Hype train ended */
    TWITCH_HYPETRAIN_ENDED = "twitch-hypetrainEnded",
    /** Poll started */
    TWITCH_POLL_STARTED = "twitch-pollStarted",
    /** Poll progress update */
    TWITCH_POLL_PROGRESSED = "twitch-pollProgressed",
    /** Poll ended */
    TWITCH_POLL_ENDED = "twitch-pollEnded",
    /** Prediction started */
    TWITCH_PREDICTION_STARTED = "twitch-predictionStarted",
    /** Prediction progress update */
    TWITCH_PREDICTION_PROGRESSED = "twitch-predictionProgressed",
    /** Prediction locked */
    TWITCH_PREDICTION_LOCKED = "twitch-predictionLocked",
    /** Prediction ended */
    TWITCH_PREDICTION_ENDED = "twitch-predictionEnded",
    /** Goal started */
    TWITCH_GOAL_STARTED = "twitch-goalStarted",
    /** Goal progress update */
    TWITCH_GOAL_PROGRESSED = "twitch-goalProgressed",
    /** Goal completed */
    TWITCH_GOAL_ENDED = "twitch-goalEnded",
    /** Charity donation */
    TWITCH_CHARITY_DONATION = "twitch-charityDonation",
    /** Charity campaign started */
    TWITCH_CHARITY_CAMPAIGN_STARTED = "twitch-charityCampaignStarted",
    /** Charity campaign progress */
    TWITCH_CHARITY_CAMPAIGN_PROGRESSED = "twitch-charityCampaignProgressed",
    /** Charity campaign stopped */
    TWITCH_CHARITY_CAMPAIGN_STOPPED = "twitch-charityCampaignStopped",
    /** Stream category changed */
    TWITCH_CATEGORY = "twitch-categoryChanged",
    /** Clip created */
    TWITCH_CLIP = "twitch-clip",
    /** User joined channel */
    TWITCH_CHANNEL_JOIN = "twitch-channelJoin",
    /** User left channel */
    TWITCH_CHANNEL_LEAVE = "twitch-channelLeave",
    /** User banned */
    TWITCH_BANNED = "twitch-banned",
    /** User timed out */
    TWITCH_TIMEOUT = "twitch-timeout",
    /** User timeout expired */
    TWITCH_TIMEOUT_OVER = "twitch-timeoutOver",
    /** Shoutout received */
    TWITCH_SHOUTOUT_RECEIVE = "twitch-shoutoutReceive",
    /** User warned */
    TWITCH_WARNED = "twitch-warned",
    /** Suspicious user sent a message */
    TWITCH_SUSPICIOUS_USER_MESSAGE = "twitch-suspiciousUserMessage",
    /** Suspicious user treatment updated */
    TWITCH_SUSPICIOUS_USER_UPDATED = "twitch-suspiciousUserUpdated",
    /** Shield mode started */
    TWITCH_SHIELD_MODE_STARTED = "twitch-shieldModeStarted",
    /** Shield mode ended */
    TWITCH_SHIELD_MODE_ENDED = "twitch-shieldModeEnded",
    /** Ad break started */
    TWITCH_AD_STARTED = "twitch-adStarted",
    /** Ad break ended */
    TWITCH_AD_STOPPED = "twitch-adStopped",
    /** Watch streak milestone */
    TWITCH_WATCH_STREAK = "twitch-watchStreak",
    /** Power-ups used */
    TWITCH_POWERUPS = "twitch-powerups",
    TWITCH_MODIVERSARY = "twitch-modiversary",
    /** YouTube stream went live */
    YOUTUBE_STREAM_LIVE = "youtube-streamLive",
    /** YouTube stream went offline */
    YOUTUBE_STREAM_OFFLINE = "youtube-streamOffline",
    /** First YouTube chat message */
    YOUTUBE_FIRST_CHATTER = "youtube-firstChatter",
    /** YouTube user entrance */
    YOUTUBE_ENTRANCE = "youtube-entrance",
    /** YouTube new subscriber */
    YOUTUBE_SUBSCRIBER = "youtube-subscriber",
    /** YouTube session subscribers */
    YOUTUBE_SESSION_SUBS = "youtube-sessionSubs",
    /** YouTube channel membership */
    YOUTUBE_MEMBER = "youtube-member",
    /** YouTube session members */
    YOUTUBE_SESSION_MEMBERS = "youtube-sessionMembers",
    /** YouTube gift members */
    YOUTUBE_GIFT_MEMBERS = "youtube-giftMembers",
    /** YouTube session gift members */
    YOUTUBE_SESSION_GIFT_MEMBERS = "youtube-sessionGiftMembers",
    /** YouTube Super Chat */
    YOUTUBE_SUPERCHAT = "youtube-superchat",
    /** YouTube session superchats */
    YOUTUBE_SESSION_SUPERCHATS = "youtube-sessionSuperchats",
    /** YouTube Super Sticker */
    YOUTUBE_SUPERSTICKER = "youtube-supersticker",
    /** YouTube session superstickers */
    YOUTUBE_SESSION_SUPERSTICKERS = "youtube-sessionSuperstickers",
    /** YouTube gift event (jewel-based) */
    YOUTUBE_GIFTS = "youtube-gifts",
    /** YouTube session gifts */
    YOUTUBE_SESSION_GIFTS = "youtube-sessionGifts",
    /** YouTube total likes */
    YOUTUBE_LIKE = "youtube-like",
    /** YouTube total views */
    YOUTUBE_VIEWERS = "youtube-viewers",
    /** Facebook stream went live */
    FACEBOOK_STREAM_LIVE = "facebook-streamLive",
    /** Facebook stream went offline */
    FACEBOOK_STREAM_OFFLINE = "facebook-streamOffline",
    /** First Facebook chat message */
    FACEBOOK_FIRST_CHATTER = "facebook-firstChatter",
    /** Facebook user entrance */
    FACEBOOK_ENTRANCE = "facebook-entrance",
    /** Facebook new follower */
    FACEBOOK_FOLLOWER = "facebook-follower",
    /** Facebook reaction */
    FACEBOOK_REACTION = "facebook-reaction",
    /** Facebook stars received */
    FACEBOOK_STAR = "facebook-star",
    /** Facebook support */
    FACEBOOK_SUPPORT = "facebook-support",
    /** Facebook gift subscription */
    FACEBOOK_GIFT_SUBSCRIPTION = "facebook-subscriptionGift",
    /** Facebook share */
    FACEBOOK_SHARE = "facebook-share",
    /** Facebook fan */
    FACEBOOK_FAN = "facebook-fan",
    /** First TikTok chat message */
    TIKTOK_FIRST_CHATTER = "tiktok-firstChatter",
    /** TikTok user entrance */
    TIKTOK_ENTRANCE = "tiktok-entrance",
    /** TikTok new follower */
    TIKTOK_FOLLOWER = "tiktok-follower",
    /** TikTok like received */
    TIKTOK_LIKE = "tiktok-like",
    /** TikTok total likes */
    TIKTOK_TOTAL_LIKES = "tiktok-totalLikes",
    /** TikTok gift received */
    TIKTOK_GIFT = "tiktok-gift",
    /** TikTok paid LIVE-only Super Fan membership event */
    TIKTOK_SUPER_FAN = "tiktok-superFan",
    /** TikTok Super Fan Box event, separate from becoming a Super Fan */
    TIKTOK_SUPER_FAN_BOX = "tiktok-superFanBox",
    /** TikTok treasure chest / envelope event */
    TIKTOK_TREASURE_CHEST = "tiktok-treasureChest",
    /** TikTok question */
    TIKTOK_QUESTION = "tiktok-question",
    /** TikTok LIVE poll event */
    TIKTOK_POLL = "tiktok-poll",
    /** TikTok LIVE shopping / shop purchase event */
    TIKTOK_SHOP_PURCHASE = "tiktok-shopPurchase",
    /** TikTok pinned message */
    TIKTOK_PIN_MESSAGE = "tiktok-pinMessage",
    /** TikTok LIVE battle started */
    TIKTOK_BATTLE_START = "tiktok-battleStart",
    /** TikTok LIVE battle progress update */
    TIKTOK_BATTLE_PROGRESS = "tiktok-battleProgress",
    /** TikTok LIVE battle finished with a final result */
    TIKTOK_BATTLE_END = "tiktok-battleEnd",
    /** TikTok share */
    TIKTOK_SHARE = "tiktok-share",
    /** TikTok stream ended */
    TIKTOK_STREAM_END = "tiktok-streamEnd",
    /** New TikTok video posted */
    TIKTOK_NEW_VIDEO = "tiktok-newVideo",
    /** Kick points earned */
    KICK_POINTS = "kick-points",
    /** First Kick chat message */
    KICK_FIRST_CHATTER = "kick-firstChatter",
    /** Kick user entrance */
    KICK_ENTRANCE = "kick-entrance",
    /** Kick new follower */
    KICK_FOLLOWER = "kick-follower",
    /** Total Session followers count */
    KICK_SESSION_FOLLOWERS = "kick-sessionFollowers",
    /** Kick new subscriber */
    KICK_SUBSCRIBER = "kick-subscriber",
    /** Total Session subs count */
    KICK_SESSION_SUBS = "kick-sessionSubs",
    /** Kick gift subscription */
    KICK_GIFT_SUBSCRIPTION = "kick-subscriptionGift",
    /** Total Session gifts count */
    KICK_SESSION_GIFT_SUBSCRIPTIONS = "kick-sessionGiftSubscriptions",
    /** Kick kicks */
    KICK_KICKS = "kick-kicks",
    /** Kick Session kicks */
    KICK_SESSION_KICKS = "kick-sessionKicks",
    /** Kick host */
    KICK_HOST = "kick-host",
    /** Kick user banned */
    KICK_BANNED = "kick-banned",
    /** Kick user unbanned */
    KICK_UNBANNED = "kick-unbanned",
    /** First Discord message */
    DISCORD_FIRST_CHATTER = "discord-firstChatter",
    /** Discord user entrance */
    DISCORD_ENTRANCE = "discord-entrance",
    /** Streamlabs donation */
    STREAMLABS_DONATION = "streamlabs-donation",
    /** Streamlabs charity donation */
    STREAMLABS_CHARITY = "streamlabs-charity",
    /** Streamlabs merchandise purchase */
    STREAMLABS_MERCH = "streamlabs-merch",
    /** Streamlabs redemption */
    STREAMLABS_REDEMPTION = "streamlabs-redemption",
    /** Streamlabs Prime gift */
    STREAMLABS_PRIMEGIFT = "streamlabs-primegift",
    /** StreamElements donation */
    STREAMELEMENTS_DONATION = "streamelements-donation",
    /** Extra Life donation */
    EXTRALIFE_DONATION = "extralife-donation",
    /** DonorDrive donation */
    DONORDRIVE_DONATION = "donordrive-donation",
    /** Tiltify campaign donation */
    TILTIFY_DONATION = "tiltify-campaignDonation",
    /** Throne gift purchase */
    THRONE_GIFT_PURCHASE = "throne-giftPurchase",
    /** Throne contribution purchase */
    THRONE_CONTRIBUTION_PURCHASE = "throne-contributionPurchase",
    /** Throne gift crowdfunded */
    THRONE_GIFT_CROWDFUNDED = "throne-giftCrowdfunded",
    /** TipeeeStream donation */
    TIPEEESTREAM_DONATION = "tipeeestream-donation",
    /** TreatStream treat */
    TREATSTREAM_TREAT = "treatstream-treat",
    /** Patreon pledge */
    PATREON_PLEDGE = "patreon-campaignPledge",
    /** Ko-fi donation */
    KOFI_DONATION = "kofi-donation",
    /** Ko-fi subscription */
    KOFI_SUBSCRIPTION = "kofi-subscription",
    /** Ko-fi commission */
    KOFI_COMMISSION = "kofi-commission",
    /** Ko-fi shop order */
    KOFI_SHOPORDER = "kofi-shopOrder",
    /** Fourthwall shop order */
    FOURTHWALL_SHOPORDER = "fourthwall-shopOrder",
    /** Fourthwall donation */
    FOURTHWALL_DONATION = "fourthwall-donation",
    /** Fourthwall subscription */
    FOURTHWALL_SUBSCRIPTION = "fourthwall-subscription",
    /** Fourthwall subscription changed */
    FOURTHWALL_SUBSCRIPTION_CHANGED = "fourthwall-subscriptionChanged",
    /** Fourthwall subscription expired */
    FOURTHWALL_SUBSCRIPTION_EXPIRED = "fourthwall-subscriptionExpired",
    /** Fourthwall gift purchase */
    FOURTHWALL_GIFTPURCHASE = "fourthwall-giftpurchase",
    /** Fourthwall giveaway started */
    FOURTHWALL_GIVEAWAY_STARTED = "fourthwall-giveawayStarted",
    /** Fourthwall giveaway ended */
    FOURTHWALL_GIVEAWAY_ENDED = "fourthwall-giveawayEnded",
    /** Fourthwall thank you sent */
    FOURTHWALL_THANKYOU_SENT = "fourthwall-thankyouSent",
    /** Fourthwall newsletter subscribed */
    FOURTHWALL_NEWSLETTER_SUBSCRIBED = "fourthwall-newsletterSubscribed",
    /** OBS profile switched */
    OBS_SWITCH_PROFILE = "obs-switchProfile",
    /** OBS scene switched */
    OBS_SWITCH_SCENE = "obs-switchScene",
    /** OBS scene item visibility changed */
    OBS_SCENE_ITEM_VISIBILITY = "obs-sceneItemVisibility",
    /** OBS scene item hidden */
    OBS_SCENE_ITEM_HIDDEN = "obs-sceneItemHidden",
    /** OBS transition switched */
    OBS_SWITCH_TRANSITION = "obs-switchTransition",
    /** OBS transition started */
    OBS_TRANSITION_BEGIN = "obs-transitionBegin",
    /** OBS transition ended */
    OBS_TRANSITION_END = "obs-transitionEnd",
    /** OBS stream starting */
    OBS_STREAM_STARTING = "obs-streamStarting",
    /** OBS stream stopping */
    OBS_STREAM_STOPPING = "obs-streamStopping",
    /** OBS recording starting */
    OBS_RECORDING_STARTING = "obs-recordingStarting",
    /** OBS recording stopping */
    OBS_RECORDING_STOPPING = "obs-recordingStopping",
    /** OBS media input playback started */
    OBS_MEDIA_INPUT_PLAYBACK_STARTED = "obs-mediaInputPlaybackStarted",
    /** OBS media input playback ended */
    OBS_MEDIA_INPUT_PLAYBACK_ENDED = "obs-mediaInputPlaybackEnded",
    /** OBS virtual camera state changed */
    OBS_VIRTUALCAM_STATE_CHANGED = "obs-virtualcamStateChanged",
    /** OBS screenshot saved */
    OBS_SCREENSHOT_SAVED = "obs-screenshotSaved",
    /** OBS replay buffer saved */
    OBS_REPLAY_BUFFER_SAVED = "obs-replayBufferSaved",
    /** OBS vertical backtrack saved */
    OBS_VERTICAL_BACKTRACK_SAVED = "obs-verticalBacktrackSaved",
    /** OBS vendor-specific event */
    OBS_VENDOR_EVENT = "obs-vendorEvent",
    /** SLOBS scene collection switched */
    SLOBS_SWITCH_SCENE_COLLECTION = "slobs-switchSceneCollection",
    /** SLOBS scene switched */
    SLOBS_SWITCH_SCENE = "slobs-switchScene",
    /** SLOBS scene item visibility changed */
    SLOBS_SCENE_ITEM_VISIBILITY = "slobs-sceneItemVisibility",
    /** SLOBS scene item hidden */
    SLOBS_SCENE_ITEM_HIDDEN = "slobs-sceneItemHidden",
    /** Spotify song changed */
    SPOTIFY_SWITCH_SONG = "spotify-switchSong",
    /** Spotify song started playing */
    SPOTIFY_SONG_PLAYED = "spotify-songPlayed",
    /** Spotify song paused */
    SPOTIFY_SONG_PAUSED = "spotify-songPaused",
    /** YouTube Music song changed */
    YOUTUBEMUSIC_SWITCH_SONG = "youtubemusic-switchSong",
    /** YouTube Music song started playing */
    YOUTUBEMUSIC_SONG_PLAYED = "youtubemusic-songPlayed",
    /** YouTube Music song paused */
    YOUTUBEMUSIC_SONG_PAUSED = "youtubemusic-songPaused",
    /** Now Playing song changed */
    NOWPLAYING_SWITCH_SONG = "nowplaying-switchSong",
    /** Now Playing song started */
    NOWPLAYING_SONG_PLAYED = "nowplaying-songPlayed",
    /** Now Playing song paused */
    NOWPLAYING_SONG_PAUSED = "nowplaying-songPaused",
    /** VLC song changed */
    VLC_SWITCH_SONG = "vlc-switchSong",
    /** VLC song started playing */
    VLC_SONG_PLAYED = "vlc-songPlayed",
    /** VLC song paused */
    VLC_SONG_PAUSED = "vlc-songPaused",
    /** Heart rate update from Pulse */
    PULSE_HEARTRATE = "pulse-heartrate",
    /** Calories burned update from Pulse */
    PULSE_CALORIES = "pulse-calories",
    /** New Twitter/X follower */
    TWITTER_FOLLOWER = "twitter-follower",
    /** Twitter/X like received */
    TWITTER_LIKE = "twitter-like",
    /** Twitter/X retweet */
    TWITTER_RETWEET = "twitter-retweet",
    /** WooCommerce order received */
    WOOCOMMERCE_ORDER = "woocommerce-order",
    /** Streamer.bot action executed */
    STREAMERBOT_ACTION = "streamerbot-action",
    /** Crowd Control effect triggered */
    CROWDCONTROL_EFFECT = "crowdcontrol-effect",
    /** VTube Studio hotkey triggered */
    VTUBESTUDIO_HOTKEY_TRIGGERED = "vtubestudio-hotkeyTriggered",
    /** VTube Studio model loaded */
    VTUBESTUDIO_MODEL_LOADED = "vtubestudio-modelLoaded",
    /** VTube Studio animation started */
    VTUBESTUDIO_ANIMATION_START = "vtubestudio-animationStart",
    /** VTube Studio animation ended */
    VTUBESTUDIO_ANIMATION_END = "vtubestudio-animationEnd",
    /** VTube Studio item added */
    VTUBESTUDIO_ITEM_ADDED = "vtubestudio-itemAdded",
    /** VTube Studio item removed */
    VTUBESTUDIO_ITEM_REMOVED = "vtubestudio-itemRemoved",
    /** VTube Studio background changed */
    VTUBESTUDIO_BACKGROUND_CHANGED = "vtubestudio-backgroundChanged",
    /** Meld stream starting */
    MELD_STREAM_STARTING = "meld-streamStarting",
    /** Meld stream stopping */
    MELD_STREAM_STOPPING = "meld-streamStopping",
    /** Meld recording starting */
    MELD_RECORDING_STARTING = "meld-recordingStarting",
    /** Meld recording stopping */
    MELD_RECORDING_STOPPING = "meld-recordingStopping",
    /** Meld scene switched */
    MELD_SWITCH_SCENE = "meld-switchScene",
    /** Meld vertical scene switched */
    MELD_SWITCH_VERTICAL_SCENE = "meld-switchVerticalScene"
}

// <auto-generated-end name="LumiaAlertValues" />

// -----------------------------------------------------------------------------
// System Variables
// Use the **string values** of this enum inside overlays: e.g. {{twitch_total_subscriber_count}}, not {{TWITCH_TOTAL_SUBSCRIBER_COUNT}}.
// -----------------------------------------------------------------------------

// <auto-generated-start name="SystemVariables" />
export declare enum SystemVariables {
    /** Read from a local file. Example: {{read_file=C:\path\file.txt}}. Use in overlays as {{read_file}}. */
    READ_FILE = "read_file",
    /** Read from a simple GET URL (2s timeout). Example: {{read_url=https://api.example.com}}. Use as {{read_url}}. */
    READ_URL = "read_url",
    /** Selection helper for predefined options. Example: {{selection=first,second}}. Use as {{selection}}. */
    SELECTION = "selection",
    /** Random number between two values. Example: {{random=1,20}}. Use as {{random}}. */
    RANDOM = "random",
    /** Pick a random item from a comma list. Example: {{random_input=a,b,c}}. Use as {{random_input}}. */
    RANDOM_INPUT = "random_input",
    /** Evaluate a math expression. Example: {{math={{var1}}+{{var2}}}}. Use as {{math}}. */
    MATH = "math",
    /** Evaluate a JavaScript expression in a sandbox. Example: {{js=10 * {{var1}}}}. Use as {{js}}. */
    JS = "js",
    /** Compare two values. Example: {{compare={{var1}},>,{{var2}}}}. Use as {{compare}}. */
    COMPARE = "compare",
    /** Round a value to decimal places. Example: {{round={{math={{var1}}/{{var2}}}},2}}. Use as {{round}}. */
    ROUND = "round",
    /** Conditional output based on truthy value. Example: {{if={{compare={{var1}},>,10}},high,low}}. Use as {{if}}. */
    IF = "if",
    /** Return first non-empty input. Example: {{coalesce={{display_name}},{{username}},Anonymous}}. Use as {{coalesce}}. */
    COALESCE = "coalesce",
    /** Check if value is between two numbers. Example: {{between={{var1}},10,50}}. Use as {{between}}. */
    BETWEEN = "between",
    /** Return minimum numeric value. Example: {{min={{v1}},{{v2}},100}}. Use as {{min}}. */
    MIN = "min",
    /** Return maximum numeric value. Example: {{max={{v1}},{{v2}},100}}. Use as {{max}}. */
    MAX = "max",
    /** Extract regex capture group from text. Example: {{regex_extract={{message}},\"(\\d+)\",1}}. Use as {{regex_extract}}. */
    REGEX_EXTRACT = "regex_extract",
    /** Replace text or regex matches. Example: {{replace={{message}},badword,***}}. Use as {{replace}}. */
    REPLACE = "replace",
    /** Format a date with a pattern. Example: {{format_date={{session_start_date}},MM/DD/YYYY hh:mm A}}. Use as {{format_date}}. */
    FORMAT_DATE = "format_date",
    /** Show elapsed time since date in short format. Example: {{time_since={{follow_time}}}}. Use as {{time_since}}. */
    TIME_SINCE = "time_since",
    /** Show time remaining until a future date. Example: {{time_until=2026-12-25T00:00:00Z}}. Use as {{time_until}}. */
    TIME_UNTIL = "time_until",
    /** Current date (no time). Optional IANA timezone: {{today=America/New_York}}. Use as {{today}}. */
    TODAY = "today",
    /** Sum multiple variables. Example: {{sum_variables=twitch_total_follower_count,kick_total_follower_count}}. Use as {{sum_variables}}. */
    SUM_VARIABLES = "sum_variables",
    /** Offset a variable by a number. Example: {{offset_count=twitch_total_follower_count,10}}. Use as {{offset_count}}. */
    OFFSET_COUNT = "offset_count",
    /** Get user-accessible commands. Use as {{get_commands}}. */
    GET_COMMANDS = "get_commands",
    /** Get all commands (full list). Use as {{get_all_commands}}. */
    GET_ALL_COMMANDS = "get_all_commands",
    /** Convert color names to hex; passes through hex. Example: {{convert_color_to_hex=green}}. Use as {{convert_color_to_hex}}. */
    CONVERT_COLOR_TO_HEX = "convert_color_to_hex",
    /** Latest file from a folder. Example: {{get_latest_file_from_folder=C:/Users/Desktop}}. Use as {{get_latest_file_from_folder}}. */
    GET_LATEST_FILE_FROM_FOLDER = "get_latest_file_from_folder",
    /** Random file from a folder. Example: {{get_random_file_from_folder=C:/Users/Desktop}}. Use as {{get_random_file_from_folder}}. */
    GET_RANDOM_FILE_FROM_FOLDER = "get_random_file_from_folder",
    /** Desktop screenshot (monitor selectable). Example: {{screenshot=2}}. Use as {{screenshot}}. */
    SCREENSHOT = "screenshot",
    /** Overlay screenshot. Example: {{overlay_screenshot=Overlay 1}}. Use as {{overlay_screenshot}}. */
    OVERLAY_SCREENSHOT = "overlay_screenshot",
    /** OBS screenshot (scene selectable). Example: {{obs_screenshot=Scene 1}}. Use as {{obs_screenshot}}. */
    OBS_SCREENSHOT = "obs_screenshot",
    /** Save OBS replay buffer (optional delay). Example: {{obs_replay=5}}. Use as {{obs_replay}}. */
    OBS_REPLAY = "obs_replay",
    /** Save OBS vertical replay (optional delay). Example: {{obs_vertical_replay=5}}. Use as {{obs_vertical_replay}}. */
    OBS_VERTICAL_REPLAY = "obs_vertical_replay",
    /** Current queue count. Example: {{get_queue_count}}. Use as {{get_queue_count}}. */
    GET_QUEUE_COUNT = "get_queue_count",
    /** Extract variable(s) from a message. Example: {{get_var_from_msg=name}}. Use as {{get_var_from_msg}}. */
    GET_VAR_FROM_MSG = "get_var_from_msg",
    /** Get loyalty points for a user. Example: {{get_user_loyalty_points=username,twitch}}. Use as {{get_user_loyalty_points}}. */
    GET_USER_LOYALTY_POINTS = "get_user_loyalty_points",
    /** Translate text (Google). Example: {{translate={{message}}|es}}. Use as {{translate}}. */
    TRANSLATE = "translate",
    /** Get the ai response from ai integration. Example: {{ai_prompt={{message}}}}. Use as {{ai_prompt}}. */
    AI_PROMPT = "ai_prompt",
    /** Current weather for a location via wttr.in. Returns a one-line summary like */
    WEATHER = "weather",
    /** Save a value to local storage (persists across restarts, kept out of the variables list) and return it. Example: {{save_local=highscore,100}}. Use as {{save_local}}. */
    SAVE_LOCAL = "save_local",
    /** Load a value saved with save_local; optional fallback when the key is unset. Example: {{load_local=highscore}} or {{load_local=highscore,0}}. Use as {{load_local}}. */
    LOAD_LOCAL = "load_local",
    /** Commands URL/page. Use in overlays as {{commands_url}}. */
    COMMANDS_URL = "commands_url",
    /** Session start time (ISO). Use as {{session_start_date}}. */
    SESSION_START_DATE = "session_start_date",
    /** Last overlay screenshot path. Use as {{last_overlay_screenshot_path}}. */
    LAST_OVERLAY_SCREENSHOT_PATH = "last_overlay_screenshot_path",
    /**
     * Streamer's display name. Platform-agnostic — resolves to the streamer's
     * username on whichever platform is currently connected, preferring the
     * primary platform when multiple are connected. Use as {{streamer}}.
     *
     * Resolution order in the renderer: twitch_username → kick_username →
     * youtube_username → facebook_username → tiktok_username, falling back to
     * '' when no platform is connected. Re-evaluated whenever any of those
     * underlying username variables changes.
     *
     * Useful for templates that want to say "{{streamer}}'s overlay" without
     * knowing which platform the streamer is on — and for SE imports which
     * use the same `{streamer}` token as a platform-agnostic placeholder.
     */
    STREAMER = "streamer",
    /** Last player to trigger a game. Use as {{game_last_player}}. */
    GAME_LAST_PLAYER = "game_last_player",
    /** Lumia app uptime. Use as {{lumia_uptime}}. */
    LUMIA_UPTIME = "lumia_uptime",
    /** ISO timestamp of when the Lumia app started. Use as {{lumia_uptime_timestamp}}. */
    LUMIA_UPTIME_TIMESTAMP = "lumia_uptime_timestamp",
    /** Twitch stream uptime. Use as {{twitch_uptime}}. */
    TWITCH_UPTIME = "twitch_uptime",
    /** ISO timestamp of when the Twitch stream started. Use as {{twitch_uptime_timestamp}}. */
    TWITCH_UPTIME_TIMESTAMP = "twitch_uptime_timestamp",
    /** YouTube stream uptime. Use as {{youtube_uptime}}. */
    YOUTUBE_UPTIME = "youtube_uptime",
    /** ISO timestamp of when the YouTube stream started. Use as {{youtube_uptime_timestamp}}. */
    YOUTUBE_UPTIME_TIMESTAMP = "youtube_uptime_timestamp",
    /** Facebook stream uptime. Use as {{facebook_uptime}}. */
    FACEBOOK_UPTIME = "facebook_uptime",
    /** ISO timestamp of when the Facebook stream started. Use as {{facebook_uptime_timestamp}}. */
    FACEBOOK_UPTIME_TIMESTAMP = "facebook_uptime_timestamp",
    /** Kick stream uptime. Use as {{kick_uptime}}. */
    KICK_UPTIME = "kick_uptime",
    /** ISO timestamp of when the Kick stream started. Use as {{kick_uptime_timestamp}}. */
    KICK_UPTIME_TIMESTAMP = "kick_uptime_timestamp",
    /** TikTok stream uptime. Use as {{tiktok_uptime}}. */
    TIKTOK_UPTIME = "tiktok_uptime",
    /** ISO timestamp of when the TikTok stream started. Use as {{tiktok_uptime_timestamp}}. */
    TIKTOK_UPTIME_TIMESTAMP = "tiktok_uptime_timestamp",
    /** Twitch live status (true/false). Use as {{twitch_live}}. */
    TWITCH_LIVE = "twitch_live",
    /** YouTube live status (true/false). Use as {{youtube_live}}. */
    YOUTUBE_LIVE = "youtube_live",
    /** TikTok live status (true/false). Use as {{tiktok_live}}. */
    TIKTOK_LIVE = "tiktok_live",
    /** Facebook live status (true/false). Use as {{facebook_live}}. */
    FACEBOOK_LIVE = "facebook_live",
    /** Kick live status (true/false). Use as {{kick_live}}. */
    KICK_LIVE = "kick_live",
    /** BRB clips list (comma-separated URLs). Use as {{overlays_brb_clips}}. */
    OVERLAYS_BRB_CLIPS = "overlays_brb_clips",
    /** Last donator name. Use as {{latest_donator}}. */
    LATEST_DONATOR = "latest_donator",
    /** Last donation amount. Use as {{latest_donator_amount}}. */
    LATEST_DONATOR_AMOUNT = "latest_donator_amount",
    /** Last donation currency code. Use as {{latest_donator_currency}}. */
    LATEST_DONATOR_CURRENCY = "latest_donator_currency",
    /** Last donation currency symbol. Use as {{latest_donator_currency_symbol}}. */
    LATEST_DONATOR_CURRENCY_SYMBOL = "latest_donator_currency_symbol",
    /** Top donator this session. Use as {{session_top_donator}}. */
    SESSION_TOP_DONATOR = "session_top_donator",
    /** Top donation amount this session. Use as {{session_top_donator_amount}}. */
    SESSION_TOP_DONATOR_AMOUNT = "session_top_donator_amount",
    /** Top donation currency this session. Use as {{session_top_donator_currency}}. */
    SESSION_TOP_DONATOR_CURRENCY = "session_top_donator_currency",
    /** Top donation currency symbol this session. Use as {{session_top_donator_currency_symbol}}. */
    SESSION_TOP_DONATOR_CURRENCY_SYMBOL = "session_top_donator_currency_symbol",
    /** All-time top donator. Use as {{top_donator}}. */
    TOP_DONATOR = "top_donator",
    /** All-time top donation amount. Use as {{top_donator_amount}}. */
    TOP_DONATOR_AMOUNT = "top_donator_amount",
    /** All-time top donation currency code. Use as {{top_donator_currency}}. */
    TOP_DONATOR_CURRENCY = "top_donator_currency",
    /** All-time top donation currency symbol. Use as {{top_donator_currency_symbol}}. */
    TOP_DONATOR_CURRENCY_SYMBOL = "top_donator_currency_symbol",
    /** Top donators list (last 10). Use as {{top_donator_list}}. */
    TOP_DONATOR_LIST = "top_donator_list",
    /** Amounts for TOP_DONATOR_LIST. Use as {{top_donator_list_amount}}. */
    TOP_DONATOR_LIST_AMOUNT = "top_donator_list_amount",
    /** Currency codes for TOP_DONATOR_LIST. Use as {{top_donator_list_currency}}. */
    TOP_DONATOR_LIST_CURRENCY = "top_donator_list_currency",
    /** Currency symbols for TOP_DONATOR_LIST. Use as {{top_donator_list_currency_symbol}}. */
    TOP_DONATOR_LIST_CURRENCY_SYMBOL = "top_donator_list_currency_symbol",
    /** All-time total donation amount (normalized). Use as {{total_donation_amount}}. */
    TOTAL_DONATION_AMOUNT = "total_donation_amount",
    /** Currency code for TOTAL_DONATION_AMOUNT. Use as {{total_donation_amount_currency}}. */
    TOTAL_DONATION_AMOUNT_CURRENCY = "total_donation_amount_currency",
    /** Currency symbol for TOTAL_DONATION_AMOUNT. Use as {{total_donation_amount_currency_symbol}}. */
    TOTAL_DONATION_AMOUNT_CURRENCY_SYMBOL = "total_donation_amount_currency_symbol",
    /** Session donation sum. Use as {{session_donation_amount}}. */
    SESSION_DONATION_AMOUNT = "session_donation_amount",
    /** Session donation currency code. Use as {{session_donation_amount_currency}}. */
    SESSION_DONATION_AMOUNT_CURRENCY = "session_donation_amount_currency",
    /** Session donation currency symbol. Use as {{session_donation_amount_currency_symbol}}. */
    SESSION_DONATION_AMOUNT_CURRENCY_SYMBOL = "session_donation_amount_currency_symbol",
    /** All-time donation count. Use as {{donation_count}}. */
    DONATION_COUNT = "donation_count",
    /** Session donation count. Use as {{session_donation_count}}. */
    SESSION_DONATION_COUNT = "session_donation_count",
    /** Session donators list. Use as {{session_donator_list}}. */
    SESSION_DONATOR_LIST = "session_donator_list",
    /** Session donators with amounts. Use as {{session_donator_list_with_amount}}. */
    SESSION_DONATOR_LIST_WITH_AMOUNT = "session_donator_list_with_amount",
    /** Raw donation total ignoring currency. Use as {{total_raw_donation_amount}}. */
    TOTAL_RAW_DONATION_AMOUNT = "total_raw_donation_amount",
    /** Donation sum for the current calendar week. Use as {{week_donation_amount}}. */
    WEEK_DONATION_AMOUNT = "week_donation_amount",
    /** Donation sum for the current calendar month. Use as {{month_donation_amount}}. */
    MONTH_DONATION_AMOUNT = "month_donation_amount",
    /** Session-wide gross money across every income source (tips, bits, subs, gift subs, super chats, super stickers, TikTok gifts, kicks, stars…), normalized to your default currency. Use as {{session_money_amount}}. */
    SESSION_MONEY_AMOUNT = "session_money_amount",
    /** Gross money across every income source for the current calendar week. Use as {{week_money_amount}}. */
    WEEK_MONEY_AMOUNT = "week_money_amount",
    /** Gross money across every income source for the current calendar month. Use as {{month_money_amount}}. */
    MONTH_MONEY_AMOUNT = "month_money_amount",
    /** All-time gross money across every income source. Use as {{total_money_amount}}. */
    TOTAL_MONEY_AMOUNT = "total_money_amount",
    /** Donation event count for the current calendar week. Use as {{week_donation_count}}. */
    WEEK_DONATION_COUNT = "week_donation_count",
    /** Donation event count for the current calendar month. Use as {{month_donation_count}}. */
    MONTH_DONATION_COUNT = "month_donation_count",
    /** Top donator for the current calendar week. Use as {{week_top_donator}}. */
    WEEK_TOP_DONATOR = "week_top_donator",
    /** Amount for WEEK_TOP_DONATOR. Use as {{week_top_donator_amount}}. */
    WEEK_TOP_DONATOR_AMOUNT = "week_top_donator_amount",
    /** Top donators this week (top 10, comma-separated usernames). Use as {{week_top_donator_list}}. */
    WEEK_TOP_DONATOR_LIST = "week_top_donator_list",
    /** Amounts for WEEK_TOP_DONATOR_LIST (parallel comma-separated). Use as {{week_top_donator_list_amount}}. */
    WEEK_TOP_DONATOR_LIST_AMOUNT = "week_top_donator_list_amount",
    /** Top donator for the current calendar month. Use as {{month_top_donator}}. */
    MONTH_TOP_DONATOR = "month_top_donator",
    /** Amount for MONTH_TOP_DONATOR. Use as {{month_top_donator_amount}}. */
    MONTH_TOP_DONATOR_AMOUNT = "month_top_donator_amount",
    /** Top donators this month. Use as {{month_top_donator_list}}. */
    MONTH_TOP_DONATOR_LIST = "month_top_donator_list",
    /** Amounts for MONTH_TOP_DONATOR_LIST. Use as {{month_top_donator_list_amount}}. */
    MONTH_TOP_DONATOR_LIST_AMOUNT = "month_top_donator_list_amount",
    /** Followers this session across all platforms. Use as {{session_follower_count}}. */
    SESSION_FOLLOWER_COUNT = "session_follower_count",
    /** Followers this week across all platforms. Use as {{week_follower_count}}. */
    WEEK_FOLLOWER_COUNT = "week_follower_count",
    /** Followers this month across all platforms. Use as {{month_follower_count}}. */
    MONTH_FOLLOWER_COUNT = "month_follower_count",
    /** Lifetime followers across all platforms. Use as {{total_follower_count}}. */
    TOTAL_FOLLOWER_COUNT = "total_follower_count",
    /** Most recent follower (any platform). Use as {{last_follower}}. */
    LAST_FOLLOWER = "last_follower",
    /** Subscribers this session across all platforms (new + resub + gifted). Use as {{session_subscriber_count}}. */
    SESSION_SUBSCRIBER_COUNT = "session_subscriber_count",
    /** New (first-time) subscribers this session. Use as {{session_new_subscribers_count}}. */
    SESSION_NEW_SUBSCRIBERS_COUNT = "session_new_subscribers_count",
    /** Resubscribers this session. Use as {{session_resub_subscribers_count}}. */
    SESSION_RESUB_SUBSCRIBERS_COUNT = "session_resub_subscribers_count",
    /** Gifted subs this session. Use as {{session_gifted_subscribers_count}}. */
    SESSION_GIFTED_SUBSCRIBERS_COUNT = "session_gifted_subscribers_count",
    /** Subscribers this week across all platforms. Use as {{week_subscriber_count}}. */
    WEEK_SUBSCRIBER_COUNT = "week_subscriber_count",
    /** Subscribers this month across all platforms. Use as {{month_subscriber_count}}. */
    MONTH_SUBSCRIBER_COUNT = "month_subscriber_count",
    /** Lifetime subscribers across all platforms. Use as {{total_subscriber_count}}. */
    TOTAL_SUBSCRIBER_COUNT = "total_subscriber_count",
    /** Most recent subscriber (any platform). Use as {{last_subscriber}}. */
    LAST_SUBSCRIBER = "last_subscriber",
    /** All-time top gifter (any platform). Use as {{alltime_top_gifter}}. */
    ALLTIME_TOP_GIFTER = "alltime_top_gifter",
    /** Most recent gifter (any platform), { name, amount }. Use as {{last_gifter}} / {{last_gifter.amount}}. */
    LAST_GIFTER = "last_gifter",
    /** Most recent gift recipient (any platform). Use as {{last_gifted}}. */
    LAST_GIFTED = "last_gifted",
    /** Cheers (bits/kicks) this session across all platforms. Use as {{session_cheers_count}}. */
    SESSION_CHEERS_COUNT = "session_cheers_count",
    /** Cheers this week across all platforms. Use as {{week_cheers_count}}. */
    WEEK_CHEERS_COUNT = "week_cheers_count",
    /** Cheers this month across all platforms. Use as {{month_cheers_count}}. */
    MONTH_CHEERS_COUNT = "month_cheers_count",
    /** Top cheerer (by total bits) this session. Use as {{session_top_cheerer}}. */
    SESSION_TOP_CHEERER = "session_top_cheerer",
    /** Amount for SESSION_TOP_CHEERER. Use as {{session_top_cheerer_amount}}. */
    SESSION_TOP_CHEERER_AMOUNT = "session_top_cheerer_amount",
    /** Top cheerer this week. Use as {{week_top_cheerer}}. */
    WEEK_TOP_CHEERER = "week_top_cheerer",
    /** Amount for WEEK_TOP_CHEERER. Use as {{week_top_cheerer_amount}}. */
    WEEK_TOP_CHEERER_AMOUNT = "week_top_cheerer_amount",
    /** Top cheerer this month. Use as {{month_top_cheerer}}. */
    MONTH_TOP_CHEERER = "month_top_cheerer",
    /** Amount for MONTH_TOP_CHEERER. Use as {{month_top_cheerer_amount}}. */
    MONTH_TOP_CHEERER_AMOUNT = "month_top_cheerer_amount",
    /** All-time top cheerer. Use as {{alltime_top_cheerer}}. */
    ALLTIME_TOP_CHEERER = "alltime_top_cheerer",
    /** Amount for ALLTIME_TOP_CHEERER. Use as {{alltime_top_cheerer_amount}}. */
    ALLTIME_TOP_CHEERER_AMOUNT = "alltime_top_cheerer_amount",
    /** Largest single cheer this session. Use as {{session_top_cheer}}. */
    SESSION_TOP_CHEER = "session_top_cheer",
    /** Amount for SESSION_TOP_CHEER. Use as {{session_top_cheer_amount}}. */
    SESSION_TOP_CHEER_AMOUNT = "session_top_cheer_amount",
    /** Most recent cheer (bits/kicks, any platform), { name, amount }. Use as {{last_cheer}} / {{last_cheer.amount}}. */
    LAST_CHEER = "last_cheer",
    /** Most recent raider/host (any platform). Use as {{last_raider}}. */
    LAST_RAIDER = "last_raider",
    /** Viewer count for LAST_RAIDER. Use as {{last_raid_amount}}. */
    LAST_RAID_AMOUNT = "last_raid_amount",
    /** Raffle title. Use as {{raffle_title}}. */
    RAFFLE_TITLE = "raffle_title",
    /** Raffle description. Use as {{raffle_description}}. */
    RAFFLE_DESCRIPTION = "raffle_description",
    /** Raffle entries (comma-separated). Use as {{raffle_entries}}. */
    RAFFLE_ENTRIES = "raffle_entries",
    /** Raffle generated number. Use as {{raffle_generated_number}}. */
    RAFFLE_GENERATED_NUMBER = "raffle_generated_number",
    /** Raffle entries count. Use as {{raffle_entries_count}}. */
    RAFFLE_ENTRIES_COUNT = "raffle_entries_count",
    /** Raffle winners (comma-separated). Use as {{raffle_winners}}. */
    RAFFLE_WINNERS = "raffle_winners",
    /** Raffle type/mode. Use as {{raffle_type}}. */
    RAFFLE_TYPE = "raffle_type",
    /** Current/last raffle winner username. Use as {{raffle_winner}}. */
    RAFFLE_WINNER = "raffle_winner",
    /** Raffle winner avatar URL. Use as {{raffle_winner_avatar}}. */
    RAFFLE_WINNER_AVATAR = "raffle_winner_avatar",
    /** Command used to enter the raffle (e.g., !join). Use as {{raffle_entry_command}}. */
    RAFFLE_ENTRY_COMMAND = "raffle_entry_command",
    /** Tournament title. Use as {{tournament_title}}. */
    TOURNAMENT_TITLE = "tournament_title",
    /** Tournament description. Use as {{tournament_description}}. */
    TOURNAMENT_DESCRIPTION = "tournament_description",
    /** Tournament game. Use as {{tournament_game}}. */
    TOURNAMENT_GAME = "tournament_game",
    /** Tournament format. Use as {{tournament_format}}. */
    TOURNAMENT_FORMAT = "tournament_format",
    /** Tournament state. Use as {{tournament_state}}. */
    TOURNAMENT_STATE = "tournament_state",
    /** Tournament participants count. Use as {{tournament_participants_count}}. */
    TOURNAMENT_PARTICIPANTS_COUNT = "tournament_participants_count",
    /** Tournament entry command (e.g., !tournament). Use as {{tournament_entry_command}}. */
    TOURNAMENT_ENTRY_COMMAND = "tournament_entry_command",
    /** Tournament winner. Use as {{tournament_winner}}. */
    TOURNAMENT_WINNER = "tournament_winner",
    /** Tournament winner avatar URL. Use as {{tournament_winner_avatar}}. */
    TOURNAMENT_WINNER_AVATAR = "tournament_winner_avatar",
    /** Viewer queue title. Use as {{viewerqueue_title}}. */
    VIEWERQUEUE_TITLE = "viewerqueue_title",
    /** Viewer queue entry command (e.g., !joinq). Use as {{viewerqueue_entry_command}}. */
    VIEWERQUEUE_ENTRY_COMMAND = "viewerqueue_entry_command",
    /** Viewer queue entries (comma-separated). Use as {{viewerqueue_entries}}. */
    VIEWERQUEUE_ENTRIES = "viewerqueue_entries",
    /** Viewer queue selected players (comma-separated). Use as {{viewerqueue_players}}. */
    VIEWERQUEUE_PLAYERS = "viewerqueue_players",
    /** Viewer queue entries count. Use as {{viewerqueue_entries_count}}. */
    VIEWERQUEUE_ENTRIES_COUNT = "viewerqueue_entries_count",
    /** Viewer queue max entries limit. Use as {{viewerqueue_queue_limit}}. */
    VIEWERQUEUE_QUEUE_LIMIT = "viewerqueue_queue_limit",
    /** Achievement id. Use as {{achievement_id}}. */
    ACHIEVEMENT_ID = "achievement_id",
    /** Achievement name. Use as {{achievement_name}}. */
    ACHIEVEMENT_NAME = "achievement_name",
    /** Achievement description. Use as {{achievement_description}}. */
    ACHIEVEMENT_DESCRIPTION = "achievement_description",
    /** Achievements completed count. Use as {{achievements_completed}}. */
    ACHIEVEMENTS_COMPLETED = "achievements_completed",
    /** Achievements total count. Use as {{achievements_total}}. */
    ACHIEVEMENTS_TOTAL = "achievements_total",
    /** Achievement completion percent. Use as {{achievements_percent}}. */
    ACHIEVEMENTS_PERCENT = "achievements_percent",
    /** Response from most recent API Action (JSON stringified). Use as {{api_action_global_response}}. */
    API_ACTION_GLOBAL_RESPONSE = "api_action_global_response",
    /** Last RANDOM_INPUT selection. Use as {{last_random_input}}. */
    LAST_RANDOM_INPUT = "last_random_input",
    /** Loyalty currency display name (e.g., Lumipoints). Use as {{loyalty_currency_name}}. */
    LOYALTY_CURRENCY_NAME = "loyalty_currency_name",
    /** Time a user has followed (followage). Use as {{twitch_followage}}. */
    TWITCH_FOLLOWAGE = "twitch_followage",
    /** Time until next ad. Use as {{twitch_next_ad}}. */
    TWITCH_NEXT_AD = "twitch_next_ad",
    /** Get avatar by username. Example: {{twitch_get_avatar={{message}}}}. Use as {{twitch_get_avatar}}. */
    TWITCH_GET_AVATAR = "twitch_get_avatar",
    /** Channel user ID. Use as {{twitch_user_id}}. */
    TWITCH_USER_ID = "twitch_user_id",
    /** Channel username. Use as {{twitch_username}}. */
    TWITCH_USERNAME = "twitch_username",
    /** Current viewer count. Use as {{twitch_current_viewer_count}}. */
    TWITCH_CURRENT_VIEWER_COUNT = "twitch_current_viewer_count",
    /** Current viewers (comma-separated). Use as {{twitch_current_viewers}}. */
    TWITCH_CURRENT_VIEWERS = "twitch_current_viewers",
    /** Lifetime follower count. Use as {{twitch_total_follower_count}}. */
    TWITCH_TOTAL_FOLLOWER_COUNT = "twitch_total_follower_count",
    /** Current followers (comma-separated). Use as {{twitch_current_followers}}. */
    TWITCH_CURRENT_FOLLOWERS = "twitch_current_followers",
    /** Session followers count. Use as {{twitch_session_follower_count}}. */
    TWITCH_SESSION_FOLLOWER_COUNT = "twitch_session_follower_count",
    /** Followers for the current calendar week. Use as {{twitch_week_follower_count}}. */
    TWITCH_WEEK_FOLLOWER_COUNT = "twitch_week_follower_count",
    /** Followers for the current calendar month. Use as {{twitch_month_follower_count}}. */
    TWITCH_MONTH_FOLLOWER_COUNT = "twitch_month_follower_count",
    /** Current subscribers (comma-separated). Use as {{twitch_current_subscribers}}. */
    TWITCH_CURRENT_SUBSCRIBERS = "twitch_current_subscribers",
    /** Lifetime total subs. Use as {{twitch_total_subscriber_count}}. */
    TWITCH_TOTAL_SUBSCRIBER_COUNT = "twitch_total_subscriber_count",
    /** Session subs count. Use as {{twitch_session_subscribers_count}}. */
    TWITCH_SESSION_SUBSCRIBERS_COUNT = "twitch_session_subscribers_count",
    /** Session NEW subscribers (excluding resubs / gifts). Use as {{twitch_session_new_subscribers_count}}. */
    TWITCH_SESSION_NEW_SUBSCRIBERS_COUNT = "twitch_session_new_subscribers_count",
    /** Session resubscribers (excluding new / gifts). Use as {{twitch_session_resub_subscribers_count}}. */
    TWITCH_SESSION_RESUB_SUBSCRIBERS_COUNT = "twitch_session_resub_subscribers_count",
    /** Session gifted subscribers. Use as {{twitch_session_gifted_subscribers_count}}. */
    TWITCH_SESSION_GIFTED_SUBSCRIBERS_COUNT = "twitch_session_gifted_subscribers_count",
    /** Subscribers for the current calendar week. Use as {{twitch_week_subscriber_count}}. */
    TWITCH_WEEK_SUBSCRIBER_COUNT = "twitch_week_subscriber_count",
    /** Subscribers for the current calendar month. Use as {{twitch_month_subscriber_count}}. */
    TWITCH_MONTH_SUBSCRIBER_COUNT = "twitch_month_subscriber_count",
    /** Session gifts count. Use as {{twitch_session_gifts_count}}. */
    TWITCH_SESSION_GIFTS_COUNT = "twitch_session_gifts_count",
    /** All-time top gifter. Use as {{twitch_alltime_top_gifter}}. */
    TWITCH_ALLTIME_TOP_GIFTER = "twitch_alltime_top_gifter",
    /** Lifetime gift count for TWITCH_ALLTIME_TOP_GIFTER. Use as {{twitch_alltime_top_gifter_amount}}. */
    TWITCH_ALLTIME_TOP_GIFTER_AMOUNT = "twitch_alltime_top_gifter_amount",
    /** Lifetime gift members count. Use as {{twitch_total_gift_subscription_count}}. */
    TWITCH_TOTAL_GIFT_SUBSCRIPTION_COUNT = "twitch_total_gift_subscription_count",
    /** Current moderators (comma-separated). Use as {{twitch_current_mods}}. */
    TWITCH_CURRENT_MODS = "twitch_current_mods",
    /** Last follower. Use as {{twitch_last_follower}}. */
    TWITCH_LAST_FOLLOWER = "twitch_last_follower",
    /** Session followers list. Use as {{twitch_session_follower}}. */
    TWITCH_SESSION_FOLLOWERS = "twitch_session_follower",
    /** Last subscriber of any kind (new sub, resub, or recipient of a gift). Use as {{twitch_last_subscriber}}. */
    TWITCH_LAST_SUBSCRIBER = "twitch_last_subscriber",
    /** Last person to subscribe for the first time (excludes resubs and gift-recipients). Use as {{twitch_last_new_subscriber}}. */
    TWITCH_LAST_NEW_SUBSCRIBER = "twitch_last_new_subscriber",
    /** Last person to extend an existing subscription (any month past month 1, consecutive or not). Use as {{twitch_last_resubscriber}}. */
    TWITCH_LAST_RESUBSCRIBER = "twitch_last_resubscriber",
    /** Last gifter (the person who sent the gift). Use as {{twitch_last_gifter}}. */
    TWITCH_LAST_GIFTER = "twitch_last_gifter",
    /** Last gifted sub amount (number of subs in the last gift drop). Use as {{twitch_last_gifter_amount}}. */
    TWITCH_LAST_GIFTER_AMOUNT = "twitch_last_gifter_amount",
    /** Last gift recipient (the person who received the most recent gifted sub). Use as {{twitch_last_gifted}}. */
    TWITCH_LAST_GIFTED = "twitch_last_gifted",
    /** Session subscribers list. Use as {{twitch_session_subscribers}}. */
    TWITCH_SESSION_SUBSCRIBERS = "twitch_session_subscribers",
    /** Session chat count. Use as {{twitch_session_chat_count}}. */
    TWITCH_SESSION_CHAT_COUNT = "twitch_session_chat_count",
    /** Current first chatter. Use as {{twitch_current_first_chatter}}. */
    TWITCH_CURRENT_FIRST_CHATTER = "twitch_current_first_chatter",
    /** Current first chatter count. Use as {{twitch_current_first_chatter_count}}. */
    TWITCH_CURRENT_FIRST_CHATTER_COUNT = "twitch_current_first_chatter_count",
    /** Previous first chatter. Use as {{twitch_previous_first_chatter}}. */
    TWITCH_PREVIOUS_FIRST_CHATTER = "twitch_previous_first_chatter",
    /** Previous first chatter count. Use as {{twitch_previous_first_chatter_count}}. */
    TWITCH_PREVIOUS_FIRST_CHATTER_COUNT = "twitch_previous_first_chatter_count",
    /** Last chatter. Use as {{twitch_last_chatter}}. */
    TWITCH_LAST_CHATTER = "twitch_last_chatter",
    /** Last raider. Use as {{twitch_last_raider}}. */
    TWITCH_LAST_RAIDER = "twitch_last_raider",
    /** Last raid amount. Use as {{twitch_last_raid_amount}}. */
    TWITCH_LAST_RAID_AMOUNT = "twitch_last_raid_amount",
    /** Session raiders list. Use as {{twitch_session_raiders}}. */
    TWITCH_SESSION_RAIDERS = "twitch_session_raiders",
    /** Lifetime bits total. Use as {{twitch_total_bits_count}}. */
    TWITCH_TOTAL_BITS_COUNT = "twitch_total_bits_count",
    /** Session bits count. Use as {{twitch_session_bits_count}}. */
    TWITCH_SESSION_BITS_COUNT = "twitch_session_bits_count",
    /** Bits for the current calendar week. Use as {{twitch_week_bits_count}}. */
    TWITCH_WEEK_BITS_COUNT = "twitch_week_bits_count",
    /** Bits for the current calendar month. Use as {{twitch_month_bits_count}}. */
    TWITCH_MONTH_BITS_COUNT = "twitch_month_bits_count",
    /** Last bit sender. Use as {{twitch_last_bit}}. */
    TWITCH_LAST_BIT = "twitch_last_bit",
    /** Last bit amount. Use as {{twitch_last_bit_amount}}. */
    TWITCH_LAST_BIT_AMOUNT = "twitch_last_bit_amount",
    /** Session bits list. Use as {{twitch_session_bits}}. */
    TWITCH_SESSION_BITS = "twitch_session_bits",
    /** Session bits with amounts list. Use as {{twitch_session_bits_with_amount}}. */
    TWITCH_SESSION_BITS_WITH_AMOUNT = "twitch_session_bits_with_amount",
    /** Top single cheer this session. Use as {{twitch_session_top_cheer}}. */
    TWITCH_SESSION_TOP_CHEER = "twitch_session_top_cheer",
    /** Amount for TWITCH_SESSION_TOP_CHEER. Use as {{twitch_session_top_cheer_amount}}. */
    TWITCH_SESSION_TOP_CHEER_AMOUNT = "twitch_session_top_cheer_amount",
    /** Top cheerer this session (by total bits). Use as {{twitch_session_top_cheerer}}. */
    TWITCH_SESSION_TOP_CHEERER = "twitch_session_top_cheerer",
    /** Total bits for TWITCH_SESSION_TOP_CHEERER. Use as {{twitch_session_top_cheerer_amount}}. */
    TWITCH_SESSION_TOP_CHEERER_AMOUNT = "twitch_session_top_cheerer_amount",
    /** Top cheerer for the current calendar week. Use as {{twitch_week_top_cheerer}}. */
    TWITCH_WEEK_TOP_CHEERER = "twitch_week_top_cheerer",
    /** Total bits for TWITCH_WEEK_TOP_CHEERER. Use as {{twitch_week_top_cheerer_amount}}. */
    TWITCH_WEEK_TOP_CHEERER_AMOUNT = "twitch_week_top_cheerer_amount",
    /** Top cheerer for the current calendar month. Use as {{twitch_month_top_cheerer}}. */
    TWITCH_MONTH_TOP_CHEERER = "twitch_month_top_cheerer",
    /** Total bits for TWITCH_MONTH_TOP_CHEERER. Use as {{twitch_month_top_cheerer_amount}}. */
    TWITCH_MONTH_TOP_CHEERER_AMOUNT = "twitch_month_top_cheerer_amount",
    /** Whether a hype train is currently active (true/false). Use as {{twitch_hypetrain_active}}. */
    TWITCH_HYPETRAIN_ACTIVE = "twitch_hypetrain_active",
    /** Current hype train level. Use as {{twitch_hypetrain_level}}. */
    TWITCH_HYPETRAIN_LEVEL = "twitch_hypetrain_level",
    /** Current hype train progress toward the next level. Use as {{twitch_hypetrain_progress}}. */
    TWITCH_HYPETRAIN_PROGRESS = "twitch_hypetrain_progress",
    /** Target value to reach the next hype train level. Use as {{twitch_hypetrain_level_goal}}. */
    TWITCH_HYPETRAIN_LEVEL_GOAL = "twitch_hypetrain_level_goal",
    /** Total contributions this hype train (running sum). Use as {{twitch_hypetrain_total}}. */
    TWITCH_HYPETRAIN_TOTAL = "twitch_hypetrain_total",
    /** Top contributor for the current hype train. Use as {{twitch_hypetrain_top_contributor}}. */
    TWITCH_HYPETRAIN_TOP_CONTRIBUTOR = "twitch_hypetrain_top_contributor",
    /** Amount contributed by TWITCH_HYPETRAIN_TOP_CONTRIBUTOR. Use as {{twitch_hypetrain_top_contributor_amount}}. */
    TWITCH_HYPETRAIN_TOP_CONTRIBUTOR_AMOUNT = "twitch_hypetrain_top_contributor_amount",
    /** All-time top cheerer (by total bits). Use as {{twitch_alltime_top_cheerer}}. */
    TWITCH_ALLTIME_TOP_CHEERER = "twitch_alltime_top_cheerer",
    /** Total bits for TWITCH_ALLTIME_TOP_CHEERER. Use as {{twitch_alltime_top_cheerer_amount}}. */
    TWITCH_ALLTIME_TOP_CHEERER_AMOUNT = "twitch_alltime_top_cheerer_amount",
    /** Top cheerers list (top 10, comma-separated usernames, sorted by total bits). Use as {{top_cheerer_list}}. */
    TOP_CHEERER_LIST = "top_cheerer_list",
    /** Total bits for TOP_CHEERER_LIST (parallel comma-separated). Use as {{top_cheerer_list_amount}}. */
    TOP_CHEERER_LIST_AMOUNT = "top_cheerer_list_amount",
    /** Top cheerers this week (top 10, comma-separated usernames). Use as {{week_top_cheerer_list}}. */
    WEEK_TOP_CHEERER_LIST = "week_top_cheerer_list",
    /** Total bits for WEEK_TOP_CHEERER_LIST (parallel comma-separated). Use as {{week_top_cheerer_list_amount}}. */
    WEEK_TOP_CHEERER_LIST_AMOUNT = "week_top_cheerer_list_amount",
    /** Top cheerers this month. Use as {{month_top_cheerer_list}}. */
    MONTH_TOP_CHEERER_LIST = "month_top_cheerer_list",
    /** Total bits for MONTH_TOP_CHEERER_LIST. Use as {{month_top_cheerer_list_amount}}. */
    MONTH_TOP_CHEERER_LIST_AMOUNT = "month_top_cheerer_list_amount",
    /** Top gifters list (top 10, comma-separated usernames, sorted by lifetime gifted subs). Use as {{top_gifter_list}}. */
    TOP_GIFTER_LIST = "top_gifter_list",
    /** Total gifts for TOP_GIFTER_LIST (parallel comma-separated). Use as {{top_gifter_list_amount}}. */
    TOP_GIFTER_LIST_AMOUNT = "top_gifter_list_amount",
    /** Top gifters this week. Use as {{week_top_gifter_list}}. */
    WEEK_TOP_GIFTER_LIST = "week_top_gifter_list",
    /** Total gifts for WEEK_TOP_GIFTER_LIST. Use as {{week_top_gifter_list_amount}}. */
    WEEK_TOP_GIFTER_LIST_AMOUNT = "week_top_gifter_list_amount",
    /** Top gifters this month. Use as {{month_top_gifter_list}}. */
    MONTH_TOP_GIFTER_LIST = "month_top_gifter_list",
    /** Total gifts for MONTH_TOP_GIFTER_LIST. Use as {{month_top_gifter_list_amount}}. */
    MONTH_TOP_GIFTER_LIST_AMOUNT = "month_top_gifter_list_amount",
    /** Last clip ID. Use as {{twitch_last_clip_id}}. */
    TWITCH_LAST_CLIP_ID = "twitch_last_clip_id",
    /** Last clip URL. Use as {{twitch_last_clip_url}}. */
    TWITCH_LAST_CLIP_URL = "twitch_last_clip_url",
    /** Last clip thumbnail URL. Use as {{twitch_last_clip_thumbnail_url}}. */
    TWITCH_LAST_CLIP_THUMBNAIL_URL = "twitch_last_clip_thumbnail_url",
    /** Channel title. Use as {{twitch_channel_title}}. */
    TWITCH_CHANNEL_TITLE = "twitch_channel_title",
    /** Channel description. Use as {{twitch_channel_description}}. */
    TWITCH_CHANNEL_DESCRIPTION = "twitch_channel_description",
    /** Channel avatar URL. Use as {{twitch_avatar}}. */
    TWITCH_AVATAR = "twitch_avatar",
    /** Offline image URL. Use as {{twitch_offline_image}}. */
    TWITCH_OFFLINE_IMAGE = "twitch_offline_image",
    /** Current category/game. Use as {{twitch_category}}. */
    TWITCH_CATEGORY = "twitch_category",
    /** Current category/game ID. Use as {{twitch_category_id}}. */
    TWITCH_CATEGORY_ID = "twitch_category_id",
    /** Current poll ID. Use as {{twitch_current_poll_id}}. */
    TWITCH_CURRENT_POLL_ID = "twitch_current_poll_id",
    /** Current prediction ID. Use as {{twitch_current_prediction_id}}. */
    TWITCH_CURRENT_PREDICTION_ID = "twitch_current_prediction_id",
    /** Channel id. Use as {{youtube_channel_id}}. */
    YOUTUBE_CHANNEL_ID = "youtube_channel_id",
    /** Current live broadcast video id, for embedding the active stream. Use as {{youtube_live_video_id}}. */
    YOUTUBE_LIVE_VIDEO_ID = "youtube_live_video_id",
    /** Second live broadcast video id, for a simultaneous (e.g. vertical) stream. Use as {{youtube_second_live_video_id}}. */
    YOUTUBE_SECOND_LIVE_VIDEO_ID = "youtube_second_live_video_id",
    /** Channel username (custom URL slug, falls back to channel title). Use as {{youtube_username}}. */
    YOUTUBE_USERNAME = "youtube_username",
    /** Current viewer count. Use as {{youtube_current_viewer_count}}. */
    YOUTUBE_CURRENT_VIEWER_COUNT = "youtube_current_viewer_count",
    /** Total viewer count (stream). Use as {{youtube_total_viewer_count}}. */
    YOUTUBE_TOTAL_VIEWER_COUNT = "youtube_total_viewer_count",
    /** Stream likes. Use as {{youtube_stream_likes}}. */
    YOUTUBE_STREAM_LIKES = "youtube_stream_likes",
    /** Stream dislikes. Use as {{youtube_stream_dislikes}}. */
    YOUTUBE_STREAM_DISLIKES = "youtube_stream_dislikes",
    /** Stream chat message count. Use as {{youtube_stream_chat_count}}. */
    YOUTUBE_STREAM_CHAT_COUNT = "youtube_stream_chat_count",
    /** Session chat count. Use as {{youtube_session_chat_count}}. */
    YOUTUBE_SESSION_CHAT_COUNT = "youtube_session_chat_count",
    /** Current first chatter. Use as {{youtube_current_first_chatter}}. */
    YOUTUBE_CURRENT_FIRST_CHATTER = "youtube_current_first_chatter",
    /** Current first chatter count. Use as {{youtube_current_first_chatter_count}}. */
    YOUTUBE_CURRENT_FIRST_CHATTER_COUNT = "youtube_current_first_chatter_count",
    /** Previous first chatter. Use as {{youtube_previous_first_chatter}}. */
    YOUTUBE_PREVIOUS_FIRST_CHATTER = "youtube_previous_first_chatter",
    /** Previous first chatter count. Use as {{youtube_previous_first_chatter_count}}. */
    YOUTUBE_PREVIOUS_FIRST_CHATTER_COUNT = "youtube_previous_first_chatter_count",// keep exact value
    /** Last chatter. Use as {{youtube_last_chatter}}. */
    YOUTUBE_LAST_CHATTER = "youtube_last_chatter",
    /** Session subscriber count. Use as {{youtube_session_subscriber_count}}. */
    YOUTUBE_SESSION_SUBSCRIBER_COUNT = "youtube_session_subscriber_count",
    /** Subscribers for the current calendar week. Use as {{youtube_week_subscriber_count}}. */
    YOUTUBE_WEEK_SUBSCRIBER_COUNT = "youtube_week_subscriber_count",
    /** Subscribers for the current calendar month. Use as {{youtube_month_subscriber_count}}. */
    YOUTUBE_MONTH_SUBSCRIBER_COUNT = "youtube_month_subscriber_count",
    /** Lifetime subscriber count. Use as {{youtube_total_subscriber_count}}. */
    YOUTUBE_TOTAL_SUBSCRIBER_COUNT = "youtube_total_subscriber_count",
    /** Session SuperChat count. Use as {{youtube_session_superchat_count}}. */
    YOUTUBE_SESSION_SUPERCHAT_COUNT = "youtube_session_superchat_count",
    /** Last SuperChatter. Use as {{youtube_last_superchatter}}. */
    YOUTUBE_LAST_SUPERCHATTER = "youtube_last_superchatter",
    /** Session SuperChatters (list). Use as {{youtube_session_superchatters}}. */
    YOUTUBE_SESSION_SUPERCHATTERS = "youtube_session_superchatters",
    /** Session SuperSticker count. Use as {{youtube_session_supersticker_count}}. */
    YOUTUBE_SESSION_SUPERSTICKER_COUNT = "youtube_session_supersticker_count",
    /** Last SuperSticker sender. Use as {{youtube_last_supersticker}}. */
    YOUTUBE_LAST_SUPERSTICKER = "youtube_last_supersticker",
    /** Session SuperStickers (list). Use as {{youtube_session_superstickers}}. */
    YOUTUBE_SESSION_SUPERSTICKERS = "youtube_session_superstickers",
    /** Lifetime member count. Use as {{youtube_total_member_count}}. */
    YOUTUBE_TOTAL_MEMBER_COUNT = "youtube_total_member_count",
    /** Session member count. Use as {{youtube_session_member_count}}. */
    YOUTUBE_SESSION_MEMBER_COUNT = "youtube_session_member_count",
    /** Members for the current calendar week. Use as {{youtube_week_member_count}}. */
    YOUTUBE_WEEK_MEMBER_COUNT = "youtube_week_member_count",
    /** Members for the current calendar month. Use as {{youtube_month_member_count}}. */
    YOUTUBE_MONTH_MEMBER_COUNT = "youtube_month_member_count",
    /** Last member. Use as {{youtube_last_member}}. */
    YOUTUBE_LAST_MEMBER = "youtube_last_member",
    /** Session members (list). Use as {{youtube_session_members}}. */
    YOUTUBE_SESSION_MEMBERS = "youtube_session_members",
    /** Lifetime gift members count. Use as {{youtube_total_gift_members_count}}. */
    YOUTUBE_TOTAL_GIFT_MEMBERS_COUNT = "youtube_total_gift_members_count",
    /** Session gift members count. Use as {{youtube_session_gift_members_count}}. */
    YOUTUBE_SESSION_GIFT_MEMBERS_COUNT = "youtube_session_gift_members_count",
    /** Last gift member. Use as {{youtube_last_gift_member}}. */
    YOUTUBE_LAST_GIFT_MEMBER = "youtube_last_gift_member",
    /** Session gift members (list). Use as {{youtube_session_gift_members}}. */
    YOUTUBE_SESSION_GIFT_MEMBERS = "youtube_session_gift_members",
    /** Lifetime jewels count. Use as {{youtube_total_jewels_count}}. */
    YOUTUBE_TOTAL_JEWELS_COUNT = "youtube_total_jewels_count",
    /** Session jewels count. Use as {{youtube_session_jewels_count}}. */
    YOUTUBE_SESSION_JEWELS_COUNT = "youtube_session_jewels_count",
    /** Last jewel amount. Use as {{youtube_last_jewels}}. */
    YOUTUBE_LAST_JEWELS = "youtube_last_jewels",
    /** Last user that sent jewels. Use as {{youtube_last_jewels_user}}. */
    YOUTUBE_LAST_JEWELS_USER = "youtube_last_jewels_user",
    /** Session jewel gifters (list). Use as {{youtube_session_jewels_gifters}}. */
    YOUTUBE_SESSION_JEWELS_GIFTERS = "youtube_session_jewels_gifters",
    /** Last subscriber. Use as {{youtube_last_subscriber}}. */
    YOUTUBE_LAST_SUBSCRIBER = "youtube_last_subscriber",
    /** Total uploaded videos. Use as {{youtube_total_video_count}}. */
    YOUTUBE_TOTAL_VIDEO_COUNT = "youtube_total_video_count",
    /** Total channel views. Use as {{youtube_total_view_count}}. */
    YOUTUBE_TOTAL_VIEW_COUNT = "youtube_total_view_count",
    /** Page / user id. Use as {{facebook_user_id}}. */
    FACEBOOK_USER_ID = "facebook_user_id",
    /** Page / user username. Use as {{facebook_username}}. */
    FACEBOOK_USERNAME = "facebook_username",
    /** Session chat count. Use as {{facebook_session_chat_count}}. */
    FACEBOOK_SESSION_CHAT_COUNT = "facebook_session_chat_count",
    /** Current first chatter. Use as {{facebook_current_first_chatter}}. */
    FACEBOOK_CURRENT_FIRST_CHATTER = "facebook_current_first_chatter",
    /** Current first chatter count. Use as {{facebook_current_first_chatter_count}}. */
    FACEBOOK_CURRENT_FIRST_CHATTER_COUNT = "facebook_current_first_chatter_count",
    /** Previous first chatter. Use as {{facebook_previous_first_chatter}}. */
    FACEBOOK_PREVIOUS_FIRST_CHATTER = "facebook_previous_first_chatter",
    /** Previous first chatter count. Use as {{facebook_previous_first_chatter_count}}. */
    FACEBOOK_PREVIOUS_FIRST_CHATTER_COUNT = "facebook_previous_first_chatter_count",// keep exact value
    /** Last chatter. Use as {{facebook_last_chatter}}. */
    FACEBOOK_LAST_CHATTER = "facebook_last_chatter",
    /** Lifetime follower count. Use as {{facebook_total_follower_count}}. */
    FACEBOOK_TOTAL_FOLLOWER_COUNT = "facebook_total_follower_count",
    /** Session follower count. Use as {{facebook_session_follower_count}}. */
    FACEBOOK_SESSION_FOLLOWER_COUNT = "facebook_session_follower_count",
    /** Followers for the current calendar week. Use as {{facebook_week_follower_count}}. */
    FACEBOOK_WEEK_FOLLOWER_COUNT = "facebook_week_follower_count",
    /** Followers for the current calendar month. Use as {{facebook_month_follower_count}}. */
    FACEBOOK_MONTH_FOLLOWER_COUNT = "facebook_month_follower_count",
    /** Lifetime fan count. Use as {{facebook_total_fan_count}}. */
    FACEBOOK_TOTAL_FAN_COUNT = "facebook_total_fan_count",
    /** Session fan count. Use as {{facebook_session_fan_count}}. */
    FACEBOOK_SESSION_FAN_COUNT = "facebook_session_fan_count",
    /** Fans for the current calendar week. Use as {{facebook_week_fan_count}}. */
    FACEBOOK_WEEK_FAN_COUNT = "facebook_week_fan_count",
    /** Fans for the current calendar month. Use as {{facebook_month_fan_count}}. */
    FACEBOOK_MONTH_FAN_COUNT = "facebook_month_fan_count",
    /** Session reaction count. Use as {{facebook_reaction_count}}. */
    FACEBOOK_REACTION_COUNT = "facebook_reaction_count",
    /** Last Stars sender. Use as {{facebook_last_star}}. */
    FACEBOOK_LAST_STAR = "facebook_last_star",
    /** Last Stars amount. Use as {{facebook_last_star_amount}}. */
    FACEBOOK_LAST_STAR_AMOUNT = "facebook_last_star_amount",
    /** Session Stars list. Use as {{facebook_session_stars}}. */
    FACEBOOK_SESSION_STARS = "facebook_session_stars",
    /** Session Stars with amounts list. Use as {{facebook_session_stars_with_amount}}. */
    FACEBOOK_SESSION_STARS_WITH_AMOUNT = "facebook_session_stars_with_amount",
    /** Channel user id. Use as {{tiktok_user_id}}. */
    TIKTOK_USER_ID = "tiktok_user_id",
    /** Channel username. Use as {{tiktok_username}}. */
    TIKTOK_USERNAME = "tiktok_username",
    /** Session chat count. Use as {{tiktok_session_chat_count}}. */
    TIKTOK_SESSION_CHAT_COUNT = "tiktok_session_chat_count",
    /** Current first chatter. Use as {{tiktok_current_first_chatter}}. */
    TIKTOK_CURRENT_FIRST_CHATTER = "tiktok_current_first_chatter",
    /** Current first chatter count. Use as {{tiktok_current_first_chatter_count}}. */
    TIKTOK_CURRENT_FIRST_CHATTER_COUNT = "tiktok_current_first_chatter_count",
    /** Previous first chatter. Use as {{tiktok_previous_first_chatter}}. */
    TIKTOK_PREVIOUS_FIRST_CHATTER = "tiktok_previous_first_chatter",
    /** Previous first chatter count. Use as {{tiktok_previous_first_chatter_count}}. */
    TIKTOK_PREVIOUS_FIRST_CHATTER_COUNT = "tiktok_previous_first_chatter_count",// keep exact value
    /** Last chatter. Use as {{tiktok_last_chatter}}. */
    TIKTOK_LAST_CHATTER = "tiktok_last_chatter",
    /** Current viewer count. Use as {{tiktok_current_viewer_count}}. */
    TIKTOK_CURRENT_VIEWER_COUNT = "tiktok_current_viewer_count",
    /** Lifetime follower count. Use as {{tiktok_total_follower_count}}. */
    TIKTOK_TOTAL_FOLLOWER_COUNT = "tiktok_total_follower_count",
    /** Session follower count. Use as {{tiktok_session_follower_count}}. */
    TIKTOK_SESSION_FOLLOWER_COUNT = "tiktok_session_follower_count",
    /** Followers for the current calendar week. Use as {{tiktok_week_follower_count}}. */
    TIKTOK_WEEK_FOLLOWER_COUNT = "tiktok_week_follower_count",
    /** Followers for the current calendar month. Use as {{tiktok_month_follower_count}}. */
    TIKTOK_MONTH_FOLLOWER_COUNT = "tiktok_month_follower_count",
    /** Session super fan count. Use as {{tiktok_session_super_fan_count}}. */
    TIKTOK_SESSION_SUPER_FAN_COUNT = "tiktok_session_super_fan_count",
    /** Session share count. Use as {{tiktok_session_share_count}}. */
    TIKTOK_SESSION_SHARE_COUNT = "tiktok_session_share_count",
    /** Last follower. Use as {{tiktok_last_follower}}. */
    TIKTOK_LAST_FOLLOWER = "tiktok_last_follower",
    /** Last super fan. Use as {{tiktok_last_super_fan}}. */
    TIKTOK_LAST_SUPER_FAN = "tiktok_last_super_fan",
    /** Last gifter. Use as {{tiktok_last_gifter}}. */
    TIKTOK_LAST_GIFTER = "tiktok_last_gifter",
    /** Session gifters (list). Use as {{tiktok_session_gifters}}. */
    TIKTOK_SESSION_GIFTERS = "tiktok_session_gifters",
    /** Session gifts (count/list). Use as {{tiktok_session_gifts}}. */
    TIKTOK_SESSION_GIFTS = "tiktok_session_gifts",
    /** Total gifts. Use as {{tiktok_total_gifts}}. */
    TIKTOK_TOTAL_GIFTS = "tiktok_total_gifts",
    /** Total likes. Use as {{tiktok_total_likes}}. */
    TIKTOK_TOTAL_LIKES = "tiktok_total_likes",
    /** Session likes (running total this session). Use as {{tiktok_session_likes}}. */
    TIKTOK_SESSION_LIKES = "tiktok_session_likes",
    /** Uploaded videos count. Use as {{tiktok_video_count}}. */
    TIKTOK_VIDEO_COUNT = "tiktok_video_count",
    /** Last video title. Use as {{tiktok_last_video_title}}. */
    TIKTOK_LAST_VIDEO_TITLE = "tiktok_last_video_title",
    /** Last video ID. Use as {{tiktok_last_video_id}}. */
    TIKTOK_LAST_VIDEO_ID = "tiktok_last_video_id",
    /** Last video link. Use as {{tiktok_last_video_link}}. */
    TIKTOK_LAST_VIDEO_LINK = "tiktok_last_video_link",
    /** Last video embed URL. Use as {{tiktok_last_video_embed}}. */
    TIKTOK_LAST_VIDEO_EMBED = "tiktok_last_video_embed",
    /** Channel user ID. Use as {{kick_user_id}}. */
    KICK_USER_ID = "kick_user_id",
    /** Channel username. Use as {{kick_username}}. */
    KICK_USERNAME = "kick_username",
    /** Channel title. Use as {{kick_channel_title}}. */
    KICK_CHANNEL_TITLE = "kick_channel_title",
    /** Channel description. Use as {{kick_channel_description}}. */
    KICK_CHANNEL_DESCRIPTION = "kick_channel_description",
    /** Channel avatar URL. Use as {{kick_avatar}}. */
    KICK_AVATAR = "kick_avatar",
    /** Current category. Use as {{kick_category}}. */
    KICK_CATEGORY = "kick_category",
    /** Current category ID. Use as {{kick_category_id}}. */
    KICK_CATEGORY_ID = "kick_category_id",
    /** Stream title. Use as {{kick_stream_title}}. */
    KICK_STREAM_TITLE = "kick_stream_title",
    /** Session chat count. Use as {{kick_session_chat_count}}. */
    KICK_SESSION_CHAT_COUNT = "kick_session_chat_count",
    /** Current first chatter. Use as {{kick_current_first_chatter}}. */
    KICK_CURRENT_FIRST_CHATTER = "kick_current_first_chatter",
    /** Current first chatter count. Use as {{kick_current_first_chatter_count}}. */
    KICK_CURRENT_FIRST_CHATTER_COUNT = "kick_current_first_chatter_count",
    /** Previous first chatter. Use as {{kick_previous_first_chatter}}. */
    KICK_PREVIOUS_FIRST_CHATTER = "kick_previous_first_chatter",
    /** Previous first chatter count. Use as {{kick_previous_first_chatter_count}}. */
    KICK_PREVIOUS_FIRST_CHATTER_COUNT = "kick_previous_first_chatter_count",// keep exact value
    /** Last chatter. Use as {{kick_last_chatter}}. */
    KICK_LAST_CHATTER = "kick_last_chatter",
    /** Current viewer count. Use as {{kick_current_viewer_count}}. */
    KICK_CURRENT_VIEWER_COUNT = "kick_current_viewer_count",
    /** Lifetime follower count. Use as {{kick_total_follower_count}}. */
    KICK_TOTAL_FOLLOWER_COUNT = "kick_total_follower_count",
    /** Session follower count. Use as {{kick_session_follower_count}}. */
    KICK_SESSION_FOLLOWER_COUNT = "kick_session_follower_count",
    /** Followers for the current calendar week. Use as {{kick_week_follower_count}}. */
    KICK_WEEK_FOLLOWER_COUNT = "kick_week_follower_count",
    /** Followers for the current calendar month. Use as {{kick_month_follower_count}}. */
    KICK_MONTH_FOLLOWER_COUNT = "kick_month_follower_count",
    /** Lifetime total subs. Use as {{kick_total_subscriber_count}}. */
    KICK_TOTAL_SUBSCRIBER_COUNT = "kick_total_subscriber_count",
    /** Session subs count. Use as {{kick_session_subscriber_count}}. */
    KICK_SESSION_SUBSCRIBER_COUNT = "kick_session_subscriber_count",
    /** Subscribers for the current calendar week. Use as {{kick_week_subscriber_count}}. */
    KICK_WEEK_SUBSCRIBER_COUNT = "kick_week_subscriber_count",
    /** Subscribers for the current calendar month. Use as {{kick_month_subscriber_count}}. */
    KICK_MONTH_SUBSCRIBER_COUNT = "kick_month_subscriber_count",
    /** Session gifts count. Use as {{kick_session_gifts_count}}. */
    KICK_SESSION_GIFTS_COUNT = "kick_session_gifts_count",
    /** Session subscribers list. Use as {{kick_session_subscribers}}. */
    KICK_SESSION_SUBSCRIBERS = "kick_session_subscribers",
    /** Last user to send a Kicks. Use as {{kick_last_kicks}}. */
    KICK_LAST_KICKS = "kick_last_kicks",
    /** Last amount of a Kicks sent. Use as {{kick_last_kicks_amount}}. */
    KICK_LAST_KICKS_AMOUNT = "kick_last_kicks_amount",
    /** Lifetime kicks count. Use as {{kick_total_kicks_count}}. */
    KICK_TOTAL_KICKS_COUNT = "kick_total_kicks_count",
    /** Session kicks count. Use as {{kick_session_kicks_count}}. */
    KICK_SESSION_KICKS_COUNT = "kick_session_kicks_count",
    /** Session kicks list. Use as {{kick_session_kicks}}. */
    KICK_SESSION_KICKS = "kick_session_kicks",
    /** Session kicks with amounts list. Use as {{kick_session_kicks_with_amount}}. */
    KICK_SESSION_KICKS_WITH_AMOUNT = "kick_session_kicks_with_amount",
    /** Last follower. Use as {{kick_last_follower}}. */
    KICK_LAST_FOLLOWER = "kick_last_follower",
    /** Last subscriber. Use as {{kick_last_subscriber}}. */
    KICK_LAST_SUBSCRIBER = "kick_last_subscriber",
    /** Last gifter (the person who sent the gift). Use as {{kick_last_gifter}}. */
    KICK_LAST_GIFTER = "kick_last_gifter",
    /** Last gifted sub amount (number of subs in the last gift drop). Use as {{kick_last_gifter_amount}}. */
    KICK_LAST_GIFTER_AMOUNT = "kick_last_gifter_amount",
    /** Last gift recipient (the person who received the most recent gifted sub on Kick). Use as {{kick_last_gifted}}. */
    KICK_LAST_GIFTED = "kick_last_gifted",
    /** Last host. Use as {{kick_last_host}}. */
    KICK_LAST_HOST = "kick_last_host",
    /** Last host viewer amount. Use as {{kick_last_host_amount}}. */
    KICK_LAST_HOST_AMOUNT = "kick_last_host_amount",
    /** Lifetime gift members count. Use as {{kick_total_gift_subscription_count}}. */
    KICK_TOTAL_GIFT_SUBSCRIPTION_COUNT = "kick_total_gift_subscription_count",
    /** Get avatar by username. Use as {{kick_get_avatar}}. */
    KICK_GET_AVATAR = "kick_get_avatar",
    /** Now playing song title. Use as {{spotify_now_playing_song}}. */
    SPOTIFY_NOW_PLAYING_SONG = "spotify_now_playing_song",
    /** Now playing artwork URL. Use as {{spotify_now_playing_image}}. */
    SPOTIFY_NOW_PLAYING_IMAGE = "spotify_now_playing_image",
    /** Now playing artist(s). Use as {{spotify_now_playing_artist}}. */
    SPOTIFY_NOW_PLAYING_ARTIST = "spotify_now_playing_artist",
    /** Now playing track ID. Use as {{spotify_now_playing_id}}. */
    SPOTIFY_NOW_PLAYING_ID = "spotify_now_playing_id",
    /** Now playing track URL. Use as {{spotify_now_playing_url}}. */
    SPOTIFY_NOW_PLAYING_URL = "spotify_now_playing_url",
    /** Now playing Spotify URI. Use as {{spotify_now_playing_uri}}. */
    SPOTIFY_NOW_PLAYING_URI = "spotify_now_playing_uri",
    /** Now playing track duration in seconds. Use as {{spotify_now_playing_duration}}. */
    SPOTIFY_NOW_PLAYING_DURATION = "spotify_now_playing_duration",
    /** Now playing track position in seconds at the last play/pause/seek anchor. Use as {{spotify_now_playing_progress}}. */
    SPOTIFY_NOW_PLAYING_PROGRESS = "spotify_now_playing_progress",
    /** Epoch ms when the progress anchor was captured (for client-side interpolation). Use as {{spotify_now_playing_progress_ts}}. */
    SPOTIFY_NOW_PLAYING_PROGRESS_TS = "spotify_now_playing_progress_ts",
    /** Whether playback is currently advancing (true/false). Use as {{spotify_now_playing_is_playing}}. */
    SPOTIFY_NOW_PLAYING_IS_PLAYING = "spotify_now_playing_is_playing",
    /** Now playing album name. Use as {{spotify_now_playing_album}}. */
    SPOTIFY_NOW_PLAYING_ALBUM = "spotify_now_playing_album",
    /** Now playing album release year. Use as {{spotify_now_playing_release_year}}. */
    SPOTIFY_NOW_PLAYING_RELEASE_YEAR = "spotify_now_playing_release_year",
    /** Now playing track popularity score 0-100 from Spotify. Use as {{spotify_now_playing_popularity}}. */
    SPOTIFY_NOW_PLAYING_POPULARITY = "spotify_now_playing_popularity",
    /** Upcoming queue as a JSON array of {name, artist, image, uri, url}. Use as {{spotify_now_playing_queue}}. */
    SPOTIFY_NOW_PLAYING_QUEUE = "spotify_now_playing_queue",
    /** Next song title. Use as {{spotify_next_song}}. */
    SPOTIFY_NEXT_SONG = "spotify_next_song",
    /** Next song artwork URL. Use as {{spotify_next_image}}. */
    SPOTIFY_NEXT_IMAGE = "spotify_next_image",
    /** Next song artist(s). Use as {{spotify_next_artist}}. */
    SPOTIFY_NEXT_ARTIST = "spotify_next_artist",
    /** Next song ID. Use as {{spotify_next_id}}. */
    SPOTIFY_NEXT_ID = "spotify_next_id",
    /** Next song URL. Use as {{spotify_next_url}}. */
    SPOTIFY_NEXT_URL = "spotify_next_url",
    /** Next song Spotify URI. Use as {{spotify_next_uri}}. */
    SPOTIFY_NEXT_URI = "spotify_next_uri",
    /** Now playing song title. Use as {{youtubemusic_now_playing_song}}. */
    YOUTUBEMUSIC_NOW_PLAYING_SONG = "youtubemusic_now_playing_song",
    /** Now playing artwork URL. Use as {{youtubemusic_now_playing_image}}. */
    YOUTUBEMUSIC_NOW_PLAYING_IMAGE = "youtubemusic_now_playing_image",
    /** Now playing artist(s). Use as {{youtubemusic_now_playing_artist}}. */
    YOUTUBEMUSIC_NOW_PLAYING_ARTIST = "youtubemusic_now_playing_artist",
    /** Now playing ID. Use as {{youtubemusic_now_playing_id}}. */
    YOUTUBEMUSIC_NOW_PLAYING_ID = "youtubemusic_now_playing_id",
    /** Now playing URL. Use as {{youtubemusic_now_playing_url}}. */
    YOUTUBEMUSIC_NOW_PLAYING_URL = "youtubemusic_now_playing_url",
    /** Now playing track duration in seconds. Use as {{youtubemusic_now_playing_duration}}. */
    YOUTUBEMUSIC_NOW_PLAYING_DURATION = "youtubemusic_now_playing_duration",
    /** Now playing track position in seconds at the last play/pause/seek anchor. Use as {{youtubemusic_now_playing_progress}}. */
    YOUTUBEMUSIC_NOW_PLAYING_PROGRESS = "youtubemusic_now_playing_progress",
    /** Epoch ms when the progress anchor was captured (for client-side interpolation). Use as {{youtubemusic_now_playing_progress_ts}}. */
    YOUTUBEMUSIC_NOW_PLAYING_PROGRESS_TS = "youtubemusic_now_playing_progress_ts",
    /** Whether playback is currently advancing (true/false). Use as {{youtubemusic_now_playing_is_playing}}. */
    YOUTUBEMUSIC_NOW_PLAYING_IS_PLAYING = "youtubemusic_now_playing_is_playing",
    /** Upcoming queue as a JSON array of {name, artist, image, uri, url}. Use as {{youtubemusic_now_playing_queue}}. */
    YOUTUBEMUSIC_NOW_PLAYING_QUEUE = "youtubemusic_now_playing_queue",
    /** Next song title. Use as {{youtubemusic_next_song}}. */
    YOUTUBEMUSIC_NEXT_SONG = "youtubemusic_next_song",
    /** Next song artwork URL. Use as {{youtubemusic_next_image}}. */
    YOUTUBEMUSIC_NEXT_IMAGE = "youtubemusic_next_image",
    /** Next song artist(s). Use as {{youtubemusic_next_artist}}. */
    YOUTUBEMUSIC_NEXT_ARTIST = "youtubemusic_next_artist",
    /** Next song ID. Use as {{youtubemusic_next_id}}. */
    YOUTUBEMUSIC_NEXT_ID = "youtubemusic_next_id",
    /** Next song URL. Use as {{youtubemusic_next_url}}. */
    YOUTUBEMUSIC_NEXT_URL = "youtubemusic_next_url",
    /** Current queue (comma-separated). Use as {{youtubemusic_queue}}. */
    YOUTUBEMUSIC_QUEUE = "youtubemusic_queue",
    /** Track ID (computed). Use as {{now_playing_id}}. */
    NOW_PLAYING_ID = "now_playing_id",
    /** Track title. Use as {{now_playing_title}}. */
    NOW_PLAYING_TITLE = "now_playing_title",
    /** Artwork URL. Use as {{now_playing_artwork}}. */
    NOW_PLAYING_ARTWORK = "now_playing_artwork",
    /** Artist name(s). Use as {{now_playing_artist}}. */
    NOW_PLAYING_ARTIST = "now_playing_artist",
    /** Album name. Use as {{now_playing_album}}. */
    NOW_PLAYING_ALBUM = "now_playing_album",
    /** Label. Use as {{now_playing_label}}. */
    NOW_PLAYING_LABEL = "now_playing_label",
    /** BPM. Use as {{now_playing_bpm}}. */
    NOW_PLAYING_BPM = "now_playing_bpm",
    /** Rating. Use as {{now_playing_rating}}. */
    NOW_PLAYING_RATING = "now_playing_rating",
    /** Length (seconds). Use as {{now_playing_length}}. */
    NOW_PLAYING_LENGTH = "now_playing_length",
    /** Comment. Use as {{now_playing_comment}}. */
    NOW_PLAYING_COMMENT = "now_playing_comment",
    /** Musical key. Use as {{now_playing_key}}. */
    NOW_PLAYING_KEY = "now_playing_key",
    /** Generic URL. Use as {{now_playing_url}}. */
    NOW_PLAYING_URL = "now_playing_url",
    /** Spotify URL. Use as {{now_playing_spotify_url}}. */
    NOW_PLAYING_SPOTIFY_URL = "now_playing_spotify_url",
    /** Beatport URL. Use as {{now_playing_beatport_url}}. */
    NOW_PLAYING_BEATPORT_URL = "now_playing_beatport_url",
    /** Beatport ID. Use as {{now_playing_beatport_id}}. */
    NOW_PLAYING_BEATPORT_ID = "now_playing_beatport_id",
    /** File path to media. Use as {{now_playing_file_path}}. */
    NOW_PLAYING_FILE_PATH = "now_playing_file_path",
    /** Currently playing media title. Use as {{vlc_now_playing_media}}. */
    VLC_NOW_PLAYING_MEDIA = "vlc_now_playing_media",
    /** Artwork URL. Use as {{vlc_now_playing_image}}. */
    VLC_NOW_PLAYING_IMAGE = "vlc_now_playing_image",
    /** Artist(s). Use as {{vlc_now_playing_artist}}. */
    VLC_NOW_PLAYING_ARTIST = "vlc_now_playing_artist",
    /** Media ID. Use as {{vlc_now_playing_id}}. */
    VLC_NOW_PLAYING_ID = "vlc_now_playing_id",
    /** Media URL. Use as {{vlc_now_playing_url}}. */
    VLC_NOW_PLAYING_URL = "vlc_now_playing_url",
    /** Now playing media duration in seconds. Use as {{vlc_now_playing_duration}}. */
    VLC_NOW_PLAYING_DURATION = "vlc_now_playing_duration",
    /** Now playing media position in seconds at the last play/pause/seek anchor. Use as {{vlc_now_playing_progress}}. */
    VLC_NOW_PLAYING_PROGRESS = "vlc_now_playing_progress",
    /** Epoch ms when the progress anchor was captured (for client-side interpolation). Use as {{vlc_now_playing_progress_ts}}. */
    VLC_NOW_PLAYING_PROGRESS_TS = "vlc_now_playing_progress_ts",
    /** Whether playback is currently advancing (true/false). Use as {{vlc_now_playing_is_playing}}. */
    VLC_NOW_PLAYING_IS_PLAYING = "vlc_now_playing_is_playing",
    /** Media URI. Use as {{vlc_now_playing_uri}}. */
    VLC_NOW_PLAYING_URI = "vlc_now_playing_uri",
    /** Voice changer on (true/false). Use as {{voicemod_voice_changer_on}}. */
    VOICEMOD_VOICE_CHANGER_ON = "voicemod_voice_changer_on",
    /** Previous voice. Use as {{voicemod_previous_voice}}. */
    VOICEMOD_PREVIOUS_VOICE = "voicemod_previous_voice",
    /** Current voice. Use as {{voicemod_current_voice}}. */
    VOICEMOD_CURRENT_VOICE = "voicemod_current_voice",
    /** Last order full name. Use as {{woocommerce_last_order_name}}. */
    WOOCOMMERCE_LAST_ORDER_NAME = "woocommerce_last_order_name",
    /** Last order first name. Use as {{woocommerce_last_order_first_name}}. */
    WOOCOMMERCE_LAST_ORDER_FIRST_NAME = "woocommerce_last_order_first_name",
    /** Last order last name. Use as {{woocommerce_last_order_last_name}}. */
    WOOCOMMERCE_LAST_ORDER_LAST_NAME = "woocommerce_last_order_last_name",
    /** Last ordered item (first). Use as {{woocommerce_last_order_item}}. */
    WOOCOMMERCE_LAST_ORDER_ITEM = "woocommerce_last_order_item",
    /** Last ordered items (list). Use as {{woocommerce_last_order_items}}. */
    WOOCOMMERCE_LAST_ORDER_ITEMS = "woocommerce_last_order_items",
    /** Last order amount. Use as {{woocommerce_last_order_amount}}. */
    WOOCOMMERCE_LAST_ORDER_AMOUNT = "woocommerce_last_order_amount",
    /** Last order amount currency code. Use as {{woocommerce_last_order_amount_currency}}. */
    WOOCOMMERCE_LAST_ORDER_AMOUNT_CURRENCY = "woocommerce_last_order_amount_currency",
    /** Is streaming (true/false). Use as {{obs_is_streaming}}. */
    OBS_IS_STREAMING = "obs_is_streaming",
    /** Is recording (true/false). Use as {{obs_is_recording}}. */
    OBS_IS_RECORDING = "obs_is_recording",
    /** Last recording path. Use as {{obs_last_recording_path}}. */
    OBS_LAST_RECORDING_PATH = "obs_last_recording_path",
    /** Studio mode on (true/false). Use as {{obs_studio_mode}}. */
    OBS_STUDIO_MODE = "obs_studio_mode",
    /** Current profile. Use as {{obs_current_profile}}. */
    OBS_CURRENT_PROFILE = "obs_current_profile",
    /** Current scene. Use as {{obs_current_scene}}. */
    OBS_CURRENT_SCENE = "obs_current_scene",
    /** Previous scene. Use as {{obs_previous_scene}}. */
    OBS_PREVIOUS_SCENE = "obs_previous_scene",
    /** Current transition (if transitioning). Use as {{obs_current_transition}}. */
    OBS_CURRENT_TRANSITION = "obs_current_transition",
    /** Last replay buffer save path. Use as {{obs_last_replay_buffer_path}}. */
    OBS_LAST_REPLAY_BUFFER_PATH = "obs_last_replay_buffer_path",
    /** Last vertical backtrack save path. Use as {{obs_last_vertical_backtrack_path}}. */
    OBS_LAST_VERTICAL_BACKTRACK_PATH = "obs_last_vertical_backtrack_path",
    /** Current scene. Use as {{slobs_current_scene}}. */
    SLOBS_CURRENT_SCENE = "slobs_current_scene",
    /** Previous scene. Use as {{slobs_previous_scene}}. */
    SLOBS_PREVIOUS_SCENE = "slobs_previous_scene",
    /** Current scene collection. Use as {{slobs_current_scene_collection}}. */
    SLOBS_CURRENT_SCENE_COLLECTION = "slobs_current_scene_collection",
    /** Is streaming (true/false). Use as {{meld_is_streaming}}. */
    MELD_IS_STREAMING = "meld_is_streaming",
    /** Is recording (true/false). Use as {{meld_is_recording}}. */
    MELD_IS_RECORDING = "meld_is_recording",
    /** Current scene. Use as {{meld_current_scene}}. */
    MELD_CURRENT_SCENE = "meld_current_scene",
    /** Previous scene. Use as {{meld_previous_scene}}. */
    MELD_PREVIOUS_SCENE = "meld_previous_scene",
    /** Current vertical scene. Use as {{meld_current_vertical_scene}}. */
    MELD_CURRENT_VERTICAL_SCENE = "meld_current_vertical_scene",
    /** Previous vertical scene. Use as {{meld_previous_vertical_scene}}. */
    MELD_PREVIOUS_VERTICAL_SCENE = "meld_previous_vertical_scene",
    /** Last Streamer.bot action. Use as {{streamerbot_last_action}}. */
    STREAMERBOT_LAST_ACTION = "streamerbot_last_action",
    /** Current VTS model. Use as {{vtubestudio_current_model}}. */
    VTUBESTUDIO_CURRENT_MODEL = "vtubestudio_current_model",
    /** Current VTS background. Use as {{vtubestudio_current_background}}. */
    VTUBESTUDIO_CURRENT_BACKGROUND = "vtubestudio_current_background",
    /** Last VTS hotkey triggered. Use as {{vtubestudio_last_hotkey_triggered}}. */
    VTUBESTUDIO_LAST_HOTKEY_TRIGGERED = "vtubestudio_last_hotkey_triggered",
    /** Tiltify campaign fundraising goal (currency value). Use as {{tiltify_goal_amount}}. */
    TILTIFY_GOAL_AMOUNT = "tiltify_goal_amount",
    /** Tiltify campaign amount raised so far (currency value). Use as {{tiltify_total_raised}}. */
    TILTIFY_TOTAL_RAISED = "tiltify_total_raised",
    /** Extra Life campaign fundraising goal (USD). Use as {{extralife_goal_amount}}. */
    EXTRALIFE_GOAL_AMOUNT = "extralife_goal_amount",
    /** Extra Life campaign amount raised so far (USD). Use as {{extralife_total_raised}}. */
    EXTRALIFE_TOTAL_RAISED = "extralife_total_raised",
    /** DonorDrive campaign fundraising goal. Use as {{donordrive_goal_amount}}. */
    DONORDRIVE_GOAL_AMOUNT = "donordrive_goal_amount",
    /** DonorDrive campaign amount raised so far. Use as {{donordrive_total_raised}}. */
    DONORDRIVE_TOTAL_RAISED = "donordrive_total_raised",
    /** (Twitch) Most recent channel-points redeemer name. Use as {{twitch_last_channel_points_redeemer}}. */
    TWITCH_LAST_CHANNEL_POINTS_REDEEMER = "twitch_last_channel_points_redeemer",
    /** Cost for TWITCH_LAST_CHANNEL_POINTS_REDEEMER. Use as {{twitch_last_channel_points_amount}}. */
    TWITCH_LAST_CHANNEL_POINTS_AMOUNT = "twitch_last_channel_points_amount",
    /** Follower goal target. Use as {{follower_goal}}. */
    FOLLOWER_GOAL = "follower_goal",
    /** Subscriber goal target. Use as {{subscriber_goal}}. */
    SUBSCRIBER_GOAL = "subscriber_goal",
    /** Cheer/bits goal target. Use as {{cheer_goal}}. */
    CHEER_GOAL = "cheer_goal",
    /** Tip/donation goal target. Use as {{tip_goal}}. */
    TIP_GOAL = "tip_goal",
    /** Superchat goal target. Use as {{superchat_goal}}. */
    SUPERCHAT_GOAL = "superchat_goal",
    /** Merch order count goal. Use as {{merch_goal_orders}}. */
    MERCH_GOAL_ORDERS = "merch_goal_orders",
    /** Merch item count goal. Use as {{merch_goal_items}}. */
    MERCH_GOAL_ITEMS = "merch_goal_items",
    /** Merch revenue goal. Use as {{merch_goal_total}}. */
    MERCH_GOAL_TOTAL = "merch_goal_total",
    /** Top tipper this session (cumulative giver). Use as {{session_top_tipper}}. */
    SESSION_TOP_TIPPER = "session_top_tipper",
    /** Amount for SESSION_TOP_TIPPER. Use as {{session_top_tipper_amount}}. */
    SESSION_TOP_TIPPER_AMOUNT = "session_top_tipper_amount",
    /** Top tipper this week (cumulative giver). Use as {{week_top_tipper}}. */
    WEEK_TOP_TIPPER = "week_top_tipper",
    /** Amount for WEEK_TOP_TIPPER. Use as {{week_top_tipper_amount}}. */
    WEEK_TOP_TIPPER_AMOUNT = "week_top_tipper_amount",
    /** Top tipper this month (cumulative giver). Use as {{month_top_tipper}}. */
    MONTH_TOP_TIPPER = "month_top_tipper",
    /** Amount for MONTH_TOP_TIPPER. Use as {{month_top_tipper_amount}}. */
    MONTH_TOP_TIPPER_AMOUNT = "month_top_tipper_amount",
    /** All-time top tipper (cumulative giver). Use as {{alltime_top_tipper}}. */
    ALLTIME_TOP_TIPPER = "alltime_top_tipper",
    /** Amount for ALLTIME_TOP_TIPPER. Use as {{alltime_top_tipper_amount}}. */
    ALLTIME_TOP_TIPPER_AMOUNT = "alltime_top_tipper_amount",
    /** Latest charity-campaign donor name. Use as {{last_charity_donator}}. */
    LAST_CHARITY_DONATOR = "last_charity_donator",
    /** Amount for LAST_CHARITY_DONATOR. Use as {{last_charity_donation_amount}}. */
    LAST_CHARITY_DONATION_AMOUNT = "last_charity_donation_amount",
    /** Largest single charity donation this session. Use as {{session_top_charity_donation}}. */
    SESSION_TOP_CHARITY_DONATION = "session_top_charity_donation",
    /** Amount for SESSION_TOP_CHARITY_DONATION. Use as {{session_top_charity_donation_amount}}. */
    SESSION_TOP_CHARITY_DONATION_AMOUNT = "session_top_charity_donation_amount",
    /** Largest single charity donation this week. Use as {{week_top_charity_donation}}. */
    WEEK_TOP_CHARITY_DONATION = "week_top_charity_donation",
    /** Amount for WEEK_TOP_CHARITY_DONATION. Use as {{week_top_charity_donation_amount}}. */
    WEEK_TOP_CHARITY_DONATION_AMOUNT = "week_top_charity_donation_amount",
    /** Largest single charity donation this month. Use as {{month_top_charity_donation}}. */
    MONTH_TOP_CHARITY_DONATION = "month_top_charity_donation",
    /** Amount for MONTH_TOP_CHARITY_DONATION. Use as {{month_top_charity_donation_amount}}. */
    MONTH_TOP_CHARITY_DONATION_AMOUNT = "month_top_charity_donation_amount",
    /** Largest single charity donation all-time. Use as {{alltime_top_charity_donation}}. */
    ALLTIME_TOP_CHARITY_DONATION = "alltime_top_charity_donation",
    /** Amount for ALLTIME_TOP_CHARITY_DONATION. Use as {{alltime_top_charity_donation_amount}}. */
    ALLTIME_TOP_CHARITY_DONATION_AMOUNT = "alltime_top_charity_donation_amount",
    /** Top charity donor this session (cumulative giver). Use as {{session_top_charity_donator}}. */
    SESSION_TOP_CHARITY_DONATOR = "session_top_charity_donator",
    /** Amount for SESSION_TOP_CHARITY_DONATOR. Use as {{session_top_charity_donator_amount}}. */
    SESSION_TOP_CHARITY_DONATOR_AMOUNT = "session_top_charity_donator_amount",
    /** Top charity donor this week (cumulative giver). Use as {{week_top_charity_donator}}. */
    WEEK_TOP_CHARITY_DONATOR = "week_top_charity_donator",
    /** Amount for WEEK_TOP_CHARITY_DONATOR. Use as {{week_top_charity_donator_amount}}. */
    WEEK_TOP_CHARITY_DONATOR_AMOUNT = "week_top_charity_donator_amount",
    /** Top charity donor this month (cumulative giver). Use as {{month_top_charity_donator}}. */
    MONTH_TOP_CHARITY_DONATOR = "month_top_charity_donator",
    /** Amount for MONTH_TOP_CHARITY_DONATOR. Use as {{month_top_charity_donator_amount}}. */
    MONTH_TOP_CHARITY_DONATOR_AMOUNT = "month_top_charity_donator_amount",
    /** All-time top charity donor (cumulative giver). Use as {{alltime_top_charity_donator}}. */
    ALLTIME_TOP_CHARITY_DONATOR = "alltime_top_charity_donator",
    /** Amount for ALLTIME_TOP_CHARITY_DONATOR. Use as {{alltime_top_charity_donator_amount}}. */
    ALLTIME_TOP_CHARITY_DONATOR_AMOUNT = "alltime_top_charity_donator_amount",
    /** Largest single cheer this week. Use as {{week_top_cheer}}. */
    WEEK_TOP_CHEER = "week_top_cheer",
    /** Amount for WEEK_TOP_CHEER. Use as {{week_top_cheer_amount}}. */
    WEEK_TOP_CHEER_AMOUNT = "week_top_cheer_amount",
    /** Largest single cheer this month. Use as {{month_top_cheer}}. */
    MONTH_TOP_CHEER = "month_top_cheer",
    /** Amount for MONTH_TOP_CHEER. Use as {{month_top_cheer_amount}}. */
    MONTH_TOP_CHEER_AMOUNT = "month_top_cheer_amount",
    /** Largest single cheer all-time. Use as {{alltime_top_cheer}}. */
    ALLTIME_TOP_CHEER = "alltime_top_cheer",
    /** Amount for ALLTIME_TOP_CHEER. Use as {{alltime_top_cheer_amount}}. */
    ALLTIME_TOP_CHEER_AMOUNT = "alltime_top_cheer_amount",
    /** (Twitch) Largest single cheer this week. Use as {{twitch_week_top_cheer}}. */
    TWITCH_WEEK_TOP_CHEER = "twitch_week_top_cheer",
    /** Amount for TWITCH_WEEK_TOP_CHEER. Use as {{twitch_week_top_cheer_amount}}. */
    TWITCH_WEEK_TOP_CHEER_AMOUNT = "twitch_week_top_cheer_amount",
    /** (Twitch) Largest single cheer this month. Use as {{twitch_month_top_cheer}}. */
    TWITCH_MONTH_TOP_CHEER = "twitch_month_top_cheer",
    /** Amount for TWITCH_MONTH_TOP_CHEER. Use as {{twitch_month_top_cheer_amount}}. */
    TWITCH_MONTH_TOP_CHEER_AMOUNT = "twitch_month_top_cheer_amount",
    /** (Twitch) Largest single cheer all-time. Use as {{twitch_alltime_top_cheer}}. */
    TWITCH_ALLTIME_TOP_CHEER = "twitch_alltime_top_cheer",
    /** Amount for TWITCH_ALLTIME_TOP_CHEER. Use as {{twitch_alltime_top_cheer_amount}}. */
    TWITCH_ALLTIME_TOP_CHEER_AMOUNT = "twitch_alltime_top_cheer_amount",
    /** (YouTube) Running superchat amount this session. Use as {{youtube_session_superchat_amount}}. */
    YOUTUBE_SESSION_SUPERCHAT_AMOUNT = "youtube_session_superchat_amount",
    /** (YouTube) Running superchat amount this week. Use as {{youtube_week_superchat_amount}}. */
    YOUTUBE_WEEK_SUPERCHAT_AMOUNT = "youtube_week_superchat_amount",
    /** (YouTube) Running superchat amount this month. Use as {{youtube_month_superchat_amount}}. */
    YOUTUBE_MONTH_SUPERCHAT_AMOUNT = "youtube_month_superchat_amount",
    /** (YouTube) Running superchat amount all-time. Use as {{youtube_total_superchat_amount}}. */
    YOUTUBE_TOTAL_SUPERCHAT_AMOUNT = "youtube_total_superchat_amount",
    /** (YouTube) Largest single superchat this session. Use as {{youtube_session_top_superchat}}. */
    YOUTUBE_SESSION_TOP_SUPERCHAT = "youtube_session_top_superchat",
    /** Amount for YOUTUBE_SESSION_TOP_SUPERCHAT. Use as {{youtube_session_top_superchat_amount}}. */
    YOUTUBE_SESSION_TOP_SUPERCHAT_AMOUNT = "youtube_session_top_superchat_amount",
    /** (YouTube) Largest single superchat this week. Use as {{youtube_week_top_superchat}}. */
    YOUTUBE_WEEK_TOP_SUPERCHAT = "youtube_week_top_superchat",
    /** Amount for YOUTUBE_WEEK_TOP_SUPERCHAT. Use as {{youtube_week_top_superchat_amount}}. */
    YOUTUBE_WEEK_TOP_SUPERCHAT_AMOUNT = "youtube_week_top_superchat_amount",
    /** (YouTube) Largest single superchat this month. Use as {{youtube_month_top_superchat}}. */
    YOUTUBE_MONTH_TOP_SUPERCHAT = "youtube_month_top_superchat",
    /** Amount for YOUTUBE_MONTH_TOP_SUPERCHAT. Use as {{youtube_month_top_superchat_amount}}. */
    YOUTUBE_MONTH_TOP_SUPERCHAT_AMOUNT = "youtube_month_top_superchat_amount",
    /** (YouTube) Largest single superchat all-time. Use as {{youtube_alltime_top_superchat}}. */
    YOUTUBE_ALLTIME_TOP_SUPERCHAT = "youtube_alltime_top_superchat",
    /** Amount for YOUTUBE_ALLTIME_TOP_SUPERCHAT. Use as {{youtube_alltime_top_superchat_amount}}. */
    YOUTUBE_ALLTIME_TOP_SUPERCHAT_AMOUNT = "youtube_alltime_top_superchat_amount",
    /** (YouTube) Top superchatter this session (cumulative giver). Use as {{youtube_session_top_superchatter}}. */
    YOUTUBE_SESSION_TOP_SUPERCHATTER = "youtube_session_top_superchatter",
    /** Amount for YOUTUBE_SESSION_TOP_SUPERCHATTER. Use as {{youtube_session_top_superchatter_amount}}. */
    YOUTUBE_SESSION_TOP_SUPERCHATTER_AMOUNT = "youtube_session_top_superchatter_amount",
    /** (YouTube) Top superchatter this week (cumulative giver). Use as {{youtube_week_top_superchatter}}. */
    YOUTUBE_WEEK_TOP_SUPERCHATTER = "youtube_week_top_superchatter",
    /** Amount for YOUTUBE_WEEK_TOP_SUPERCHATTER. Use as {{youtube_week_top_superchatter_amount}}. */
    YOUTUBE_WEEK_TOP_SUPERCHATTER_AMOUNT = "youtube_week_top_superchatter_amount",
    /** (YouTube) Top superchatter this month (cumulative giver). Use as {{youtube_month_top_superchatter}}. */
    YOUTUBE_MONTH_TOP_SUPERCHATTER = "youtube_month_top_superchatter",
    /** Amount for YOUTUBE_MONTH_TOP_SUPERCHATTER. Use as {{youtube_month_top_superchatter_amount}}. */
    YOUTUBE_MONTH_TOP_SUPERCHATTER_AMOUNT = "youtube_month_top_superchatter_amount",
    /** (YouTube) All-time top superchatter (cumulative giver). Use as {{youtube_alltime_top_superchatter}}. */
    YOUTUBE_ALLTIME_TOP_SUPERCHATTER = "youtube_alltime_top_superchatter",
    /** Amount for YOUTUBE_ALLTIME_TOP_SUPERCHATTER. Use as {{youtube_alltime_top_superchatter_amount}}. */
    YOUTUBE_ALLTIME_TOP_SUPERCHATTER_AMOUNT = "youtube_alltime_top_superchatter_amount",
    /** Comma-separated list of recent followers. Use as {{recent_followers}}. */
    RECENT_FOLLOWERS = "recent_followers",
    /** Comma-separated list of recent subscribers. Use as {{recent_subscribers}}. */
    RECENT_SUBSCRIBERS = "recent_subscribers",
    /** Comma-separated list of recent hosts. Use as {{recent_hosts}}. */
    RECENT_HOSTS = "recent_hosts",
    /** Comma-separated list of recent raiders. Use as {{recent_raiders}}. */
    RECENT_RAIDERS = "recent_raiders",
    /** Parallel comma-separated viewer counts for RECENT_RAIDERS. Use as {{recent_raiders_amount}}. */
    RECENT_RAIDERS_AMOUNT = "recent_raiders_amount",
    /** Comma-separated list of recent cheerers. Use as {{recent_cheers}}. */
    RECENT_CHEERS = "recent_cheers",
    /** Parallel comma-separated bit amounts for RECENT_CHEERS. Use as {{recent_cheers_amount}}. */
    RECENT_CHEERS_AMOUNT = "recent_cheers_amount",
    /** Comma-separated list of recent tippers. Use as {{recent_tips}}. */
    RECENT_TIPS = "recent_tips",
    /** Parallel comma-separated tip amounts for RECENT_TIPS. Use as {{recent_tips_amount}}. */
    RECENT_TIPS_AMOUNT = "recent_tips_amount",
    /** Comma-separated list of recent superchatters. Use as {{recent_superchats}}. */
    RECENT_SUPERCHATS = "recent_superchats",
    /** Parallel comma-separated superchat amounts for RECENT_SUPERCHATS. Use as {{recent_superchats_amount}}. */
    RECENT_SUPERCHATS_AMOUNT = "recent_superchats_amount",
    /** Comma-separated list of recent charity donors. Use as {{recent_charity_donations}}. */
    RECENT_CHARITY_DONATIONS = "recent_charity_donations",
    /** Parallel comma-separated donation amounts for RECENT_CHARITY_DONATIONS. Use as {{recent_charity_donations_amount}}. */
    RECENT_CHARITY_DONATIONS_AMOUNT = "recent_charity_donations_amount",
    /** Heart rate BPM (Pulsoid/Hyperate). Use as {{heartrate_bpm}}. */
    HEARTRATE_BPM = "heartrate_bpm"
}

// <auto-generated-end name="SystemVariables" />

// -----------------------------------------------------------------------------
//  Globals available inside a custom overlay's JS tab
// -----------------------------------------------------------------------------

declare global {
	/** The Overlay API. Available unprefixed as `Overlay` or as `window.Overlay`. */
	const Overlay: Overlay;

	interface Window {
		Overlay: Overlay;
	}

	/**
	 * Show a toast notification in Lumia.
	 * @param message - Text to display
	 * @param type - Toast style (defaults to "info")
	 */
	function toast(message: string, type?: 'info' | 'success' | 'warning' | 'error'): void;
}

Alert Types

Full file

This file is still incomplete, but it captures the alert-specific typings collected so far.

Source:

@lumiastream/lumia-types/dist/custom-overlays/custom-overlays-alerts.d.ts

custom-overlays-alerts.d.ts

/// <reference path="./custom-overlays.d.ts" />

/*
 * Only the most common alerts are modeled here as concrete types (a curated
 * subset of the ~220 `LumiaAlertValues`). Any alert not in `LumiaAlert` below
 * still arrives — just as the generic `AlertEvent` from `custom-overlays.d.ts`.
 * Read `data.alert`, `data.dynamic`, and `data.extraSettings` directly for those.
 */

import { LumiaAlertValues } from './custom-overlays';

/* -------------------------------------------------------------------------- */
/*  Utility + shared pieces                                                  */
/* -------------------------------------------------------------------------- */

/** Known platforms (extendable). */
type Platform = 'twitch' | 'youtube' | 'kick' | 'tiktok' | 'facebook' | string;
/** Known Lumia activity origins (extendable). */
type ActivityOrigin = 'system' | 'alert' | 'chat' | 'chatbot' | 'twitch-points' | 'twitch-extension' | 'kick-points' | 'api' | 'lumiastreamlink' | 'streamdeck' | 'touchportal' | 'avermedia' | 'loupedeck' | string;

/** ISO-8601 timestamp branding for better editor hints. */
type ISODateString = string & { __iso8601: true };

/**
 * Timing metadata for alerts.
 * - `checkTimingType: false` → no timing info
 * - `timingType: "duration"` → show for a number of milliseconds
 * - `timingType: "cycle"` → show for a number of cycles (app-defined)
 */
type Timing = { checkTimingType: false } | { checkTimingType: true; timingType: 'duration'; duration: number } | { checkTimingType: true; timingType: 'cycle'; cycles: number };

/**
 * Common fields many alerts include.
 * These are merged into each alert’s `extraSettings`.
 */
interface CommonExtras {
	/** Origin site/platform for this alert (e.g., "twitch"). */
	site: Platform;
	/** Lumia queue/activity origin type (e.g., "alert", "chat", "chatbot", "system"). */
	originType?: ActivityOrigin;
	/** ISO-8601 timestamp when the alert originated. */
	timestamp: ISODateString;

	/** Username on the origin platform (if available). */
	username?: string;
	/** Display name on the origin platform (if available). */
	displayname?: string;
	/** User ID on the origin platform (string or number). */
	userId?: string | number;
	/** Avatar URL (nullable if not provided). */
	avatar?: string | null;
}

/**
 * Canonical base alert shape used by all specific alerts.
 * `dynamic` is narrowed automatically when `alert` is a specific discriminator.
 */
interface BaseAlert<T extends LumiaAlertValues, D extends object, E extends object> {
	/** Discriminant – use values from LumiaAlertValues (e.g., "twitch-subscriber"). */
	alert: T;
	/** Alert payload that varies by alert type (narrowed via `alert`). */
	dynamic: D;
	/**
	 * Extra settings – alert-specific fields merged with shared `CommonExtras` and `Timing`.
	 * Do NOT duplicate CommonExtras fields in specialisations unless they truly differ.
	 */
	extraSettings: E & CommonExtras & Timing;
	/**
	 * Whether this alert originated from Lumia’s internal pipeline.
	 * Kept as boolean to make testing/mocking easier.
	 */
	fromLumia: boolean;
}

/* -------------------------------------------------------------------------- */
/*  Per-alert specialisations                                                */
/* -------------------------------------------------------------------------- */

/** New follower on Twitch. */
type TwitchFollower = BaseAlert<
	LumiaAlertValues.TWITCH_FOLLOWER,
	Record<string, never>,
	{
		/** Channel view count (at time of alert). */
		channelViews: number;
		/** Channel description text. */
		channelDescription: string;
	}
>;

/** Incoming raid on Twitch. */
type TwitchRaid = BaseAlert<
	LumiaAlertValues.TWITCH_RAID,
	{
		/** Raid size / viewer count. */
		value: number;
		/** Raider username (convenience duplicate). */
		username: string;
	},
	{
		/** Viewers included in the raid (vendor field). */
		viewers: number;
		/** Optional expanded channel description. */
		channelDescription: string | null;
		/** Avatar URL for raider. */
		avatar: string;
		/** Channel views for raider. */
		channelViews: number;
		/** Optional display message from the raider. */
		message?: string | null;
	}
>;

/** Cheer/Bits on Twitch (including PowerUps also modeled separately). */
type TwitchBits = BaseAlert<
	LumiaAlertValues.TWITCH_BITS,
	{
		/** Canonical numeric value of the contribution. */
		value: number;
		/** Cheer username. */
		username: string;
	},
	{
		/** Bits reported by vendor. */
		bits: number;
		/** Amount reported by vendor (kept for parity). */
		amount: number;
		/** Optional message accompanying the cheer. */
		message: string | null;
		/** Raw message string from the platform. */
		/** Channel views at time of alert. */
		channelViews: number;
		/** Channel description text. */
		channelDescription: string | null;
	}
>;

/** Subscription event on Twitch (sub, resub, gift). */
type TwitchSubscriber = BaseAlert<
	LumiaAlertValues.TWITCH_SUBSCRIBER,
	| {
			/** Tier value for sub/resub ("1000" | "2000" | "3000"). */
			value: '1000' | '2000' | '3000';
			/** Subscriber username. */
			username: string;
			/** Total months subbed. */
			subMonths: number;
			/** Current streak months. */
			streakMonths: number;
			/** Whether this is a Prime sub. */
			isPrime: boolean;
	  }
	| {
			/** Tier value for gifted sub. */
			value: '1000' | '2000' | '3000';
			/** Gifter username. */
			username: string;
			/** Recipient months (vendor value; may be present). */
			subMonths: number;
			/** Number of subs gifted in this event. */
			giftAmount: number;
			/** Cumulative gifted subs by this gifter. */
			totalGifts: number;
			/** Gift indicator. */
			isGift: true;
			/** Whether the gifter is anonymous. */
			isAnon?: boolean;
			/** Whether this event is Prime (rare for gifts). */
			isPrime: boolean;
			/** Whether this is a resub gift. */
			isResub: boolean;
	  },
	{
		/** Tier name ("Tier 1", "Tier 2", "Tier 3"). */
		subPlanName: string;
		/** Tier code ("1000" | "2000" | "3000"). */
		subPlan: string;
		/** Tier value duplicate for convenience. */
		value: '1000' | '2000' | '3000';
		/** Optional display/sticker message. */
		message: string | null;
		/** Gifter username, if applicable. */
		gifter?: string;
		/** Recipient username, if applicable. */
		recipient?: string;
		/** Comma-separated recipients (mass gift). */
		recipients?: string;
		/** Streak months (duplicated in dynamic for normal/resub). */
		streakMonths?: number;
		/** Gift bundle size (duplicated) */
		giftAmount?: number;
		/** Cumulative gift count by gifter. */
		totalGifts?: number;
		/** String tier (e.g., "Prime", "1000"). */
		tier: string;
	}
>;

/** Twitch PowerUps (bits-based effects). */
type TwitchPowerup = BaseAlert<
	LumiaAlertValues.TWITCH_POWERUPS,
	{
		/** Human-friendly name of the PowerUp. */
		name: string;
		/** Canonical numeric value (e.g., bits). */
		value: number;
		/** Username who triggered the PowerUp. */
		username: string;
	},
	{
		/** Bits reported by vendor. */
		bits: number;
		/** Vendor-provided type string. */
		type: string;
		/** Vendor amount (mirrors value). */
		amount: number;
		/** Raw chat message, if present. */
		/** Channel views at time of alert. */
		channelViews: number;
		/** Channel description text. */
		channelDescription: string | null;
	}
>;

/** Twitch Extension monetization / points. */
type TwitchExtension = BaseAlert<
	LumiaAlertValues.TWITCH_EXTENSION,
	{
		/** Redeemer username. */
		username: string;
		/** Item/extension name. */
		name: string;
		/** Currency type for the extension. */
		currency: 'points' | 'bits';
	},
	{
		/** Bits-based amount (when applicable). */
		bits: number;
		/** Numeric amount (points or bits). */
		amount: number;
		/** Origin tag for the event. */
		origin: 'twitch-extension';
		/** Command invoked within the extension. */
		command: string;
		/** Command identifier. */
		command_id: string;
		/** Message text (extension-defined). */
		message: string;
		/** Currency string echo. */
		currency: 'points' | 'bits';
		/** Amount type echo. */
		amount_type: 'points' | 'bits';
		/** Currency symbol (if applicable). */
		currencySymbol: string;
		/** Platform is always "twitch" for this alert. */
		platform: 'twitch';
		/** Channel views at time of alert (string|number to match vendor inconsistencies). */
		channelViews: string | number;
		/** Channel description text. */
		channelDescription: string;
	}
>;

/** Tiltify campaign donation. */
type TiltifyDonation = BaseAlert<
	LumiaAlertValues.TILTIFY_DONATION,
	{
		/** Canonical numeric donation amount. */
		value: number;
		/** ISO currency code (e.g., "USD"). */
		currency: string;
	},
	{
		/** Raw amount string as provided by vendor. */
		amount: string;
		/** Optional donor message. */
		message: string | null;
	}
>;

/** New follower on Kick. */
type KickFollower = BaseAlert<
	LumiaAlertValues.KICK_FOLLOWER,
	{
		/** Usually an empty string; keep for parity. */
		value: string;
	},
	{
		/** Nullable avatar URL. */
		avatar: string | null;
	}
>;

/** Kick channel “Points” (custom loyalty on Kick). */
type KickPoints = BaseAlert<
	LumiaAlertValues.KICK_POINTS,
	{
		/** Numeric points value used for this redemption. */
		value: number;
		/** Command/name of the points trigger. */
		name: string;
		/** Currency discriminator for points. */
		currency: 'points';
	},
	{
		/** Display title for the points command. */
		title: string;
		/** Echo of numeric value as string. */
		value: string;
		/** Amount as number (same as numeric value). */
		amount: number;
		/** Origin tag for the event. */
		origin: 'kick-points';
		/** Points value (duplicate). */
		points: number;
		/** Optional prompt text associated with the command. */
		prompt: string | null;
		/** The Kick command triggered. */
		command: string;
		/** Raw chat message (if present). */
		message: string | null;
		/** Platform discriminator. */
		platform: 'kick';
		/** Raw message (not parsed). */
		/** Amount type echo. */
		amount_type: 'points';
		/** Currency symbol (if set). */
		currencySymbol: string;
		/** Raw user levels map. */
		userLevelsRaw: {
			mod: boolean;
			vip: boolean;
			isSelf: boolean;
			follower: boolean;
			subscriber: boolean;
		};
		/** Lumia internal user levels. */
		lumiauserlevels: number[];
	}
>;

/** TikTok gift (coins/diamonds). */
type TikTokGift = BaseAlert<
	LumiaAlertValues.TIKTOK_GIFT,
	{
		/** Gift display name. */
		name: string;
		/** Canonical numeric value for this gift event. */
		value: number;
	},
	{
		/** TikTok coins value. */
		coins: number;
		/** Same as value (vendor echo). */
		value: number;
		/** Gift numeric ID. */
		giftId: number;
		/** Sender user ID. */
		userId: string;
		/** Gift description. */
		describe: string;
		/** Gift name (echo). */
		giftName: string;
		/** TikTok gift type code. */
		giftType: number;
		/** Sender username. */
		username: string;
		/** Whether repeat animation ended. */
		repeatEnd: boolean;
		/** Repeat count. */
		repeatCount: number;
		/** Diamonds for the gift. */
		diamondCount: number;
		/** URL of the gift picture. */
		giftPictureUrl: string;
		/** Receiver user ID, if applicable. */
		receiverUserId: string;
		/** Sender avatar URL. */
		profilePictureUrl: string;
		/** Sender display name. */
		displayname: string;
		/** Whether this is a new gifter. */
		isNewGifter: boolean;
	}
>;

/** New subscriber on YouTube. */
type YouTubeSubscriber = BaseAlert<
	LumiaAlertValues.YOUTUBE_SUBSCRIBER,
	{
		/** Usually an empty string; keep for parity. */
		value: string;
	},
	Record<string, never>
>;

/** YouTube SuperSticker. */
type YouTubeSuperSticker = BaseAlert<
	LumiaAlertValues.YOUTUBE_SUPERSTICKER,
	{
		/** Canonical numeric value of the sticker purchase. */
		value: number;
	},
	{
		/** Amount numeric (duplicate). */
		amount: number;
	}
>;

/** YouTube SuperChat. */
type YouTubeSuperChat = BaseAlert<
	LumiaAlertValues.YOUTUBE_SUPERCHAT,
	{
		/** Canonical numeric value for the SuperChat. */
		value: number;
		/** ISO currency code (e.g., "USD"). */
		currency: string;
		/** SuperChatter username. */
		username: string;
	},
	{
		/** Numeric amount (duplicate). */
		amount: number;
		/** Currency code (duplicate). */
		currency: string;
		/** Convenience duplicate of value for some toolchains. */
		value: number;
	}
>;

/** YouTube channel membership (join/renew). */
type YouTubeMember = BaseAlert<
	LumiaAlertValues.YOUTUBE_MEMBER,
	{
		/** Usually an empty string; keep for parity. */
		value: string;
	},
	Record<string, never>
>;

/** Crowd Control effect fired (for supported platforms). */
type CrowdControlEffect = BaseAlert<
	LumiaAlertValues.CROWDCONTROL_EFFECT,
	{
		/** Raw value (effect identifier or label). */
		value: string;
	},
	{
		/** Game name. */
		game: string;
		/** Effect label. */
		effect: string;
		/** Game ID (vendor). */
		gameId: string;
		/** Artwork URL for game/effect. */
		artwork: string;
		/** Optional message. */
		message: string;
		/** Effect ID. */
		effectId: string;
		/** Platform running the effect. */
		platform: 'twitch' | 'youtube' | 'kick';
		/** Duration in milliseconds. */
		duration: number;
	}
>;

/* -------------------------------------------------------------------------- */
/*  All alerts together                                                      */
/* -------------------------------------------------------------------------- */

/** Discriminated union of all supported alerts. */
export type LumiaAlert =
	| TwitchFollower
	| TwitchRaid
	| TwitchBits
	| TwitchSubscriber
	| TwitchPowerup
	| TwitchExtension
	| TiltifyDonation
	| KickFollower
	| KickPoints
	| TikTokGift
	| YouTubeSubscriber
	| YouTubeSuperSticker
	| YouTubeSuperChat
	| YouTubeMember
	| CrowdControlEffect;

/**
 * Map from alert discriminator to its concrete alert type.
 * Useful for generic helpers and editor navigation.
 */
export interface AlertMap {
	[LumiaAlertValues.TWITCH_FOLLOWER]: TwitchFollower;
	[LumiaAlertValues.TWITCH_RAID]: TwitchRaid;
	[LumiaAlertValues.TWITCH_BITS]: TwitchBits;
	[LumiaAlertValues.TWITCH_SUBSCRIBER]: TwitchSubscriber;
	[LumiaAlertValues.TWITCH_POWERUPS]: TwitchPowerup;
	[LumiaAlertValues.TWITCH_EXTENSION]: TwitchExtension;
	[LumiaAlertValues.TILTIFY_DONATION]: TiltifyDonation;
	[LumiaAlertValues.KICK_FOLLOWER]: KickFollower;
	[LumiaAlertValues.KICK_POINTS]: KickPoints;
	[LumiaAlertValues.TIKTOK_GIFT]: TikTokGift;
	[LumiaAlertValues.YOUTUBE_SUBSCRIBER]: YouTubeSubscriber;
	[LumiaAlertValues.YOUTUBE_SUPERSTICKER]: YouTubeSuperSticker;
	[LumiaAlertValues.YOUTUBE_SUPERCHAT]: YouTubeSuperChat;
	[LumiaAlertValues.YOUTUBE_MEMBER]: YouTubeMember;
	[LumiaAlertValues.CROWDCONTROL_EFFECT]: CrowdControlEffect;
}

/* -------------------------------------------------------------------------- */
/*  Helpers – for dev ergonomics                                             */
/* -------------------------------------------------------------------------- */

/** "twitch-subscriber" | "kick-points" | ... (all alert discriminants). */
export type AlertType = LumiaAlert['alert'];

/** Dynamic payload for a specific alert type. */
export type AlertDynamic<T extends AlertType> = AlertMap[T]['dynamic'];

/** Extra settings (merged with CommonExtras & Timing) for a specific alert type. */
export type AlertExtra<T extends AlertType> = AlertMap[T]['extraSettings'];