> For the complete documentation index, see [llms.txt](https://interactiveboard.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://interactiveboard.gitbook.io/docs/objects/static/music-player.md).

# Music Player

{% hint style="warning" %}
&#x20;[**NoteBlockAPI**](https://www.spigotmc.org/resources/noteblockapi.19287/) **is required for Music Player to work.**
{% endhint %}

Music player can play **.nbs** format music files.

```yaml
## object name, you can set this to anything that is unique
obj1:
  ## object type
  type: music_player
  ## .nbs music file to play
  music: 'somemusic.nbs'
  ## the volume of the music
  volume: 100
  ## is the music player paused
  paused: false
```
