Skip to content
Quentin Rousseau edited this page Feb 16, 2015 · 2 revisions

Audio Station API

The AudioStation API is an AuthenticatedAPI, that means the user needs to be authenticated before using this API. Fortunately, the AuthenticatedAPI is smart enough to automatically log the user.

The syno object uses the as (or audioStation alias) property to interact with the AudioStation API.

SYNO.AudioStation.Info

Description

Provide Audio Station information.

Methods

Method Name Description Required params
getAudioStationInfo(callback) Provide Audio Station information -

SYNO.AudioStation.Album

Description

Provide Audio Station Albums methods.

Methods

Method Name Description Required params
listAlbums(params, callback) List albums -

SYNO.AudioStation.Composer

Description

Provide Audio Station Composers methods.

Methods

Method Name Description Required params
listComposers(params, callback) List composers -

SYNO.AudioStation.Genre

Description

Provide Audio Station songs Genres methods.

Methods

Method Name Description Required params
listGenres(params, callback) List genres -

SYNO.AudioStation.Artist

Description

Provide Audio Station songs Artist methods.

Methods

Method Name Description Required params
listArtists(params, callback) List artists -

SYNO.AudioStation.Folder

Description

Provide Audio Station Folders methods.

Methods

Method Name Description Required params
listFolders(params, callback) List folders -
getFolderInfo(params, callback) Get information of a folder id

SYNO.AudioStation.Song

Description

Provide Audio Station songs methods.

Methods

Method Name Description Required params
listSongs(params, callback) List songs -
getSongInfo(params, callback) Get information of a song id
searchSong(params, callback) Search a song -

SYNO.AudioStation.Radio

Description

Provide Audio Station radios methods.

Methods

Method Name Description Required params
listRadios(params, callback) List radios -

TODO: Missing Methods to implements

Method Name Description Required params
addRadio(params, callback) Add a radio ?
updateRadio(params, callback) Update a radio ?

SYNO.AudioStation.Playlist

Description

Provide Audio Station playlists methods.

Methods

Method Name Description Required params
listPlaylists(params, callback) List playlists -
getPlaylistInfo(params, callback) Get information of a playlist id

TODO: Missing Methods to implements

Method Name Description Required params
createPlaylist(params, callback) Create a playlist ?
deletePlaylist(params, callback) Delete a playlist ?
renamePlaylist(params, callback) Rename a playlist ?
copyToLibraryPlaylist(params, callback) ? ?
updateSongsPlaylist(params, callback) ? ?
createSmartPlaylist(params, callback) ? ?
updateSmartPlaylist(params, callback) ? ?

SYNO.AudioStation.RemotePlayer

Description

Provide Audio Station remote players methods.

Methods

Method Name Description Required params
listRemotePlayers(params, callback) List remote players -

TODO: Missing Methods to implements

Method Name Description Required params
getRemotePlayerStatus(params, callback) Get a remote player status ?
getRemotePlayerPlaylist(params, callback) ? ?
updateRemotePlayerPlaylist(params, callback) ? ?
controlRemotePlayer(params, callback) ? ?
testRemotePlayerPassword(params, callback) ? ?
setRemotePlayerPassword(params, callback) ? ?

SYNO.AudioStation.Proxy

Description

Provide Audio Station proxy methods.

TODO: Missing Methods to implements

Method Name Description Required params
getStreamIdProxy(params, callback) ? ?
getStreamProxy(params, callback) ? ?
getSongInfoProxy(params, callback) ? ?
deleteSongInfoProxy(params, callback) ? ?

SYNO.AudioStation.Lyrics

Description

Provide Audio Station lyrics methods.

TODO: Missing Methods to implements

Method Name Description Required params
getLyrics(params, callback) ? ?
setLyrics(params, callback) ? ?

SYNO.AudioStation.LyricsSearch

Description

Provide Audio Station lyrics search methods.

TODO: Missing Methods to implements

Method Name Description Required params
searchLyrics(params, callback) ? ?

SYNO.AudioStation.MediaServer

Description

Provide Audio Station media servers methods.

Methods

Method Name Description Required params
listMediaServers(params, callback) List media servers -

SYNO.AudioStation.Cover

Description

Provide Audio Station covers methods.

TODO: Missing Methods to implements

Method Name Description Required params
getSongCover(params, callback) ? ?
getFolderCover(params, callback) ? ?
getCover(params, callback) ? ?

SYNO.AudioStation.Stream

Description

Provide Audio Station streams methods.

TODO: Missing Methods to implements

Method Name Description Required params
stream(params, callback) ? ?
transcode(params, callback) ? ?