VoipChannel

Summary

Properties

Name	Type
name	string
defaultEmitterType	VoipEmitterType
players	Player{}
emitters	VoipEmitter{}
transmissionMode	VoipTransmissionMode

Methods

Method	Returns
StartTransmitting()	void
StopTransmitting()	void
GetEmitter(player: Player)	VoipEmitter | nil

Properties

name

string

defaultEmitterType

VoipEmitterType

The type of emitter that will be created by default when a new player is added to this channel.

players

Player{}

The players that are in this channel.

emitters

VoipEmitter{}

The emitters for all the players that are in this channel. Each emitter has a one-to-one relationship with a player.

transmissionMode

VoipTransmissionMode

The transmission mode to use when the local player is in this channel. Defaults to PushToTalk.

Methods

StartTransmitting

StartTransmitting()

Starts transmitting voice through this channel. This only works if the local player is in the channel and the transmission mode of this channel is set to PushToTalk.

StopTransmitting

StopTransmitting()

Stops transmitting voice through this channel. This only works if the local player is in the channel and the transmission mode of this channel is set to PushToTalk.

GetEmitter

GetEmitter(player: Player): VoipEmitter | nil

Gets the VoIP emitter of the provided player. If the player is not in this channel, this method returns nil.

Parameters

Name	Type	Description
player	Player

Returns

Type	Description
VoipEmitter | nil