Skip to content

Commit 2321b2d

Browse files
Update content/en-us/reference/engine/classes/VoiceChatService.yaml
Co-authored-by: matthewzhang-rbx <[email protected]>
1 parent 96a142e commit 2321b2d

File tree

1 file changed

+4
-10
lines changed

1 file changed

+4
-10
lines changed

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

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -46,18 +46,12 @@ properties:
4646
Controls whether voice chat is implemented using the Audio API.
4747
description: |
4848
Controls whether voice chat is implemented using the Audio API.
49-
When `Enabled`, the `Class.AudioDeviceInput` instance controls input from each player's microphone.
49+
When `Enabled`, the `Class.AudioDeviceInput` instance controls input from each player's microphone.
50+
A default voice setup using this API can be turned on or off with `Class.VoiceChatService.EnableDefaultVoice`.
5051
51-
If `Class.VoiceChatService.UseAudioApi` is `Enabled` and `Class.VoiceChatService.EnableDefaultVoice` is `true`, then
52-
- An `Class.AudioDeviceInput` will be created and parented to each voice-eligible `Class.Player`
53-
- An `Class.AudioEmitter` will be created and parented to each voice-eligible player's `Class.Player.Character`
54-
- An `Class.AudioListener` will be created and parented to `Class.Workspace.CurrentCamera`
52+
Otherwise, an internal system controls the input from each player's microphone.
53+
This system can be turned on or off in its entirety with `Class.VoiceChatService.EnableDefaultVoice`.
5554
56-
If `Class.VoiceChatService.UseAudioApi` is `Enabled` but `Class.VoiceChatService.EnableDefaultVoice` is `false`, then no default setup is provided – however, `Class.AudioDeviceInput`s can still be used when created on their own.
57-
58-
If `Class.VoiceChatService.UseAudioApi` is `Disabled`, it is only possible to use the default voice chat setup.
59-
That is, disabling `Class.VoiceChatService.UseAudioApi` and setting `Class.VoiceChatService.EnableDefaultVoice` to `false` effectively disables voice altogether.
60-
6155
Currently, `Class.VoiceChatService.UseAudioApi` being `Automatic` has the same meaning as `Disabled`.
6256
However, in the future, `Automatic` will become `Enabled`, so that new experiences can achieve greater customization over voice.
6357
code_samples: []

0 commit comments

Comments
 (0)