AgoraRtcAudioVolumeInfo Class Reference

Inherits from NSObject
Declared in AgoraObjects.h

Overview

Properties of the audio volume information.

  uid

The user ID.

@property (assign, nonatomic) NSUInteger uid

Discussion

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

Declared In

AgoraObjects.h

  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.

@property (assign, nonatomic) NSUInteger volume

Declared In

AgoraObjects.h

  vad

Voice activity status of the local user.

@property (assign, nonatomic) NSUInteger vad

Discussion

  • 0: The local user is not speaking.
  • 1: The local user is speaking.

Note

  • The vad parameter cannot report the voice activity status of the remote users. In the remote users' callback, vad is always 0.
  • To use this parameter, you must set the report_vad parameter to YES when calling enableAudioVolumeIndication.

Declared In

AgoraObjects.h

  channelId

The name of the channel where the user is in.

@property (copy, nonatomic) NSString *channelId

Declared In

AgoraObjects.h