Module qilletni.api

Package dev.qilletni.api.music

Interface MusicTypeConverter

public interface MusicTypeConverter

Converts music types from one service provider to another. Often times, a conversion is not possible. Examples of this include a playlist that is only available on Spotify, or an album that is only available on Last.fm. The most important example of this is typically converting a track from one service provider to another, to allow, for instance, playing tracks from Last.Fm on Spotify.

Multiple types may be given to each method, one for every service provider that the type is available on currently. There will always be at least one in the list, so List.getFirst() may be used.

Method Summary

Modifier and Type	Method	Description
Optional<Album>	convertAlbum(List<Album> albums)	Converts an album from one service provider to another.
Optional<Artist>	convertArtist(List<Artist> artists)	Converts an artist from one service provider to another.
Optional<Playlist>	convertPlaylist(List<Playlist> playlists)	Converts a playlist from one service provider to another.
Optional<Track>	convertTrack(List<Track> tracks)	Converts a track from one service provider to another.
Optional<User>	convertUser(List<User> users)	Converts a user from one service provider to another.

Method Details

convertTrack

Optional<Track> convertTrack(List<Track> tracks)

Converts a track from one service provider to another. The same track from other service providers is the `tracks` parameter.

Parameters:

tracks - The tracks to convert. These originate from other service providers

Returns:

The created track in the current service provider's implementation

convertAlbum

Optional<Album> convertAlbum(List<Album> albums)

Converts an album from one service provider to another.

Parameters:

albums - The albums to convert

Returns:

The created album in the current service provider's implementation

convertArtist

Optional<Artist> convertArtist(List<Artist> artists)

Converts an artist from one service provider to another.

Parameters:

artists - The artists to convert

Returns:

The created artist in the current service provider's implementation

convertPlaylist

Optional<Playlist> convertPlaylist(List<Playlist> playlists)

Converts a playlist from one service provider to another.

Parameters:

playlists - The playlists to convert

Returns:

The created playlist in the current service provider's implementation

convertUser

Optional<User> convertUser(List<User> users)

Converts a user from one service provider to another.

Parameters:

users - The users converting from

Returns:

The created user in the current service provider's implementation