mirror of https://github.com/librespot-org/librespot.git synced 2024-11-08 16:45:43 +00:00

Open Source Spotify client library

Find a file

Yugo Amaryl 5f5356333d Fix build by removing extra parenthesis		2016-03-14 06:00:06 +00:00
cache	Fixes compilation errors	2015-12-18 19:59:10 +00:00
capi	Intern returned C strings to avoid leaking them.	2016-02-05 21:11:55 +00:00
docs	Add Blob based authentication	2016-01-27 10:44:15 +00:00
protocol	Support building with rust stable, using syntex.	2016-03-07 18:22:41 +00:00
src	Fix build by removing extra parenthesis	2016-03-14 06:00:06 +00:00
.gitignore	Add README with build and run instructions.	2015-07-14 23:27:03 +01:00
.travis.yml	Support using tremor instead of libvorbis for audio decoding.	2016-03-13 15:15:15 +00:00
build.rs	Support building with rust stable, using syntex.	2016-03-07 18:22:41 +00:00
Cargo.lock	Save reusable credentials to disk.	2016-03-13 22:35:09 +00:00
Cargo.toml	Resolve access point when connecting and pick a random one.	2016-03-13 20:03:09 +00:00
LICENSE	Initial commit.	2015-04-25 21:32:07 +01:00
README.md	Update README to indicate that rust 1.7.0 is enough.	2016-03-11 13:14:01 +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

Rust 1.7.0 or later is required to build librespot.

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 --release

Usage

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

target/release/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 --release --features discovery

When running librespot simply omit the --username argument.

Development

When developing librespot, it is preferable to use Rust nightly, and build it using the following :

cargo build --no-default-features

This produces better compilation error messages than with the default configuration.

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.