SoundService

Determines at a global level whether sound from AudioEmitters and AudioListeners should automatically implement features of acoustic simulation, such as occlusion (being muffled through walls), diffraction (bending around corners), and reverberation (echoing off of walls).

If set to false, these instances will not simulate these features, regardless of their individual AcousticSimulationEnabled settings.

A reverb preset that should be applied to all Sounds in the experience.

Each ReverbType option for this property corresponds to a preset available in the FMOD sound engine. For example, when AmbientReverb is set to ReverbType.Hangar, Sounds will have reverb applied to simulate being in a large enclosed space.

Note that this only affects Sounds and not instances in the advanced audio system such as AudioPlayers and AudioEmitters. See AudioReverb for a way to apply reverb in that system.

Determines which set of instances core scripts will use to create default character sounds. If set to RolloutState.Enabled, it will use instances in the advanced audio system such as AudioPlayers and AudioEmitters. If set to RolloutState.Disabled, it will use instances in the legacy sound system such as Sounds.

Determines where to place an AudioListener by default. The AudioListener will automatically be wired to a AudioDeviceOutput and will have an empty AudioListener.InteractionGroup set.

See ListenerLocation for detailed descriptions of each option.

The number of studs to be considered a meter by SoundService when simulating the Doppler effect for Sounds. This impacts any Sound parented to a BasePart or Attachment.

By default, this property is 3.33, meaning that a meter is considered 3.33 studs for the purposes of simulating the Doppler effect. The greater the DistanceFactor, the faster the listener has to travel relative to Sounds in order to experience the same Doppler shift.

It's recommended that you only change this property if the objects in your experience are scaled differently from what they represent. For example, if your character is meant to be very small (but is normal-sized in the engine), you may want to increase SoundService.DistanceFactor.

Note that this does not impact the behavior of instances in the advanced audio system, such as AudioPlayer or AudioEmitter.

This property determines the degree to which the pitch of a Sound varies due to the Doppler effect. This impacts any Sound parented to a BasePart or Attachment.

The Doppler effect is a phenomenon whereby the pitch of a sound changes as the source and observer of the sound move further away or closer together, which is stronger the more quickly they are moving. Increasing SoundService.DopplerScale exaggerates the impact of this effect, whereas decreasing it minimizes it. By default, the value of this property is 1.

Note that this does not impact the behavior of instances in the advanced audio system, such as AudioPlayer or AudioEmitter.

This property is only functional when ListenerType is set to ListenerType.CFrame. In that scenario, this property determines the world space position from which 3D Sounds are heard by the player.

This property is only functional when ListenerType is set to ListenerType.ObjectPosition or ListenerType.ObjectCFrame. In that scenario, this property determines which Instance will be used to determine the position from which 3D Sounds are heard by the player. This property can only be set to Instances with a position, such as a BasePart or an Attachment. If it is set to nil, 3D Sounds will not be heard by the player.

The listener type for any 3D Sounds in the experience, effectively the point from which 3D Sound audio in the experience is heard by the player. For Sounds parented to a BasePart or Attachment, the listener influences the volume and left/right balance of a playing sound. By default, this listener is set to Workspace.CurrentCamera.

Note that this does not affect the listener location when using the advanced audio system; see AudioListener for a way to set the listener location within that system.

This property may not yet be enabled for all creators. Until full rollout, use SoundService:GetListener() and SoundService:SetListener() instead.

This property determines whether Sound playback is replicated from the client to the server, and therefore from the server. In other words, when a LocalScript calls Play() and this property is true, the sound will only play on the respective client. If this property is false, other clients will also hear the sound.

Default is true, meaning filtering is enabled.

Determines how fast the volume of a spatialized Sound attenuates. This impacts any Sound parented to a BasePart or Attachment.

A higher RolloffScale means the volume of a Sound will attenuate more rapidly as the distance between the listener and the Sound grows. More precisely, the volume of the Sound will still start attenuating at a distance equal to Sound.RollOffMinDistance, but the attenuation curve will be steeper or more gradual based on the value of RolloffScale. Note that the Sound will still be inaudible past its the Sound.RollOffMaxDistance regardless of the value of SoundService.RolloffScale.

Note that this property does not affect the behavior of instances in the advanced audio system, such as AudioEmitter. See AudioEmitter:SetDistanceAttenuation for a way to apply custom attenuation in that system.

Determines whether any Sounds parented to a Part emit volumetrically. If set to VolumetricAudio.Enabled, the Sound will simulate being emitted from every point in the interior of the Part. If set to VolumetricAudio.Disabled, the Sound will only emit from a single point in the center of the Part.

Note that this does not impact Sounds parented to other objects, such as Attachments or MeshParts. This also does not impact the behavior of instances in the advanced audio system such as AudioEmitter.

Returns the current listener type used by Sounds and what object or position that listener is currently set to. This is the point from which Sound audio in the experience is heard by the player. By default, the listener is set to Workspace.CurrentCamera. The listener can be changed using SetListener().

Note that this does not affect the listener location when using the advanced audio system. See AudioListener for a way to set the listener location in that system.

Returns the number of seconds that have elapsed since the audio engine began mixing. Because this clock is derived from the number of audio samples the mixer has processed, it is stable, sample-accurate, and monotonically increasing, which makes it suitable for scheduling audible changes at precise moments.

Use this value as the basis for the atTime argument of methods that support scheduling playback to begin or end at an exact point in the future, such as Play() and Stop(). For best results, those methods expect times derived from GetMixerTime().

Opens the attenuation curve editor in Studio for the provided AudioEmitter or AudioListener instances.

Opens the directional curve editor in Studio for the provided AudioEmitter or AudioListener instances. This method is intended for use by Studio plugins that need to programmatically surface the editor, in the same way a user would open it from the Properties window.

Plays a copy of a Sound locally. The Sound will only be heard by the client calling this method, regardless of where it's parented to.

Some properties of the Sound will be carried over into the copy. These include its Sound.Volume, Sound.TimePosition, Sound.PlaybackSpeed, and any spatialization and effects that are applied to it, including through SoundGroups. Properties that do not affect the copy include Sound.Looped and SoundService.AmbientReverb.

Sets the listener type for any Sounds in the experience, which defines the point from which Sound audio in the experience is heard by the player. For Sounds parented to a BasePart or Attachment, the listener influences the volume and left/right balance of a playing sound. By default, this listener is set to Workspace.CurrentCamera.

Note that this does not affect the listener location when using the advanced audio system. See AudioListener for a way to set the listener location in that system.