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

    Interface DiscoveredSurfaceInfo<TInfo>

    Information about a discovered surface

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

    Type Parameters

    • TInfo

    Hierarchy (View Summary)

    Index

    Properties

    description pluginInfo surfaceId surfaceIdIsNotUnique?

    Properties

    description: string

    Human friendly description of the surface. Typically a model name

    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

    Settings

    Member Visibility

    On This Page

    Properties