@@ -17,21 +17,12 @@ deprecation_message: ''
1717properties :
1818 - name : VoiceChatService.EnableDefaultVoice
1919 summary : |
20- Controls whether or not the default voice chat setup will be used .
20+ Controls whether each voice-eligible player can be heard as though they were speaking through their character .
2121 description : |
22- Controls whether or not the default voice chat setup will be used.
23-
2422 When enabled, each voice-eligible player can be heard as though they were speaking through their character.
25-
26- The behavior of the default voice setup depends on `Class.VoiceChatService.UseAudioApi|UseAudioApi`.
27- If `Enum.AudioApiRollout|Enabled`, this setup is represented and controlled by `Class.AudioDeviceInput`.
28- More specifically:
29- - An `Class.AudioDeviceInput` will be created and parented to each voice-eligible `Class.Player`.
30- - An `Class.AudioEmitter` will be created and parented to each voice-eligible player's `Class.Player.Character`.
31- - An `Class.AudioListener` will be created and parented to `Class.Workspace.CurrentCamera`.
32-
33- If `Enum.AudioApiRollout|Disabled`, this setup is made by an internal-only system.
34- Using this system, disabling the default voice setup effectively disables voice altogether.
23+ The behavior of the voice setup depends on `Class.VoiceChatService.UseAudioApi|UseAudioApi`.
24+
25+ Disabling the default voice setup effectively disables voice chat altogether.
3526 code_samples : []
3627 type : bool
3728 tags : []
@@ -48,17 +39,22 @@ properties:
4839 writeCapabilities : []
4940 - name : VoiceChatService.UseAudioApi
5041 summary : |
51- Controls whether voice chat is implemented using the Audio API .
42+ Controls whether voice chat is represented and controlled by an `Class.AudioDeviceInput` object .
5243 description : |
53- Controls whether voice chat is implemented using the Audio API.
54- When `Enabled`, the `Class.AudioDeviceInput` instance controls input from each player's microphone.
55- A default voice setup using this API can be turned on or off with `Class.VoiceChatService.EnableDefaultVoice`.
44+ If `Enum.AudioApiRollout|Enabled`, the voice chat setup is represented and controlled by
45+ an `Class.AudioDeviceInput` object. More specifically:
5646
57- When `Disabled`, an internal system controls the input from each player's microphone,
58- and this system can be turned on or off in its entirety via `Class.VoiceChatService.EnableDefaultVoice`.
47+ - An `Class.AudioDeviceInput` will be created and parented to each voice-eligible `Class.Player`.
48+ - An `Class.AudioEmitter` will be created and parented to each voice-eligible player's `Class.Player.Character`.
49+ - An `Class.AudioListener` will be created and parented to `Class.Workspace.CurrentCamera`.
5950
60- Currently, `Class.VoiceChatService.UseAudioApi` being `Automatic` has the same meaning as `Disabled`.
61- However, in the future, `Automatic` will become `Enabled`, so that new experiences can achieve greater customization over voice.
51+ If `Enum.AudioApiRollout|Disabled`, the voice chat setup is done through an internal-only system.
52+
53+ Currently, setting this to `Enum.AudioApiRollout|Automatic` has the same meaning as `Enum.AudioApiRollout|Disabled`.
54+ However, in the future, `Enum.AudioApiRollout|Automatic` will become `Enum.AudioApiRollout|Enabled`, so that new
55+ experiences can achieve greater customization over voice.
56+
57+ Voice chat can be enabled or disabled in its entirety via `Class.VoiceChatService.EnableDefaultVoice|EnableDefaultVoice`.
6258 code_samples : []
6359 type : AudioApiRollout
6460 tags : []
@@ -103,7 +99,7 @@ methods:
10399 type : int64
104100 default :
105101 summary : |
106- The `UserId` to check.
102+ The `Class.Player. UserId` to check.
107103 returns :
108104 - type : bool
109105 summary : |
0 commit comments