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

    Interface SurfaceRegisterProps

    Describes the capabilities of a surface when it is registered

    interface SurfaceRegisterProps {
        brightness: boolean;
        canChangePage?: { label: string };
        configFields: SomeCompanionInputField[] | null;
        location: string | null;
        pincodeMap: SurfacePincodeMap | null;
        surfaceLayout: SurfaceSchemaLayoutDefinition;
        transferVariables?: (SurfaceInputVariable | SurfaceOutputVariable)[];
    }
    Index

    Properties

    brightness canChangePage? configFields location pincodeMap surfaceLayout transferVariables?

    Properties

    brightness: boolean

    Whether the surface supports setting brightness

    canChangePage?: { label: string }

    When set, enables the changePage context method and provides a user-facing label describing the gesture or action that triggers it (e.g. 'Horizontal Swipe Changes Page'). Omit or set to undefined to disable page-changing entirely for this surface. Note: The user must enable this in the surface settings before it will be accepted

    configFields: SomeCompanionInputField[] | null

    Any configuration fields for the surface

    location: string | null

    A user facing location string for the surface

    pincodeMap: SurfacePincodeMap | null

    If the surface supports pincode entry, this is the desired arrangement of the pin entry buttons Set to null to disable pincode entry,

    surfaceLayout: SurfaceSchemaLayoutDefinition

    The definition of the controls on the surface and the properties needed for drawing

    transferVariables?: (SurfaceInputVariable | SurfaceOutputVariable)[]

    Describes any custom input or output variables for the surface These are typically used for reporting values such as a tbar or battery level. Or for providing non-button values such as leds next to a tbar

    Settings

    Member Visibility

    On This Page

    Properties