API:Class/SoundService

< API:Class(Redirected from SoundService)
Filtered-inheritance mode: While this class technically inherits all Instance class members, some (if not all) have been hidden because they serve no purpose for this object.
Service: This class is a service. It is a top-level singleton which can be obtained with the GetService method.
Uncreatable: This object cannot be created with Instance.new.

Soundservice icon.pngSoundService : Object Icon.pngInstance

A service that controls various aspects of the Sound output.

Properties

Properties [toggle]

ReverbTypeAmbientReverb

The ambient sound environment.

|RMD member="API:Class/SoundService/AmbientReverb"|The ambient sound environment.|/RMD|
floatDistanceFactor

The relative distance factor, compared to 1.0 meters.

|RMD member="API:Class/SoundService/DistanceFactor"|The relative distance factor, compared to 1.0 meters.|/RMD|
floatDopplerScale

Sets the scale of Doppler Effect on sound.

|RMD member="API:Class/SoundService/DopplerScale"|Sets the scale of Doppler Effect on sound.|/RMD|
boolRespectFilteringEnabled [NotAccessibleSecurity]

If set to true, sound playback from the client will not replicate to the server.

|RMD member="API:Class/SoundService/RespectFilteringEnabled"|If set to true, sound playback from the client will not replicate to the server.|/RMD|
floatRolloffScale

Sets how fast sound will drop off.

|RMD member="API:Class/SoundService/RolloffScale"|Sets how fast sound will drop off.|/RMD|
The ambient sound environment.
The relative distance factor, compared to 1.0 meters.
Sets the scale of Doppler Effect on sound.
RespectFilteringEnabled [NotAccessibleSecurity]
If set to true, sound playback from the client will not replicate to the server.
Sets how fast sound will drop off.

Functions

Functions [toggle]

ListenerType, Variant<BasePart, CFrame, void>GetListener ( )

Returns the current listener type, and what is set as its listener.

|RMD member="API:Class/SoundService/GetListener"|Returns the current listener type, and what is set as its listener.|/RMD|
voidPlayLocalSound ( Sound sound )

Plays a Sound icon.pngSound locally, meaning this Sound icon.pngSound will only be heard by the client calling this function.

|RMD member="API:Class/SoundService/PlayLocalSound"|Plays a Sound icon.pngSound locally, meaning this Sound icon.pngSound will only be heard by the client calling this function.|/RMD|
voidSetListener ( ListenerType listenerType, Variant<BasePart, CFrame, void> listener )

Sets the listener for the SoundService.

|RMD member="API:Class/SoundService/SetListener"|Sets the listener for the SoundService.|/RMD|
Returns the current listener type, and what is set as its listener.
Plays a Sound icon.pngSound locally, meaning this Sound icon.pngSound will only be heard by the client calling this function.
SetListener ( ListenerType listenerType, Variant<BasePart, CFrame, void> listener )
Sets the listener for the SoundService.


|RMD member="API:Class/SoundService"|A service that controls various aspects of the Sound output. |/RMD|