Docs: Jabra SDK for macOS 1.8.8
Revision History
| Docs Revision | Date | Description |
|---|---|---|
| 5.2 | 2021-02-18 | Updated interfaces, features and device list |
| 5.1 | 2020-03-31 | Updated API list and supported devices list. |
| 5.0 | 2019-11-08 | Update API list. |
| 4.9 | 2019-10-07 | Updated supported device list. |
| 4.8 | 2019-09-27 | Added new APIs. Updated supported device list. |
| 4.7 | 2019-08-16 | Modified for Mac OS X |
| 4.6 | 2019-07-12 | Deprecated GetSerialNumber and GetWarrantyEndDate API's |
| 4.5 | 2019-05-24 | Updated library interfaces for firmware update API's |
| 4.4 | 2018-11-15 | Updated library interfaces |
| 4.3 | 2018-09-27 | Removed load and save settings interfaces |
| 4.2 | 2018-09-25 | Updated library interfaces - Removed lock references |
| 4.1 | 2018-04-12 | Updated library interfaces |
| 4.0 | 2017-12-12 | Updated library interfaces |
| 3.0 | 2017-11-10 | Updated features of dongle & child separation and Firmware Updater download from cloud. |
| 2.0 | 2017-08-24 | Updated features for Save & Load Setting, Logging and Firmware Updater. |
| 1.0 | 2017-05-09 | Initial Draft |
Introduction
Jabra SDK V2 is a dynamic library (dylib), provides interfaces to perform below functionalities in Jabra devices:
- Device Settings: Allows the user to view and change settings of the attached Jabra devices
- Remote Call control (RCC): Allows user to perform remote call control functionalities
- Get and set HID reports to and from the attached Jabra device
- Acquire and release device call locks
- Answer and End
- Mute and Unmute Call
- Ring indication
- Hold and Resume Call
- Manual Audio
- Get device serial number, battery status if supported by the device
- Button configuration (button takeover and remote MMI)
- Child device support with Link360, Link370
- Busy light indication
- Concurrency support for multiple applications of SDK
- Co-existence with Jabra Direct Online
- Device events logging
- Device firmware update
The SDK is built as a C++ dynamic library with C interfaces.
Abbreviations and Acronyms
| Acronym | Description |
|---|---|
| API | Application Programming Interface |
| DYLIB | Dynamic Linked Library |
| HID | Human Interface Device |
| SDK | Software Development Kit |
| IDE | Integrated Development Environment |
| USB | Universal Serial Bus |
| HTTP | Hypertext Transfer Protocol |
| JSON | JavaScript Object Notation |
| WPF | Windows Presentation Foundation |
| RCC | Remote Call Control |
| MMI | Man Machine Interface |
| FWU | Firmware Updater |
| RMMI | Remote Man Machine Interface |
SDK Installation
SDK Mac release package would consist of the following directories:
- Demo - Demo application and it's source code
- Library - static and dynamic libraries required for development and header files
- Doc - user guide and release notes
- Wrapper - Objective-C Wrapper framework and documentation
- readme text file
The directories contain following assets:
| Assets | Description |
|---|---|
| readme.txt | Provides information on Jabra SDK V2 |
| Doc/SDK User Guide.html | User Guide and API documentation |
| Doc/ReleaseNotes.txt | Release information and supported devices list |
| Library/libjabra.dylib | Jabra SDK dynamic library for platform (x86 and x64) |
| Library/libjabra.a | Static library for platform (x86 and x64) |
| Library/Headers/JabraNativeHid.h | Header file defining the RCC APIs |
| Library/Headers/JabraDeviceConfig.h | Header file defining the dynamic setting APIs |
| Library/Headers/Common.h | Header file defining the common interfaces used across Jabra SDK V2 |
| library/headers/Interface_*.h | Header file(s) containing interfaces related to a specific feature. |
| Library/Headers/returncodes.inc | Include file defining the Return codes |
| Library/Headers/errorcodes.inc | Include file defining the Error codes |
| Demo/Jabra SDK Demo | Demo application |
| Demo/Source | Demo application source code |
| Wrapper/JabraSDK.framework | Objective-C Wrapper framework for Mac |
| Wrapper/Documentation/Docs/index.html | Jazzy generated Wrapper API documentation |
Supported Jabra Devices
The following Jabra devices are supported by the SDK:
- AudioCodes HRS 457
- DELL PRO STEREO HEADSET UC150
- DELL PRO STEREO HEADSET UC350
- HP UC Wired Headset V2
- Jabra BIZ 1100 Mono
- Jabra BIZ 1100 Stereo
- Jabra BIZ 1500 USB Duo
- Jabra BIZ 1500 USB Mono
- Jabra BIZ 2300 USB Duo
- Jabra BIZ 2300 USB Mono
- Jabra BIZ 2400
- Jabra BIZ 2400 II CC USB Mono MS
- Jabra BIZ 2400 II CC USB Mono UC
- Jabra BIZ 2400 II CC USB Stereo
- Jabra BIZ 2400 II USB BT Duo MS
- Jabra BIZ 2400 II USB BT Duo UC
- Jabra BIZ 2400 II USB BT Mono MS
- Jabra BIZ 2400 II USB BT Mono UC
- Jabra BIZ 2400 USB MS Duo
- Jabra BIZ 2400 USB Mono
- Jabra BIZ 2400 USB UC Duo
- Jabra DIAL 550
- Jabra Engage 50 Mono
- Jabra Engage 50 Stereo
- Jabra Engage 65 Convertible
- Jabra Engage 65 Mono
- Jabra Engage 65 Stereo
- Jabra Engage 75 Convertible
- Jabra Engage 75 Mono
- Jabra Engage 75 Stereo
- Jabra Evolve 20 Mono
- Jabra Evolve 20 Stereo
- Jabra Evolve 20SE Mono
- Jabra Evolve 20SE Stereo
- Jabra Evolve 30 II Mono
- Jabra Evolve 30 II Stereo
- Jabra Evolve 30 Mono
- Jabra Evolve 30 Stereo
- Jabra Evolve 40/80
- Jabra Evolve 65 Mono
- Jabra Evolve 65 Stereo
- Jabra Evolve 65e
- Jabra Evolve 65t
- Jabra Evolve 65t Cradle
- Jabra Evolve 75
- Jabra Evolve 75e
- Jabra Evolve2 30 Mono MS
- Jabra Evolve2 30 Mono UC
- Jabra Evolve2 30 Stereo MS
- Jabra Evolve2 30 Stereo UC
- Jabra Evolve2 40 Mono MS
- Jabra Evolve2 40 Mono UC
- Jabra Evolve2 40 Stereo MS
- Jabra Evolve2 40 Stereo UC
- Jabra Evolve2 65 Deskstand
- Jabra Evolve2 65 Mono MS
- Jabra Evolve2 65 Mono UC
- Jabra Evolve2 65 Stereo MS
- Jabra Evolve2 65 Stereo UC
- Jabra Evolve2 85 Deskstand
- Jabra Evolve2 85 MS
- Jabra Evolve2 85 UC
- Jabra Handset 450
- Jabra LINK 230
- Jabra LINK 260
- Jabra LINK 265
- Jabra LINK 280
- Jabra LINK 30
- Jabra LINK 32
- Jabra LINK 33
- Jabra LINK 360
- Jabra LINK 370
- Jabra LINK 370 Teams
- Jabra LINK 380a
- Jabra LINK 380a MS
- Jabra LINK 380c
- Jabra LINK 380c MS
- Jabra LINK 43
- Jabra LINK 44
- Jabra LINK 850
- Jabra LINK 860
- Jabra LINK 950
- Jabra MOTION UC
- Jabra Motion Office
- Jabra Pro 920
- Jabra Pro 925 Dual Connectivity
- Jabra Pro 925 Single Connectivity
- Jabra Pro 930
- Jabra Pro 935
- Jabra Pro 935 Single Connectivity
- Jabra Pro 9450
- Jabra Pro 9460
- Jabra Pro 9465/9470
- Jabra SPEAK 410
- Jabra SPEAK 450 Cisco
- Jabra SPEAK 510
- Jabra SPEAK 710 MS
- Jabra SPEAK 710 Teams
- Jabra SPEAK 710 UC
- Jabra SPEAK 750 Teams
- Jabra SPEAK 750 UC
- Jabra SPEAK 810
- Jabra STEALTH UC
- Jabra SUPREME
- Jabra SUPREME UC
- Jabra Stealth
- Jabra UC VOICE 150a Duo
- Jabra UC VOICE 150a Duo MS
- Jabra UC VOICE 150a Mono
- Jabra UC VOICE 150a Mono MS
- Jabra UC VOICE 250
- Jabra UC VOICE 250 MS
- Jabra UC VOICE 250a
- Jabra UC VOICE 250a MS
- Jabra UC VOICE 550a BT
- Jabra UC VOICE 550a BT Mono
- Jabra UC VOICE 550a Duo
- Jabra UC VOICE 550a Duo MS
- Jabra UC VOICE 550a Mono
- Jabra UC VOICE 550a Mono MS
- Jabra UC VOICE 750 Mono USB
- Jabra UC VOICE 750 Mono USB MS
- Jabra UC VOICE 750 USB
- Jabra UC VOICE 750a Duo
- Jabra UC VOICE 750a Duo MS
- Jabra UC VOICE 750a Mono
- Jabra UC VOICE 750a Mono MS
- Lenovo Pro Wired Stereo VoIP Headset
- Mitel Evolve 75
- Mitel S720
- NXT Technologies HUB
- NXT Technologies UC-2000 Stereo Headset
- NXT Technologies UC-4000 Mono Headset
- NXT Technologies UC-4000 No Headset
- NXT Technologies UC-4000 Stereo Headset
- NXT Technologies UC-5100
- NXT Technologies UC-7000 Stereo Professional Headset
- NXT Technologies UC-7500 Mono
- NXT Technologies UC-7500 Stereo
- USB2 Jabra Engage 75
Prerequisites
The prerequisites for the SDK are:
- Curl libraries
Developing application Using Jabra SDK V2
System requirements
- Mac OS X : 10.14.x (Applications can be deployed from 10.12.x to 10.15.x and 11.01/11.02)
- Xcode : 10.3/11
- Network (Internet) connection