Class AVClientInterface

master

settings

isVoicePTT

• get isVoicePTT(): boolean

• Is audio broadcasting push-to-talk enabled?

  Returns boolean

isVoiceAlways

• get isVoiceAlways(): boolean

• Is audio broadcasting always enabled?

  Returns boolean

isVoiceActivated

• get isVoiceActivated(): boolean

• Is audio broadcasting voice-activation enabled?

  Returns boolean

isMuted

• get isMuted(): boolean

• Is the current user muted?

  Returns boolean

initialize

• initialize(): Promise<void>

• One-time initialization actions that should be performed for this client implementation. This will be called only once when the Game object is first set-up.

  Returns Promise<void>

connect

• connect(): Promise<boolean>

• Connect to any servers or services needed in order to provide audio/video functionality. Any parameters needed in order to establish the connection should be drawn from the settings object. This function should return a boolean for whether the connection attempt was successful.

  Returns Promise<boolean>

  Was the connection attempt successful?

disconnect

• disconnect(): Promise<boolean>

• Disconnect from any servers or services which are used to provide audio/video functionality. This function should return a boolean for whether a valid disconnection occurred.

  Returns Promise<boolean>

  Did a disconnection occur?

getAudioSinks

• getAudioSinks(): Promise<{
      object: any;
  }>

• Provide an Object of available audio sources which can be used by this implementation. Each object key should be a device id and the key should be a human-readable label.

  Returns Promise<{
      object: any;
  }>

getAudioSources

• getAudioSources(): Promise<{
      object: any;
  }>

• Provide an Object of available audio sources which can be used by this implementation. Each object key should be a device id and the key should be a human-readable label.

  Returns Promise<{
      object: any;
  }>

getVideoSources

• getVideoSources(): Promise<{
      object: any;
  }>

• Provide an Object of available video sources which can be used by this implementation. Each object key should be a device id and the key should be a human-readable label.

  Returns Promise<{
      object: any;
  }>

getConnectedUsers

• getConnectedUsers(): string[]

• Return an array of Foundry User IDs which are currently connected to A/V. The current user should also be included as a connected user in addition to all peers.

  Returns string[]

  The connected User IDs

getMediaStreamForUser

• getMediaStreamForUser(userId): MediaStream

• Provide a MediaStream instance for a given user ID

  Parameters

  • userId: string

    The User id

  Returns MediaStream

  The MediaStream for the user, or null if the user does not have one

getLevelsStreamForUser

• getLevelsStreamForUser(userId): MediaStream

• Provide a MediaStream for monitoring a given user's voice volume levels.

  Parameters

  • userId: string

    The User ID.

  Returns MediaStream

  The MediaStream for the user, or null if the user does not have one.

isAudioEnabled

• isAudioEnabled(): boolean

• Is outbound audio enabled for the current user?

  Returns boolean

isVideoEnabled

• isVideoEnabled(): boolean

• Is outbound video enabled for the current user?

  Returns boolean

toggleAudio

• toggleAudio(enable): void

• Set whether the outbound audio feed for the current game user is enabled. This method should be used when the user marks themselves as muted or if the gamemaster globally mutes them.

  Parameters

  • enable: boolean

    Whether the outbound audio track should be enabled (true) or disabled (false)

  Returns void

toggleBroadcast

• toggleBroadcast(broadcast): void

• Set whether the outbound audio feed for the current game user is actively broadcasting. This can only be true if audio is enabled, but may be false if using push-to-talk or voice activation modes.

  Parameters

  • broadcast: boolean

    Whether outbound audio should be sent to connected peers or not?

  Returns void

toggleVideo

• toggleVideo(enable): void

• Set whether the outbound video feed for the current game user is enabled. This method should be used when the user marks themselves as hidden or if the gamemaster globally hides them.

  Parameters

  • enable: boolean

    Whether the outbound video track should be enabled (true) or disabled (false)

  Returns void

setUserVideo

• setUserVideo(userId, videoElement): Promise<void>

• Set the Video Track for a given User ID to a provided VideoElement

  Parameters

  • userId: string

    The User ID to set to the element
  • videoElement: HTMLVideoElement

    The HTMLVideoElement to which the video should be set

  Returns Promise<void>

onSettingsChanged

• onSettingsChanged(changed): void

• Handle changes to A/V configuration settings.

  Parameters

  • changed: object

    The settings which have changed

  Returns void

updateLocalStream

• updateLocalStream(): Promise<void>

• Replace the local stream for each connected peer with a re-generated MediaStream.

  Returns Promise<void>