Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AVSettings

property

{boolean} [muted] Whether this user has muted themselves.

property

{boolean} [hidden] Whether this user has hidden their video.

property

{boolean} [speaking] Whether the user is broadcasting audio.

Hierarchy

  • AVSettings

Index

Constructors

Properties

Methods

Accessors

Constructors

constructor

Properties

_set

_set: any

_change

_change: any

activity

activity: Object = {}

Stores the transient AV activity data received from other users.

client

client: any

world

world: any

_original

_original: any

Static AV_MODES

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

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

Type declaration

  • DISABLED: number
  • AUDIO: number
  • VIDEO: number
  • AUDIO_VIDEO: number

Static VOICE_MODES

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

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

Type declaration

  • ALWAYS: string
  • ACTIVITY: string
  • PTT: string

Static NAMEPLATE_MODES

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

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

Type declaration

  • OFF: number
  • BOTH: number
  • PLAYER_ONLY: number
  • CHAR_ONLY: number

Static DOCK_POSITIONS

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

AV dock positions.

Type declaration

  • TOP: string
  • RIGHT: string
  • BOTTOM: string
  • LEFT: string

Static DEFAULT_CLIENT_SETTINGS

DEFAULT_CLIENT_SETTINGS: any = ...

Default client AV settings.

Static DEFAULT_WORLD_SETTINGS

DEFAULT_WORLD_SETTINGS: any = ...

Default world-level AV settings.

Static DEFAULT_USER_SETTINGS

DEFAULT_USER_SETTINGS: any = ...

Default client settings for each connected user.

Methods

initialize

  • initialize(): void

  • Returns void

changed

  • changed(): any

  • Returns any

get

  • get(scope: any, setting: any): any

  • Parameters

    • scope: any
    • setting: any

    Returns any

getUser

  • getUser(userId: any): any

  • Parameters

    • userId: any

    Returns any

set

  • set(scope: any, setting: any, value: any): void

  • Parameters

    • scope: any
    • setting: any
    • value: any

    Returns void

handleUserActivity

  • Handle another connected user changing their AV settings.

    Parameters

    Returns void

Private _getUserSettings

  • _getUserSettings(user: any): any

  • Prepare a standardized object of user settings data for a single User

    Parameters

    • user: any

    Returns any

Private _onSettingsChanged

  • _onSettingsChanged(): void

  • Handle setting changes to either rctClientSettings or rtcWorldSettings.

    Returns void

Accessors

users

  • get users(): any

  • Return a mapping of AV settings for each game User.

    Returns any

verticalDock

  • get verticalDock(): boolean

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

    Returns boolean