openmixer — generated API reference
    Preparing search index...

    Interface ResourceBroadcast<S>

    What every client is told after a successful patch or a reproject. Uniform across all entities; id is the canonical spelling; projection carries what the audio actually did.

    interface ResourceBroadcast<S extends object> {
        id: ResourceId;
        known?: readonly string[];
        path: string;
        projection?: ProjectionResult;
        state: S;
    }

    Type Parameters

    • S extends object
    Index
    known?: readonly string[]

    Which fields of state the entity actually KNOWS, when it draws that distinction.

    path: string
    projection?: ProjectionResult

    Absent when the patch changed nothing (a no-op projects nothing).

    state: S