Agora C++ API Reference for All Platforms
|
Public Member Functions | |
AudioVolumeInfo () | |
Public Attributes | |
uid_t | uid |
unsigned int | volume |
unsigned int | vad |
double | voicePitch |
The volume information of users.
|
inline |
uid_t agora::rtc::AudioVolumeInfo::uid |
User ID of the speaker.
uid
= 0.uid
is the user ID of a remote user whose instantaneous volume is one of the three highest. 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 user calls startAudioMixing
, the value of volume is the volume after audio mixing.
unsigned int agora::rtc::AudioVolumeInfo::vad |
Voice activity status of the local user.
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.reportVad
to true when calling enableAudioVolumeIndication
. double agora::rtc::AudioVolumeInfo::voicePitch |
The voice pitch (Hz) of the local user. The value ranges between 0.0 and 4000.0.
voicePitch
parameter does not report the voice pitch of remote users. In the remote users' callback, the value of voicePitch
is always 0.0.