Skip to content

A client-side javascript library for full-length playback of Rhapsody media

Notifications You must be signed in to change notification settings

jgolden/rhapsody.js

 
 

Repository files navigation

Rhapsody.js

Getting Started

Include the rhapsody.js source in your application after the dependent jQuery library. Once the source is loaded, the library must be initialized with an application key.

Rhapsody.init({
  consumerKey: 'foo'
});

Initialization Options

Attribute Default Description
consumerKey undefined The application key
version 'v1' API endpoint version
catalog 'EN' The desired catalog locale
player 'player-frame' The html element id where the player iframe will be embedded

Authentication

The Member object exposes a methods for user sessions. Use the Rhapsody.member.set(credentials) to manage sessions. After setting the member session information the player will automatically be reauthenticated.

Rhapsody.member.set({
  accessToken: 'oauth access token',
  refreshToken: 'oauth refresh token'
});

Playback

The Rhapsody object exposes a top-level player object that provides the necessary methods to manage playback.

Playing a track

Rhapsody.player.play('Tra.5156528');

Pausing

Rhapsody.player.pause();

Skipping to the next track

Rhapsody.player.next();

Skipping to the previous track

Rhapsody.player.previous();

Queueing a Track

Rhapsody.player.queue('Tra.5156528');

Clear the Queue

Rhapsody.player.clearQueue();

Shuffle

Rhapsody.player.toggleShuffle();

Repeat

Rhapsody.player.toggleRepeat();

Seek

For example, to seek to 0:10 in a given track:

Rhapsody.player.seek();

Data

The Rhapsody object exposes some API convenience methods. There are methods for HTTP GET, POST, PUT, and DELETE. The first parameter determines if a secure request is made.

Rhapsody.api.get(false, '/tracks/top', function(tracks) {
  Rhapsody.player.play(tracks[0].id);
});

Events

There are a number of interesting playback-related events you can listen for:

  • playevent: Starts, pauses, completes, etc.
  • playtimer: Current time, total time, waveform data
  • error: Bad things
  • metadata
  • queueloaded
  • queuechanged
  • authenticated
  • ready
  • playsessionexpired
  • playstopped

Listening for player events is simple:

Rhapsody.player.on('playevent', function(e) {
  console.log(e.data);
});

Rhapsody.player.on('playtimer', function(e) {
  console.log(e.data);
});

Rhapsody.player.on('error', function(e) {
  console.log(e.data);
});

About

A client-side javascript library for full-length playback of Rhapsody media

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 80.0%
  • HTML 20.0%