Member Junction
    Preparing search index...

    Shared bridge connecting a visual channel surface to the session's inbound video track, by way of the session's VideoSourceArbiter.

    Index

    Constructors

    Accessors

    Methods

    • Calls handler each time the arbiter starts sending this source to the model after it was not: another source that held the model's only stream stopped or was set aside, or this source was switched back on. The source's first registration does not count. A frame offered while the source was not sent never reached the model, so an owner that sends frames only when its picture changes sends its current picture here.

      The handler is kept across a re-registration (a reconnect's new client) and called until removed.

      Parameters

      • handler: () => void

        Called synchronously from the arbiter's change event; it should not throw.

      Returns () => void

      A function that removes the handler.

    • Pushes an event-driven frame (e.g. screencast push from RemoteBrowser or stroke completion). Registers the source on first use, so a purely event-driven channel never needs Start.

      Parameters

      • base64Jpeg: string

        The base64-encoded image frame.

      Returns boolean

      true if the frame was sent; false if dropped (throttled, not the source the model is viewing, turned off, track unestablished, or driver lacks video support).

    • Registers this bridge's source with the session's arbiter now, without starting any poll — so the source is LISTED (and can be switched on or off) before it has pushed a frame. A source that is switched off never pushes one, so without this it could never be switched back on.

      Returns boolean

      true if registered; false when there is no client or no inbound video track (nothing to register with).

    • Turns this source on or off at the arbiter (a no-op before the first registration other than remembering the choice). A disabled source is not a candidate and forwards nothing.

      Parameters

      • enabled: boolean

        Whether the model may see this source.

      • notify: boolean = true

        Whether the arbiter tells the model. Pass false when the caller sends its own note.

      Returns void

    • Starts the periodic frame pump if the session has an established inbound video track.

      Returns boolean

      true if video streaming was started; false if the model does not support inbound video (or track was not established), falling back to tool-only behaviour.