Sound On DevHub

Summary

Memory Category	Internal
ClassCategory	Sounds
ExplorerImageIndex	11 ()
ExplorerOrder	10

Inherits (1)

Instance

Member index (42)

Type	Member	History
int	ChannelCount	491 553
float	EmitterSize	262 456 599 601
bool	IsLoaded	249 553
bool	IsPaused	553 553
bool	IsPlaying	553 553
bool	IsSpatial	562
NumberRange	LoopRegion	549
bool	Looped	553
float	MaxDistance	220 456 599 601
float	MinDistance	220 262 599 601
float	Pitch	262
bool	PlayOnRemove
double	PlaybackLoudness	264 553
NumberRange	PlaybackRegion	549
bool	PlaybackRegionsEnabled	549 582
float	PlaybackSpeed	262 389 553
bool	Playing	249 417 553
float	RollOffGain	562
float	RollOffMaxDistance	456 553
float	RollOffMinDistance	456 553
RollOffMode	RollOffMode	249 266 553
SoundGroup	SoundGroup	264 329 553
Content	SoundId	553
double	TimeLength	176 178 553
double	TimePosition	176 178 417 553
UsageContext	UsageContextPermission	516
float	Volume	553
bool	isPlaying	50 49 50
null	Pause ()	573
null	Play ()	573
null	Resume ()	182 573
null	Stop ()	573
null	pause ()	50 49 50 573
null	play ()	573
null	stop ()	49 573
	DidLoop (string soundId, int numOfTimesLooped)	179
	Ended (string soundId)	204
	Loaded (string soundId)	249
	Paused (string soundId)	179
	Played (string soundId)	179
	Resumed (string soundId)	249
	Stopped (string soundId)	179
57 members inherited from Instance

601 Change Tags of Sound.EmitterSize from [] to [Deprecated]
601 Change Tags of Sound.MaxDistance from [] to [Deprecated]
601 Change Tags of Sound.MinDistance from [] to [Deprecated]
599 Change Tags of Sound.EmitterSize from [Deprecated] to []
599 Change Tags of Sound.MaxDistance from [Deprecated] to []
599 Change Tags of Sound.MinDistance from [Deprecated] to []
582 Change Tags of Sound.PlaybackRegionsEnabled from [NotBrowsable] to []
573 Change ReturnType of Sound.Pause from void to null
573 Change ReturnType of Sound.Play from void to null
573 Change ReturnType of Sound.Resume from void to null
573 Change ReturnType of Sound.Stop from void to null
573 Change ReturnType of Sound.pause from void to null
573 Change ReturnType of Sound.play from void to null
573 Change ReturnType of Sound.stop from void to null
562 Add Sound.IsSpatial
562 Add Sound.RollOffGain
553 Change Category of Sound.ChannelCount from Data to Asset
553 Change Category of Sound.IsLoaded from Data to Asset
553 Change Category of Sound.IsPaused from Data to Playback
553 Change Tags of Sound.IsPaused from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
553 Change Category of Sound.IsPlaying from Data to Playback
553 Change Tags of Sound.IsPlaying from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
553 Change Category of Sound.Looped from Data to Playback
553 Change Category of Sound.PlaybackLoudness from Data to Playback
553 Change Category of Sound.PlaybackSpeed from Data to Playback
553 Change Category of Sound.Playing from Data to Playback
553 Change Category of Sound.RollOffMaxDistance from Data to Emitter
553 Change Category of Sound.RollOffMinDistance from Data to Emitter
553 Change Category of Sound.RollOffMode from Data to Emitter
553 Change Category of Sound.SoundGroup from Data to Routing
553 Change Category of Sound.SoundId from Data to Asset
553 Change Category of Sound.TimeLength from Data to Asset
553 Change Category of Sound.TimePosition from Data to Playback
553 Change Category of Sound.Volume from Data to Playback
549 Add Sound.LoopRegion
549 Add Sound.PlaybackRegion
549 Add Sound.PlaybackRegionsEnabled
516 Add Sound.UsageContextPermission
491 Add Sound.ChannelCount
456 Change Tags of Sound.EmitterSize from [] to [Deprecated]
456 Change Tags of Sound.MaxDistance from [] to [Deprecated]
456 Add Sound.RollOffMaxDistance
456 Add Sound.RollOffMinDistance
417 Change Tags of Sound.Playing from [] to [NotReplicated]
417 Change Tags of Sound.TimePosition from [] to [NotReplicated]
389 Change Tags of Sound.PlaybackSpeed from [] to [NotReplicated]
329 Change ValueType of Sound.SoundGroup from Object to SoundGroup
266 Change Tags of Sound.RollOffMode from [Hidden] to []
264 Add Sound.PlaybackLoudness
264 Add Sound.SoundGroup
262 Add Sound.EmitterSize
262 Change Tags of Sound.MinDistance from [] to [Deprecated]
262 Change Tags of Sound.Pitch from [] to [Deprecated]
262 Add Sound.PlaybackSpeed
249 Add Sound.IsLoaded
249 Add Sound.Playing
249 Add Sound.RollOffMode
249 Add Sound.Loaded
249 Add Sound.Resumed
220 Add Sound.MaxDistance
220 Add Sound.MinDistance
204 Add Sound.Ended
182 Add Sound.Resume
179 Add Sound.DidLoop
179 Add Sound.Paused
179 Add Sound.Played
179 Add Sound.Stopped
178 Change ValueType of Sound.TimeLength from int to double
178 Change ValueType of Sound.TimePosition from int to double
176 Add Sound.TimeLength
176 Add Sound.TimePosition
50 Add Sound.isPlaying
50 Add Sound.pause
49 Remove Sound.isPlaying
49 Remove Sound.pause
50 Add Sound.isPlaying
50 Add Sound.pause
49 Add Sound.stop

Members

ChannelCount On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not browsable. It is not visible in Studio's object browser.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	int
Security	RobloxScriptSecurity
Category	Asset
Can Load	false
Can Save	false

History

553 Change Category of Sound.ChannelCount from Data to Asset
491 Add Sound.ChannelCount

Tags: [ReadOnly, NotReplicated, NotBrowsable]

DidLoop On DevHub

Parameters	2

Name	Type	Default
soundId	string	none
numOfTimesLooped	int	none

History

179 Add Sound.DidLoop

EmitterSize On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	float
Category	Data
Can Load	true
Can Save	true

History

601 Change Tags of Sound.EmitterSize from [] to [Deprecated]
599 Change Tags of Sound.EmitterSize from [Deprecated] to []
456 Change Tags of Sound.EmitterSize from [] to [Deprecated]
262 Add Sound.EmitterSize

Tags: [Deprecated]

Ended On DevHub

Parameters	1

Name	Type	Default
soundId	string	none

History

204 Add Sound.Ended

IsLoaded On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Category	Asset
Can Load	false
Can Save	false

History

553 Change Category of Sound.IsLoaded from Data to Asset
249 Add Sound.IsLoaded

Tags: [ReadOnly, NotReplicated]

IsPaused On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Category	Playback
Can Load	false
Can Save	false

History

553 Change Category of Sound.IsPaused from Data to Playback
553 Change Tags of Sound.IsPaused from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]

Tags: [Hidden, ReadOnly, NotReplicated]

IsPlaying On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Category	Playback
Can Load	false
Can Save	false

History

553 Change Category of Sound.IsPlaying from Data to Playback
553 Change Tags of Sound.IsPlaying from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]

Tags: [Hidden, ReadOnly, NotReplicated]

IsSpatial On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Security	RobloxScriptSecurity
Category	Behavior
Can Load	false
Can Save	false

History

562 Add Sound.IsSpatial

Tags: [Hidden, ReadOnly, NotReplicated]

Loaded On DevHub

Parameters	1

Name	Type	Default
soundId	string	none

History

249 Add Sound.Loaded

LoopRegion On DevHub

Value Type	NumberRange
Category	Regions
Can Load	true
Can Save	true

History

549 Add Sound.LoopRegion

Looped On DevHub

Value Type	bool
Category	Playback
Can Load	true
Can Save	true

History

553 Change Category of Sound.Looped from Data to Playback

MaxDistance On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	float
Category	Data
Can Load	false
Can Save	false

History

601 Change Tags of Sound.MaxDistance from [] to [Deprecated]
599 Change Tags of Sound.MaxDistance from [Deprecated] to []
456 Change Tags of Sound.MaxDistance from [] to [Deprecated]
220 Add Sound.MaxDistance

Tags: [Deprecated]

MinDistance On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	float
Category	Data
Can Load	true
Can Save	false

History

601 Change Tags of Sound.MinDistance from [] to [Deprecated]
599 Change Tags of Sound.MinDistance from [Deprecated] to []
262 Change Tags of Sound.MinDistance from [] to [Deprecated]
220 Add Sound.MinDistance

Tags: [Deprecated]

Pause On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null

History

573 Change ReturnType of Sound.Pause from void to null

Paused On DevHub

Parameters	1

Name	Type	Default
soundId	string	none

History

179 Add Sound.Paused

Pitch On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	float
Category	Data
Can Load	true
Can Save	false

History

262 Change Tags of Sound.Pitch from [] to [Deprecated]

Tags: [Deprecated]

Play On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null

History

573 Change ReturnType of Sound.Play from void to null

PlayOnRemove On DevHub

Value Type	bool
Category	Behavior
Can Load	true
Can Save	true

PlaybackLoudness On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	double
Category	Playback
Can Load	false
Can Save	false

History

553 Change Category of Sound.PlaybackLoudness from Data to Playback
264 Add Sound.PlaybackLoudness

Tags: [ReadOnly, NotReplicated]

PlaybackRegion On DevHub

Value Type	NumberRange
Category	Regions
Can Load	true
Can Save	true

History

549 Add Sound.PlaybackRegion

PlaybackRegionsEnabled On DevHub

Value Type	bool
Category	Playback
Can Load	true
Can Save	true

History

582 Change Tags of Sound.PlaybackRegionsEnabled from [NotBrowsable] to []
549 Add Sound.PlaybackRegionsEnabled

PlaybackSpeed On DevHub

This item is not replicated. Its interface does not cross the network boundary.

Value Type	float
Category	Playback
Can Load	true
Can Save	true
SliderScaling	Square
UIMaximum	20
UIMinimum	0
UINumTicks	1000

History

553 Change Category of Sound.PlaybackSpeed from Data to Playback
389 Change Tags of Sound.PlaybackSpeed from [] to [NotReplicated]
262 Add Sound.PlaybackSpeed

Tags: [NotReplicated]

Played On DevHub

Parameters	1

Name	Type	Default
soundId	string	none

History

179 Add Sound.Played

Playing On DevHub

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Category	Playback
Can Load	true
Can Save	true

History

553 Change Category of Sound.Playing from Data to Playback
417 Change Tags of Sound.Playing from [] to [NotReplicated]
249 Add Sound.Playing

Tags: [NotReplicated]

Resume On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null

History

573 Change ReturnType of Sound.Resume from void to null
182 Add Sound.Resume

Resumed On DevHub

Parameters	1

Name	Type	Default
soundId	string	none

History

249 Add Sound.Resumed

RollOffGain On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	float
Security	RobloxScriptSecurity
Category	Playback
Can Load	false
Can Save	false

History

562 Add Sound.RollOffGain

Tags: [Hidden, ReadOnly, NotReplicated]

RollOffMaxDistance On DevHub

This item is not replicated. Its interface does not cross the network boundary.

Value Type	float
Category	Emitter
Can Load	false
Can Save	false

History

553 Change Category of Sound.RollOffMaxDistance from Data to Emitter
456 Add Sound.RollOffMaxDistance

Tags: [NotReplicated]

RollOffMinDistance On DevHub

This item is not replicated. Its interface does not cross the network boundary.

Value Type	float
Category	Emitter
Can Load	false
Can Save	false

History

553 Change Category of Sound.RollOffMinDistance from Data to Emitter
456 Add Sound.RollOffMinDistance

Tags: [NotReplicated]

RollOffMode On DevHub

Value Type	RollOffMode
Category	Emitter
Can Load	true
Can Save	true

History

553 Change Category of Sound.RollOffMode from Data to Emitter
266 Change Tags of Sound.RollOffMode from [Hidden] to []
249 Add Sound.RollOffMode

SoundGroup On DevHub

Value Type	SoundGroup
Category	Routing
Can Load	true
Can Save	true

History

553 Change Category of Sound.SoundGroup from Data to Routing
329 Change ValueType of Sound.SoundGroup from Object to SoundGroup
264 Add Sound.SoundGroup

SoundId On DevHub

Value Type	Content
Category	Asset
Can Load	true
Can Save	true

History

553 Change Category of Sound.SoundId from Data to Asset

Stop On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null

History

573 Change ReturnType of Sound.Stop from void to null

Stopped On DevHub

Parameters	1

Name	Type	Default
soundId	string	none

History

179 Add Sound.Stopped

TimeLength On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	double
Category	Asset
Can Load	false
Can Save	false

History

553 Change Category of Sound.TimeLength from Data to Asset
178 Change ValueType of Sound.TimeLength from int to double
176 Add Sound.TimeLength

Tags: [ReadOnly, NotReplicated]

TimePosition On DevHub

This item is not replicated. Its interface does not cross the network boundary.

Value Type	double
Category	Playback
Can Load	true
Can Save	true

History

553 Change Category of Sound.TimePosition from Data to Playback
417 Change Tags of Sound.TimePosition from [] to [NotReplicated]
178 Change ValueType of Sound.TimePosition from int to double
176 Add Sound.TimePosition

Tags: [NotReplicated]

UsageContextPermission On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	UsageContext
Security	RobloxScriptSecurity
Category	Behavior
Can Load	false
Can Save	false

History

516 Add Sound.UsageContextPermission

Tags: [Hidden, NotReplicated]

Volume On DevHub

Value Type	float
Category	Playback
Can Load	true
Can Save	true
SliderScaling	Square
UIMaximum	10
UIMinimum	0
UINumTicks	1000

History

553 Change Category of Sound.Volume from Data to Playback

isPlaying On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Category	Data
Can Load	false
Can Save	false

History

Tags: [ReadOnly, NotReplicated, Deprecated]

pause On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	null

History

573 Change ReturnType of Sound.pause from void to null
50 Add Sound.pause
49 Remove Sound.pause
50 Add Sound.pause

Tags: [Deprecated]

play On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	null

History

573 Change ReturnType of Sound.play from void to null

Tags: [Deprecated]

stop On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	null

History

573 Change ReturnType of Sound.stop from void to null
49 Add Sound.stop

Tags: [Deprecated]

Relevant classes (1)

SoundGroup