openmixer — generated API reference
    Preparing search index...

    Interface AdapterInstance

    A live adapter instance: a startable/stoppable binding with a status. The factory produces this; the manager drives its lifecycle. A concrete adapter is free to also be a canonical MixerAdapter — this is the minimal shape the manager needs to own it.

    interface AdapterInstance {
        status: AdapterStatus;
        detail?(): Promise<string | undefined>;
        start(): Promise<void>;
        stop(): Promise<void>;
    }

    Implemented by

    Index
    status
    detail? start stop
    status: AdapterStatus

    Current status.

    • Optional richer status detail beyond status (see AdapterStatusReport.detail). Read FRESH on every AdapterStatusReport — never cached by the manager — so a type whose generic status alone would mislead (started ≠ actually connected) can report the live truth instead. Absent for types with nothing finer-grained to add.

      Returns Promise<string | undefined>

    • Start the binding (connect, subscribe).

      Returns Promise<void>

    • Stop the binding and release resources.

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods