SoundService
Controls global audio settings, listeners, and audio streams.
- Service
game:GetService("SoundService")- Inherits
- Instance
- Replication
- Never
Behavior
SoundService controls global audio settings, listeners, and audio streams.
Summary
The global room-reverb preset.
The conversion factor used for spatial audio distances.
The multiplier applied to Doppler pitch shifts.
The Instance used as the spatial audio listener.
The transform source used for spatial audio listening.
The global audio volume multiplier.
Whether the audio service respects sound filtering settings.
The multiplier applied to distance attenuation.
Returns the audio playback clock, in seconds.
Returns this instance if it is an ExecutionGroup.
Returns the current listener mode and source.
Selects the spatial audio listener mode and transform source.
Properties
AmbientReverb
SoundService.AmbientReverb: Enum.ReverbType = Enum.ReverbType.NoReverbThe global room-reverb preset.
DistanceFactor
SoundService.DistanceFactor: number = 10The conversion factor used for spatial audio distances.
DopplerScale
SoundService.DopplerScale: number = 1The multiplier applied to Doppler pitch shifts.
ListenerObject
SoundService.ListenerObject: Instance? = nilThe Instance used as the spatial audio listener.
ListenerType
SoundService.ListenerType: Enum.ListenerType = Enum.ListenerType.CameraThe transform source used for spatial audio listening.
MasterVolume
SoundService.MasterVolume: number = 1The global audio volume multiplier.
RespectFilteringEnabled
SoundService.RespectFilteringEnabled: boolean = trueWhether the audio service respects sound filtering settings.
RolloffScale
SoundService.RolloffScale: number = 1The multiplier applied to distance attenuation.
Methods
GetAudioTime
SoundService:GetAudioTime(): numberReturns the audio playback clock, in seconds.
GetExecutionGroup
SoundService:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
GetListener
Returns the current listener mode and source.
SetListener
Selects the spatial audio listener mode and transform source.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying