Skip to main content

Home > @gnaudio/jabra-js > init

init() function#

Initialize the Jabra SDK. Entry point to being able to control Jabra hardware.

Signature:
declare function init(config?: IConfig | null): Promise<IApi>;

Parameters#

ParameterTypeDescription
configIConfig | nullOptional configuration settings. See IConfig for more details.
Returns:

Promise<IApi>

The initialized SDK object, which can be used to control Jabra hardware.

Exceptions#

If the underlying transport object (console-app or Chrome extension) fails to connect for some reason, e.g. when it's not installed on the system.

Example#

Here is a small example that initializes the Jabra SDK:

// Import the Jabra SDK
import * as jabraSdk from '../../esm/index.js';
// Initialize the SDK
const jabraApi = await jabraSdk.init();