Events¶

Send an event¶

this.api.events.eventManager.fireEvent('onTrackChange', audio);

Handle an event¶

this.api.events.eventManager.onEvent('onTrackChange', this.handleTrackChange);

Receivable Events¶

Tracks¶

onTrackPlay - Fired when the track is played
onTrackChange - Fired when the track changes (Pause/unpause, seeking, played)

Library¶

onLibraryUpdate - Fired after library is updated (scanned)

Search¶

onSearch- Fired when a search is performed

Lyrics¶

onLyricsRequested - Fired when lyrics are requested (ex. click on lyrics button for a track)

Sendable Events¶

Search¶

addSearchResult - Add a custom search results tab to the search results list (Takes payload of FriendlyTrack)

Lyrics¶

onLyricsLoaded - Add lyrics to the track (Takes payload of Lyrics)

Example Plugin¶

export default class EventsTestPlugin {
 static id = 'com.cleftly.docs.events';
 static name = 'Events Test Plugin';
 static author = 'Cleftly Docs';
 static description = '';
 static version = '1.0.0';
 static api_version = 'v1'; // Must be v1

 api;

 constructor(api) {
  this.api = api;

  this.api.events.eventManager.onEvent('onTrackChange', this.handleTrackChange);
 }

 async handleTrackChange(audio) {
  console.log(
   `Playing track ${audio.track.title} by ${audio.track.artist.name}`
  );
 }
}