Connectors

Lavalink plays the audio, but Discord only tells your bot where to connect. A connector does three things:

1. Sends opcode 4 (join/leave voice) to the right shard.
2. Forwards raw gateway events (VOICE_STATE_UPDATE, VOICE_SERVER_UPDATE, GUILD_CREATE, …) to raya.handleRaw().
3. Calls raya.init(botUserId) once Discord is ready.

discord.js

const { Raya, Connectors } = require('raya.js');

const raya = new Raya({
  nodes,
  connector: new Connectors.DiscordJS(client), // before client.login()
});

Eris

const raya = new Raya({
  nodes,
  connector: new Connectors.Eris(client), // before client.connect()
});

Oceanic

const raya = new Raya({
  nodes,
  connector: new Connectors.Oceanic(client), // before client.connect()
});

Any library

const raya = new Raya({
  nodes,
  // Send the opcode 4 payload through the shard that owns the guild
  send: (guildId, payload) => getShardFor(guildId).send(payload),
});

// Forward every raw dispatch packet ({ t, d })
gateway.on('dispatch', (packet) => raya.handleRaw(packet));

// Once logged in
await raya.init(botUserId);

Create the connector before logging in

Raya tracks who is in which voice channel from GUILD_CREATE packets. That powers the empty-channel detection in auto-leave. If the connector attaches after login, those packets are missed.

Writing your own connector

A connector is any object with attach and send. Add getToken to enable voice channel status without passing a token.

import type { Connector, Raya } from 'raya.js';

class MyConnector implements Connector {
  constructor(private client: MyClient) {}

  attach(raya: Raya) {
    this.client.on('raw', (packet) => raya.handleRaw(packet));
    this.client.once('ready', () => raya.init(this.client.user.id));
  }

  send(guildId: string, payload) {
    this.client.shardFor(guildId).send(payload);
  }

  getToken() {
    return this.client.token;
  }
}