Skip to content

Commit 85f9e26

Browse files
rbxphogenmatthewzhang-rbxIgnisRBX
authored
Make VoiceChatService's documentation clearer (#866)
## Changes Adds detailed descriptions of `UseAudioApi` and `EnableDefaultVoice` – revise the summary. ## Checks By submitting your pull request for review, you agree to the following: - [x] This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses. - [x] I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses. - [x] To the best of my knowledge, all proposed changes are accurate. --------- Co-authored-by: matthewzhang-rbx <[email protected]> Co-authored-by: IgnisRBX <[email protected]>
1 parent 8f2ac23 commit 85f9e26

File tree

1 file changed

+24
-12
lines changed

1 file changed

+24
-12
lines changed

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

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@ type: class
33
category:
44
memory_category: Instances
55
summary: |
6-
**VoiceChatService** holds voice functions not tied to other instances.
6+
**VoiceChatService** is responsible for voice chat's high-level functionality.
77
description: |
8-
**VoiceChatService** holds voice functions not tied to other instances.
8+
**VoiceChatService** is responsible for voice chat's high-level functionality.
9+
This mostly consists of configuration options, and functions that are not specifically-controlled by more-specific instances.
910
code_samples:
1011
inherits:
1112
- Instance
@@ -16,15 +17,13 @@ deprecation_message: ''
1617
properties:
1718
- name: VoiceChatService.EnableDefaultVoice
1819
summary: |
19-
Indicates whether or not the place uses the default voice manager.
20+
Controls whether each voice-eligible player can be heard as though they were speaking through their character.
2021
description: |
21-
Indicates whether or not the place uses the default voice manager. This is
22-
enabled by default.
22+
When enabled, each voice-eligible player can be heard as though they were speaking through their character.
23+
The implementation details of the voice setup depend on `Class.VoiceChatService.UseAudioApi|UseAudioApi`.
2324
24-
When enabled, the default voice manager adds all voice-eligible users to
25-
voice chat as they join the place. When disabled, the place doesn't use
26-
the default voice manager, and users are not added to voice chat when they
27-
join the place.
25+
When `Class.VoiceChatService.UseAudioApi|UseAudioApi` is `Enum.AudioApiRollout|Disabled`,
26+
disabling the default voice setup effectively disables voice chat altogether.
2827
code_samples: []
2928
type: bool
3029
tags: []
@@ -40,8 +39,21 @@ properties:
4039
capabilities: []
4140
writeCapabilities: []
4241
- name: VoiceChatService.UseAudioApi
43-
summary: ''
44-
description: ''
42+
summary: |
43+
Controls whether voice chat is represented and controlled by `Class.AudioDeviceInput` objects.
44+
description: |
45+
If `Enum.AudioApiRollout|Enabled`, the voice chat setup is represented and controlled by
46+
`Class.AudioDeviceInput` objects. More specifically:
47+
48+
- An `Class.AudioDeviceInput` will be created and parented to each voice-eligible `Class.Player`.
49+
- An `Class.AudioEmitter` will be created and parented to each voice-eligible player's `Class.Player.Character`.
50+
- An `Class.AudioListener` will be created and parented to `Class.Workspace.CurrentCamera`.
51+
52+
If `Enum.AudioApiRollout|Disabled`, the voice chat setup is done through an internal-only system.
53+
54+
Currently, setting this to `Enum.AudioApiRollout|Automatic` has the same meaning as `Enum.AudioApiRollout|Disabled`.
55+
However, in the future, `Enum.AudioApiRollout|Automatic` will become `Enum.AudioApiRollout|Enabled`, so that new
56+
experiences can achieve greater customization over voice.
4557
code_samples: []
4658
type: AudioApiRollout
4759
tags: []
@@ -86,7 +98,7 @@ methods:
8698
type: int64
8799
default:
88100
summary: |
89-
The `UserId` to check.
101+
The `Class.Player.UserId` to check.
90102
returns:
91103
- type: bool
92104
summary: |

0 commit comments

Comments
 (0)