Skip to content

Default listener location description #1039

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 8 commits into from
Closed

Default listener location description #1039

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
677b37c
Add a description for SoundService.DefaultListenerLocation
rbxphogen Oct 17, 2024
76a3032
Apply suggestions from code review
rbxphogen Oct 17, 2024
2ee9be3
Apply suggestions from code review
rbxphogen Oct 17, 2024
87cc130
Merge branch 'main' into DefaultListenerLocation-description
aetter Nov 11, 2024
20da9a6
Merge branch 'main' into DefaultListenerLocation-description
rbxphogen Dec 2, 2024
58b9a0d
Merge branch 'main' into DefaultListenerLocation-description
IgnisRBX Dec 9, 2024
a0c12de
Merge branch 'main' into DefaultListenerLocation-description
IgnisRBX Mar 4, 2025
1c4e037
Merge branch 'main' into DefaultListenerLocation-description
IgnisRBX Mar 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions content/en-us/reference/engine/classes/SoundService.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,29 @@ properties:
capabilities: []
writeCapabilities: []
- name: SoundService.DefaultListenerLocation
summary: ''
description: ''
summary: |
Determines where (if anywhere) to place an `Class.AudioListener` by default.
description: |
Determines where to place an `Class.AudioListener` by default.
If `Class.SoundService.DefaultListenerLocation` is `None`, then no `Class.AudioListener` will be created by default, but `Class.AudioListeners` can be created separately by scripts.
If `Class.SoundService.DefaultListenerLocation` is `Camera`, then
- an `Class.AudioListener` will be created and parented to `Class.Workspace.CurrentCamera`
- an `Class.AudioDeviceOutput` will be created and parented to `Class.SoundService`
- a `Class.Wire` will be created and parented to the previously-created `Class.AudioListener`
- `Class.Wire.SourceInstance` will be set to the previously-created `Class.AudioListener`, and `Class.Wire.TargetInstance` will be set to the previously-created `Class.AudioDeviceOutput`
As a result, the world will be heard from the perspective (postition and orientation) of your camera.

If `Class.SoundService.DefaultListenerLocation` is `Character`, then
- an `Class.Attachment` will be created and parented to your `Class.Players.LocalPlayer`'s `Class.Player.Character`'s `Class.Model.PrimaryPart`
- an `Class.AudioListener` will be created and parented to the `Class.Attachment`
- an `Class.AudioDeviceOutput` will be created and parented to `Class.SoundService`
- a `Class.Wire` will be created and parented to the previously-created `Class.AudioListener`
- `Class.Wire.SourceInstance` will be set to the previously-created `Class.AudioListener`, and `Class.Wire.TargetInstance` will be set to the previously-created `Class.AudioDeviceOutput`
- the previously-created `Class.Attachment` will be updated once-per-frame to face the same direction as `Class.Workspace.CurrentCamera`
As a result, the world will be heard from the position of your character, while matching the orientation of your camera.

If `Class.SoundService.DefaultListenerLocation` is `Default`, then its behavior depends on the value of `Class.VoiceChatService.EnableDefaultVoice` and `Class.VoiceChatService.UseAudioApi`.
When using the default voice setup with the audio API, this behaves similarly to `Camera`.
code_samples: []
type: ListenerLocation
tags: []
Expand Down