Agora RTC Objective-C API Reference  Refactor
Data Fields
AudioVolumeInfo Struct Reference

Data Fields

uid_t uid
 
unsigned int volume
 
unsigned int vad
 
double voicePitch
 

Detailed Description

The volume information of users.

Constructor & Destructor Documentation

◆ AudioVolumeInfo()

AudioVolumeInfo ( )
inline

Field Documentation

◆ uid

uid_t uid

User ID of the speaker.

  • In the local user's callback, uid = 0.
  • In the remote users' callback, uid is the user ID of a remote user whose instantaneous volume is one of the three highest.

◆ volume

unsigned int 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.

◆ vad

unsigned int 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 voicePitch

The voice pitch (Hz) 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.