SoundService On DevHub

Summary

This class is not creatable. An object 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
ExplorerImageIndex	31 ()
ExplorerOrder	500

Tags: [NotCreatable, Service]

Inherits (1)

Instance

Member index (22)

Type	Member	History
ReverbType	AmbientReverb	79 78 79
float	DistanceFactor	79 78 79
float	DopplerScale	79 78 79
bool	RespectFilteringEnabled	305
float	RolloffScale	79 78 79
VolumetricAudio	VolumetricAudio	536 538
bool	BeginRecording ()	249 251 251 250 250 251 251
Dictionary	EndRecording ()	249 251 251 251 250 250 250 251 251 251
Tuple	GetInputDevice ()	550
Tuple	GetInputDevices ()	550
Tuple	GetListener ()	210
Tuple	GetOutputDevice ()	467
Tuple	GetOutputDevices ()	467
Dictionary	GetRecordingDevices ()	252
Dictionary	GetSoundMemoryData ()	372
null	PlayLocalSound (Instance sound)	259 573
null	SetInputDevice (string name, string guid)	550 573
null	SetListener (ListenerType listenerType, Tuple listener)	210 573
null	SetOutputDevice (string name, string guid)	467 573
bool	SetRecordingDevice (int deviceIndex)	252
	AudioInstanceAdded (Instance instance)	599
	DeviceListChanged (Tuple newDevices)	475
57 members inherited from Instance

Removed member index (1)

Type		Member	History
void		PlayStockSound (SoundType sound)	473

599 Add SoundService.AudioInstanceAdded
573 Change ReturnType of SoundService.PlayLocalSound from void to null
573 Change ReturnType of SoundService.SetInputDevice from void to null
573 Change ReturnType of SoundService.SetListener from void to null
573 Change ReturnType of SoundService.SetOutputDevice from void to null
550 Add SoundService.GetInputDevice
550 Add SoundService.GetInputDevices
550 Add SoundService.SetInputDevice
538 Change Tags of SoundService.VolumetricAudio from [NotScriptable, NotBrowsable] to [NotScriptable]
536 Add SoundService.VolumetricAudio
475 Add SoundService.DeviceListChanged
473 Remove SoundService.PlayStockSound
467 Add SoundService.GetOutputDevice
467 Add SoundService.GetOutputDevices
467 Add SoundService.SetOutputDevice
372 Add SoundService.GetSoundMemoryData
305 Add SoundService.RespectFilteringEnabled
259 Add SoundService.PlayLocalSound
252 Add SoundService.GetRecordingDevices
252 Add SoundService.SetRecordingDevice
251 Change ReturnType of SoundService.BeginRecording from void to bool
251 Change Security of SoundService.BeginRecording from RobloxSecurity to RobloxScriptSecurity
251 Change ReturnType of SoundService.EndRecording from string to Dictionary
251 Change Security of SoundService.EndRecording from RobloxSecurity to RobloxScriptSecurity
251 Change Tags of SoundService.EndRecording from [] to [Yields]
250 Change ReturnType of SoundService.BeginRecording from bool to void
250 Change Security of SoundService.BeginRecording from RobloxScriptSecurity to RobloxSecurity
250 Change ReturnType of SoundService.EndRecording from Dictionary to string
250 Change Security of SoundService.EndRecording from RobloxScriptSecurity to RobloxSecurity
250 Change Tags of SoundService.EndRecording from [Yields] to []
251 Change ReturnType of SoundService.BeginRecording from void to bool
251 Change Security of SoundService.BeginRecording from RobloxSecurity to RobloxScriptSecurity
251 Change ReturnType of SoundService.EndRecording from string to Dictionary
251 Change Security of SoundService.EndRecording from RobloxSecurity to RobloxScriptSecurity
251 Change Tags of SoundService.EndRecording from [] to [Yields]
249 Add SoundService.BeginRecording
249 Add SoundService.EndRecording
210 Add SoundService.GetListener
210 Add SoundService.SetListener
79 Change Tags of SoundService.AmbientReverb from [preliminary] to []
79 Change Tags of SoundService.DistanceFactor from [preliminary] to []
79 Change Tags of SoundService.DopplerScale from [preliminary] to []
79 Change Tags of SoundService.RolloffScale from [preliminary] to []
78 Change Tags of SoundService.AmbientReverb from [] to [preliminary]
78 Change Tags of SoundService.DistanceFactor from [] to [preliminary]
78 Change Tags of SoundService.DopplerScale from [] to [preliminary]
78 Change Tags of SoundService.RolloffScale from [] to [preliminary]
79 Change Tags of SoundService.AmbientReverb from [preliminary] to []
79 Change Tags of SoundService.DistanceFactor from [preliminary] to []
79 Change Tags of SoundService.DopplerScale from [preliminary] to []
79 Change Tags of SoundService.RolloffScale from [preliminary] to []

Members

AmbientReverb On DevHub

Value Type	ReverbType
Category	Data
Can Load	true
Can Save	true

History

79 Change Tags of SoundService.AmbientReverb from [preliminary] to []
78 Change Tags of SoundService.AmbientReverb from [] to [preliminary]
79 Change Tags of SoundService.AmbientReverb from [preliminary] to []

AudioInstanceAdded On DevHub

Parameters	1

Name	Type	Default
instance	Instance	none

Security	RobloxScriptSecurity

History

599 Add SoundService.AudioInstanceAdded

BeginRecording On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool
Security	RobloxScriptSecurity

History

251 Change ReturnType of SoundService.BeginRecording from void to bool
251 Change Security of SoundService.BeginRecording from RobloxSecurity to RobloxScriptSecurity
250 Change ReturnType of SoundService.BeginRecording from bool to void
250 Change Security of SoundService.BeginRecording from RobloxScriptSecurity to RobloxSecurity
251 Change ReturnType of SoundService.BeginRecording from void to bool
251 Change Security of SoundService.BeginRecording from RobloxSecurity to RobloxScriptSecurity
249 Add SoundService.BeginRecording

DeviceListChanged On DevHub

Parameters	1

Name	Type	Default
newDevices	Tuple	none

Security	RobloxScriptSecurity

History

475 Add SoundService.DeviceListChanged

DistanceFactor On DevHub

Value Type	float
Category	Data
Can Load	true
Can Save	true

History

79 Change Tags of SoundService.DistanceFactor from [preliminary] to []
78 Change Tags of SoundService.DistanceFactor from [] to [preliminary]
79 Change Tags of SoundService.DistanceFactor from [preliminary] to []

DopplerScale On DevHub

Value Type	float
Category	Data
Can Load	true
Can Save	true

History

79 Change Tags of SoundService.DopplerScale from [preliminary] to []
78 Change Tags of SoundService.DopplerScale from [] to [preliminary]
79 Change Tags of SoundService.DopplerScale from [preliminary] to []

EndRecording On DevHub

This function yields. It will block the calling thread until completion.

Parameters	0

Name	Type	Default
No parameters.

Return Type	Dictionary
Security	RobloxScriptSecurity

History

251 Change ReturnType of SoundService.EndRecording from string to Dictionary
251 Change Security of SoundService.EndRecording from RobloxSecurity to RobloxScriptSecurity
251 Change Tags of SoundService.EndRecording from [] to [Yields]
250 Change ReturnType of SoundService.EndRecording from Dictionary to string
250 Change Security of SoundService.EndRecording from RobloxScriptSecurity to RobloxSecurity
250 Change Tags of SoundService.EndRecording from [Yields] to []
251 Change ReturnType of SoundService.EndRecording from string to Dictionary
251 Change Security of SoundService.EndRecording from RobloxSecurity to RobloxScriptSecurity
251 Change Tags of SoundService.EndRecording from [] to [Yields]
249 Add SoundService.EndRecording

Tags: [Yields]

GetInputDevice On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Tuple
Security	RobloxScriptSecurity

History

550 Add SoundService.GetInputDevice

GetInputDevices On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Tuple
Security	RobloxScriptSecurity

History

550 Add SoundService.GetInputDevices

GetListener On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Tuple

History

210 Add SoundService.GetListener

GetOutputDevice On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Tuple
Security	RobloxScriptSecurity

History

467 Add SoundService.GetOutputDevice

GetOutputDevices On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Tuple
Security	RobloxScriptSecurity

History

467 Add SoundService.GetOutputDevices

GetRecordingDevices On DevHub

This function yields. It will block the calling thread until completion.

Parameters	0

Name	Type	Default
No parameters.

Return Type	Dictionary
Security	RobloxScriptSecurity

History

252 Add SoundService.GetRecordingDevices

Tags: [Yields]

GetSoundMemoryData On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Dictionary
Security	RobloxScriptSecurity

History

372 Add SoundService.GetSoundMemoryData

PlayLocalSound On DevHub

Parameters	1

Name	Type	Default
sound	Instance	none

Return Type	null

History

573 Change ReturnType of SoundService.PlayLocalSound from void to null
259 Add SoundService.PlayLocalSound

RespectFilteringEnabled On DevHub

Value Type	bool
Category	Data
Can Load	true
Can Save	true

History

305 Add SoundService.RespectFilteringEnabled

RolloffScale On DevHub

Value Type	float
Category	Data
Can Load	true
Can Save	true

History

79 Change Tags of SoundService.RolloffScale from [preliminary] to []
78 Change Tags of SoundService.RolloffScale from [] to [preliminary]
79 Change Tags of SoundService.RolloffScale from [preliminary] to []

SetInputDevice On DevHub

Parameters	2

Name	Type	Default
name	string	none
guid	string	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of SoundService.SetInputDevice from void to null
550 Add SoundService.SetInputDevice

SetListener On DevHub

Parameters	2

Name	Type	Default
listenerType	ListenerType	none
listener	Tuple	none

Return Type	null

History

573 Change ReturnType of SoundService.SetListener from void to null
210 Add SoundService.SetListener

SetOutputDevice On DevHub

Parameters	2

Name	Type	Default
name	string	none
guid	string	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of SoundService.SetOutputDevice from void to null
467 Add SoundService.SetOutputDevice

SetRecordingDevice On DevHub

Parameters	1

Name	Type	Default
deviceIndex	int	none

Return Type	bool
Security	RobloxScriptSecurity

History

252 Add SoundService.SetRecordingDevice

VolumetricAudio On DevHub

This member is not scriptable. It cannot be accessed by Lua code.

Value Type	VolumetricAudio
Category	Data
Can Load	true
Can Save	true

History

538 Change Tags of SoundService.VolumetricAudio from [NotScriptable, NotBrowsable] to [NotScriptable]
536 Add SoundService.VolumetricAudio

Tags: [NotScriptable]

Removed members

PlayStockSound

Parameters	1

Name	Type	Default
sound	SoundType	none

Return Type	void
Security	RobloxScriptSecurity