Skip to main content

AudioStation

warning

This API is not documented yet.

Overview​

A class to interact with Synology AudioStation API.

Methods​

get_info​

Retrieve general information about the AudioStation service.

Internal API​

SYNO.AudioStation.Info

Returns​

dict[str, object]
A dictionary containing the service information or a string in case of an error.


get_playlist_info​

Retrieve information about playlists in AudioStation.

Internal API​

SYNO.AudioStation.Playlist

Returns​

dict[str, object]
A dictionary containing playlist information or a string in case of an error.


list_remote_player​

Retrieve a list of remote players available in AudioStation.

Internal API​

SYNO.AudioStation.RemotePlayer

Returns​

dict[str, object]
A dictionary containing information about remote players, or a string in case of an error.


list_pinned_song​

Retrieve a list of pinned songs in AudioStation.

Internal API​

SYNO.AudioStation.Pin

Returns​

dict[str, object]
A dictionary containing information about pinned songs, or a string in case of an error.


device_id​

Retrieve the playlist for a specific remote device in AudioStation.

Internal API​

SYNO.AudioStation.RemotePlayer

Parameters​

device str
The ID of the remote device.

Returns​

dict[str, object]
A dictionary containing the playlist information for the specified device.


remote_play​

Start playback on a specified remote device in AudioStation.

Internal API​

SYNO.AudioStation.RemotePlayer

Parameters​

device str
The ID of the remote device on which to start playback.

Returns​

dict[str, object] or str
A dictionary containing the playback status or a string in case of an error.


remote_stop​

Stop playback on a specified remote device in AudioStation.

Internal API​

SYNO.AudioStation.RemotePlayer

Parameters​

device str
The ID of the remote device on which to stop playback.

Returns​

dict[str, object] or str
A dictionary containing the stop status or a string in case of an error.


remote_next​

Skip to the next track on a specified remote device in AudioStation.

Internal API​

SYNO.AudioStation.RemotePlayer

Parameters​

device str
The ID of the remote device on which to skip to the next track.

Returns​

dict[str, object] or str
A dictionary containing the status of the operation or a string in case of an error.


remote_prev​

Skip to the previous track on a specified remote device in AudioStation.

Internal API​

SYNO.AudioStation.RemotePlayer

Parameters​

device str
The ID of the remote device on which to skip to the previous track.

Returns​

dict[str, object] or str
A dictionary containing the status of the operation or a string in case of an error.