Skip to content

REVO / API version 0.0.10

IVoice

Property Type Details
channels
readonly
readonly IVoiceChannelInfo[] Frozen channel snapshots, updated asynchronously. Empty while disconnected.
connected
readonly
boolean —
talkingPlayers
readonly
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
readonly number[] Selected channels with transmit permission. The microphone may be inactive.

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.

Parameter Type
player number | Player

number


getPlayerVolume(player): number

Parameter Type
player number | Player

number


isPlayerMuted(player): boolean

Parameter Type
player number | Player

boolean


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.

Parameter Type
player number | Player

boolean


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.

Parameter Type
player number | Player
muted boolean

boolean


setPlayerVolume(player, volume): boolean

Playback gain in dB: -100..12, default 0. Independent of mute. Positive gain uses peak limiting. Does not change getPlayerLevel().

Parameter Type
player number | Player
volume number

boolean


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.

Parameter Type
networkIds readonly number[] | null

boolean