AudioVolumeInfo

User volume information.

export class AudioVolumeInfo {

  uid?: number;

  volume?: number;

  vad?: number;

  voicePitch?: number;
}

Properties

uid
User ID.
  • In the local user callback, uid is 0.
  • In the remote user callback, uid is the ID of the remote user (up to 3) with the highest instantaneous volume.
volume
User volume, range [0,255]. If the user mutes themselves (sets muteLocalAudioStream to true) but enables audio capture, the volume value indicates the volume of the locally captured signal.
vad
Note:
  • vad cannot report the voice status of remote users. For remote users, the value of vad is always 1.
  • To use this parameter, set reportVad to true when calling enableAudioVolumeIndication.
Local user's voice activity status.
  • 0: No voice detected locally.
  • 1: Voice detected locally.
voicePitch
Local user's voice pitch (Hz). Value range: [0.0,4000.0].
Note: voicePitch cannot report the pitch of remote users. For remote users, the value of voicePitch is always 0.0.