koice v0.2.4

Before using this package, you confirm you understand by using this package, you are violating

• Section 3.2.3 or 3.2.5 of the KOOK Software Permission and Service Agreement, and
• Section Data Information, or Abusive Use, of the KOOK Developer Privacy Policy

Your KOOK account could face penalty including, but not limited to,

• restriction to the access of developer tools and resources
• suspension of user account

Use this package at your own risk. No warranties are provided.

import Koice from 'koice';

You must have ffmpeg in your PATH, or you can specify one

const client = new Koice('Your KOOK bot token');
// const client = new Koice('Your KOOK bot token', '/path/to/your/ffmpeg/binary');

Connect to WebSocket and retrive RTP URL.

client.connectWebSocket("8403799012661514");

Start streaming with path to a file or a stream.Readable;

import * as fs from 'fs';
const stream = fs.createReadStream('/path/to/music/file');
await client.startStream(stream);

or

await client.startStream('/path/to/music/file');

You can also start a ZeroMQ server to be able to stream different files without disconnecting. You can do that by invoking Koice.startServer() first, then start streaming.

await client.startServer();
await client.startStream('/path/to/music/file');

And you can also close the ZeroMQ server without stopping the stream, to switch voice channel without streaming again.

import * as fs from 'fs';

const stream = fs.createReadStream('/path/to/music/file');

client.connectWebSocket("8591468140337193");
await client.startServer();

await client.startStream(stream);

await delay(1000);

await client.closeServer();
await client.disconnectWebSocket();

client.connectWebSocket("1586400722913705");
await client.startServer();

You can refer to kook-arisa for usage of this package in real world application.

© 2022-2023 Hexona, Koice.js and kook-arisa, released under the MIT license.