github-mirrors/librespot
1
0
Fork 0
mirror of https://github.com/librespot-org/librespot.git synced 2024-09-19 16:08:30 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Open Source Spotify client library
78 commits 4 branches 12 tags 7.1 MiB
Rust 97.9%
Shell 0.9%
Dockerfile 0.8%
Python 0.4%
Go to file
Erik 17a5bb122a Added Volume in a fishy manner by modulating stream, could maybe be optimized.
2016-01-14 13:12:01 +01:00
cache Fixes compilation errors 2015-12-18 19:59:10 +00:00
docs Add some details to zeroconf authentication 2016-01-02 14:49:51 +01:00
protocol Use the protobuf_build crate to simplify build process. 2016-01-13 00:16:02 +00:00
src Added Volume in a fishy manner by modulating stream, could maybe be optimized. 2016-01-14 13:12:01 +01:00
.gitignore Add README with build and run instructions. 2015-07-14 23:27:03 +01:00
.travis.yml travis: Don’t install external version of rust-protobuf anymore 2016-01-13 00:17:05 +00:00
build.rs Update dependencies 2016-01-13 00:17:05 +00:00
Cargo.lock Update dependencies 2016-01-13 00:17:05 +00:00
Cargo.toml Update dependencies 2016-01-13 00:17:05 +00:00
LICENSE Initial commit. 2015-04-25 21:32:07 +01:00
README.md change binary name 2016-01-03 22:50:41 +01:00

README.md

librespot

librespot is an open source client library for Spotify. It enables applications to use Spotify's service, without using the official but closed-source libspotify. Additionally, it provides extra features which are not available in the official library.

Status

librespot is currently under development and is not fully functional yet. You are however welcome to experiment with it.

Building

Building librespot requires rust nightly. It will not work on rust stable or beta.

You will also need the protobuf compiler, and the rust-protobuf plugin. protoc-gen-rust must be in your $PATH.

Also required is an installation of portaudio, which can be installed via brew install portaudio for an OS X machine.

Once you've cloned this repository you can build librespot using cargo.

cargo build

Usage

A sample program implementing a headless Spotify Connect receiver is provided. Once you've built librespot, run it using :

target/debug/librespot -a APPKEY -u USERNAME -c CACHEDIR -n DEVICENAME

where APPKEY is the path to a Spotify application key file, USERNAME is your Spotify username, CACHEDIR is the path to directory where data will be cached, and DEVICENAME is the name that will appear in the Spotify Connect menu.

Troubleshooting

If you connect using a facebook account, librespot will not show up among the devices in the Spotify app. What you need to do is apply for a device password and use that to sign in instead.

Disclaimer

Using this code to connect to Spotify's API is probably forbidden by them, and might result in you application key getting banned. Use at you own risk

Contact

Come and hang out on gitter if you need help or want to offer some. https://gitter.im/sashahilton00/spotify-connect-resources

License

Everything in this repository is licensed under the MIT license.