AudioVolumeInfo

User volume information.

export class AudioVolumeInfo {

  uid?: number;

  volume?: number;

  vad?: number;

  voicePitch?: number;
}

Properties

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