You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en-us/reference/engine/classes/VoiceChatService.yaml
+4-10Lines changed: 4 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -46,18 +46,12 @@ properties:
46
46
Controls whether voice chat is implemented using the Audio API.
47
47
description: |
48
48
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`.
50
51
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`.
55
54
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
-
61
55
Currently, `Class.VoiceChatService.UseAudioApi` being `Automatic` has the same meaning as `Disabled`.
62
56
However, in the future, `Automatic` will become `Enabled`, so that new experiences can achieve greater customization over voice.
0 commit comments