SoundService
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
| Memory category | Instances |
|---|
Member index 26
Removed member index 1
| History | Member | |
|---|---|---|
| 473 | PlayStockSound(sound: SoundType): void |
History 86
- 630 Add OpenAudioEqualizerEditorSignal
- 629 Add OpenAttenuationCurveEditorSignal
- 629 Add OpenAttenuationCurveEditor
- 599 Add AudioInstanceAdded
- 573 Change ReturnType of SetOutputDevice from void to null
- 573 Change ReturnType of SetListener from void to null
- 573 Change ReturnType of SetInputDevice from void to null
- 573 Change ReturnType of PlayLocalSound from void to null
- 559 Add
- 553 Change Default of VolumetricAudio from to Automatic
- 553 Change Default of RolloffScale from to 1
- 553 Change Default of RespectFilteringEnabled from to false
- 553 Change Default of DopplerScale from to 1
- 553 Change Default of DistanceFactor from to 3.32999992
- 553 Change Default of AmbientReverb from to NoReverb
- 550 Add SetInputDevice
- 550 Add GetInputDevices
- 550 Add GetInputDevice
- 538 Change Tags of VolumetricAudio from [NotScriptable, NotBrowsable] to [NotScriptable]
- 536 Add VolumetricAudio
- 486 Change ThreadSafety of RolloffScale from ReadOnly to ReadSafe
- 486 Change ThreadSafety of RespectFilteringEnabled from ReadOnly to ReadSafe
- 486 Change ThreadSafety of DopplerScale from ReadOnly to ReadSafe
- 486 Change ThreadSafety of DistanceFactor from ReadOnly to ReadSafe
- 486 Change ThreadSafety of AmbientReverb from ReadOnly to ReadSafe
- 475 Add DeviceListChanged
- 473 Remove PlayStockSound
- 467 Add SetOutputDevice
- 467 Add GetOutputDevices
- 467 Add GetOutputDevice
- 462 Change ThreadSafety of SetRecordingDevice from to Unsafe
- 462 Change ThreadSafety of SetListener from to Unsafe
- 462 Change ThreadSafety of PlayStockSound from to Unsafe
- 462 Change ThreadSafety of PlayLocalSound from to Unsafe
- 462 Change ThreadSafety of GetSoundMemoryData from to Unsafe
- 462 Change ThreadSafety of GetRecordingDevices from to Unsafe
- 462 Change ThreadSafety of GetListener from to Unsafe
- 462 Change ThreadSafety of EndRecording from to Unsafe
- 462 Change ThreadSafety of BeginRecording from to Unsafe
- 462 Change ThreadSafety of RolloffScale from to ReadOnly
- 462 Change ThreadSafety of RespectFilteringEnabled from to ReadOnly
- 462 Change ThreadSafety of DopplerScale from to ReadOnly
- 462 Change ThreadSafety of DistanceFactor from to ReadOnly
- 462 Change ThreadSafety of AmbientReverb from to ReadOnly
- 372 Add GetSoundMemoryData
- 305 Add RespectFilteringEnabled
- 259 Add PlayLocalSound
- 252 Add SetRecordingDevice
- 252 Add GetRecordingDevices
- 251 Change Tags of EndRecording from [] to [Yields]
- 251 Change Security of EndRecording from RobloxSecurity to RobloxScriptSecurity
- 251 Change ReturnType of EndRecording from string to Dictionary
- 251 Change Security of BeginRecording from RobloxSecurity to RobloxScriptSecurity
- 251 Change ReturnType of BeginRecording from void to bool
- 250 Change ReturnType of EndRecording from Dictionary to string
- 250 Change Security of EndRecording from RobloxScriptSecurity to RobloxSecurity
- 250 Change Tags of EndRecording from [Yields] to []
- 250 Change Security of BeginRecording from RobloxScriptSecurity to RobloxSecurity
- 250 Change ReturnType of BeginRecording from bool to void
- 251 Change Tags of EndRecording from [] to [Yields]
- 251 Change Security of EndRecording from RobloxSecurity to RobloxScriptSecurity
- 251 Change ReturnType of EndRecording from string to Dictionary
- 251 Change Security of BeginRecording from RobloxSecurity to RobloxScriptSecurity
- 251 Change ReturnType of BeginRecording from void to bool
- 249 Add EndRecording
- 249 Add BeginRecording
- 210 Add SetListener
- 210 Add GetListener
- 79 Change Tags of RolloffScale from [preliminary] to []
- 79 Change Tags of DopplerScale from [preliminary] to []
- 79 Change Tags of DistanceFactor from [preliminary] to []
- 79 Change Tags of AmbientReverb from [preliminary] to []
- 78 Change Tags of RolloffScale from [] to [preliminary]
- 78 Change Tags of DopplerScale from [] to [preliminary]
- 78 Change Tags of DistanceFactor from [] to [preliminary]
- 78 Change Tags of AmbientReverb from [] to [preliminary]
- 79 Change Tags of RolloffScale from [preliminary] to []
- 79 Change Tags of DopplerScale from [preliminary] to []
- 79 Change Tags of DistanceFactor from [preliminary] to []
- 79 Change Tags of AmbientReverb from [preliminary] to []
- 47 Add PlayStockSound
- 47 Add RolloffScale
- 47 Add DopplerScale
- 47 Add DistanceFactor
- 47 Add AmbientReverb
- 47 Add SoundService
Members 26
AmbientReverb
| Type | Default | |
|---|---|---|
| ReverbType | NoReverb | |
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 7
- 553 Change Default of AmbientReverb from to NoReverb
- 486 Change ThreadSafety of AmbientReverb from ReadOnly to ReadSafe
- 462 Change ThreadSafety of AmbientReverb from to ReadOnly
- 79 Change Tags of AmbientReverb from [preliminary] to []
- 78 Change Tags of AmbientReverb from [] to [preliminary]
- 79 Change Tags of AmbientReverb from [preliminary] to []
- 47 Add AmbientReverb
AudioInstanceAdded
| Parameters (1) | |
|---|---|
| instance | Instance |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
BeginRecording
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| bool | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 8
- 462 Change ThreadSafety of BeginRecording from to Unsafe
- 251 Change Security of BeginRecording from RobloxSecurity to RobloxScriptSecurity
- 251 Change ReturnType of BeginRecording from void to bool
- 250 Change Security of BeginRecording from RobloxScriptSecurity to RobloxSecurity
- 250 Change ReturnType of BeginRecording from bool to void
- 251 Change Security of BeginRecording from RobloxSecurity to RobloxScriptSecurity
- 251 Change ReturnType of BeginRecording from void to bool
- 249 Add BeginRecording
DeviceListChanged
| Parameters (1) | |
|---|---|
| newDevices | Tuple |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 475 Add DeviceListChanged
DistanceFactor
| Type | Default | |
|---|---|---|
| float | 3.32999992 | |
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 7
- 553 Change Default of DistanceFactor from to 3.32999992
- 486 Change ThreadSafety of DistanceFactor from ReadOnly to ReadSafe
- 462 Change ThreadSafety of DistanceFactor from to ReadOnly
- 79 Change Tags of DistanceFactor from [preliminary] to []
- 78 Change Tags of DistanceFactor from [] to [preliminary]
- 79 Change Tags of DistanceFactor from [preliminary] to []
- 47 Add DistanceFactor
DopplerScale
| Type | Default | |
|---|---|---|
| float | 1 | |
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 7
- 553 Change Default of DopplerScale from to 1
- 486 Change ThreadSafety of DopplerScale from ReadOnly to ReadSafe
- 462 Change ThreadSafety of DopplerScale from to ReadOnly
- 79 Change Tags of DopplerScale from [preliminary] to []
- 78 Change Tags of DopplerScale from [] to [preliminary]
- 79 Change Tags of DopplerScale from [preliminary] to []
- 47 Add DopplerScale
EndRecording
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Dictionary | ||
This function yields. It will block the calling thread until completion.
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 11
- 462 Change ThreadSafety of EndRecording from to Unsafe
- 251 Change Tags of EndRecording from [] to [Yields]
- 251 Change Security of EndRecording from RobloxSecurity to RobloxScriptSecurity
- 251 Change ReturnType of EndRecording from string to Dictionary
- 250 Change ReturnType of EndRecording from Dictionary to string
- 250 Change Security of EndRecording from RobloxScriptSecurity to RobloxSecurity
- 250 Change Tags of EndRecording from [Yields] to []
- 251 Change Tags of EndRecording from [] to [Yields]
- 251 Change Security of EndRecording from RobloxSecurity to RobloxScriptSecurity
- 251 Change ReturnType of EndRecording from string to Dictionary
- 249 Add EndRecording
GetInputDevice
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Tuple | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 550 Add GetInputDevice
GetInputDevices
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Tuple | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 550 Add GetInputDevices
GetListener
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Tuple | ||
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetListener from to Unsafe
- 210 Add GetListener
GetOutputDevice
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Tuple | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 467 Add GetOutputDevice
GetOutputDevices
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Tuple | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 467 Add GetOutputDevices
GetRecordingDevices
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Dictionary | ||
This function yields. It will block the calling thread until completion.
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetRecordingDevices from to Unsafe
- 252 Add GetRecordingDevices
GetSoundMemoryData
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Dictionary | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetSoundMemoryData from to Unsafe
- 372 Add GetSoundMemoryData
OpenAttenuationCurveEditor
| Parameters (1) | ||
|---|---|---|
| selectedCurveObjects | Objects | |
| Returns (1) | ||
| null | ||
| Security | PluginSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
OpenAttenuationCurveEditorSignal
| Parameters (1) | |
|---|---|
| selectedCurveObjects | Objects |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
OpenAudioEqualizerEditorSignal
| Parameters (1) | |
|---|---|
| selectedEqualizerObjects | Objects |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
PlayLocalSound
| Parameters (1) | ||
|---|---|---|
| sound | Instance | |
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of PlayLocalSound from void to null
- 462 Change ThreadSafety of PlayLocalSound from to Unsafe
- 259 Add PlayLocalSound
RespectFilteringEnabled
| Type | Default | |
|---|---|---|
| bool | false | |
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 4
- 553 Change Default of RespectFilteringEnabled from to false
- 486 Change ThreadSafety of RespectFilteringEnabled from ReadOnly to ReadSafe
- 462 Change ThreadSafety of RespectFilteringEnabled from to ReadOnly
- 305 Add RespectFilteringEnabled
RolloffScale
| Type | Default | |
|---|---|---|
| float | 1 | |
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 7
- 553 Change Default of RolloffScale from to 1
- 486 Change ThreadSafety of RolloffScale from ReadOnly to ReadSafe
- 462 Change ThreadSafety of RolloffScale from to ReadOnly
- 79 Change Tags of RolloffScale from [preliminary] to []
- 78 Change Tags of RolloffScale from [] to [preliminary]
- 79 Change Tags of RolloffScale from [preliminary] to []
- 47 Add RolloffScale
SetInputDevice
| Parameters (2) | ||
|---|---|---|
| name | string | |
| guid | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 573 Change ReturnType of SetInputDevice from void to null
- 550 Add SetInputDevice
SetListener
| Parameters (2) | ||
|---|---|---|
| listenerType | ListenerType | |
| listener | Tuple | |
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of SetListener from void to null
- 462 Change ThreadSafety of SetListener from to Unsafe
- 210 Add SetListener
SetOutputDevice
| Parameters (2) | ||
|---|---|---|
| name | string | |
| guid | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 573 Change ReturnType of SetOutputDevice from void to null
- 467 Add SetOutputDevice
SetRecordingDevice
| Parameters (1) | ||
|---|---|---|
| deviceIndex | int | |
| Returns (1) | ||
| bool | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of SetRecordingDevice from to Unsafe
- 252 Add SetRecordingDevice
VolumetricAudio
| Type | Default | |
|---|---|---|
| VolumetricAudio | Automatic | |
This property is not scriptable. It cannot be accessed by script code.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 3
- 553 Change Default of VolumetricAudio from to Automatic
- 538 Change Tags of VolumetricAudio from [NotScriptable, NotBrowsable] to [NotScriptable]
- 536 Add VolumetricAudio
Removed members 1
PlayStockSound
| Parameters (1) | ||
|---|---|---|
| sound | SoundType | |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 473 Remove PlayStockSound
- 462 Change ThreadSafety of PlayStockSound from to Unsafe
- 47 Add PlayStockSound