We use cookies on this site to enhance your user experience

SoundService

SoundService

A service that determines various aspects of how Sounds play in the game. SoundService is also often used to store SoundGroups although this is not mandatory for SoundGroups to work.

What can SoundService do?

SoundService properties such as SoundService/AmbientReverb, SoundService/DistanceFactor, SoundService/DopplerScale and SoundService/RolloffScale can be used to change how all Sounds play in the game.

The SoundService/SetListener function allows developers to set the position where sounds are heard from.

SoundService/PlayLocalSound can be used to play a sound locally regardless of where it is parented to.

Developers looking to find out more about how sound works in Roblox should consult the documentation provided for the FMOD sound engine.

Properties

Name Type Description
ReverbType

The ambient sound environment preset used by SoundService.

float

The number of studs to be considered a meter by SoundService when calculating 3D Sound volume attenuation.

float

This property determines the degree to with a 3D Sounds pitch varies due to the Doppler effect.

bool

Sets whether Sound playback from a client will replicate to the server when Experimental Mode is off.

float

Sets how fast 3D Sound volume attenuates, or ‘rolls off’.

Inherited from Instance

Archivable ClassName DataCost Name Parent RobloxLocked

Functions

Name Type Description
Tuple

GetListener returns SoundServices current listener type and what is set as listener.

void

Plays a Sound locally, meaning the Sound will only be heard by the client calling this function regardless of where it is parented to.

void

Sets the listener for the SoundService.

Inherited from Instance

ClearAllChildren Clone Destroy FindFirstAncestor FindFirstAncestorOfClass FindFirstAncestorWhichIsA FindFirstChild FindFirstChildOfClass FindFirstChildWhichIsA GetChildren GetDebugId GetDescendants GetFullName GetPropertyChangedSignal IsA IsAncestorOf IsDescendantOf WaitForChild