Revoice-ts NPM

Revoice.ts - TypeScript typings for Revoice.js

This is a direct port of Revoice.js

The only feature added is a customArgs argument on the constructor for custom FFMPEG args.

Not all internal typings are done, mostly because i dont know what they are supposed to be.

npm i revoice-ts (cant do .ts because of imports)

Revoice.js - A Voice Module for Revolt

This package is still in developement and lacks many features.

You still are able to play sound to a voice channel. Other features like channel info will follow.

Developement paused because of vortex rewrite

Vortex are the voice servers behind revolt and they are currently being rewritten so adding new features now doesn't make any sense. User stuff, play/pause, audio works but without proper docs. I'm sorry about the docs but they will be updated in the upcoming rewrite of the library after the vortex update.

TODO:

Play/Pause for the media class (help apreciated ;))
Non-voice events like UserJoined and roominfo
Audio reception
Error Handling; Right now, you have to take care of things like stopping the music if you start to play another song while one is playing

Disclamer: I might have forgotten some things on the list and thus it might be extended. Feel free to open issues to suggest new features :)

Installation

Just execute npm install revoice.js to install the package, have fun! :)

Usage

TL;DR: You initiate a client, you join a voice channel and then you play media.

Please note that unlike on Discord bots, Revolt bots are able to join multiple voice channels at once. Thus a single bot is able to be in every voice channel it has access to. I have no idea about the limitations.

Media has to be created using the MediaPlayer class. You can stream both node streams and media files to revolt.

Example:

const { Revoice, MediaPlayer } = require("revoice.js");
const fs = require("fs");

const revoice = new Revoice("the-token-of-your-bot");
const connection = await revoice.join("the-voice-channel-id");
const media = new MediaPlayer();
connection.on("join", () => {
  connection.play(media); // playing audio does only work after the the bot joined the voice channel

  // IMPORTANT: If you want to hear music,
  // you have to call connection.play(media)
  // BEFORE you start playing something in the media player

  media.playFile("./assets/some-nice-song.mp3");
  // or something like the following:
  media.playStream(fs.createReadStream("./assets/some-nice-song.mp3"));

  // you don't have to store the voice connection, you can retrieve it if you have the id of the voice channel like this:
  const con = revoice.getVoiceConnection("someChannelId");

  // ... pause it
  media.pause();

  // ... resume it later
  media.resume();
});

Rejoice for Revoice!

API

Revoice Client

Properties/Methods:

on(event, callback): Equally to EventEmitter.on, for supported events refer to: The Events section
once(event, callback): Equally to EventEmitter.once, refer to on()
join(channelId): Connect to a voice channel; channelId typeof String
getVoiceConnection(channelId): Returns the voice connection to the given channel; Params: channelId typeof String

VoiceConnection

Properties/Methods:

play(media): Stream a MediaPlayer(Or Media) object to the current voice channel
leave(): Leave the voice channel and destroy the connection

Events:

state:
- Data: typeof Revoice.State;
- This event gets fired whenever the current state changes. The possible states are:
  - State.OFFLINE: The bot hasn't joined any channel yet
  - State.IDLE: The bot is in a voice channel but isn't doesn't play anything
  - State.JOINING: The bot is currently in the join process
  - State.PLAYING: The bot is in a voice channel and transmitting sound
  - State.BUFFERING: The bot is in a voice channel and there is a stream with audio buffering
  - State.PAUSED: The bot is in a voice channel and the audio has been paused
  - State.UNKNOWN: The bot is in a voice channel and might be playing something. This occurs when you choose to use the Media class as the Media class just contains some base functionality
join:
- Data: empty
- This events get fired after the bot has successfully established a connection with the voice channel
leave
- Data: empty
- This event gets fired after the bot has left a voice channel

MediaPlayer

Constructor:

new MediaPlayer(logs?, port?):

Creates a new Revoice-compatible media player object with basic sound controls like play/pause
Parameters:
- logs: typeof Boolean; Wether or not output ffmpeg logs in the console; Optional, default: false
- port: typeof int; The port ffmpeg should send the rtp data to; Optional but should be changed if wanting to run multiple instances, defaults to 5030

Properties/Methods:

Inherits from the Media class

getMediaTrack(): Get the MediaStreamTrack used for WebRTC transports
playFile(path): Play the file from the given filePath; Param typeof String
playStream(stream): Play a ReadableStream; Param typeof Readable
pause(): Pause the current playback if playing
resume(): Unpause the current playback if paused (This function is developement but working)
stop(): Completely stop the current playback; This can be used to stop a song to play another
on(event, callback): Equally to EventEmitter.on, for supported events refer to: The Events section
once(event, callback): Equally to EventEmitter.once, refer to on()

Events:

start:
- Data: empty
- This event gets fired when the MusicPlayer starts to process music. This includes buffering and playing
finish:
- Data: empty
- This event gets fired when a music stream finishes to stream. This feature is under developement but working

Media

This class should only be used if you want to implement your own MediaPlayer class.

Constructor:

new Media(logs?, port?):

Creates a new Revoice-compatible media object
Parameters:
- logs: typeof Boolean; Wether or not output ffmpeg logs in the console; Optional, default: false
- port: typeof int; The port ffmpeg should send the rtp data to; Optional, defaults to 5030

Properties/Methods:

getMediaTrack(): Get the MediaStreamTrack used for WebRTC transports
playFile(path): Play the file from the given filePath; Param typeof String
playStream(stream): Play a ReadableStream; Param typeof Readable