AudioVolumeInfo

The volume information of users.

export class AudioVolumeInfo {

  uid?: number;

  volume?: number;

  vad?: number;

  voicePitch?: number;
}

Attributes

uid
The user ID.
  • In the local user's callback, uid is 0.
  • In the remote users' callback, uid is the user ID of a remote user whose instantaneous volume is the highest.
volume
The volume of the user. The value ranges between 0 (the lowest volume) and 255 (the highest volume). If the local user enables audio capturing and calls muteLocalAudioStream and set it as true to mute, the value of volume indicates the volume of locally captured audio signal.
vad
Voice activity status of the local user.
  • 0: The local user is not speaking.
  • 1: The local user is speaking.
Attention:
  • The vad parameter does not report the voice activity status of remote users. In a remote user's callback, the value of vad is always 1.
  • To use this parameter, you must set reportVad to true when calling enableAudioVolumeIndication.
voicePitch

The voice pitch of the local user. The value ranges between 0.0 and 4000.0.

Attention: The voicePitch parameter does not report the voice pitch of remote users. In the remote users' callback, the value of voicePitch is always 0.0.