HeadsetDetection-PhoneGap-Plugin

by Eddy Verbruggen / @eddyverbruggen

Description
Installation 2. Automatically (CLI / Plugman) 2. Manually 2. PhoneGap Build
Usage
Credits
License

1. Description

Detect a wired or wireless (Bluetooth) headset, connected to you phone.

Works on Android, probably every version you'd care about.
Works on iOS 6+

2. Installation

Automatically (CLI / Plugman)

HeadsetDetection is compatible with Cordova Plugman and the PhoneGap and Cordova CLI:

PhoneGap CLI:

$ phonegap local plugin add https://github.com/uxder/HeadsetDetection-PhoneGap-Plugin.git

Cordova CLI:

$ cordova plugin add https://github.com/uxder/HeadsetDetection-PhoneGap-Plugin.git
$ cordova prepare

Manually

1. Add the following xml to your config.xml in the root directory of your www folder:

<!-- for iOS -->
<feature name="HeadsetDetection">
  <param name="ios-package" value="HeadsetDetection" />
</feature>

<!-- for Android -->
<feature name="HeadsetDetection">
  <param name="android-package" value="nl.xservices.plugins.HeadsetDetection" />
</feature>

2. Grab a copy of HeadsetDetection.js, add it to your project and reference it in index.html:

<script type="text/javascript" src="js/HeadsetDetection.js"></script>

3. Download the source files for iOS and/or Android and copy them to your project.

iOS: Copy HeadsetDetection.h and HeadsetDetection.m to platforms/ios/<ProjectName>/Plugins

Android: Copy HeadsetDetection.java to platforms/android/src/nl/xservices/plugins (create the folders)

4. For most Android devices you need to add a permission to AndroidManifest.xml:

<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS"/>

PhoneGap Build

HeadsetDetection will soon work with PhoneGap build too (submitted for review on April 8th 2014). Just add the following xml to your config.xml to always use the latest version of this plugin:

<gap:plugin name="nl.x-services.plugins.headsetdetection" />

The required javascript file is brought in automatically. There is no need to change or add anything in your html.

3. Usage

<button onclick="window.plugins.headsetdetection.detect(function(detected) {alert(detected)})">headphone detected?</button>

The successCallback (first argument) is a boolean (true or false). Couldn't be easier :)

4. CREDITS

This plugin was created by and enhanced for Plugman / PhoneGap Build by Eddy Verbruggen.

5. License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

uxder / HeadsetDetection-PhoneGap-Plugin