Member Junction
    Preparing search index...

    Interface VisualPerceptionOptions

    Options for BaseRealtimeChannelClient.EnableVisualPerception.

    interface VisualPerceptionOptions {
        ConfirmationNote?: string | ((changeId: number) => string);
        StartBridgePoller?: boolean;
    }
    Index

    Properties

    ConfirmationNote? StartBridgePoller?

    Properties

    ConfirmationNote?: string | ((changeId: number) => string)

    The note sent after a confirmation frame — a literal string, or a function of the change id. Default: a structured frame_confirmed note carrying a do-not-narrate instruction. The Whiteboard passes its original wording to stay byte-for-byte what it was.

    StartBridgePoller?: boolean

    Also start the shared bridge's fixed-rate poller (1 fps) once the video track is up.

    Default false: the pump is purely change-driven. This exists ONLY so the Whiteboard keeps the behavior it had before the pump was lifted: it has always started the bridge's poller (which re-sends the board every second regardless of change) despite its own comments and design stating it is heartbeat-free. Nothing new should set this.

    Settings

    Member Visibility

    On This Page

    Properties