Sound

Missing API Documentation

This API Class does not have any or complete API documentation. Please add API documentation if possible.

Sound
Icon
Legacy IconsThese icon(s) are only a part of legacy Roblox Studio versions, or are unused as of the studio icons update.
Category	Sounds
Memory category	Internal
Subclasses
Inheritance
Object Instance Sound

The Sound class inherits from Instance. Sounds are linked to an audio file or asset through the SoundId property. Sounds are controlled by SoundService. Sounds work if parented to BaseParts, the Workspace, or a Player's PlayerGui. Sounds are additionally processed by parenting an instance that is a subclass of SoundEffect to a sound, such as ReverbSoundEffect. Sounds can additionally be parented to SoundGroups, which applies SoundEffects in the group to all sounds in it.

Roblox uses FMOD for playing sounds.

Properties

ChannelCount: int

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.
• Not browsableThis member is not visible in documentation for end-users.

This class member is missing documentation. Create or add to its subpage at Class:Sound/ChannelCount.

• Category: Asset.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

EmitterSize: float

• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:Sound/EmitterSize.

• Category: Data.
• Serialization: can load only.
• Thread safety: read safe

IsLoaded: bool

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Sound/IsLoaded.

• Category: Asset.
• Serialization: cannot load or save.
• Thread safety: read safe

IsPaused: bool

• HiddenThis property is not shown in the object browser and properties window.
• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Sound/IsPaused.

• Category: Playback.
• Serialization: cannot load or save.
• Thread safety: read safe

IsPlaying: bool

• HiddenThis property is not shown in the object browser and properties window.
• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Sound/IsPlaying.

• Category: Playback.
• Serialization: cannot load or save.
• Thread safety: read safe

IsSpatial: bool

• HiddenThis property is not shown in the object browser and properties window.
• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Sound/IsSpatial.

• Category: Behavior.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

LoopRegion: NumberRange

This class member is missing documentation. Create or add to its subpage at Class:Sound/LoopRegion.

• Category: Regions.
• Serialization: can save and load.
• Thread safety: read safe

Looped: bool

This class member is missing documentation. Create or add to its subpage at Class:Sound/Looped.

• Category: Playback.
• Serialization: can save and load.
• Thread safety: read safe

MaxDistance: float

• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:Sound/MaxDistance.

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

MinDistance: float

• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:Sound/MinDistance.

• Category: Data.
• Serialization: can load only.
• Thread safety: read safe

Pitch: float

• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:Sound/Pitch.

• Category: Data.
• Serialization: can load only.
• Thread safety: read safe

PlayOnRemove: bool

This class member is missing documentation. Create or add to its subpage at Class:Sound/PlayOnRemove.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

PlaybackLoudness: double

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Sound/PlaybackLoudness.

• Category: Playback.
• Serialization: cannot load or save.
• Thread safety: read safe

PlaybackRegion: NumberRange

This class member is missing documentation. Create or add to its subpage at Class:Sound/PlaybackRegion.

• Category: Regions.
• Serialization: can save and load.
• Thread safety: read safe

PlaybackRegionsEnabled: bool

This class member is missing documentation. Create or add to its subpage at Class:Sound/PlaybackRegionsEnabled.

• Category: Playback.
• Serialization: can save and load.
• Thread safety: read safe

PlaybackSpeed: float

• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Sound/PlaybackSpeed.

• Category: Playback.
• Serialization: can save and load.
• Thread safety: read safe

Playing: bool

• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Sound/Playing.

• Category: Playback.
• Serialization: can save and load.
• Thread safety: read safe

RollOffGain: float

• HiddenThis property is not shown in the object browser and properties window.
• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Sound/RollOffGain.

• Category: Playback.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

RollOffMaxDistance: float

This class member is missing documentation. Create or add to its subpage at Class:Sound/RollOffMaxDistance.

• Category: Emitter.
• Serialization: can save and load.
• Thread safety: read safe

RollOffMinDistance: float

This class member is missing documentation. Create or add to its subpage at Class:Sound/RollOffMinDistance.

• Category: Emitter.
• Serialization: can save and load.
• Thread safety: read safe

RollOffMode: RollOffMode

This class member is missing documentation. Create or add to its subpage at Class:Sound/RollOffMode.

• Category: Emitter.
• Serialization: can save and load.
• Thread safety: read safe

SoundGroup: SoundGroup

This class member is missing documentation. Create or add to its subpage at Class:Sound/SoundGroup.

• Category: Routing.
• Serialization: can save and load.
• Thread safety: read safe

SoundId: ContentId

This class member is missing documentation. Create or add to its subpage at Class:Sound/SoundId.

• Category: Asset.
• Serialization: can save and load.
• Thread safety: read safe

TimeLength: double

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Sound/TimeLength.

• Category: Asset.
• Serialization: cannot load or save.
• Thread safety: read safe

TimePosition: double

• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Sound/TimePosition.

• Category: Playback.
• Serialization: can save and load.
• Thread safety: read safe

UsageContextPermission: UsageContext

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Sound/UsageContextPermission.

• Category: Behavior.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

Volume: float

This class member is missing documentation. Create or add to its subpage at Class:Sound/Volume.

• Category: Playback.
• Serialization: can save and load.
• Thread safety: read safe

isPlaying: bool

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

Use IsPlaying instead.

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

Methods

Pause(): null

This class member is missing documentation. Create or add to its subpage at Class:Sound/Pause.

• Thread safety: unsafe

Play(): null

This class member is missing documentation. Create or add to its subpage at Class:Sound/Play.

• Thread safety: unsafe

Resume(): null

This class member is missing documentation. Create or add to its subpage at Class:Sound/Resume.

• Thread safety: unsafe

Stop(): null

This class member is missing documentation. Create or add to its subpage at Class:Sound/Stop.

• Thread safety: unsafe

pause(): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Use Pause instead.

• Thread safety: unsafe

play(): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Use Play instead.

• Thread safety: unsafe

stop(): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Use Stop instead.

• Thread safety: unsafe

Events

DidLoop(soundId: string, numOfTimesLooped: int)

Parameters

Name	Type
soundId	string
numOfTimesLooped	int

• Thread safety: unsafe

Ended(soundId: string)

Parameters

Name	Type
soundId	string

• Thread safety: unsafe

Loaded(soundId: string)

Parameters

Name	Type
soundId	string

• Thread safety: unsafe

Paused(soundId: string)

Parameters

Name	Type
soundId	string

• Thread safety: unsafe

Played(soundId: string)

Parameters

Name	Type
soundId	string

• Thread safety: unsafe

Resumed(soundId: string)

Parameters

Name	Type
soundId	string

• Thread safety: unsafe

Stopped(soundId: string)

Parameters

Name	Type
soundId	string

• Thread safety: unsafe

External links

• Sound in the Roblox Creator Documentation
• Sound in the Roblox API Reference