Paused

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Event of:

Description:

Fires whenever the Sound is paused using Sound/Pause.

As with Sound/Played, Sound/Resumed and Sound/Stopped only the respective sound function will cause the event to fire. This means that Pause will only fire when Sound/Pause is called.

Parameters

Name	Type	Default	Description
Name soundId	Type string	Default	Summary The `Sound/SoundId` of the `Sound` that was paused.

Code Samples

Sound Functions

This sample gives a simple demonstration of what each of the Sound functions (Sound.Play, Sound.Stop, Sound.Pause and Sound.Resume) do to Sound.Playing and Sound.TimePosition.

			
				Sound Functions

				Expected Output
			
				Expand
				
			-- create a sound
local sound = Instance.new("Sound", game.Workspace)
sound.SoundId = "rbxassetid://301964312"

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

wait(10)

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

wait(3)

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

wait(3)

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

wait(3)

sound:Play()
print("play", sound.Playing, sound.TimePosition) -- play true 0
		
				Copy Code
			
				Light Theme