Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AudioVolumeInfo

Properties of the audio volume information. An array containing the user ID and volume information for each speaker.

Hierarchy

  • AudioVolumeInfo

Index

Properties

Properties

channelId

channelId: string

The channel ID, which indicates which channel the speaker is in.

uid

uid: number

The user ID of the speaker. The uid of the local user is 0.

vad

vad: number

Voice activity status of the local user.

  • 0: The local user is not speaking.
  • 1: The local user is speaking.

Note

  • The vad parameter cannot report the voice activity status of the remote users. In the remote users' callback, vad is always 1.
  • Ensure that you set report_vad(true) in the enableAudioVolumeIndication method to enable the voice activity detection of the local user.

volume

volume: number

The sum of the voice volume and audio-mixing volume of the speaker. The value ranges between 0 (lowest volume) and 255 (highest volume).

Generated using TypeDoc