rocksky - v1.0.0

rocksky/song

app.rocksky.song.* — fetch and create song records.

Types

NewSong

</>

Builder for a createSong payload. Build one with new_song(...) and pipe it through with_* setters, then create to get a Request.

pub type NewSong {
  NewSong(
    title: String,
    artist: String,
    album_artist: String,
    album: String,
    duration: option.Option(Int),
    mb_id: option.Option(String),
    isrc: option.Option(String),
    album_art: option.Option(String),
    track_number: option.Option(Int),
    release_date: option.Option(String),
    year: option.Option(Int),
    disc_number: option.Option(Int),
    lyrics: option.Option(String),
  )
}

Constructors

Values

create

</> 
pub fn create(s: NewSong) -> rocksky.Request(types.Song)

Convert a NewSong into a Request(Song) ready for rocksky.send.

get_song

</> 
pub fn get_song(uri uri: String) -> rocksky.Request(types.Song)

app.rocksky.song.getSong — fetch a song by AT-URI. Combine with with_mbid, with_isrc, or with_spotify_id instead of (or in addition to) the URI; the server matches on any provided field.

get_song_by_isrc

</> 
pub fn get_song_by_isrc(
  isrc isrc: String,
) -> rocksky.Request(types.Song)

Variant of get_song keyed by ISRC.

get_song_by_mbid

</> 
pub fn get_song_by_mbid(
  mbid mbid: String,
) -> rocksky.Request(types.Song)

Variant of get_song keyed by MusicBrainz ID instead of URI.

get_song_by_spotify_id

</> 
pub fn get_song_by_spotify_id(
  spotify_id spotify_id: String,
) -> rocksky.Request(types.Song)

Variant of get_song keyed by Spotify track ID.

get_song_recent_listeners

</> 
pub fn get_song_recent_listeners(
  uri uri: String,
) -> rocksky.Request(List(types.Listener))

app.rocksky.song.getSongRecentListeners — recent listeners of a song.

get_songs

</> 
pub fn get_songs() -> rocksky.Request(List(types.Song))

app.rocksky.song.getSongs — paginated songs catalogue. Refine with rocksky.limit, rocksky.offset, rocksky.genre, with_mbid, with_isrc, with_spotify_id.

match_song

</> 
pub fn match_song(
  title title: String,
  artist artist: String,
) -> rocksky.Request(types.Song)

app.rocksky.song.matchSong — find an existing song record matching the given metadata.

new_song

</> 
pub fn new_song(
  title title: String,
  artist artist: String,
  album_artist album_artist: String,
  album album: String,
) -> NewSong

song_with_album_art

</> 
pub fn song_with_album_art(s: NewSong, v: String) -> NewSong

song_with_disc_number

</> 
pub fn song_with_disc_number(s: NewSong, v: Int) -> NewSong

song_with_duration_ms

</> 
pub fn song_with_duration_ms(s: NewSong, v: Int) -> NewSong

song_with_isrc

</> 
pub fn song_with_isrc(s: NewSong, v: String) -> NewSong

song_with_lyrics

</> 
pub fn song_with_lyrics(s: NewSong, v: String) -> NewSong

song_with_mb_id

</> 
pub fn song_with_mb_id(s: NewSong, v: String) -> NewSong

song_with_release_date

</> 
pub fn song_with_release_date(s: NewSong, v: String) -> NewSong

song_with_track_number

</> 
pub fn song_with_track_number(s: NewSong, v: Int) -> NewSong

song_with_year

</> 
pub fn song_with_year(s: NewSong, v: Int) -> NewSong

with_isrc

</> 
pub fn with_isrc(
  req: rocksky.Request(a),
  isrc: String,
) -> rocksky.Request(a)

with_mbid

</> 
pub fn with_mbid(
  req: rocksky.Request(a),
  mbid: String,
) -> rocksky.Request(a)

with_spotify_id

</> 
pub fn with_spotify_id(
  req: rocksky.Request(a),
  id: String,
) -> rocksky.Request(a)
✨ Search Document