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
94 commits 4 branches 12 tags 7.1 MiB
Rust 97.9%
Shell 0.9%
Dockerfile 0.8%
Python 0.4%
Go to file
Paul Lietar f822031ce3 Expose some more metadata.
2016-01-26 22:24:36 +00: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 Expose some more metadata. 2016-01-26 22:24:36 +00:00
.gitignore Add README with build and run instructions. 2015-07-14 23:27:03 +01:00
.travis.yml Make dns-sd opt in rather than opt out. 2016-01-20 13:35:02 +00:00
build.rs Update dependencies 2016-01-13 00:17:05 +00:00
Cargo.lock Ignore files which don’t have an id. 2016-01-20 10:37:57 +00:00
Cargo.toml Make dns-sd opt in rather than opt out. 2016-01-20 13:35:02 +00:00
LICENSE Initial commit. 2015-04-25 21:32:07 +01:00
README.md Update the README to reflect the new build dependencies. 2016-01-20 13:36:58 +00: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 will provide 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.

It also requires a C and C++ toolchain, with libprotoc and portaudio.

On debian / ubuntu, the following command will install these dependencies :

sudo apt-get install build-essential portaudio19-dev libprotoc-dev

On OS X, using homebrew :

brew install portaudio protobuf

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 --appkey APPKEY --username USERNAME --cache CACHEDIR --name DEVICENAME

Discovery mode

librespot can be run in discovery mode, in which case no password is required at startup. dns-sd or avahi's compatibility layer is required for this. On debian/ubuntu this is the libavahi-compat-libdnssd-dev package. It come preinstalled on OS X.

It must be enabled at build time :

cargo build --features discovery

When running librespot simply omit the --username argument.

Facebook Accounts

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.