Struct MusicPlayerServer

pub struct MusicPlayerServer { /* private fields */ }

Implementations

impl MusicPlayerServer

pub fn new( db: Arc<Surreal<Db>>, settings: Arc<Settings>, audio_kernel: Arc<AudioKernelSender>, event_publisher: Arc<RwLock<Sender<Message>>>, terminator: Terminator, ) -> Self

pub async fn publish( &self, message: impl Into<Message> + Send + Sync + Debug, ) -> Result<(), UdpError>

Publish a message to all listeners.

Errors

Returns an error if the message could not be sent or encoded.

Trait Implementations

impl Clone for MusicPlayerServer

fn clone(&self) -> MusicPlayerServer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MusicPlayerServer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl MusicPlayer for MusicPlayerServer

async fn library_rescan( self, context: Context, ) -> Result<(), SerializableLibraryError>

Rescans the music library, only error is if a rescan is already in progress.

async fn library_rescan_in_progress(self, context: Context) -> bool

Check if a rescan is in progress.

async fn library_analyze( self, context: Context, overwrite: bool, ) -> Result<(), SerializableLibraryError>

Analyze the music library, only error is if an analysis is already in progress.

async fn library_analyze_in_progress(self, context: Context) -> bool

Check if an analysis is in progress.

async fn library_recluster( self, context: Context, ) -> Result<(), SerializableLibraryError>

Recluster the music library, only error is if a recluster is already in progress.

async fn library_recluster_in_progress(self, context: Context) -> bool

Check if a recluster is in progress.

async fn library_brief( self, context: Context, ) -> Result<LibraryBrief, SerializableLibraryError>

Returns brief information about the music library.

async fn library_full( self, context: Context, ) -> Result<LibraryFull, SerializableLibraryError>

Returns full information about the music library. (all songs, artists, albums, etc.)

async fn library_artists_brief( self, context: Context, ) -> Result<Box<[ArtistBrief]>, SerializableLibraryError>

Returns brief information about the music library’s artists.

async fn library_artists_full( self, context: Context, ) -> Result<Box<[Artist]>, SerializableLibraryError>

Returns full information about the music library’s artists.

async fn library_albums_brief( self, context: Context, ) -> Result<Box<[AlbumBrief]>, SerializableLibraryError>

Returns brief information about the music library’s albums.

async fn library_albums_full( self, context: Context, ) -> Result<Box<[Album]>, SerializableLibraryError>

Returns full information about the music library’s albums.

async fn library_songs_brief( self, context: Context, ) -> Result<Box<[SongBrief]>, SerializableLibraryError>

Returns brief information about the music library’s songs.

async fn library_songs_full( self, context: Context, ) -> Result<Box<[Song]>, SerializableLibraryError>

Returns full information about the music library’s songs.

async fn library_health( self, context: Context, ) -> Result<LibraryHealth, SerializableLibraryError>

Returns information about the health of the music library (are there any missing files, etc.)

async fn library_song_get(self, context: Context, id: SongId) -> Option<Song>

Get a song by its ID.

async fn library_song_get_by_path( self, context: Context, path: PathBuf, ) -> Option<Song>

Get a song by its file path.

async fn library_song_get_artist( self, context: Context, id: SongId, ) -> OneOrMany<Artist>

Get the artists of a song.

async fn library_song_get_album( self, context: Context, id: SongId, ) -> Option<Album>

Get the album of a song.

async fn library_song_get_playlists( self, context: Context, id: SongId, ) -> Box<[Playlist]>

Get the Playlists a song is in.

async fn library_song_get_collections( self, context: Context, id: SongId, ) -> Box<[Collection]>

Get the Collections a song is in.

async fn library_album_get(self, context: Context, id: AlbumId) -> Option<Album>

Get an album by its ID.

async fn library_album_get_artist( self, context: Context, id: AlbumId, ) -> OneOrMany<Artist>

Get the artists of an album

async fn library_album_get_songs( self, context: Context, id: AlbumId, ) -> Option<Box<[Song]>>

Get the songs of an album

async fn library_artist_get( self, context: Context, id: ArtistId, ) -> Option<Artist>

Get an artist by its ID.

async fn library_artist_get_songs( self, context: Context, id: ArtistId, ) -> Option<Box<[Song]>>

Get the songs of an artist

async fn library_artist_get_albums( self, context: Context, id: ArtistId, ) -> Option<Box<[Album]>>

Get the albums of an artist

async fn daemon_shutdown(self, context: Context)

tells the daemon to shutdown.

async fn state_audio(self, context: Context) -> Option<StateAudio>

returns full information about the current state of the audio player (queue, current song, etc.)

async fn current_artist(self, context: Context) -> OneOrMany<Artist>

returns the current artist.

async fn current_album(self, context: Context) -> Option<Album>

returns the current album.

async fn current_song(self, context: Context) -> Option<Song>

returns the current song.

async fn rand_artist(self, context: Context) -> Option<Artist>

returns a random artist.

async fn rand_album(self, context: Context) -> Option<Album>

returns a random album.

async fn rand_song(self, context: Context) -> Option<Song>

returns a random song.

async fn search( self, context: Context, query: String, limit: u32, ) -> SearchResult

returns a list of artists, albums, and songs matching the given search query.

async fn search_artist( self, context: Context, query: String, limit: u32, ) -> Box<[Artist]>

returns a list of artists matching the given search query.

async fn search_album( self, context: Context, query: String, limit: u32, ) -> Box<[Album]>

returns a list of albums matching the given search query.

async fn search_song( self, context: Context, query: String, limit: u32, ) -> Box<[Song]>

returns a list of songs matching the given search query.

async fn playback_toggle(self, context: Context)

toggles playback (play/pause).

async fn playback_play(self, context: Context)

start playback (unpause).

async fn playback_pause(self, context: Context)

pause playback.

async fn playback_stop(self, context: Context)

stop playback.

async fn playback_restart(self, context: Context)

restart the current song.

async fn playback_skip_forward(self, context: Context, amount: usize)

skip forward by the given amount of songs

async fn playback_skip_backward(self, context: Context, amount: usize)

go backwards by the given amount of songs.

async fn playback_clear_player(self, context: Context)

stop playback. (clears the queue and stops playback)

async fn playback_clear(self, context: Context)

clear the queue.

async fn playback_seek( self, context: Context, seek: SeekType, duration: Duration, )

seek forwards, backwards, or to an absolute second in the current song.

async fn playback_repeat(self, context: Context, mode: RepeatMode)

set the repeat mode.

async fn playback_shuffle(self, context: Context)

Shuffle the current queue, then start playing from the 1st Song in the queue.

async fn playback_volume(self, context: Context, volume: f32)

set the volume to the given value The value 1.0 is the “normal” volume (unfiltered input). Any value other than 1.0 will multiply each sample by this value.

async fn playback_volume_up(self, context: Context, amount: f32)

increase the volume by the given amount

async fn playback_volume_down(self, context: Context, amount: f32)

decrease the volume by the given amount

async fn playback_volume_toggle_mute(self, context: Context)

toggle the volume mute.

async fn playback_mute(self, context: Context)

mute the volume.

async fn playback_unmute(self, context: Context)

unmute the volume.

async fn queue_add( self, context: Context, thing: RecordId, ) -> Result<(), SerializableLibraryError>

add a song to the queue. (if the queue is empty, it will start playing the song.)

async fn queue_add_list( self, context: Context, list: Vec<RecordId>, ) -> Result<(), SerializableLibraryError>

add a list of things to the queue. (if the queue is empty, it will start playing the first thing in the list.)

async fn queue_set_index(self, context: Context, index: usize)

set the current song to a queue index. if the index is out of bounds, it will be clamped to the nearest valid index.

async fn queue_remove_range(self, context: Context, range: Range<usize>)

remove a range of songs from the queue. if the range is out of bounds, it will be clamped to the nearest valid range.

async fn playlist_list(self, context: Context) -> Box<[PlaylistBrief]>

Returns brief information about the users playlists.

async fn playlist_get_or_create( self, context: Context, name: String, ) -> Result<PlaylistId, SerializableLibraryError>

create a new playlist. if a playlist with the same name already exists, this will return that playlist’s id in the error variant

async fn playlist_remove( self, context: Context, id: PlaylistId, ) -> Result<(), SerializableLibraryError>

remove a playlist.

async fn playlist_clone( self, context: Context, id: PlaylistId, ) -> Result<PlaylistId, SerializableLibraryError>

clone a playlist. (creates a new playlist with the same name (append “ (copy)“) and contents as the given playlist.) returns the id of the new playlist

async fn playlist_get_id( self, context: Context, name: String, ) -> Option<PlaylistId>

get the id of a playlist. returns none if the playlist does not exist.

async fn playlist_remove_songs( self, context: Context, playlist: PlaylistId, songs: Vec<SongId>, ) -> Result<(), SerializableLibraryError>

remove a list of songs from a playlist. if the songs are not in the playlist, this will do nothing.

async fn playlist_add( self, context: Context, playlist: PlaylistId, thing: RecordId, ) -> Result<(), SerializableLibraryError>

Add a thing to a playlist. If the thing is something that has songs (an album, artist, etc.), it will add all the songs.

async fn playlist_add_list( self, context: Context, playlist: PlaylistId, list: Vec<RecordId>, ) -> Result<(), SerializableLibraryError>

Add a list of things to a playlist. If the things are something that have songs (an album, artist, etc.), it will add all the songs.

async fn playlist_get( self, context: Context, id: PlaylistId, ) -> Option<Playlist>

Get a playlist by its ID.

async fn playlist_get_songs( self, context: Context, id: PlaylistId, ) -> Option<Box<[Song]>>

Get the songs of a playlist

async fn playlist_rename( self, context: Context, id: PlaylistId, name: String, ) -> Result<Playlist, SerializableLibraryError>

Rename a playlist.

async fn playlist_export( self, context: Context, id: PlaylistId, path: PathBuf, ) -> Result<(), SerializableLibraryError>

Export a playlist to a .m3u file

async fn playlist_import( self, context: Context, path: PathBuf, name: Option<String>, ) -> Result<PlaylistId, SerializableLibraryError>

Import a playlist from a .m3u file

async fn collection_list(self, context: Context) -> Box<[CollectionBrief]>

Collections: Return brief information about the users auto curration collections.

async fn collection_get( self, context: Context, id: CollectionId, ) -> Option<Collection>

Collections: get a collection by its ID.

async fn collection_freeze( self, context: Context, id: CollectionId, name: String, ) -> Result<PlaylistId, SerializableLibraryError>

Collections: freeze a collection (convert it to a playlist).

async fn collection_get_songs( self, context: Context, id: CollectionId, ) -> Option<Box<[Song]>>

Get the songs of a collection

async fn radio_get_similar( self, context: Context, things: Vec<RecordId>, n: u32, ) -> Result<Box<[Song]>, SerializableLibraryError>

Radio: get the n most similar songs to the given things.

async fn radio_get_similar_ids( self, context: Context, things: Vec<RecordId>, n: u32, ) -> Result<Box<[SongId]>, SerializableLibraryError>

Radio: get the ids of the n most similar songs to the given things.

async fn dynamic_playlist_create( self, context: Context, name: String, query: Query, ) -> Result<DynamicPlaylistId, SerializableLibraryError>

Dynamic Playlists: create a new DP with the given name and query

async fn dynamic_playlist_list(self, context: Context) -> Box<[DynamicPlaylist]>

Dynamic Playlists: list all DPs

async fn dynamic_playlist_update( self, context: Context, id: DynamicPlaylistId, changes: DynamicPlaylistChangeSet, ) -> Result<DynamicPlaylist, SerializableLibraryError>

Dynamic Playlists: update a DP

async fn dynamic_playlist_remove( self, context: Context, id: DynamicPlaylistId, ) -> Result<(), SerializableLibraryError>

Dynamic Playlists: remove a DP

async fn dynamic_playlist_get( self, context: Context, id: DynamicPlaylistId, ) -> Option<DynamicPlaylist>

Dynamic Playlists: get a DP by its ID

async fn dynamic_playlist_get_songs( self, context: Context, id: DynamicPlaylistId, ) -> Option<Box<[Song]>>

Dynamic Playlists: get the songs of a DP

async fn dynamic_playlist_export( self, context: Context, path: PathBuf, ) -> Result<(), SerializableLibraryError>

Dynamic Playlists: export dynamic playlists to a csv file

async fn dynamic_playlist_import( self, context: Context, path: PathBuf, ) -> Result<Vec<DynamicPlaylist>, SerializableLibraryError>

Dynamic Playlists: import dynamic playlists from a csv file

async fn register_listener(self, context: Context, listener_addr: SocketAddr)

Register a UDP listener with the daemon.

async fn ping(self, _: Context) -> String

fn serve(self) -> ServeMusicPlayer<Self>

Returns a serving function to use with InFlightRequest::execute.