Skip to content

Commit 7ad93d3

Browse files
Update content/en-us/reference/engine/classes/VoiceChatService.yaml
Co-authored-by: matthewzhang-rbx <[email protected]>
1 parent 6842d9e commit 7ad93d3

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,15 @@ properties:
2222
Controls whether or not the default spatial voice chat setup will be used.
2323
2424
When enabled, each voice-eligible player can be heard as though they were speaking through their character.
25-
If `Class.VoiceChatService.EnableDefaultVoice` is `true`, and `Class.VoiceChatService.UseAudioApi` is `Enabled`,
26-
then this setup is represented and controlled by instance types from the Audio API:
25+
26+
The behavior of the default voice setup depends on `Class.VoiceChatService.UseAudioApi`.
27+
If `Class.VoiceChatService.UseAudioApi` is `Enabled`, then this setup is represented and controlled by instance types from the Audio API. Specifically:
2728
- An `Class.AudioDeviceInput` will be created and parented to each voice-eligible `Class.Player`
2829
- An `Class.AudioEmitter` will be created and parented to each voice-eligible player's `Class.Player.Character`
2930
- An `Class.AudioListener` will be created and parented to `Class.Workspace.CurrentCamera`
31+
32+
If `Class.VoiceChatService.UseAudioApi` is `Disabled`, then this setup is made by an internal-only system.
33+
Using this system, disabling the default voice setup effectively disables voice altogether.
3034
code_samples: []
3135
type: bool
3236
tags: []

0 commit comments

Comments
 (0)