Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
IgnisRBX authored Oct 18, 2024
1 parent 7ad93d3 commit 3e5444f
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions content/en-us/reference/engine/classes/VoiceChatService.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,20 @@ deprecation_message: ''
properties:
- name: VoiceChatService.EnableDefaultVoice
summary: |
Controls whether or not the default spatial voice chat setup will be used.
Controls whether or not the default voice chat setup will be used.
description: |
Controls whether or not the default spatial voice chat setup will be used.
Controls whether or not the default voice chat setup will be used.
When enabled, each voice-eligible player can be heard as though they were speaking through their character.
The behavior of the default voice setup depends on `Class.VoiceChatService.UseAudioApi`.
If `Class.VoiceChatService.UseAudioApi` is `Enabled`, then this setup is represented and controlled by instance types from the Audio API. Specifically:
- An `Class.AudioDeviceInput` will be created and parented to each voice-eligible `Class.Player`
- An `Class.AudioEmitter` will be created and parented to each voice-eligible player's `Class.Player.Character`
- An `Class.AudioListener` will be created and parented to `Class.Workspace.CurrentCamera`
The behavior of the default voice setup depends on `Class.VoiceChatService.UseAudioApi|UseAudioApi`.
If `Enum.AudioApiRollout|Enabled`, this setup is represented and controlled by `Class.AudioDeviceInput`.
More specifically:
- An `Class.AudioDeviceInput` will be created and parented to each voice-eligible `Class.Player`.
- An `Class.AudioEmitter` will be created and parented to each voice-eligible player's `Class.Player.Character`.
- An `Class.AudioListener` will be created and parented to `Class.Workspace.CurrentCamera`.
If `Class.VoiceChatService.UseAudioApi` is `Disabled`, then this setup is made by an internal-only system.
If `Enum.AudioApiRollout|Disabled`, this setup is made by an internal-only system.
Using this system, disabling the default voice setup effectively disables voice altogether.
code_samples: []
type: bool
Expand Down

0 comments on commit 3e5444f

Please sign in to comment.