Skip to content

LyricsFoundEvent

The LyricsFoundEvent is sent by the server to the client after a lyrics search (via the REST API or player subscription) is successful.


FieldTypeDescription
opstringAlways event
typestringAlways LyricsFoundEvent
guildIdstringThe Discord guild ID
lyricsobjectThe lyrics data object
FieldTypeDescription
sourceNamestringThe name of the lyrics source (e.g., “Genius”, “Musixmatch”)
providerstring (optional)The provider of the lyrics
textstring (optional)The full plaintext lyrics
linesarray (optional)An array of Lyrics Line objects
FieldTypeDescription
timestampnumberStart time of the line in milliseconds
durationnumber (optional)Duration of the line in milliseconds
linestringThe text content of the line

{
"op": "event",
"type": "LyricsFoundEvent",
"guildId": "1234567890",
"lyrics": {
"sourceName": "Musixmatch",
"synced": true,
"lines": [
{ "timestamp": 0, "duration": 3000, "line": "Hello from the other side" },
{ "timestamp": 3500, "duration": 2500, "line": "I must have called a thousand times" }
]
}
}