The gRPC server runs on port 6061 and serves both native gRPC and gRPC-Web (so browser clients work without a proxy).Documentation Index
Fetch the complete documentation index at: https://rockboxzig.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
- Endpoint —
localhost:6061 - Schema — published on Buf: buf.build/tsiry/rockboxapis ↗
- Buf Studio playground — open ↗
Services
The proto definitions live underproto/ (in
buf.build/tsiry/rockboxapis) and
generate Rust bindings at crates/rpc/:
| Service | Purpose |
|---|---|
PlaybackService | Transport, current/next track, seek, volume |
LibraryService | Albums, artists, tracks, search |
PlaylistService | Live queue + saved playlists |
SettingsService | Read / update global_settings |
SoundService | Volume + sound parameters |
BrowseService | Filesystem browsing |
SystemService | Version, scan, status |
Generating clients
Use Buf to generate clients in any supported language:Quick test with grpcurl
gRPC-Web from the browser
The same port speaks gRPC-Web — useful for browser apps that want a strongly-typed binding without a translating reverse proxy. Use@bufbuild/connect-web
or the language equivalent.