Agora C++ API Reference for All Platforms
agora::rtc::AudioVolumeInfo Struct Reference

#include <IAgoraRtcEngine.h>

Public Attributes

uid_t uid
unsigned int volume
unsigned int vad
const char * channelId

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 = 0.
  • In the remote users' callback, uid is the ID of a remote user whose instantaneous volume is one of the three highest.

◆ volume

unsigned int agora::rtc::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

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.
  • 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

const char* agora::rtc::AudioVolumeInfo::channelId

The name of the channel where the user is in.