Purpose:
The purpose of this glossary is to identify and clarify terms that Jabra SDK users need to be familiar with. It aims to provide a common understanding and a consistent domain terminology.
| Term | Definition | Description |
|---|---|---|
| AcceptCall | The same signal that StartCall uses. This sets HookSwitch (true). | - |
| Action | A triggerable event which causes a transition from one state to another in the headset. | - |
| Analytics | The analysis of large data sets to detect patterns and thereby extra meaning from those data-sets. | - |
| Answer call | The action of accepting an incoming call. | Answering a call should start the call, therefore setting the state to OffHook. |
| API | Application Programming Interface. | https://en.wikipedia.org/wiki/API |
| API Reference | Documentation listing all function calls, data types, and data structures contained in an API. | Typically sorted alphabetically or by class. |
| Base station/ Charging stand/ Base/ Base stand/ Desk stand/ Cradle | Base stand (Engage 75), Base (Engage 65), Charging stand (Evolve 75, Evolve2 65). Function: holding the device (storage), charging the device, radio link (DECT), it can provide call control, it might have a display, some models can function as a "call bridging device". Some can route audio between attached devices. You can connect multiple DECT headsets to the same base stand and use them simultaneously. | - |
| Call Control (CC) | Ability to control the flow of audio and video conversations using physical interactions with Jabra devices. This can also be known as Remote Call Control. | Industry term, not defined by usb.org. |
| Call lock | A mechanism for ensuring only one softphone gets access to a device for call control-related purposes. | The Call lock has to be acquired prior to executing any call-control features (e.g. starting the ringer) and released after completing a call. Acquiring the call lock should always be the first step in performing call control operations. The lock is needed because it should be impossible for two different calls to use the same device simultaneously. |
| Click | An action performed by a user. | "Click" is only used when describing the action a user has to perform on a computer screen using a pointing device (for example a mouse). |
| Code sample | A short and simple program or code snippet that shows how to access a specific feature or implement a specific action / flow. | How a developer can implement a feature in their code by using the example provided. |
| Customer journey | A sequence of steps that takes the customer from A to B. | - |
| DECT | Digital Enhanced Cordless Telecommunications | https://en.wikipedia.org/wiki/Digital_enhanced_cordless_telecommunications |
| Demo program | A program to showcase the use, application, and value of a specific feature. | The program should exemplify either generic usage of a functionality, or special uses of the functionality. |
| Deployment | The act of putting something into active use. | You can deploy headsets, you can deploy software solutions. |
| Developer guide | A document, often in from of a narrative, that gives an overview and a path through developing a piece of software, using a specific library. | - |
| Device management | Performing a number of monitoring, controlling and maintenance activities on a Jabra device. | This includes (but is not necessarily limited to): enumerating and connecting to a device, reading device information, monitoring and/or changing the device state, updating the device firmware, etc. |
| Device settings | A list of options that change the way a device works (e.g. changing the preferred audio protection method). | The settings for each device are defined in the Manifest. |
| Digital functions | Functionality of Jabra devices that are realized by digital means. (including hardware and software). | - |
| Dongle/ USB adapter/ BT adapter | A USB device that allows a computer to connect to a wireless headset. A dongle can pair to multiple devices, but can only connect to one device at a time. | - |
| Electronic Hook Switch (EHS) | Electronic Hook Switch. | Physical device that lifts the receiver of a desk phone. |
| EndCall | Action. Alias for changing the state of a device to OnHook. (OffHook=false). | Starting with SDK3, StartCall is used as an alias for setting the device's state to OffHook, and EndCall as an alias for setting the state to OnHook. |
| End-user | The person who uses a device. | - |
| Event | An occurrence of something, specifically with a time-stamp. | Event is something happening at a specific time, you get a notification of an event, you don't get the event. |
| Firmware update | This is the action of replacing the firmware on the device. Typically this is the replacement of the firmware with a newer version, for example an upgrade which adds more functionality. In some circumstances an update can also replace the firmware with an older version. | - |
| Firmware upgrade | This is the action of replacing the firmware on the device with a version with more functionality. | - |
| Flash | Incoming signal from a device. Generates a momentary OnHook condition. Used for alternate line selection during hold/resume. | Flash is a legacy term from analogue phones. Using flash will swap the active call and call on hold. The softphone needs to swap the calls, the device does not do anything. |
| Hang-up | Ending an active call. Synonym of EndCall. | - |
| HID | Human Interface Device. | A type of device that takes input from or provides output to humans. The term also refers to a protocol for communicating between hosts and devices. |
| Hold/ Resume call | Action. Pause the current call (put it on hold). If one or more other calls were previously on hold, the next one in line becomes active. | Like off/on hook, the hold(on/off) action only affects the device's state and not the actual sound processing or streaming, which needs to be handled by the softphone. |
| HookSwitch | Indicates whether the handset is OnHook or Offhook. | HookSwitch is a single bit where 1 is OffHook as defined by https://usb.org/ (See section 14.3 Call Control in the HID Usage Tables available at that site). |
| JSP | Jabra Solution Partner | - |
| Long-press | An action performed by a user. | Long-pressing a button means that you hold down the button for a 'longer time' to activate a feature (as opposed to just pressing the button once). |
| Manifest | Information describing the capabilities and settings of a device. | Client applications such as Jabra Direct use the Jabra library to access the contents of the manifest in order to dynamically show device-specific information and settings. The manifest is retrieved from a user-supplied source such as Jabra cloud services when it is needed (for example, when the presence of a specific device is detected). |
| Message | A piece of data transmitted from one execution thread to another. No timing is normally embedded. | A message has some sort of meaning, it should not be empty. |
| Mouseover | An action performed by a user. | A computer function in which an image or hyperlink can be generated by moving a cursor over a specific point (i.e. an element) on a web page. |
| Mute | Incoming signal from a device or a command from the softphone. Indicates that the state of the microphone on a device has toggled (either from unmuted to muted or vice versa). | The device will always change state to mute, despite the softphone not reacting to this. There is a software mute and a physical (hard) mute. You cannot unmute a hard mute via software commands. |
| OffHook | State. The device is active, it is ready for call control interactions other than Offhook. | The term comes from the physical act of answering a desk phone by lifting up the headset, which sets off the devices' hook. |
| OnHook | State. The device is on standby, ready to initiate a call or accept an incoming call. | Answering a call should start the call, therefore changing the state to OffHook. Hanging up is the process of ending a call, which sets the state to OnHook. |
| Preferred softphone | A feature in Jabra Direct where the user can choose a default softphone that will get headset signals with priority. | If JD is not installed (and therefore no preferred softphone is set), all softphones will get notified of the button event. If the device has a call lock by another softphone, that softphone gets priority over the preferred softphone. |
| Press | An action performed by a user. | You press a button on a device e.g. the volume up button. |
| Readme file | Small file local to a distribution unit (archive) that explain what the archive is, and any important (danger) information. Generally spans minor releases. Not to be confused with release notes, which mainly explain differences from previous release. | Important information that a user should be aware of. |
| RejectCall | Signal from the headset that the user intends not to accept a call (which is indicated by the device ringer). | - |
| Release note | A document accompanying a specific release, containing information about that release compared to previous releases. It can also provide the reason for the release and a perspective on whether developers should be interested in the release. Items covered: Bug fixes, new features, new device compatibilities, major (breaking) changes etc. | - |
| Release package | A downloadable installer (or archive) of a software product. | - |
| Release process | The process that leads to a new release or update of a package (see Release package). | - |
| Remote Call Control (RCC) | Remote Call Control is an alias for Call Control. | - |
| Ring | Action. You tell the device to ring, i.e. the softphone tells the device to ring. | - |
| Ringer | a feature on the device that can signal an incoming call to the user. | - |
| Ringing | Ringing is a state which indicates that the device is receiving an incoming call. | The softphone puts the device into ringing state via the ring action. When a device is in the ringing state it typically emits a sound/light to draw the attention to the user that an incoming call is present. The user can accept or reject the call by interacting with the device or softphone GUI. |
| RTE | Run-Time Environment. | This term covers run-time layers, frameworks, or even virtual machines that let applications be implemented in non-native formats and programming languages. |
| Runtime library configuration | A set of configuration parameters that alter the initialization of the SDK (e.g. optional flag for using WebHID). | The usage of the SDK can be altered by providing some of these optional configuration parameters. This can range from providing a custom logging function, to changing the underlying system that the SDK uses to communicate with devices (for example using a browser extension, a native console application or WebHID). The configuration parameters are optionally provided by the SDK client when calling the SDK init() function. |
| Scroll | An action performed by a user. | Scrolling is sliding text, images or video across a monitor or display, vertically or horizontally. |
| SDK | Software Development Kit. | - |
| Signal | A means of sending a notification that an event has occurred. | - |
| Softphone | A software program for making telephone calls over the Internet using a general purpose computer rather than dedicated hardware. | https://en.wikipedia.org/wiki/Softphone |
| StartCall | Action. Alias for changing the state of a device to OffHook. (OffHook=true). | Starting with SDK3, StartCall is used as an alias for setting the device's state to OffHook, and EndCall as an alias for setting the state to OnHook. |
| State | Describes the current operational condition of a device. | - |
| Telemetry | The provisioning of regularly updated measurements from a device to an application or system connected via electronic communications. | https://en.wikipedia.org/wiki/Telemetry |
| UI | User interface. The space where interactions between humans and machines occur. | https://en.wikipedia.org/wiki/User_interface |
| UX | User experience. "A person's perceptions and responses that result from the use or anticipated use of a product, system or service" (ISO 9241-910). | https://en.wikipedia.org/wiki/User_experience |
| WebHID | An API which allows a web page to communicate with HID devices. | https://wicg.github.io/webhid/EXPLAINER.html |