Member Junction
    Preparing search index...

    How the pump reaches the channel and the session.

    interface VisualPerceptionPumpHost {
        CaptureFrame(): Promise<string | null>;
        GetCadenceMs(): number;
        GetChangeId(): number;
        GetSink(): VisualFrameSink | null;
        IsInboundVideoEstablished(): boolean;
        IsPermitted?(): boolean;
        OnError(context: string, error: unknown): void;
        OnFramePushed(
            frame: string,
            reason: VisualFrameReason,
            changeId: number,
        ): void;
        SendConfirmationNote(changeId: number): void;
    }
    Index

    Methods

    • Renders the current frame as a base64 JPEG, or null when none is available.

      Returns Promise<string | null>

    • Whether the session has an established inbound video track — without one the pump is inert.

      Returns boolean

    • Whether exposure policy currently lets this channel show the model pixels. Optional: absent means permitted. While false the pump captures and sends nothing and drops any pending settle.

      Returns boolean

    • Logs a problem; the pump never throws into a timer or an unawaited promise.

      Parameters

      • context: string
      • error: unknown

      Returns void

    • Sends the "do not narrate your own change" note after a confirmation frame the sink took.

      Parameters

      • changeId: number

      Returns void