voicechat.joincomchannel Asynchronous

Request a voice communication channel operation and read its immediate request status.

Syntax
Luau
voicechat.joincomchannel(id: string?) -> (success: boolean, status: string)

Parameters

Function parameters
ParameterTypeDescription
idstring?Optional channel identifier. An explicit identifier only succeeds when it is already the current channel.

Returns

(success: boolean, status: string)

Two values: a success boolean and a status string. The operation can continue asynchronously after the request result is returned.

Usage notes

The returned success flag reports request status rather than confirmation that later asynchronous work has completed.

Kawaii documentation