The volume information of users. More...

#include <AgoraBase.h>

Public Attributes
uid_t	uid

unsigned int	volume

unsigned int	vad

double	voicePitch

Detailed Description

The volume information of users.

Member Data Documentation

◆ uid

uid_t agora::rtc::AudioVolumeInfo::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

unsigned int agora::rtc::AudioVolumeInfo::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. If the user calls startAudioMixing(const char* filePath, bool loopback, int cycle, int startPos), the value of volume indicates the volume after audio mixing.

◆ vad

unsigned int agora::rtc::AudioVolumeInfo::vad

Voice activity status of the local user.

0: The local user is not speaking.
1: The local user is speaking.
Note
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

double agora::rtc::AudioVolumeInfo::voicePitch

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

Note: 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.