music.d.js

0.0.5 • Public • Published

#music.d.js A music library for discord.js Now we can flood the discord community with amazing music bots! Its just that easy!

#Do Not Download! Still In Development

###Example

const Player = require('music.d.js')

let options = {
    scKey: "1234567",
    ytKey: "7654321",
    autoPlay: true
}

let player = Player(options)

voiceChannel.join().then(connection => {
  
   player.addConnection(connection, message)
  
}

####options

Value Default Description
scKey false The SoundCloud API Key, if no key is provided, soundcloud functionality is disabled
ytKey false The YouTube API Key, if no key is provided, youtube playlist and search is disabled
autoPlay true When enabled, will start playing music on queue without having to run play()

####Song Object returned from queue(song url) and nextSong event

Value Description
title The song title
owner The song uploader
stream Streaming url ignore
url The songs url
duration The song duration in MS
regionsAllowed Array of regions allowed, true if no restrictions
requester The provided requester info in queue() or false if not provided

####Playlist Object return from queue(playlist url)

Value Description
title The playlist title
owner The playlist uploader
tracks An array of Song Objects

##Player ####.setup({options}) setup the music player

returns Promise<Options>

Player.setup(options)
.then(options => {
    //The options set
})
.catch(err => {
    //Invalid api keys or options were simply incorrect
})

####.addConnection(connection, message) Add a voiceConnection

returns GuildPlayer Class of id, else returns false on error

voiceChannel.join().then(connection => {
    let GuildPlayer = Player.addConnection(connection, message)
})
//connection: The VoiceChannel connection object
//message: The standard d.js Message Object

####.get(id) Get a GuildPlayer by ID if it exists

returns GuildPlayer Class of id, else returns false

let GuildPlayer = Player.get('12345678899')

After Player#get you can use the following functions with the returned object:

##GuildPlayer ####.queue(url [, requester) Queue a song, playlist, or search query Optional requester argument, Unecessary for normal function, But if given, will be returned in the nextSong event If autoplay is true then this will trigger music to start playing if it isnt already

returns Promise<Song Object/Arra>

GuildPlayer.queue('http://youtube.com/yoyoma2', requester).then(song => {
    //Song Object
}.catch(err => //something went wrong)

Readme

Keywords

Package Sidebar

Install

npm i music.d.js

Weekly Downloads

1

Version

0.0.5

License

MIT

Last publish

Collaborators

  • funnbot