API for the Music Player
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
src
.gitignore
.npmignore
Gruntfile.coffee
README.md
package.json

README.md


music player api

Music Player for Reddit API

Node.js wrapper around the API for the Music Player for Reddit.

An authentication token is required which you can get after logging in and clicking generate token.

Installation

npm install musicplayer

Usage

var MusicPlayerAPI = require('musicplayer')("YOUR_TOKEN");

MusicPlayerAPI.user.get(function(result) {
  if (result.status == false) return console.error(result.message);

  var user = result.data;
  console.log("I am logged in as " + user.name);
})

Play

  • get : Get the state of the player, true for playing
MusicPlayerAPI.play.get(function(result) {
  if (result.status == false) return console.error(result.message);
  console.log(result.data);
})
  • post : Toggles the state of the player
MusicPlayerAPI.play.post(function(result) {
  if (result.status == false) return console.error(result.message);
  console.log(result.success);
})

Forward

  • post : Skips to the next playable song
MusicPlayerAPI.forward.post();

Backward

  • post : Rewinds back to the previous playable song
MusicPlayerAPI.backward.post();

User

  • get : Gets the information from the logged in user
MusicPlayerAPI.user.get(function(result) {
  if (result.status == false) return console.error(result.message);

  var user = result.data;
  console.log("I am logged in as " + user.name);
})

Subreddits

  • get : Gets a list of subreddits
MusicPlayerAPI.subreddits.get(function(result) {
    if (result.status == false) return console.error(result.message);
    console.log(result.data);
})
  • post : Posts a list of subreddits
  • Arguments: {subreddits: "sub1+sub2"}
MusicPlayerAPI.subreddits.post({
    subreddits: "listentothis+music"
  }, function(result) {
    if (result.status == false) return console.error(result.message);
    console.log(result.subreddits);
})

Song

  • get : Gets information about the current song
MusicPlayerAPI.song.get(function(result) {
  if (result.status == false) return console.error(result.message);

  var song = result.data;
  console.log("Current song title is " + song.title);
})

CLI

This module also contains a link to musicplayer-cli. Just in case someone installs the wrong module.