Class PlayerPlugin<EventMap>Abstract

Abstract base class for Player plugins Plugins can extend the player functionality and add custom events

Example

class MyPlugin extends PlayerPlugin<{
  customEvent: [data: string];
}> {
  readonly name = "my-plugin";

  init(player: Player) {
    player.on("trackStart", () => {
      this.emit("customEvent", "track started");
    });
  }

  // Example of a toJSON method, assuming it's meant to be part of the plugin class
  // and not inside the player.on callback.
  // The instruction "Improving toJSON return type" suggests this method might exist elsewhere
  // or is being added.
  toJSON(): Record<string, unknown> {
    return {
      name: this.name,
      // ... other plugin properties
    };
  }
}
Copy