Switch Song

• Alert key: nowplaying-switchSong
• Source: NowPlaying
• Event list label: Switch Song

Default message template

Song switched to {{title}}

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 variable	Overlay payload field	Description
{{id}}	data.extraSettings.id	No description available yet.
{{title}}	data.extraSettings.title	The title of the Twitch Redemption that was redeemed
{{artwork}}	data.extraSettings.artwork	No description available yet.
{{artist}}	data.extraSettings.artist	No description available yet.
{{album}}	data.extraSettings.album	No description available yet.
{{label}}	data.extraSettings.label	No description available yet.
{{bpm}}	data.extraSettings.bpm	No description available yet.
{{rating}}	data.extraSettings.rating	No description available yet.
{{length}}	data.extraSettings.length	Length of time in seconds
{{comment}}	data.extraSettings.comment	No description available yet.
{{key}}	data.extraSettings.key	No description available yet.
{{url}}	data.extraSettings.url	No description available yet.
{{spotify_url}}	data.extraSettings.spotify_url	No description available yet.
{{beatport_url}}	data.extraSettings.beatport_url	No description available yet.
{{beatport_id}}	data.extraSettings.beatport_id	No description available yet.
{{file_key}}	data.extraSettings.file_key	No description available yet.

Example payloads

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

Song changed

{
  "alert": "nowplaying-switchSong",
  "dynamic": {
    "value": "Lumia Dream"
  },
  "extraSettings": {
    "title": "Lumia Dream",
    "artist": "Lumia Stream",
    "url": "https://open.spotify.com/track/3vBn6l5T2AWm4NlqNWE43f",
    "image": "https://lh3.googleusercontent.com/hxcNF4a-5MZqN9HmIyPMlVm6AzQ6CI0MmisFqZTglun4VJ2Ghli4lvyQpJS2oeqjnT8a0S2EAWklTo14=w544-h544-l90-rj",
    "id": "",
    "artwork": "",
    "album": "",
    "label": "",
    "bpm": "",
    "rating": "",
    "length": "",
    "comment": "",
    "key": "",
    "spotify_url": "",
    "beatport_url": "",
    "beatport_id": "",
    "file_key": ""
  }
}

Variation conditions

Dimensions you can branch on when configuring alert variations:

• RANDOM
• EQUAL_STRING - Title is equal to
• EQUAL_VARIABLE

Related

• Alert Explorer - live preview of every alert
• Overlay Type Definitions - full AlertEvent TypeScript type