> ## Documentation Index
> Fetch the complete documentation index at: https://docs.reskate.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Music
> reskate.music: read and control the music an outside player plays, and the game's own soundtrack.
`reskate.music` reads the song playing and skips it. Every function, and the `track_changed` event, needs the `music` permission; calling one without it raises an error. See [permissions](/plugins/permissions).
There are two kinds of music:
* **An outside player**: Spotify or another app playing on the player's computer, read and controlled through Windows' own media controls (the ones the media keys use). `current`, `play`, `pause`, `next` and `previous` work on it.
* **The game's own soundtrack**, on the player's headphones. `game` and `game_next` work on it. While a Spotify station is on, the outside player's song is the one heard, and the game's soundtrack has no song.
`play`, `pause`, `next`, `previous` and `game_next` share a budget of 2 calls a second.
## An outside player
### `reskate.music.current()`
The song the outside player has now. The first call starts ReSkate listening to it.
`nil` when there is no outside player to read.
The app playing it, by its application id as Windows names it.
The song's title.
Its artist.
Its album.
False while it is paused.
```lua theme={null}
local track = reskate.music.current()
if track and track.playing then
reskate.ui.toast(track.artist .. " - " .. track.title)
end
```
Needs the `music` permission.
### `reskate.music.play()`
Tells the outside player to play.
True when the command was sent. It does not say an app took it.
`"more than 2 a second"` when `ok` is false.
Needs the `music` permission.
### `reskate.music.pause()`
Tells the outside player to pause.
True when the command was sent.
`"more than 2 a second"` when `ok` is false.
Needs the `music` permission.
### `reskate.music.next()`
Tells the outside player to skip to the next song.
True when the command was sent.
`"more than 2 a second"` when `ok` is false.
```lua theme={null}
reskate.input.bind("skip", "Pad.Back+Pad.RB")
reskate.on("action", function(name)
if name == "skip" then reskate.music.next() end
end)
```
Needs the `music` permission (and `input` for the example's bind).
### `reskate.music.previous()`
Tells the outside player to go back a song.
True when the command was sent.
`"more than 2 a second"` when `ok` is false.
Needs the `music` permission.
## The game's soundtrack
### `reskate.music.game()`
The song the game's own soundtrack plays now.
`nil` while a Spotify station is on, or before a song has started.
Always `"skate."`.
The song's title.
Its artist.
Always empty.
Always true.
```lua theme={null}
local song = reskate.music.game()
if song then reskate.log("now playing " .. song.title .. " by " .. song.artist) end
```
Needs the `music` permission.
### `reskate.music.game_next()`
Skips the game's soundtrack to its next song.
True when the song was skipped.
Why not: `"asked more than twice in a second"` or `"the game's music cannot skip now (a Spotify station is on, or no song has started)"`.
Needs the `music` permission. Shares the budget of 2 calls a second with the outside player's commands.
## The `track_changed` event
Fired when anything about the outside player's song changes: another song, or it pauses or plays. ReSkate looks once a second. The game's own soundtrack does not fire it.
```lua theme={null}
reskate.on("track_changed", function(track)
if track.playing then
reskate.ui.toast("Now playing: " .. track.title)
end
end)
```
The app playing it, by its application id as Windows names it.
The song's title.
Its artist.
False while it is paused.
The event's table has no `album`; call `reskate.music.current()` for it. Registering a handler needs the `music` permission. See [events](/plugins/events).
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.