Member Junction
    Preparing search index...

    Interface VideoSourceDescriptor

    What a source registers itself as.

    interface VideoSourceDescriptor {
        ChannelKey?: string;
        Enabled?: boolean;
        Kind?: VideoSourceKind;
        Label: string;
        SourceID: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    ChannelKey? Enabled? Kind? Label SourceID

    Properties

    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

    Whether a newly registered source starts enabled. Default true. A source the agent may not see yet registers disabled, so the model is never told it is looking at it. Ignored for an id that is already registered; use VideoSourceArbiter.SetSourceEnabled for that.

    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.

    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