Voice

const Voice: object

Defined in: client/api.d.ts:5236

Local player’s proximity voice chat settings: on/off, playback volume, hearing range and the push-to-talk binding.

Type Declaration

getActivationThreshold()

getActivationThreshold(): number

Reads the voice-activation threshold.

Returns

number

Level from 0 to 1.

getHearingRange()

getHearingRange(): number

Reads the local hearing-range limit.

Returns

number

Radius in world units, or 0 when the server’s range applies unreduced.

getInputDevice()

getInputDevice(): string

Reads the chosen microphone.

Returns

string

Its name, or an empty string for the system default.

getInputDevices()

getInputDevices(): string[]

Lists the microphones voice can record from.

Returns

string[]

Device names as the player would recognise them; empty when the game chooses the device itself.

getInputLevel()

getInputLevel(): number

Reads how loud the microphone is right now, whether or not anything is being sent – the value to draw a level meter from and to tune the activation threshold against.

Returns

number

Smoothed level from 0 to 1; 0 while no microphone is open.

getPushToTalkKey()

getPushToTalkKey(): string

Reads the push-to-talk binding.

Returns

string

Canonical key name, e.g. “v”.

getPushToTalkReleaseDelay()

getPushToTalkReleaseDelay(): number

Reads the push-to-talk release delay.

Returns

number

Delay in milliseconds; 0 when transmission stops the moment the key is released.

getRange()

getRange(): number

Reads the server’s proximity range for talkers with no override of their own.

Returns

number

Radius in world units.

getTier()

getTier(): number

Reads the voice tier this player is on.

Returns

number

0 whisper, 1 normal, 2 shout.

getTransmitMode()

getTransmitMode(): "pushToTalk" | "voiceActivity"

Reads what opens the microphone.

Returns

"pushToTalk" | "voiceActivity"

The current transmit mode.

getVolume()

getVolume(): number

Reads the voice playback volume.

Returns

number

Current gain, where 1 is unattenuated.

hasMicrophone()

hasMicrophone(): boolean

Checks whether a capture device opened for this session.

Returns

boolean

False when the player has no working microphone, i.e. they are listen-only.

isEnabled()

isEnabled(): boolean

Checks whether voice chat is enabled for this player.

Returns

boolean

True unless the player turned voice chat off.

isNoiseSuppressionEnabled()

isNoiseSuppressionEnabled(): boolean

Checks whether noise suppression is on.

Returns

boolean

True while background noise is being filtered.

isTalking()

isTalking(): boolean

Checks whether the local player is speaking right now. The same state raises the voiceStart and voiceStop events.

Returns

boolean

True while push-to-talk is open – held, or still inside the release delay – and the microphone is producing audio.

setActivationThreshold()

setActivationThreshold(level): void

Sets the voice-activation sensitivity: lower sends quieter speech, higher ignores more background noise. Clamped to 0..1.

Parameters

level

number

Microphone level, 0 to 1 on the scale getInputLevel reports, above which voice activation sends.

Returns

void

setEnabled()

setEnabled(enabled): void

Turns voice chat on or off. Off closes the microphone and playback devices and tells the server to stop relaying voice to this client.

Parameters

enabled

boolean

Whether voice chat runs at all for this player.

Returns

void

setHearingRange()

setHearingRange(range): void

Narrows how far this player hears others. Can only reduce the server’s range, since a talker beyond it is never relayed.

Parameters

range

number

Audibility radius in world units; 0 removes the local limit.

Returns

void

setInputDevice()

setInputDevice(name): void

Chooses the microphone. A running microphone is reopened on the new device; a device that is no longer connected falls back to the default.

Parameters

name

string

A name from getInputDevices, or an empty string for the system default.

Returns

void

setNoiseSuppression()

setNoiseSuppression(enabled): void

Turns noise suppression on or off. It runs before the level is measured, so it also keeps steady noise from tripping voice activation.

Parameters

enabled

boolean

Whether to filter background noise out of the microphone.

Returns

void

setPushToTalkKey()

setPushToTalkKey(key): void

Rebinds push-to-talk. Unknown key names throw.

Parameters

key

string

Case-insensitive key name, using the same names as Key.bind.

Returns

void

setPushToTalkReleaseDelay()

setPushToTalkReleaseDelay(milliseconds): void

Sets how long transmission continues after push-to-talk is released, so letting go slightly early does not clip the end of a word. Muting, turning voice off and losing input focus still stop it at once.

Parameters

milliseconds

number

How long to keep transmitting after the key goes up. Clamped to 0..2000.

Returns

void

setTier()

setTier(tier): void

Switches how far this player’s voice carries. A request: the server paces it, decides the radius, and may move the player itself.

Parameters

tier

number

Voice tier: 0 whisper, 1 normal, 2 shout.

Returns

void

setTransmitMode()

setTransmitMode(mode): void

Chooses what opens the microphone. Switching closes whatever the previous mode had open. Unknown modes throw.

Parameters

mode

"pushToTalk" | "voiceActivity"

pushToTalk sends while the key is held; voiceActivity sends whenever the microphone is louder than the activation threshold.

Returns

void

setVolume()

setVolume(volume): void

Sets the playback volume of incoming voice. A game that plays voice through its own audio engine applies the same gain there.

Parameters

volume

number

Playback gain, where 1 is unattenuated. Clamped to 0..4.

Returns

void