AudioUser

The user object defines the user that will be participating in the audio channels.

Constructor

const user = new AudioUser(id [, options])

Parameter

Required

Description

id

Yes

Unique User Identifier

options

No

UserOptions

Property

Description

name

Name to be displayed in the list of participants for the current user. If not provided, a name will be generated from the user id and deviceId

deviceId

Unique device identifier. If not provided a random id will be generated.

Example AudioUser Instantiation

 const user = new AudioUser(
   "Some unique id",
   {
     name: "Some display name for the user",
     deviceId: "Some unique id associated with user's current device"
   }
 );

Properties

Property

Description

id

User Identifier

name

Name to be displayed in the list of participants for the current user. If not provided, a name will be generated from the user id and deviceId

deviceId

Unique device identifier. If not provided a random id will be generated.

Last updated