REVO / API version 0.0.10
IVoice
Properties
Section titled “Properties”| Property | Type | Details |
|---|---|---|
channels |
readonly IVoiceChannelInfo[] |
Frozen channel snapshots, updated asynchronously. Empty while disconnected. |
connected |
boolean |
— |
talkingPlayers |
readonly Player[] |
Frozen list of streamed-in players transmitting to this client, including the local player while transmitting. Local mute and volume settings leave this list unchanged. |
transmitChannels |
readonly number[] |
Selected channels with transmit permission. The microphone may be inactive. |
Methods
Section titled “Methods”getPlayerLevel()
Section titled “getPlayerLevel()”getPlayerLevel(
player):number
Smoothed RMS level, 0..1. Returns 0 for inactive or unknown players. Remote levels are measured before effects, distance, listener gain and mute. Local levels use processed microphone frames being transmitted, before encoding.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
player |
number | Player |
Returns
Section titled “Returns”number
getPlayerVolume()
Section titled “getPlayerVolume()”getPlayerVolume(
player):number
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
player |
number | Player |
Returns
Section titled “Returns”number
isPlayerMuted()
Section titled “isPlayerMuted()”isPlayerMuted(
player):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
player |
number | Player |
Returns
Section titled “Returns”boolean
isPlayerTalking()
Section titled “isPlayerTalking()”isPlayerTalking(
player):boolean
True while sending or receiving voice frames. Becomes false after a short gap. For the local player, this is true only while transmitting to others.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
player |
number | Player |
Returns
Section titled “Returns”boolean
setPlayerMuted()
Section titled “setPlayerMuted()”setPlayerMuted(
player,muted):boolean
Mutes the player locally across all channels. Returns false for unknown IDs. Lasts until the player disconnects or the resource that last changed the setting stops.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
player |
number | Player |
muted |
boolean |
Returns
Section titled “Returns”boolean
setPlayerVolume()
Section titled “setPlayerVolume()”setPlayerVolume(
player,volume):boolean
Playback gain in dB: -100..12, default 0. Independent of mute. Positive gain uses peak limiting. Does not change getPlayerLevel().
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
player |
number | Player |
volume |
number |
Returns
Section titled “Returns”boolean
setTransmitChannels()
Section titled “setTransmitChannels()”setTransmitChannels(
networkIds):boolean
Selects up to 16 channels by network ID. [] disables transmission. null restores automatic selection. Returns false for unknown channels. Invalid or duplicate IDs throw. Transmission still requires server permission and an enabled microphone. Each successful call replaces the selection. Stopping that resource restores automatic selection.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
networkIds |
readonly number[] | null |
Returns
Section titled “Returns”boolean