VoiceChannel

@vimp-mp/types 2.0.1

Interface · Server API

Server-owned voice channel and its per-player routing permissions.

interface VoiceChannel

Members

id

readonly id: number

Server-assigned channel identifier.

maxDistance

readonly maxDistance: number | null

Maximum audible distance, or null for a non-spatial channel.

name

readonly name: string

Application-defined channel name.

players

readonly players: Array<Player>

Players currently routed through this channel.

spatial

readonly spatial: boolean

Whether the channel uses distance-based attenuation.

addPlayer

addPlayer(player: number | Player, permissions?: VoicePermissions): boolean

Adds a connected player; omitted permissions allow speaking and listening.

destroy

destroy(): boolean

Destroys this voice channel instance.

getPlayerPermissions

getPlayerPermissions(player: number | Player): VoicePermissions | null

Returns the member's routing permissions, or null if they are not a member.

hasPlayer

hasPlayer(player: number | Player): boolean

Reports whether the player is a member of this channel.

removePlayer

removePlayer(player: number | Player): boolean

Removes a player from this channel. Returns false if no membership existed.

setPlayerPermissions

setPlayerPermissions(player: number | Player, permissions: VoicePermissions): boolean

Replaces a member's speaking and listening permissions.