rockbox.core — org.clojars.tsiry/rockbox-clj 0.1.2-SNAPSHOT

Idiomatic Clojure SDK for Rockbox.

Quick start

(require '[rockbox.core :as rb]
         '[rockbox.playback :as pb]
         '[rockbox.library  :as lib])

(def client (rb/client))

;; Optional: open the WebSocket for real-time events
(rb/connect client)
(rb/on client :track-changed
  (fn [t] (println "▶" (:title t) "—" (:artist t))))

;; Look at what's playing
(when-let [t (pb/current-track client)]
  (println (:title t)))

;; Pipe-friendly: actions return the client so they compose
(-> client
    (pb/pause)
    (pb/seek 90000)
    (pb/resume))

Module map

Domain	Namespace
Transport controls	rockbox.playback
Library / search	rockbox.library
Live queue	rockbox.playlist
Saved playlists	rockbox.saved-playlists
Smart playlists	rockbox.smart-playlists
Volume	rockbox.sound
Settings	rockbox.settings
System info	rockbox.system
Filesystem browser	rockbox.browse
Output devices	rockbox.devices
Bluetooth (Linux)	rockbox.bluetooth
Real-time events	rockbox.events
Plugin system	rockbox.plugin
Enums and helpers	rockbox.types

channel clj

See rockbox.events/channel.

client clj

(client)

(client {:keys [host port http-url ws-url timeout-ms headers http-client]})

Build a Rockbox client.

Options (all optional):

:host hostname or IP of rockboxd (default "localhost") :port GraphQL HTTP/WS port (default 6062) :http-url full HTTP URL override (overrides host/port) :ws-url full WebSocket URL override (overrides host/port) :timeout-ms request timeout in milliseconds (default 15000) :headers map of extra HTTP headers :http-client java.net.http.HttpClient instance to reuse

The returned value is a plain map — passable to all rockbox.* functions as their first argument so calls compose with ->.

(def c (rb/client))
(def c (rb/client {:host "music.home" :port 6062}))
(def c (rb/client {:http-url "https://music.home/graphql"}))

connect clj

(connect client)

Open the WebSocket and start the three default subscriptions (track / status / playlist). Idempotent. Returns the client.

default-host clj

default-port clj

default-timeout-ms clj

disconnect clj

(disconnect client)

Close the WebSocket connection. Returns the client.

installed-plugins clj

(installed-plugins client)

List installed plugins.

off clj

See rockbox.events/off.

off-all clj

See rockbox.events/off-all.

on clj

See rockbox.events/on.

once clj

See rockbox.events/once.

query clj

(query client gql)

(query client gql vars)

Execute a raw GraphQL query/mutation. Returns the kebabized data map. Use this for operations not yet covered by the SDK.

(rb/query client "query { rockboxVersion }")
;=> {:rockbox-version "1.0.0"}

(rb/query client
          "query Album($id: String!) { album(id: $id) { id title } }"
          {:id "abc-123"})

unuse-plugin clj

(unuse-plugin client plugin-name)

Uninstall a plugin by name. Returns the client.

use-plugin clj

(use-plugin client plugin)

Install a plugin. See rockbox.plugin. Returns the client.

with-headers clj

(with-headers c h)

Merge extra headers into c. Pipe-friendly.

with-host clj

(with-host c h)

Return c with :host set to h (and URLs rebuilt). Pipe-friendly.

with-http-url clj

(with-http-url c url)

with-port clj

(with-port c p)

with-timeout clj

(with-timeout c ms)

Return c with :timeout-ms set. Pipe-friendly.

with-ws-url clj

(with-ws-url c url)