Skip to main content

Song Paused

  • Alert key: youtubemusic-songPaused
  • Source: YouTube Music
  • Event list label: Song Paused

Default message template​

Song {{name}} paused

Template variables​

Use any of these in alert text, TTS, or chat templates. The same names appear under data.extraSettings.* when you subscribe via Overlay.on('alert').

Template variableOverlay payload fieldDescription
{{youtubemusic_now_playing_song}}data.extraSettings.youtubemusic_now_playing_song(Youtube Music) the current song playing
{{youtubemusic_now_playing_image}}data.extraSettings.youtubemusic_now_playing_image(Youtube Music) the url for the album art work of the current song playing
{{youtubemusic_now_playing_id}}data.extraSettings.youtubemusic_now_playing_id(Youtube Music) the id of the current song playing
{{youtubemusic_now_playing_artist}}data.extraSettings.youtubemusic_now_playing_artist(Youtube Music) the artists of the current song playing
{{youtubemusic_now_playing_url}}data.extraSettings.youtubemusic_now_playing_url(Youtube Music) the full URL of the current song playing
{{youtubemusic_next_song}}data.extraSettings.youtubemusic_next_song(Youtube Music) the next song in queue
{{youtubemusic_next_image}}data.extraSettings.youtubemusic_next_image(Youtube Music) the url for the album art work of the next song in queue
{{youtubemusic_next_artist}}data.extraSettings.youtubemusic_next_artist(Youtube Music) the artists of the next song in queue
{{youtubemusic_next_id}}data.extraSettings.youtubemusic_next_id(Youtube Music) the id of the next song in queue
{{youtubemusic_next_url}}data.extraSettings.youtubemusic_next_url(Youtube Music) the full URL of the next song in queue
{{youtubemusic_queue}}data.extraSettings.youtubemusic_queue(Youtube Music) the current queue separated by commas

Example payloads​

Each scenario below mirrors what Lumia emits in Overlay.on('alert', (data) => …).

Song paused​

{
  "alert": "youtubemusic-songPaused",
  "dynamic": {
    "value": "Lumia Dream"
  },
  "extraSettings": {
    "name": "Lumia Dream",
    "url": "https://music.youtube.com/watch?v=M8xO9hyYC4U",
    "image": "https://lh3.googleusercontent.com/hxcNF4a-5MZqN9HmIyPMlVm6AzQ6CI0MmisFqZTglun4VJ2Ghli4lvyQpJS2oeqjnT8a0S2EAWklTo14=w544-h544-l90-rj",
    "youtubemusic_now_playing_song": "",
    "youtubemusic_now_playing_image": "",
    "youtubemusic_now_playing_id": "",
    "youtubemusic_now_playing_artist": "",
    "youtubemusic_now_playing_url": "",
    "youtubemusic_next_song": "",
    "youtubemusic_next_image": "",
    "youtubemusic_next_artist": "",
    "youtubemusic_next_id": "",
    "youtubemusic_next_url": "",
    "youtubemusic_queue": ""
  }
}

Variation conditions​

Dimensions you can branch on when configuring alert variations:

  • RANDOM
  • EQUAL_STRING - Name is equal to
  • EQUAL_VARIABLE