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

    Interface DetectionSurfaceInfo<TInfo>

    Information about a surface discovered via a detection/remote mechanism. Extends DiscoveredSurfaceInfo with a stable tracking handle (deviceHandle) that can be used to re-identify the same physical device between scans.

    interface DetectionSurfaceInfo<TInfo> {
        description: string;
        deviceHandle: string;
        pluginInfo: TInfo;
        surfaceId: string;
        surfaceIdIsNotUnique?: boolean;
    }

    Type Parameters

    • TInfo

    Hierarchy (View Summary)

    Index

    Properties

    description: string

    Human friendly description of the surface. Typically a model name

    deviceHandle: string

    A stable unique identifier for the device. This is used to identify the same physical device between scans and operations, until it is disconnected. It is not shown to the user

    This is the same logical concept that other interfaces may refer to as devicePath, but is named deviceHandle here because, depending on the transport or platform, it may not literally be a filesystem path. For USB devices it will typically be the device path, while for other transports it can be another stable identifier.

    pluginInfo: TInfo

    Plugin specific info about the surface

    surfaceId: string

    Desired id of the surface. Typically a serialnumber. It may not be opened with this id, as collisions may be resolved by the host This does not have to be unique, if collisions are found it will be given a suffix to make it unique

    surfaceIdIsNotUnique?: boolean

    Set this to true if the surface id is known to not be unique and should always be given a suffix Otherwise, a suffix will only be added if a collision is detected