voicechat.incomingpacket:Once Asynchronous

Subscribe to one inbound culling or RTP packet and automatically disconnect after it is queued for delivery.

Syntax

Luau

voicechat.incomingpacket:Once(callback: (VoicePacket) -> ()) -> VoicePacketConnection

Parameters

Call this method with a voicechat.incomingpacket receiver. The colon supplies self implicitly; a dot call must pass the receiver explicitly.

Function parameters
Parameter	Type	Description
`callback`	`(VoicePacket) -> ()`	Function receiving a VoicePacket table.

VoicePacket fields

Luau

VoicePacket = {
  Data: buffer, Channel: "data" | "rtp",
  Direction: "outgoing" | "incoming",
  Injected: boolean, Accepted: boolean
}

VoicePacketConnection

A connection with Connected and Disconnect.

VoicePacketConnection fields

Luau

VoicePacketConnection = {Connected: boolean, Disconnect: Function}

The callback may yield because it is deferred.

Luau

voicechat.incomingpacket:Once(function(packet)
    print(packet.Channel)
end)