AudioVolumeInfo

User volume information.

public class AudioVolumeInfo
    {
        public AudioVolumeInfo()
        {
            uid = 0;
            volume = 0;
            vad = 0;
            voicePitch = 0.0;
        }

        public AudioVolumeInfo(uint uid, uint volume, uint vad, double voicePitch)
        {
            this.uid = uid;
            this.volume = volume;
            this.vad = vad;
            this.voicePitch = voicePitch;
        }

        public uint uid { set; get; }
        public uint volume { set; get; }
        public uint vad { set; get; }
        public double voicePitch { set; get; }
    }

Properties

uid
User ID.
  • In the callback for the local user, uid is 0.
  • In the callback for remote users, uid is the ID of the remote user with the highest instantaneous volume (up to 3 users).
volume
User's volume, ranging from [0,255]. If the user mutes themselves (sets MuteLocalAudioStream to true) but audio capture is still enabled, the volume value indicates the volume of the locally captured signal.
vad
Note:
  • vad cannot report the voice activity 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.
Voice activity status of the local user.
  • 0: No voice detected locally.
  • 1: Voice detected locally.
voicePitch
Voice pitch of the local user (Hz). Value range: [0.0, 4000.0].
Note: voicePitch cannot report the voice pitch of remote users. For remote users, the value of voicePitch is always 0.0.