Video SDK v3.7.1 API Reference for Unity
Public Attributes | List of all members
agora_gaming_rtc.AudioVolumeInfo Struct Reference

Public Attributes

uint uid
uint volume
uint vad
string channelId

Detailed Description

The volume information of users.

Member Data Documentation

◆ uid

uint agora_gaming_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

uint agora_gaming_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

uint agora_gaming_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 0.
  • To use this parameter, you must set the report_vad parameter to true when calling EnableAudioVolumeIndication.

◆ channelId

string agora_gaming_rtc.AudioVolumeInfo.channelId

The name of the channel where the user is in.

The documentation for this struct was generated from the following file: