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

    Interface SurfaceModuleManifest

    This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

    interface SurfaceModuleManifest {
        $schema?: string;
        allowMultipleInstances?: boolean;
        bugs: string;
        description: string;
        id: string;
        isPrerelease?: boolean;
        keywords: string[];
        license: string;
        maintainers: SurfaceModuleManifestMaintainer[];
        name: string;
        products: [string, ...string[]];
        repository: string;
        runtime: SurfaceModuleManifestRuntime;
        shortname: string;
        type: "surface";
        usbIds: SurfaceModuleManifestUsbIds[];
        version: string;
    }
    Index

    Properties

    $schema? allowMultipleInstances? bugs description id isPrerelease? keywords license maintainers name products repository runtime shortname type usbIds version

    Properties

    $schema?: string
    allowMultipleInstances?: boolean

    Whether multiple instances of this module can be run simultaneously

    bugs: string

    URL to bug tracker

    description: string

    Description of the module

    id: string

    Unique identifier for the module

    isPrerelease?: boolean

    Is this a pre-release version

    keywords: string[]
    license: string

    SPDX identifier for license of the module

    maintainers: SurfaceModuleManifestMaintainer[]

    List of active maintiners

    name: string

    Name of the module

    products: [string, ...string[]]

    1

    repository: string

    URL to the source repository

    runtime: SurfaceModuleManifestRuntime
    shortname: string
    type: "surface"

    Type of module. Must be: surface

    usbIds: SurfaceModuleManifestUsbIds[]

    List of USB vendor and product IDs that the module supports. Your module will only be notified of devices matching these IDs.

    version: string

    Current version of the module

    Settings

    Member Visibility

    On This Page

    Properties