Git Product home page Git Product logo

cordova-spotify's Introduction

Cordova Spotify SDK Plugin

Greenkeeper badge Travis

An Apache Cordova plugin providing access to the Spotify SDK for iOS and Android.

API documentation

Features

This plugin provides a very simple and atomic layer over playback functionality of the Spotify SDK. It allows you to play Spotify tracks via their URI. Metadata and authentication functionality has deliberately been left out in favor of the Web API and our Spotify OAuth 2 plugin cordova-spotify-oauth.

Installation

cordova plugin add cordova-spotify

Note: Make sure your installation path doesn't contain any spaces.

Examples

The plugin is very simple to use. All methods can be called at any time and there is no initialization step. The plugin performs all necessary state changes automatically. All methods documented in the API documentation are exported under the global cordova.plugins.spotify-object.

Play some good music

cordova.plugins.spotify.play("spotify:track:0It6VJoMAare1zdV2wxqZq", { 
  clientId: "<YOUR SPOTIFY CLIENT ID",
  token: "<YOUR VALID SPOTIFY ACCESS TOKEN WITH STREAMING SCOPE>"
})
  .then(() => console.log("Music is playing 🎶"));

React to user pressing pause button

cordova.plugins.spotify.pause()
  .then(() => console.log("Music is paused ⏸"));

Display current playing position

cordova.plugins.spotify.getPosition()
  .then(pos => console.log(`We're currently ${pos}ms into the track.`))
  .catch(() => console.log("Whoops, no track is playing right now."));

React to events from native SKDs

cordova.plugins.spotify.getEventEmitter()
  .then(emitter => emitter.on('playbackevent', eventName => {
    switch (eventName) {
      case 'PlaybackNotifyPlay':
        console.log("Playback was started");
         break;
      case 'PlaybackNotifyPause':
        console.log("Playback was paused");
        break;
      default:
        console.log("Some other event was raised:", eventName);
        break;
    }
  }))

Contributing

Pull requests are very welcome! Please use the gitmoji style for commit messages.

cordova-spotify's People

Contributors

greenkeeper[bot] avatar leolabs avatar mraerino avatar neolegends avatar psamsotha avatar shi11 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.