@distdev/vmix-utils/dist/shortcuts/index.d.ts

Utility functions and data for vMix

import { type FunctionIDsAudio } from './audio';
import { type FunctionIDsBrowser } from './browser';
import { type FunctionIDsDataSources } from './dataSources';
import { type FunctionIDsGeneral } from './general';
import { type FunctionIDsInput } from './input';
import { type FunctionIDsNDI } from './ndi';
import { type FunctionIDsOutput } from './output';
import { type FunctionIDsOverlay } from './overlay';
import { type FunctionIDsPlayList } from './playlist';
import { type FunctionIDsPreset } from './preset';
import { type FunctionIDsPTZ } from './ptz';
import { type FunctionIDsReplay } from './replay';
import { type FunctionIDsScripting } from './scripting';
import { type FunctionIDsTitle } from './title';
import { type FunctionIDsTransition } from './transition';
export type Category = 'General' | 'Audio' | 'Transition' | 'Output' | 'Title' | 'Input' | 'Overlay' | 'PlayList' | 'Scripting' | 'Replay' | 'NDI' | 'PTZ' | 'Preset' | 'DataSources' | 'Browser';
export type VMixFunction = {
    id: FunctionIDs;
    category: Category;
    description?: string;
    params: FunctionParams[];
    version: string;
    info?: string;
};
export type FunctionIDs = FunctionIDsAudio | FunctionIDsBrowser | FunctionIDsDataSources | FunctionIDsGeneral | FunctionIDsInput | FunctionIDsNDI | FunctionIDsOutput | FunctionIDsOverlay | FunctionIDsPlayList | FunctionIDsPreset | FunctionIDsPTZ | FunctionIDsReplay | FunctionIDsScripting | FunctionIDsTitle | FunctionIDsTransition;
export type FunctionParams = {
    name: string;
    default?: string | number;
    description?: string;
    required: boolean;
    range?: EnumRange | IntRange | NumberRange;
};
type EnumRange = {
    type: 'enum';
    values: (string | number)[];
};
type IntRange = {
    type: 'int';
    min?: number;
    max?: number;
};
type NumberRange = {
    type: 'number';
    min?: number;
    max?: number;
};
export declare const functions: VMixFunction[];
export {};