Agora Java API Reference for Android
io.agora.rtc.IRtcEngineEventHandler.AudioVolumeInfo Class Reference

Public Attributes

int uid
 
int volume
 
int vad
 
String channelId
 

Detailed Description

Properties of the audio volume information. An array containing the user ID and volume information for each speaker.

Member Data Documentation

◆ uid

int io.agora.rtc.IRtcEngineEventHandler.AudioVolumeInfo.uid

The user ID.

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

◆ volume

int io.agora.rtc.IRtcEngineEventHandler.AudioVolumeInfo.volume

The volume of each user after audio mixing. The value ranges between 0 (lowest volume) and 255 (highest volume). In the local user's callback, volume = totalVolume.

◆ vad

int io.agora.rtc.IRtcEngineEventHandler.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 cannot report the voice activity status of remote users. In the remote users' callback, vad is always 1.
  • To use this parameter, you must set the report_vad parameter to true when calling enableAudioVolumeIndication.

◆ channelId

String io.agora.rtc.IRtcEngineEventHandler.AudioVolumeInfo.channelId

The name of the channel where the user is in.