isServerRunning

Gets the boolean value if the server is running or not

isServerRunning
Returns
Promise<string>: true = running

serverStatus

Gets the status object of the server

serverStatus
Returns
Promise<object>: server status object {running:boolean, message:string}

serverTime

Gets the time from the server

serverTime
Returns
Promise<string>: time as string

letters

Gets unique array of all first letters of stations

letters
Returns
Promise<array>: first letters of all stations

hasLetter

Determines if any stations starts with a certain letter

hasLetter
Parameters
letter (string) letter to test
Returns
Promise<boolean>: if a station begins with the given letter

genres

Get all genres available

genres
Returns
Promise<array>: all genres

genresRaw

Gets raw object of all genres

genresRaw
Returns
Promise<array>: array of genre objects {name:string, score:number, related: [string,...] }

genre

Gets raw genres objects related to another genre

genre
Parameters
genre (string) an existing genre
Returns
Promise<array>: array of raw related genres objects {name:string, score:number, related: [string, ...] }

stationNames

Gets all station names

stationNames
Returns
Promise<array>: all station names

hasStation

Indicates if a station exists

hasStation
Parameters
station (string) station to test
Returns
Promise<boolean>: if station tested exists

allListeners

Gets total number of listeners

allListeners
Returns
Promise<number>: number of current listeners

listeners

Gets listeners for a particular station

listeners
Parameters
station (string) station to get listeners for
Returns
Promise<number>: number of listeners for station

liveStationsRaw

Get raw objects of all stations broadcasting live

liveStationsRaw
Returns
Promise<array>: array of station objects broadcasting live

liveStations

Get names of all stations broadcasting live

liveStations
Returns
Promise<array>: all stations broadcasting live

stationIsLive

Determine if a station is currently broadcasting live

stationIsLive
Parameters
station (string) station to test
Returns
Promise<boolean>: if station is broadcasting live

numLiveStations

Indicate how many stations are broadcasting live

numLiveStations
Returns
Promise<number>: number of stations broadcasting live

allStations

Gets all Stations

allStations
Parameters
options (object = {}) {limit:number, offset:number, lat:number, long:number}
Returns
Promise<array>: an array of station objects

stationStartsWith

Get stations beginning with a certain letter or number

stationStartsWith
Parameters
startw ((string | number)) station starts with
options (object = {}) {limit:number, offset:number, lat:number, long:number}
Returns
Promise<array>: array of station objects

stations

Gets information for specific stations

stations
Parameters
stations (array) array of station names
options (object = {}) {lat:number, long:number}
Returns
Promise<array>: array of station objects

stationsByGenre

Get all stations of a particular genre

stationsByGenre
Parameters
genre (string) genre to search for
options (object = {}) {limit:number, offset:number, lat:number, long:number}
Returns
Promise<array>: array of station objects

Search (?-mix:\A\/station\/([\w\d_-]+)\/images\/([\w\d_-]+)\Z)

Song Change JSON Stream /song_change.stream.json

Song Change WebSocket /song_change.ws.json

Song Change Chunks (last 50) /song_change.chunk.json {Song, ...}

Teaser /teaser [{headline: String, schedule:[], link:String, img_l: String, img_m: String, img_s: String}, ...]

Station

Class representing a specific station

new Station(station: any)
Parameters
station (any)
Instance Members
info()
currentSong()
lastSong()
schedule()
playlists()
listeners()
nextArtists()
genresC(count)
imagesSize(type, size)
name
displayName
pageUrl
streamUrl
format
description
djs
location
latLong
color
updatedAt
genres
active
skillName
invocationName
facebook
twitterUrl
twitterName
website
phonostarUrl
radiodeUrl
images
currentPlaylist
nextPlaylist
topArtists
position