VoiceManager

@vimp-mp/types 2.0.1

Interface · Client API

Exposes local voice state, channels, and per-player playback controls.

interface VoiceManager

Members

activeChannelId

readonly activeChannelId: number | null

Selected voice channel ID, or null.

channels

readonly channels: Array<VoiceChannelInfo>

Voice channels announced by the server.

enabled

readonly enabled: boolean

Whether voice is currently enabled.

inputLevel

readonly inputLevel: number

Current microphone input level.

isTalking

readonly isTalking: boolean

Whether the local player is transmitting voice audio.

state

readonly state: VoiceState

Current voice subsystem snapshot.

getPlayerVolume

getPlayerVolume(player: number | Player): number

Returns the remote player's local playback multiplier.

isPlayerMuted

isPlayerMuted(player: number | Player): boolean

Reports whether the remote player is muted by this client.

selectChannel

selectChannel(id: number | null): void

Selects a voice channel, or clears the selection with null.

setPlayerMuted

setPlayerMuted(player: number | Player, muted: boolean): void

Applies or removes a client-local playback mute for a remote player.

setPlayerVolume

setPlayerVolume(player: number | Player, volume: number): boolean

Sets a remote player's local playback multiplier in the 0–2 range.