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

    Interface DiscoveredRemoteSurfaceInfo

    interface DiscoveredRemoteSurfaceInfo {
        addresses: string | null;
        config: OptionsObject;
        description: string;
        displayName: string;
        id: string;
    }
    Index

    Properties

    addresses: string | null

    An address (if applicable) for the connection. Such as an IP or hostname This is used for display purposes, not for connecting.

    The configuration object to use for connecting to this remote surface. This should match the schema defined with configFields, as once added it will be user editable with those fields

    description: string

    A secondary description for the connection. Such as the model or device type

    displayName: string

    A user friendly name for the connection. Such as the hostname or user chosen name

    id: string

    A unique id. This is used to identify the connection for updates and being forgotten