AudioChannel

The current channel object defines the audio channel that the user is currently participating in.

Constructor

const channel = new AudioChannel(id [, options])

Property

Required

Description

id

Yes

Unique alphanumeric channel identifier

options

No

ChannelOptions

Property

Default

Description

isFullDuplex

false

If true this is a full duplex channel. Otherwise it is a PTT channel.

languageCode

en-US

BCP 47 language code that denotes the language that user speaks and wants to hear from TTS. See: Supported Language Codes.

Example AudioChannel Instantiation

const currentChannel = new AudioChannel(
  'Unique id for the channel',
  {
    isFullDuplex: false
  }
}

Properties

Property

Description

id

Channel Identifier

isFullDuplex

If true this is a full duplex channel. Otherwise it is a PTT channel.

languageCode

BCP 47 language code that denotes the language that user speaks and wants to hear from TTS. See: Supported Language Codes.

Methods

getParticipants()

Once the user is connected to the channel, this methos returns the current list of participants in the channel.

Last updated