Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Class AVSettings

    Index

    Properties

    activity changed AV_MODES DOCK_POSITIONS NAMEPLATE_MODES VOICE_MODES

    Accessors

    users verticalDock DEFAULT_USER_SETTINGS schemaFields

    Methods

    handleUserActivity register

    Properties

    activity: Record<string, AVSettingsData> = {}

    Stores the transient AV activity data received from other users.

    changed: () => void

    A debounce callback for when either the world or client settings change.

    AV_MODES: {
        AUDIO: number;
        AUDIO_VIDEO: number;
        DISABLED: number;
        VIDEO: number;
    } = ...

    WebRTC Mode, Disabled, Audio only, Video only, Audio & Video

    DOCK_POSITIONS: { BOTTOM: string; LEFT: string; RIGHT: string; TOP: string } = ...

    AV dock positions.

    NAMEPLATE_MODES: {
        BOTH: number;
        CHAR_ONLY: number;
        OFF: number;
        PLAYER_ONLY: number;
    } = ...

    Displayed nameplate options: Off entirely, animate between player and character name, player name only, character name only.

    VOICE_MODES: { ACTIVITY: string; ALWAYS: string; PTT: string } = ...

    Voice modes: Always-broadcasting, voice-level triggered, push-to-talk.

    Accessors

    • get users(): object

      Return a mapping of AV settings for each game User.

      Returns object

    • get verticalDock(): boolean

      A helper to determine if the dock is configured in a vertical position.

      Returns boolean

    • get DEFAULT_USER_SETTINGS(): object

      Default client settings for each connected user.

      Returns object

    Methods

    • Handle another connected user changing their AV settings.

      Parameters

      Returns void

    • Register world and client WebRTC settings.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods