Member Junction
    Preparing search index...

    Interface MediaParticipant

    One person or agent in a session, as the media stage and its tiles see them.

    interface MediaParticipant {
        AgentCanSee?: boolean;
        ConnectionQuality?: MediaConnectionQuality;
        DisplayName: string;
        GetAudioLevel?: () => number;
        Identity: string;
        IsMuted?: boolean;
        IsSpeaking: boolean;
        PreferredVideo?: MediaSourceKind;
        Role: "self" | "agent" | "host" | "participant";
        Video: Partial<Record<MediaSourceKind, MediaVideoSource>>;
    }
    Index

    Properties

    AgentCanSee? ConnectionQuality? DisplayName GetAudioLevel? Identity IsMuted? IsSpeaking PreferredVideo? Role Video

    Properties

    AgentCanSee?: boolean

    Whether an agent can see this participant's camera and shared screen: they allowed it, and an agent is there to watch. A tile shows "Agent can see". Absent means no.

    ConnectionQuality?: MediaConnectionQuality

    The connection's quality, when the platform reports one.

    DisplayName: string
    GetAudioLevel?: () => number

    Reads the participant's current audio level, 0..1, for a meter. Called on every animation frame.

    Identity: string

    Stable identity within the session.

    IsMuted?: boolean

    Whether the participant's microphone is off.

    IsSpeaking: boolean

    Whether the participant is speaking now.

    PreferredVideo?: MediaSourceKind

    Which video a tile shows when there are several. Defaults to a shared screen, then the camera, then the avatar.

    Role: "self" | "agent" | "host" | "participant"

    'self' is the local user.

    Video: Partial<Record<MediaSourceKind, MediaVideoSource>>

    The participant's videos, by kind: a camera, a shared screen, an avatar.

    Settings

    Member Visibility

    On This Page

    Properties