Skip to content

REVO / API version 0.0.10

VoiceChannel

A player can speak on multiple channels independently. Speakers do not hear themselves.

new VoiceChannel(options?): VoiceChannel

Parameter Type
options? IVoiceChannelOptions

VoiceChannel

Base.constructor

Property Type Details
category string Client-defined AudioCategory name. An empty name uses the neutral voice category.
effects readonly AudioEffect[] Up to 16 effects, applied in order before category effects, separately for each speaker and listener. Returns a copy. Assign a new array to update, or [] to clear.
enabled boolean —
id
readonly
number Inherited from Base.id
networkId
readonly
number | null —
playerCount
readonly
number —
players
readonly
readonly Player[] —
range number Maximum delivery distance in metres for spatial channels. Must be positive. GTA handles local attenuation.
spatial boolean —
type
readonly
BaseType Inherited from Base.type
valid
readonly
boolean Inherited from Base.valid
volume number -100..0 dB.
all
static readonly
readonly VoiceChannel[] Overrides Base.all
count
static readonly
number Overrides Base.count

addPlayer(player, permissions?): boolean

Omitted permissions default to true. Existing members keep their permissions.

Parameter Type
player Player
permissions? Partial<IVoicePermissions>

boolean


clearPlayers(): void

void


deleteSyncedMeta(key): void

Parameter Type
key string

void

Base.deleteSyncedMeta


destroy(): void

void


getPlayerPermissions(player): Readonly<IVoicePermissions> | null

Parameter Type
player Player

Readonly<IVoicePermissions> | null


getSyncedMeta<K>(key): ICustomBaseSyncedMeta[K] | undefined

Type Parameter
K extends never
Parameter Type
key K

ICustomBaseSyncedMeta[K] | undefined

Base.getSyncedMeta

getSyncedMeta<T>(key): T | undefined

Type Parameter Default type
T TransportValue
Parameter Type
key string

T | undefined

Base.getSyncedMeta


getSyncedMetaKeys(): string[]

string[]

Base.getSyncedMetaKeys


hasPlayer(player): boolean

Parameter Type
player Player

boolean


hasSyncedMeta(key): boolean

Parameter Type
key string

boolean

Base.hasSyncedMeta


removePlayer(player): boolean

Parameter Type
player Player

boolean


setPlayerPermissions(player, permissions): boolean

Returns false if the player is not a member.

Parameter Type
player Player
permissions IVoicePermissions

boolean


setSyncedMeta<K>(key, value): void

Copies and replicates the value to the object’s audience. Player metadata also goes to that player.

Type Parameter
K extends string
Parameter Type
key K
value K extends never ? ICustomBaseSyncedMeta[K] : TransportValue

void

Base.setSyncedMeta

setSyncedMeta(values): void

Atomically merges own enumerable fields. Unsupported values reject the entire batch.

Parameter Type
values Partial<ICustomBaseSyncedMeta> & Record<string, TransportValue>

void

Base.setSyncedMeta


static getById(id): VoiceChannel | null

Parameter Type
id number

VoiceChannel | null

Base.getById


static getByNetworkId(networkId): VoiceChannel | null

Parameter Type
networkId number

VoiceChannel | null

Your first voice channel