Sound

Show Deprecated

Code Samples

Music Playing Part
local part = Instance.new("Part")

part.Anchored = true

part.Position = Vector3.new(0, 3, 0)

part.BrickColor = BrickColor.new("Bright red")

part.Name = "MusicBox"

part.Parent = workspace



-- create a sound

local sound = Instance.new("Sound", part)

sound.SoundId = "rbxassetid://9120386436"

sound.EmitterSize = 5 -- decrease the emitter size (for earlier volume drop off)

sound.Looped = true

sound.Parent = part



local clickDetector = Instance.new("ClickDetector")

clickDetector.Parent = part



-- toggle the sound playing / not playing

clickDetector.MouseClick:Connect(function()

	if not sound.IsPlaying then

		part.BrickColor = BrickColor.new("Bright green")

		sound:Play()

	else

		part.BrickColor = BrickColor.new("Bright red")

		sound:Stop()

	end

end)

Summary

Properties

View all inherited from Instance
View all inherited from Object

Properties

ChannelCount

number
Read Only
Not Replicated
Not Browsable
Roblox Script Security
Read Parallel

IsLoaded

boolean
Read Only
Not Replicated
Read Parallel

Code Samples

Load Sound
local sound = script.Parent.Sound



if not sound.IsLoaded then

	sound.Loaded:Wait()

end



print("The sound has loaded!")

IsMutedForCapture

boolean
Roblox Script Security
Read Parallel

IsPaused

boolean
Hidden
Read Only
Not Replicated
Read Parallel

Code Samples

Sound IsPlaying and SoundIsPaused
local sound = Instance.new("Sound")

sound.SoundId = "rbxassetid://9120386436"

sound.Looped = true

sound.Parent = workspace



if not sound.isLoaded then

	sound.Loaded:Wait()

end



sound:Play()

print(sound.IsPlaying, sound.IsPaused) -- true, false



task.wait(2)

sound:Pause()

print(sound.IsPlaying, sound.IsPaused) -- false, true



task.wait(2)

sound:Play()

print(sound.IsPlaying, sound.IsPaused) -- true, false



task.wait(2)

sound:Stop()

print(sound.IsPlaying, sound.IsPaused) -- false, true

IsPlaying

boolean
Hidden
Read Only
Not Replicated
Read Parallel

Code Samples

Sound IsPlaying and SoundIsPaused
local sound = Instance.new("Sound")

sound.SoundId = "rbxassetid://9120386436"

sound.Looped = true

sound.Parent = workspace



if not sound.isLoaded then

	sound.Loaded:Wait()

end



sound:Play()

print(sound.IsPlaying, sound.IsPaused) -- true, false



task.wait(2)

sound:Pause()

print(sound.IsPlaying, sound.IsPaused) -- false, true



task.wait(2)

sound:Play()

print(sound.IsPlaying, sound.IsPaused) -- true, false



task.wait(2)

sound:Stop()

print(sound.IsPlaying, sound.IsPaused) -- false, true

LoopRegion

NumberRange
Read Parallel

Looped

boolean
Read Parallel

Code Samples

Loop a Number of Times
local function loopNTimes(sound, numberOfLoops)

	if not sound.IsPlaying then

		sound.Looped = true

		local connection = nil

		connection = sound.DidLoop:Connect(function(_soundId, numOfTimesLooped)

			print(numOfTimesLooped)

			if numOfTimesLooped >= numberOfLoops then

				-- disconnect the connection

				connection:Disconnect()

				-- stop the sound

				sound:Stop()

			end

		end)

		sound:Play()

	end

end



local sound = Instance.new("Sound")

sound.SoundId = "rbxassetid://0"



loopNTimes(sound, 5)

PlayOnRemove

boolean
Read Parallel

PlaybackLoudness

number
Read Only
Not Replicated
Read Parallel

Code Samples

Volume Amplitude Bar
-- to be placed in StarterPlayer > StarterPlayerScripts



local Players = game:GetService("Players")



-- wait for local player PlayerGui

local LocalPlayer = Players.LocalPlayer

local playerGui = LocalPlayer:WaitForChild("PlayerGui")



-- create a ScreenGui

local screenGui = Instance.new("ScreenGui")

screenGui.Parent = playerGui



-- create a holder for our bar

local frame = Instance.new("Frame")

frame.AnchorPoint = Vector2.new(0.5, 0.5)

frame.Position = UDim2.new(0.5, 0, 0.5, 0)

frame.Size = UDim2.new(0.3, 0, 0.05, 0)

frame.Parent = screenGui



-- create a bar

local bar = Instance.new("Frame")

bar.Position = UDim2.new(0, 0, 0, 0)

bar.Size = UDim2.new(1, 0, 1, 0)

bar.BackgroundColor3 = Color3.new(0, 1, 0)

bar.Parent = frame



-- create a sound

local sound = Instance.new("Sound")

sound.SoundId = "rbxassetid://9120386436"

sound.Looped = true

sound.Parent = screenGui

sound:Play()



-- define a max loudness

local maxLoudness = 30



-- animate the amplitude bar

while true do

	local amplitude = math.clamp(sound.PlaybackLoudness / maxLoudness, 0, 1)

	bar.Size = UDim2.new(amplitude, 0, 1, 0)

	wait(0.05)

end

PlaybackRegion

NumberRange
Read Parallel

PlaybackRegionsEnabled

boolean
Read Parallel

PlaybackSpeed

number
Not Replicated
Read Parallel

Code Samples

Sound PlaybackSpeed
local sound = Instance.new("Sound")

sound.SoundId = "rbxassetid://9120386436"

sound.Looped = true

sound.Parent = workspace



sound:Play()

task.wait(10)

sound.PlaybackSpeed = 3 -- 3x faster

task.wait(5)

sound.PlaybackSpeed = 0.5 -- 2x slower

task.wait(5)

sound.PlaybackSpeed = 1 -- default

Playing

boolean
Not Replicated
Read Parallel

Code Samples

Sound Playing
local sound = Instance.new("Sound")

sound.SoundId = "rbxassetid://9120386436"

sound.Looped = true

sound.Parent = workspace



print("playing sound")

sound.Playing = true



task.wait(10)



print("stopping sound")

sound.Playing = false



task.wait(5)



sound.Playing = true

local timePosition = sound.TimePosition

print("resumed at time position: " .. tostring(timePosition)) -- c. 10 seconds

RollOffMaxDistance

number
Read Parallel

RollOffMinDistance

number
Read Parallel

RollOffMode

Enum.RollOffMode
Read Parallel

SoundGroup

SoundGroup
Read Parallel

SoundId

ContentId
Read Parallel

TimeLength

number
Read Only
Not Replicated
Read Parallel

Code Samples

Play a Sound for a Specific Duration
local function playForDuration(sound, duration)

	if not sound.IsLoaded then

		sound.Loaded:wait()

	end

	local speed = sound.TimeLength / duration

	sound.PlaybackSpeed = speed

	sound:Play()

end



local sound = script.Parent

playForDuration(sound, 5)

TimePosition

number
Not Replicated
Read Parallel

Code Samples

Sound TimePosition
local sound = Instance.new("Sound")

sound.SoundId = "rbxassetid://9120386436"

sound.Parent = workspace



sound.TimePosition = 30



sound:Play()



task.wait(5)



sound.TimePosition = 100



task.wait(5)



sound.TimePosition = 0

Volume

number
Read Parallel
View all inherited from Instance
View all inherited from Object

Methods

Pause

()

Returns

()

Code Samples

Sound Functions
-- create a sound

local sound = Instance.new("Sound", game.Workspace)

sound.SoundId = "rbxassetid://9120386436"



if not sound.IsLoaded then

	sound.Loaded:Wait()

end



-- listen for events

sound.Played:Connect(function(_soundId)

	print("Sound.Played event")

end)



sound.Paused:Connect(function(_soundId)

	print("Sound.Paused event")

end)



sound.Resumed:Connect(function(_soundId)

	print("Sound.Resumed event")

end)



sound.Stopped:Connect(function(_soundId)

	print("Sound.Stopped event")

end)



sound:Play()

print("play", sound.Playing, sound.TimePosition) -- play true 0



task.wait(10)



sound:Pause()

print("pause", sound.Playing, sound.TimePosition) -- pause false 10



task.wait(3)



sound:Resume()

print("play", sound.Playing, sound.TimePosition) -- play true 10



task.wait(3)



sound:Stop()

print("stop", sound.Playing, sound.TimePosition) -- stop false 0



task.wait(3)



sound:Play()

print("play", sound.Playing, sound.TimePosition) -- play true 0

Play

()

Returns

()

Code Samples

Sound Functions
-- create a sound

local sound = Instance.new("Sound", game.Workspace)

sound.SoundId = "rbxassetid://9120386436"



if not sound.IsLoaded then

	sound.Loaded:Wait()

end



-- listen for events

sound.Played:Connect(function(_soundId)

	print("Sound.Played event")

end)



sound.Paused:Connect(function(_soundId)

	print("Sound.Paused event")

end)



sound.Resumed:Connect(function(_soundId)

	print("Sound.Resumed event")

end)



sound.Stopped:Connect(function(_soundId)

	print("Sound.Stopped event")

end)



sound:Play()

print("play", sound.Playing, sound.TimePosition) -- play true 0



task.wait(10)



sound:Pause()

print("pause", sound.Playing, sound.TimePosition) -- pause false 10



task.wait(3)



sound:Resume()

print("play", sound.Playing, sound.TimePosition) -- play true 10



task.wait(3)



sound:Stop()

print("stop", sound.Playing, sound.TimePosition) -- stop false 0



task.wait(3)



sound:Play()

print("play", sound.Playing, sound.TimePosition) -- play true 0

Resume

()

Returns

()

Code Samples

Sound Functions
-- create a sound

local sound = Instance.new("Sound", game.Workspace)

sound.SoundId = "rbxassetid://9120386436"



if not sound.IsLoaded then

	sound.Loaded:Wait()

end



-- listen for events

sound.Played:Connect(function(_soundId)

	print("Sound.Played event")

end)



sound.Paused:Connect(function(_soundId)

	print("Sound.Paused event")

end)



sound.Resumed:Connect(function(_soundId)

	print("Sound.Resumed event")

end)



sound.Stopped:Connect(function(_soundId)

	print("Sound.Stopped event")

end)



sound:Play()

print("play", sound.Playing, sound.TimePosition) -- play true 0



task.wait(10)



sound:Pause()

print("pause", sound.Playing, sound.TimePosition) -- pause false 10



task.wait(3)



sound:Resume()

print("play", sound.Playing, sound.TimePosition) -- play true 10



task.wait(3)



sound:Stop()

print("stop", sound.Playing, sound.TimePosition) -- stop false 0



task.wait(3)



sound:Play()

print("play", sound.Playing, sound.TimePosition) -- play true 0

Stop

()

Returns

()

Code Samples

Sound Functions
-- create a sound

local sound = Instance.new("Sound", game.Workspace)

sound.SoundId = "rbxassetid://9120386436"



if not sound.IsLoaded then

	sound.Loaded:Wait()

end



-- listen for events

sound.Played:Connect(function(_soundId)

	print("Sound.Played event")

end)



sound.Paused:Connect(function(_soundId)

	print("Sound.Paused event")

end)



sound.Resumed:Connect(function(_soundId)

	print("Sound.Resumed event")

end)



sound.Stopped:Connect(function(_soundId)

	print("Sound.Stopped event")

end)



sound:Play()

print("play", sound.Playing, sound.TimePosition) -- play true 0



task.wait(10)



sound:Pause()

print("pause", sound.Playing, sound.TimePosition) -- pause false 10



task.wait(3)



sound:Resume()

print("play", sound.Playing, sound.TimePosition) -- play true 10



task.wait(3)



sound:Stop()

print("stop", sound.Playing, sound.TimePosition) -- stop false 0



task.wait(3)



sound:Play()

print("play", sound.Playing, sound.TimePosition) -- play true 0
View all inherited from Instance
View all inherited from Object

Events

DidLoop

Parameters

soundId: string
numOfTimesLooped: number

Code Samples

Loop a Number of Times
local function loopNTimes(sound, numberOfLoops)

	if not sound.IsPlaying then

		sound.Looped = true

		local connection = nil

		connection = sound.DidLoop:Connect(function(_soundId, numOfTimesLooped)

			print(numOfTimesLooped)

			if numOfTimesLooped >= numberOfLoops then

				-- disconnect the connection

				connection:Disconnect()

				-- stop the sound

				sound:Stop()

			end

		end)

		sound:Play()

	end

end



local sound = Instance.new("Sound")

sound.SoundId = "rbxassetid://0"



loopNTimes(sound, 5)

Ended

Parameters

soundId: string

Loaded

Parameters

soundId: string

Code Samples

Load Sound
local sound = script.Parent.Sound



if not sound.IsLoaded then

	sound.Loaded:Wait()

end



print("The sound has loaded!")

Paused

Parameters

soundId: string

Code Samples

Sound Functions
-- create a sound

local sound = Instance.new("Sound", game.Workspace)

sound.SoundId = "rbxassetid://9120386436"



if not sound.IsLoaded then

	sound.Loaded:Wait()

end



-- listen for events

sound.Played:Connect(function(_soundId)

	print("Sound.Played event")

end)



sound.Paused:Connect(function(_soundId)

	print("Sound.Paused event")

end)



sound.Resumed:Connect(function(_soundId)

	print("Sound.Resumed event")

end)



sound.Stopped:Connect(function(_soundId)

	print("Sound.Stopped event")

end)



sound:Play()

print("play", sound.Playing, sound.TimePosition) -- play true 0



task.wait(10)



sound:Pause()

print("pause", sound.Playing, sound.TimePosition) -- pause false 10



task.wait(3)



sound:Resume()

print("play", sound.Playing, sound.TimePosition) -- play true 10



task.wait(3)



sound:Stop()

print("stop", sound.Playing, sound.TimePosition) -- stop false 0



task.wait(3)



sound:Play()

print("play", sound.Playing, sound.TimePosition) -- play true 0

Played

Parameters

soundId: string

Code Samples

Sound Functions
-- create a sound

local sound = Instance.new("Sound", game.Workspace)

sound.SoundId = "rbxassetid://9120386436"



if not sound.IsLoaded then

	sound.Loaded:Wait()

end



-- listen for events

sound.Played:Connect(function(_soundId)

	print("Sound.Played event")

end)



sound.Paused:Connect(function(_soundId)

	print("Sound.Paused event")

end)



sound.Resumed:Connect(function(_soundId)

	print("Sound.Resumed event")

end)



sound.Stopped:Connect(function(_soundId)

	print("Sound.Stopped event")

end)



sound:Play()

print("play", sound.Playing, sound.TimePosition) -- play true 0



task.wait(10)



sound:Pause()

print("pause", sound.Playing, sound.TimePosition) -- pause false 10



task.wait(3)



sound:Resume()

print("play", sound.Playing, sound.TimePosition) -- play true 10



task.wait(3)



sound:Stop()

print("stop", sound.Playing, sound.TimePosition) -- stop false 0



task.wait(3)



sound:Play()

print("play", sound.Playing, sound.TimePosition) -- play true 0

Resumed

Parameters

soundId: string

Code Samples

Sound Functions
-- create a sound

local sound = Instance.new("Sound", game.Workspace)

sound.SoundId = "rbxassetid://9120386436"



if not sound.IsLoaded then

	sound.Loaded:Wait()

end



-- listen for events

sound.Played:Connect(function(_soundId)

	print("Sound.Played event")

end)



sound.Paused:Connect(function(_soundId)

	print("Sound.Paused event")

end)



sound.Resumed:Connect(function(_soundId)

	print("Sound.Resumed event")

end)



sound.Stopped:Connect(function(_soundId)

	print("Sound.Stopped event")

end)



sound:Play()

print("play", sound.Playing, sound.TimePosition) -- play true 0



task.wait(10)



sound:Pause()

print("pause", sound.Playing, sound.TimePosition) -- pause false 10



task.wait(3)



sound:Resume()

print("play", sound.Playing, sound.TimePosition) -- play true 10



task.wait(3)



sound:Stop()

print("stop", sound.Playing, sound.TimePosition) -- stop false 0



task.wait(3)



sound:Play()

print("play", sound.Playing, sound.TimePosition) -- play true 0

Stopped

Parameters

soundId: string

Code Samples

Sound Functions
-- create a sound

local sound = Instance.new("Sound", game.Workspace)

sound.SoundId = "rbxassetid://9120386436"



if not sound.IsLoaded then

	sound.Loaded:Wait()

end



-- listen for events

sound.Played:Connect(function(_soundId)

	print("Sound.Played event")

end)



sound.Paused:Connect(function(_soundId)

	print("Sound.Paused event")

end)



sound.Resumed:Connect(function(_soundId)

	print("Sound.Resumed event")

end)



sound.Stopped:Connect(function(_soundId)

	print("Sound.Stopped event")

end)



sound:Play()

print("play", sound.Playing, sound.TimePosition) -- play true 0



task.wait(10)



sound:Pause()

print("pause", sound.Playing, sound.TimePosition) -- pause false 10



task.wait(3)



sound:Resume()

print("play", sound.Playing, sound.TimePosition) -- play true 10



task.wait(3)



sound:Stop()

print("stop", sound.Playing, sound.TimePosition) -- stop false 0



task.wait(3)



sound:Play()

print("play", sound.Playing, sound.TimePosition) -- play true 0
View all inherited from Instance
View all inherited from Object