Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iteam1337/wejay-node
https://github.com/iteam1337/wejay-node
Last synced: about 8 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/iteam1337/wejay-node
- Owner: Iteam1337
- Created: 2014-01-15T20:17:03.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2017-03-03T20:57:39.000Z (over 7 years ago)
- Last Synced: 2024-04-14T11:04:24.873Z (7 months ago)
- Language: JavaScript
- Size: 39.1 KB
- Stars: 0
- Watchers: 18
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
About
=====
Wejay is a music app for Spotify, this is the API documentation. Read more about Wejay here:
http://wejay.org or here http://github.com/iteam1337/Wejay
## Build status:
Install and connect:
====================
Include client lib from this url: [/socket.io/socket.io.js](). Connect with default settings:
```javascript
var socket = io.connect(apiUrl);
```
Basic usage:
============
## Join room:
When joining a room you will receive an updated room object containing the latest info including current playing song. The current playing song also contains a position marker which you can use to skip inside the song to
```javascript
socket.emit('join', {roomName: 'foo', user: {id: facebookId, ... }}, function(room){
scope.room = room;
if (room.currentSong){
song.player.play(room.currentSong);
}
});
```
## Add song to room:
Make sure you have first joined the room before calling this method so the server has information about the room and your user info.
```javascript
socket.emit('addSong', {spotifyId: '1337', user: {id: facebookId, ... }});
```
When you add a song, all connected clients will receive a new queue (see below) and if no songs was previously playing you will receive a
nextSong event directly.
## Skip to the next song
To skip to the next song in the queue you must send the song id of the current song to prevent two users skipping the same song twice, in that case the second request will be discarded.
```javascript
socket.emit('skip', {spotifyId: '1337'});
```
When you skip a song, all connected users will receive two events: 'queue' and 'nextSong'
## Receive updates
Once you have joined a room you will start receiving updates when songs are added or removed from the queue:
```javascript
socket.on('queue', function(queue){
scope.room.queue = queue;
})
```
When someone joins the room:
```javascript
socket.on('userJoined', function(users){
scope.room.users = users;
})
```
When a new song is being played:
```javascript
socket.on('nextSong', function(song){
player.play(song.spotifyId);
})
```
Models
======
## Room
roomName : String,
users : [User],
userSongs : {}, // dictionary with all user queued songs
currentSong : Song,
history : [Song], // last 50 songs played in this room
queue : [Song] // a merged list of all queued songs
## Song
spotifyId : *String,
started : Date,
position : Milliseconds,
user : User, // the user that added the song
...
## User
id : *String,
lastJoinDate : Date,
lastPlayDate : Date,
\* Required