AudioVolumeInfo | Video SDK v1.3.1_3.1 API Reference for Cocos Creator

Properties of the audio volume information.

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

Hierarchy

AudioVolumeInfo

Index

Properties

channelId
uid
vad
volume

Properties

channelId

channelId: string

The channel name the user is in.

uid

uid: number

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.

vad

vad: number

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

volume

volume: number

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.