@companion-module/base
    Preparing search index...

    Type Alias CompanionInternalActionSchemas

    Companion's built-in "internal" actions that may be referenced from a module's presets.

    These are exposed under reserved internal:* ids which are merged into the preset action manifest, so they can be used alongside a module's own actions in presets. Companion translates each of these to the matching internal action when a preset is imported onto a control, resolving any references (such as the button location) to the control the preset is placed on.

    This list is deliberately small and self-scoped; it can grow over future api versions. When adding a new entry, also add it to INTERNAL_PRESET_MIN_API_VERSION.

    type CompanionInternalActionSchemas = {
        "internal:abortButton": { options: { skipReleaseActions?: boolean } };
        "internal:customLog": { options: { message: string } };
        "internal:localVariableSet": { options: { name: string; value: string } };
        "internal:wait": { options: { time: number } };
    }
    Index

    Properties

    internal:abortButton internal:customLog internal:localVariableSet internal:wait

    Properties

    "internal:abortButton": { options: { skipReleaseActions?: boolean } }

    Abort the actions currently running on this button

    "internal:customLog": { options: { message: string } }

    Write a message to the Companion log

    "internal:localVariableSet": { options: { name: string; value: string } }

    Set the value of one of this button's local variables

    "internal:wait": { options: { time: number } }

    Wait for a specified amount of time

    Settings

    Member Visibility

    On This Page

    Properties