Member Junction
    Preparing search index...

    Interface VideoSourceState

    A source as the arbiter currently sees it.

    interface VideoSourceState {
        Active: boolean;
        ChannelKey?: string;
        Enabled: boolean;
        FramesSent: number;
        Kind?: VideoSourceKind;
        Label: string;
        LastFrameAt?: number;
        Picked?: boolean;
        SourceID: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    Active ChannelKey? Enabled FramesSent Kind? Label LastFrameAt? Picked? SourceID

    Properties

    Active: boolean

    Whether the arbiter is currently forwarding this source's frames to the model.

    ChannelKey?: string

    The channel this source belongs to, when it comes from one. The UI maps a source to the user's persisted per-channel visual-perception choice by this key.

    Enabled: boolean

    false when the user (or exposure policy) turned the source off: it is not a candidate and sends nothing.

    FramesSent: number

    Frames forwarded to the model so far.

    Kind?: VideoSourceKind

    What kind of source this is. Defaults to 'surface'.

    Label: string

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

    LastFrameAt?: number

    Epoch ms of the last forwarded frame; undefined before the first.

    Picked?: boolean

    true while it is the user's pick (VideoSourceArbiter.SelectSource), which beats every other rule. Absent otherwise, and while nothing is picked the policy decides.

    SourceID: string

    Stable id of the source within the session. Registering an existing id updates it in place.

    Settings

    Member Visibility

    On This Page

    Properties