1.2.7 • Published 9 years ago

cordova-plugin-media-controller v1.2.7

Weekly downloads
8
License
MIT
Repository
github
Last release
9 years ago

cordova-plugin-media-controller

Interactive multimedia controls. Based on https://github.com/homerours/cordova-music-controls-plugin

Platforms

  • Android (4.1+)
  • iOS (under development)
  • Windows (10+)

Installation

cordova plugin add https://github.com/filfat-Studios-AB/cordova-plugin-music-controller
cordova prepare

Methods

Create the media controller:

MusicController.create({
    track: 'Speak Now',				//Requierd
	artist: 'Taylor Swift',			//Required
    cover: 'albums/speak-now.jpg',	//Required
	album: 'Speak Now',				//Optional, Only visible on Android
    isPlaying: true					//Required
}, onSuccess, onError);

Destroy the media controller:

MusicController.destroy(onSuccess, onError);

Subscribe to the media controller events:

function events(action) {
	switch(action){
		case 'music-controller-next':
			//Do something
			break;
		case 'music-controller-previous':
			//Do something
			break;
		case 'music-controller-pause':
			//Do something
			break;
		case 'music-controller-play':
			//Do something
			break;

		//Headset events
		case 'music-controller-headset-unplugged':
			//Do something
			break;
		case 'music-controller-headset-plugged':
			//Do something
			break;
		case 'music-controller-headset-button':
			//Do something
			break;
		default:
			break;
	}
}
//Register callback
MusicController.subscribe(events);

//Start listening for events
MusicController.listen();

Feature detect to avoid crash or errors on unsupported platforms:

document.addEventListener("deviceready", function () {
	if(typeof MusicController !== 'undefined'){
		//It's safe to use MusicController here	
	}
}, function(){}, function(){});

Quirks

  • Cordova 5.0 or higher is required for Windows support.
  • Android is qurrently the only platform that supports the headset events.
  • Windows currently only supports locally stored covers.
  • Windows Mobile requires to have at least one audio player active before showing up.
  • This plugin is still under development which means that it's not yet "production ready".

Screenshots

Android Windows