cordova-plugin-audiocontroller

Cordova Audio Controller Plugin

Thanks

This plugin is partly inspired by https://github.com/homerours/cordova-music-controls-plugin repository. It is not updated on NPM anymore so I took the liberty to rewrite objective C code and push it with a different name.

Major diffferences

• Removed the listen() method (it is now automatic)
• Fixed a lot of bugs on IOS
• Added a Audio interruption event on IOS
• Removed the updateIsPlaying method and destroy on IOS (for now)

Music controls for Cordova applications. Display a 'media' notification with play/pause, previous, next buttons, allowing the user to control the play. Handle also headset event (plug, unplug, headset button).

Supported platforms

• Android (4.1+)
• iOS 8+

Installation

cordova plugin add https://github.com/bhvr-business-solutions/cordova-plugin-audiocontroller

Methods

• Replace the media controls:

AudioController.setControls({
    	track       : 'Time is Running Out',		// optional, default : ''
    artist      : 'Muse',						// optional, default : ''
    	cover       : 'albums/absolution.jpg',		// optional, default : nothing
    // cover can be a local path (use fullpath 'file:///storage/emulated/...', or only 'my_image.jpg' if my_image.jpg is in the www folder of your app)
    //			 or a remote url ('http://...', 'https://...', 'ftp://...')
    isPlaying   : true,							// optional, default : true
 
    // hide previous/next/close buttons:
    hasPrev   : true,		// show previous button, optional, default: true
    hasNext   : true,		// show next button, optional, default: true
    	album       : 'Absolution',     // optional, default: ''
    
    
    	// iOS only, optional
    album       : 'Absolution',     // optional, default: ''
    duration : 60, // optional, default: 0
    elapsed : 10, // optional, default: 0
  	hasSkipForward : true, //optional, default: false. true value overrides hasNext.
  	hasSkipBackward : true, //optional, default: false. true value overrides hasPrev.
  	skipForwardInterval : 15, //optional. default: 0.
    skipBackwardInterval : 15, //optional. default: 0.
    hasScrubbing : false, //optional. default to false. Enable scrubbing from control center progress bar 
 
    // Android only, optional
    // text displayed in the status bar when the notification (and the ticker) are updated
    ticker	  : 'Now playing "Time is Running Out"',
    //All icons default to their built-in android equivalents
    //The supplied drawable name, e.g. 'media_play', is the name of a drawable found under android/res/drawable* folders
    playIcon: 'media_play',
    pauseIcon: 'media_pause',
    prevIcon: 'media_prev',
    nextIcon: 'media_next',
    closeIcon: 'media_close',
    notificationIcon: 'notification'
    
});

• Subscribe events to the media controller:

// Register callback
AudioController.subscribe(function(eventName) {
    
});

List of media button events

• Default:

'play', 'pause',
'previous', 'next', 'pause', 'play',
'skip-backward', 'skip-forward'

• iOS Only:

'interruption-started', 'interruption-ended', 'seek' (2nd argument available)

• Android Only:

'fast-forward', 'rewind',
'play-pause', 'stop',
'step-backward', 'step-forward',
'meta-left', 'meta-right', 'music',
'volume-up', 'volume-down', 'volume-mute',
'headset-hook'

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Thanks !