Overview

The BlueParrott SDK provides developer access to the programmable BlueParrott Button™ and other functions of compatible headsets.

Typical uses of the BlueParrott SDK are:

• Push to Talk and Voice Messaging Applications, where recording is triggered by pressing the BlueParrott Button
• Voice Recognition and custom Voice Assistant applications, where the Voice Assistant is triggered by tapping the BlueParrott button
• Other Enterprise Applications, where custom features can be triggered based on one or more button event

Functionality

The SDK provides following functionality:

• BlueParrott Button configuration
• Automatic configuration of the BlueParrott Button for use with an application
• Support for foreground and/or background control within an application
• Access to sensor data
• Headset firmware version
• Headset Configuration

This functionality requires compatible BlueParrott devices.

BlueParrott Button

The BlueParrott Button can be configured for up to five Events:

• Press (for example to start a Push to Talk Call)
• Release (for example to end a Push to Talk Call)
• Single Tap (to invoke a voice recognition or other enterprise application)
• Double Tap
• Long Press

Each of these states is addressable for individual functions within a mobile application. To increase the overall utility of integration, functionality can be either limited to when the application is in the foreground or extended to offer background access as well.

SDK Content

There are two different versions of BlueParrott SDK:

• BlueParrott SDK for Android
• BlueParrott SDK for iOS

The SDK contains (for both Android and iOS):

• SDK Library
• Example test application to show connectivity and connected device BlueParrott Button state
• Notes and documentation.

Only the SDK for Android contains:

• Example test application to additionally show foreground and background processing and utilise audio.

Note: Audio recording and playback are generally not part of the BlueParrott SDK. However, some considerations for audio applications are discussed with reference to the sample application under Advanced Android Integration.

Compatibility

This table shows headset compatibility for the latest version of BlueParrott SDK.

Supported Operating Systems

BlueParrott SDK for Android SDK supports:

• Android (version 4.4 or higher)

Capabilities of the SDK vary depending on the Android version:

• Android 4.4 – SDK supports integration with the BlueParrott B550-XT only
  
• Android 5 and greater – SDK supports integration with all compatible headsets

Downloads