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

    Type Alias CompanionInternalFeedbackSchemas

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

    As with CompanionInternalActionSchemas, these are exposed under reserved internal:* ids and translated by Companion at preset import time. The type of each feedback drives whether a style (and isInverted) is required when used in a preset, exactly as for a module's own feedbacks.

    When adding a new entry, also add it to INTERNAL_PRESET_MIN_API_VERSION.

    type CompanionInternalFeedbackSchemas = {
        "internal:buttonCurrentStep": {
            options: { step: number };
            type: "boolean";
        };
        "internal:buttonPushed": {
            options: { treatSteppedAsPressed?: boolean };
            type: "boolean";
        };
        "internal:checkExpression": {
            options: { expression: string };
            type: "boolean";
        };
    }
    Index

    Properties

    internal:buttonCurrentStep internal:buttonPushed internal:checkExpression

    Properties

    "internal:buttonCurrentStep": { options: { step: number }; type: "boolean" }

    Change style based on the current step of this button

    "internal:buttonPushed": {
        options: { treatSteppedAsPressed?: boolean };
        type: "boolean";
    }

    Change style when this button is being pressed

    "internal:checkExpression": { options: { expression: string }; type: "boolean" }

    Change style based on a boolean expression

    Settings

    Member Visibility

    On This Page

    Properties