Voice chat (function list)

Status: Implemented (API 1.24). Generated from client/clight/idl/clight_api.json by tools/docs/gen_api_reference.py; do not edit by hand. 5 functions, the newest from API 1.7.

Explanations and examples: Sound and music, Guide: Audio and effects. Every function of the voice module is listed here in table order. The details of each function follow the table, in the same order. Side: where the function works (server, client, both). Context: the thread it may be called on (Conventions). Since: the API version that added it.

C function	Lua	Side	Context	Since
cl_voice_is_available	cl.voice.is_available	client	ANY	1.7
cl_voice_is_muted	cl.voice.is_muted	client	ANY	1.7
cl_voice_is_disabled	cl.voice.is_disabled	client	ANY	1.7
cl_voice_is_talking	cl.voice.is_talking	client	ANY	1.7
cl_voice_monitor	cl.voice.monitor	client	ANY	1.7

cl_voice_is_available

bool cl_voice_is_available(void);

Connected to a voice chat server.

• Side: client. Context: ANY (any thread). Since: API 1.7.
• Lua: cl.voice.is_available
• C++: clight::voice::is_available() → bool

cl_voice_is_muted

bool cl_voice_is_muted(void);

• Side: client. Context: ANY (any thread). Since: API 1.7.
• Lua: cl.voice.is_muted
• C++: clight::voice::is_muted() → bool

cl_voice_is_disabled

bool cl_voice_is_disabled(void);

Voice chat switched off or deafened.

• Side: client. Context: ANY (any thread). Since: API 1.7.
• Lua: cl.voice.is_disabled
• C++: clight::voice::is_disabled() → bool

cl_voice_is_talking

bool cl_voice_is_talking(cl_uuid speaker);

• Side: client. Context: ANY (any thread). Since: API 1.7.
• Lua: cl.voice.is_talking
• C++: clight::voice::is_talking(cl_uuid speaker) → bool

cl_voice_monitor

cl_result cl_voice_monitor(const cl_voice_monitor_opts* opts);

• Side: client. Context: ANY (any thread). Since: API 1.7.
• Lua: cl.voice.monitor
• C++: clight::voice::monitor(const cl_voice_monitor_opts* opts) → Expected<void>
• Returns CL_OK or an error code (Error codes). Lua raises a cl.Error on failure.