class
FVoiceSettings
- Module
- VoiceChat
- Header
#include "VoiceChat/FVoiceSettings.h"- Namespace
Mowo
Properties
| Type | Name | Description |
|---|---|---|
static constexpr const char* | kEnabled | The cvar names a UI layer binds to directly. Stable: renaming one breaks a settings screen that cannot be compiled against this header. Default "voice.Enabled". |
static constexpr const char* | kInputDevice | Default "voice.InputDevice". |
static constexpr const char* | kInputDeviceList | Default "voice.InputDeviceList". |
static constexpr const char* | kInputGain | Default "voice.InputGain". |
static constexpr const char* | kOutputVolume | Default "voice.OutputVolume". |
static constexpr const char* | kMode | Default "voice.Mode". |
static constexpr const char* | kActivationThreshold | Default "voice.GateOpenRms". |
static constexpr const char* | kCodec | Default "voice.Codec". |
static constexpr const char* | kOpusBitrate | Default "voice.OpusBitrate". |
static constexpr const char* | kEchoCancellation | Default "voice.EchoCancellation". |
static constexpr const char* | kNoiseSuppression | Default "voice.NoiseSuppression". |
static constexpr const char* | kAutoGain | Default "voice.AutoGain". |
Public functions
| Returns | Name | Description |
|---|---|---|
FVoiceSettingsState | Read | |
void | Apply | Writes every field at its cvar. |
void | SetEnabled | |
void | SetInputDevice | |
void | SetInputGain | |
void | SetOutputVolume | |
void | SetActivationThreshold | |
void | SetMode | |
void | SetEchoCancellation | |
void | SetNoiseSuppression | |
void | SetAutoGain | |
bool | SetCodecPreference | False when Opus was asked for and this build has none — the screen should say so rather than showing a codec that is not running. |
bool | IsOpusAvailable | |
const char* | ActiveCodecName | The codec actually running, or nullptr when no system is live. |
std::vector<FVoiceDeviceInfo> | EnumerateInputDevices | |
void | PublishInputDevices | Packs the device list into the voice.InputDeviceList cvar as id|name rows separated by newlines, so a UI layer that cannot link this plugin can still populate a device dropdown. |
std::vector<FVoiceDeviceInfo> | ParsePublishedDevices |
Function details
Read
C++
static FVoiceSettingsState Read()Apply
C++
static void Apply(const FVoiceSettingsState& state)Writes every field at its cvar. The live system picks the change up on its next Update, so this is safe to call from anywhere, including before a system exists.
SetEnabled
C++
static void SetEnabled(bool enabled)SetInputDevice
C++
static void SetInputDevice(const std::string& deviceId)SetInputGain
C++
static void SetInputGain(float gain)SetOutputVolume
C++
static void SetOutputVolume(float volume)SetActivationThreshold
C++
static void SetActivationThreshold(float rms)SetMode
C++
static void SetMode(EVoiceMode mode)SetEchoCancellation
C++
static void SetEchoCancellation(bool enabled)SetNoiseSuppression
C++
static void SetNoiseSuppression(bool enabled)SetAutoGain
C++
static void SetAutoGain(bool enabled)SetCodecPreference
C++
static bool SetCodecPreference(EVoiceCodecPreference preference)False when Opus was asked for and this build has none — the screen should say so rather than showing a codec that is not running.
IsOpusAvailable
C++
static bool IsOpusAvailable()ActiveCodecName
C++
static const char* ActiveCodecName()The codec actually running, or nullptr when no system is live.
EnumerateInputDevices
C++
static std::vector<FVoiceDeviceInfo> EnumerateInputDevices()PublishInputDevices
C++
static void PublishInputDevices()Packs the device list into the voice.InputDeviceList cvar as id|name rows separated by newlines, so a UI layer that cannot link this plugin can still populate a device dropdown. Called once when the plugin registers; call it again after a device hot-plug.
ParsePublishedDevices
C++
static std::vector<FVoiceDeviceInfo> ParsePublishedDevices(const std::string& packed)Generated from VoiceChat/FVoiceSettings.h via voicechat.json · Oct 26, 2026Version 1.0.0