Skip to content

Commit 2112ef8

Browse files
authored
Improve EnableDefaultVoice documentation
1 parent 8af5677 commit 2112ef8

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

content/en-us/reference/engine/classes/VoiceChatService.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ properties:
2626
setup depend on `Class.VoiceChatService.UseAudioApi|UseAudioApi`.
2727
2828
When `Class.VoiceChatService.UseAudioApi|UseAudioApi` is
29+
`Enum.AudioApiRollout|Enabled`, disabling this property disables the
30+
default setup, but `Class.AudioDeviceInput` will still work. Conversely,
31+
when `Class.VoiceChatService.UseAudioApi|UseAudioApi` is
2932
`Enum.AudioApiRollout|Disabled`, disabling the default voice setup
3033
effectively disables voice chat altogether.
3134
code_samples: []
@@ -57,6 +60,9 @@ properties:
5760
- An `Class.AudioListener` will be created and parented to
5861
`Class.Workspace.CurrentCamera`.
5962
63+
You can disable the default setup by setting
64+
`Class.VoiceChatService.EnableDefaultVoice` to `false`.
65+
6066
If `Enum.AudioApiRollout|Disabled`, the voice chat setup is done through
6167
an internal-only system.
6268

0 commit comments

Comments
 (0)