Home > @gnaudio/jabra-js

jabra-js package

Classes

Class	Description
CallControlFactory	Enables the creation of a device with call control functionality.A CallControlFactory is initialized by passing in softphone information and the core IApi interface. It can then be used to create ICallControl instances.

Enumerations

Enumeration	Description
ErrorType	Determines what caused an error to be thrown.
LogLevel	Error severity of a log, i.e. whether a log event is due to an exception, warning, or just a info message. See ILogEvent.
ReportType	Type of report which is to be passed between SDK and device.
RequestedBrowserTransport	Optional transport modes that can be requested on initialisation. These are relevant when operating within a browser context only. They are not used outside of a browser, where Node is used instead.
SignalType	Definitions for incoming signals from Jabra devices related to call control.
StackLayer	The stack layer in which the log event occured, i.e. which module caused the ILogEvent.
TransportContext	Transport context to determine what mechanism is used to communicate with connected devices
ValueType	HID usage value type

Functions

Function	Description
init(config)	Initialize the Jabra SDK. Entry point to being able to control Jabra hardware.
webHidPairing()	Triggers WebHID consent dialogue in compatible browsersUse like this:

import { webHidPairing } from '@gnaudio/jabra-js';

document.getElementById('consent-button').addEventListener('click', async () => {

await webHidPairing();

});

// Init library as normal

|

Interfaces

Interface	Description
IApi	Main Jabra API object. Returned after SDK initialization (see init()).Provides an entry point to reflecting and changing the state of Jabra devices.
ICallControl	Defines the necessary functionality for call control: - being able to start/end a call, - mute/unmute the microphone, - hold/resume a call, - start/stop the ringer on the device, - events for emitted signals from the device, and - the required call lock for executing all of these functions.
ICallControlSignal	Represent a signal that is emitted from a Jabra device. These signals notify you that something has happened on the device.This could be:- the user expressing an intent to do something by interacting with the device (e.g. pressing a button).- acknowledgement to a request (e.g. a SignalType.HOOK_SWITCH signal after your softphone starts a call successfully).- an error condition (e.g. headset out of range from the base station).
IConfig	Optional configuration used when initializing the Jabra SDK.
IConsoleLogger	Console logging functionality.
IHidChannel	This class is a simple wrapper for a stream of incoming HID reports from a device and a callback to output HID reports to the device.
IHidReport	HID Report.
IHidUsage	HID Usage.
IJabraError	Describes an error that can be thrown while utilizing the Jabra SDK.It has the usual properties of an Error, with some additional ones added.
ILogEvent	Describes all necessary information about a log event.
ILogger	Interface used to describe an object that can log runtime information.
ISdkDevice	Describes all properties of a physical Jabra device along with methods for basic device communication via HID or GNP.
ISoftphoneInfo	Softphone information used for Jabra Direct integration
ITransport

Type Aliases

Type Alias	Description
DeviceId	Device ID.