Member Junction
    Preparing search index...

    Interface ChannelInboundVideoBridgeOptions

    Options for the inbound channel video bridge.

    interface ChannelInboundVideoBridgeOptions {
        Arbiter?: VideoSourceArbiter;
        ChannelKey?: string;
        Kind?: VideoSourceKind;
        Label?: string;
        MimeType?: string;
        Rate?: number;
        SourceID?: string;
    }
    Index

    Properties

    Arbiter? ChannelKey? Kind? Label? MimeType? Rate? SourceID?

    Properties

    Arbiter?: VideoSourceArbiter

    The arbiter to register with. Defaults to the one for the session's client (VideoSourceArbiter.ForSink), which is what makes it a single writer. Override for tests.

    ChannelKey?: string

    The channel this source belongs to, so the UI can map it to the user's persisted per-channel choice.

    Kind?: VideoSourceKind

    What kind of source this is. Defaults to 'surface' (a channel surface, not a user capture).

    Label?: string

    Human-readable name used in notes to the model and in the UI's "agent can see" list. Defaults to the source id.

    MimeType?: string

    Output MIME type. Defaults to 'image/jpeg'.

    Rate?: number

    Target poll rate in fps for ChannelInboundVideoBridge.Start.

    The poll follows the rate the inbound video track NEGOTIATED (the model's own ceiling), read from the client. When set, the poll runs at the lower of this and the negotiated rate; it is no longer clamped to a constant 1 fps.

    SourceID?: string

    The id this source registers under. Defaults to a unique generated id. A channel passes a stable one (<channel>#<instance>) so the UI can address the source.

    Settings

    Member Visibility

    On This Page

    Properties