Skip to content

Improve EnableDefaultVoice documentation #1058

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 24, 2025
Merged

Improve EnableDefaultVoice documentation #1058

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2112ef8
Improve EnableDefaultVoice documentation
metatablecat Mar 22, 2025
33d668c
Merge branch 'main' into patch-8
IgnisRBX Mar 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions content/en-us/reference/engine/classes/VoiceChatService.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ properties:
setup depend on `Class.VoiceChatService.UseAudioApi|UseAudioApi`.

When `Class.VoiceChatService.UseAudioApi|UseAudioApi` is
`Enum.AudioApiRollout|Enabled`, disabling this property disables the
default setup, but `Class.AudioDeviceInput` will still work. Conversely,
when `Class.VoiceChatService.UseAudioApi|UseAudioApi` is
`Enum.AudioApiRollout|Disabled`, disabling the default voice setup
effectively disables voice chat altogether.
code_samples: []
Expand Down Expand Up @@ -57,6 +60,9 @@ properties:
- An `Class.AudioListener` will be created and parented to
`Class.Workspace.CurrentCamera`.

You can disable the default setup by setting
`Class.VoiceChatService.EnableDefaultVoice` to `false`.

If `Enum.AudioApiRollout|Disabled`, the voice chat setup is done through
an internal-only system.

Expand Down