Class DeviceType

applyColorControlPresetAsync

• applyColorControlPresetAsync(PresetSlot: enumColorControlPreset): Promise<void>

• Applies color controls from a given preset slot.

  Parameters

  • PresetSlot: enumColorControlPreset

  Returns Promise<void>

  • Resolves to void on success, rejects with JabraError on error.

applyPTZPresetAsync

• applyPTZPresetAsync(PresetSlot: enumPTZPreset): Promise<void>

• Applies Pan/Tilt/Zoom settings from a given preset slot.

  Parameters

  • PresetSlot: enumPTZPreset

  Returns Promise<void>

  • Resolves to void on success, rejects with JabraError on error.

cancelFirmwareDownloadAsync

• cancelFirmwareDownloadAsync(): Promise<void>

• Cancels the firmware download (Async).

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

checkForFirmwareUpdateAsync

• checkForFirmwareUpdateAsync(authorization?: undefined | string): Promise<boolean>

• Check if Firmware update available for device.

  Parameters

  • Optional authorization: undefined | string

  Returns Promise<boolean>

  • Resolve boolean if successful otherwise Reject with error.
  • true - if a new firmware update is available (existing firmware not up to date), false otherwise (existing firmware up to date).

clearPairedDeviceAsync

• clearPairedDeviceAsync(deviceName: string, deviceBTAddr: string, isConnected: boolean): Promise<void>

• Clear a device from paired device list.

  Parameters

  • deviceName: string

    name of device to be connected.

  • deviceBTAddr: string

    BTAddress of device to be connected.

  • isConnected: boolean

    current status of device to be connected.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

clearPairingListAsync

• clearPairingListAsync(): Promise<void>

• Clear list of paired Bluetooth devices from Bluetooth adapter.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

configureXpressManagementAsync

• configureXpressManagementAsync(url?: undefined | string, proxySettings?: ProxySettings, timeout?: undefined | number): Promise<void>

• Configures networked device for stand-alone remote management

  Parameters

  • Optional url: undefined | string

    URL for the Xpress backend server If empty/undefined, management will be disabled

  • Optional proxySettings: ProxySettings

    (optional) Proxy configuration If undefined, proxy will be disabled

  • Optional timeout: undefined | number

    (optional) Total time limit for validation of new configuration If undefined, will use default timeout of 10'000 ms

  Returns Promise<void>

  • Resolves to void on success, rejects with JabraError if an error occurs.

connectBTDeviceAsync

• connectBTDeviceAsync(): Promise<void>

• Connect/Reconnect Bluetooth device to the Jabra Bluetooth adapter. Ensure the Bluetooth device is switched on and within range.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

connectNewDeviceAsync

• connectNewDeviceAsync(deviceName: string, deviceBTAddr: string, isConnected: boolean): Promise<void>

• Connect a new Bluetooth device.

  Parameters

  • deviceName: string

    name of device to be connected.

  • deviceBTAddr: string

    BTAddress of device to be connected.

  • isConnected: boolean

    current status of device to be connected.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

connectPairedDeviceAsync

• connectPairedDeviceAsync(deviceName: string, deviceBTAddr: string, isConnected: boolean): Promise<void>

• Connect a Bluetooth device which was already paired.

  Parameters

  • deviceName: string

    name of device to be connected.

  • deviceBTAddr: string

    BTAddress of device to be connected.

  • isConnected: boolean

    current status of device to be connected.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.
  • Note : After device connection, getPairingListAsync api has to be called to get updated connection status.

disconnectBTDeviceAsync

• disconnectBTDeviceAsync(): Promise<void>

• Disconnect Bluetooth device from Bluetooth adapter.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

disconnectPairedDeviceAsync

• disconnectPairedDeviceAsync(deviceName: string, deviceBTAddr: string, isConnected: boolean): Promise<void>

• Disconnect a paired Bluetooth device.

  Parameters

  • deviceName: string

    name of device to be disconnected.

  • deviceBTAddr: string

    BTAddress of device to be disconnected.

  • isConnected: boolean

    current status of device to be disconnected.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.
  • Note : After device disconnection, getPairingListAsync api has to be called to get updated connection status.

downloadFirmwareAsync

• downloadFirmwareAsync(version: string, authorization?: undefined | string): Promise<void>

• Downloads the specified firmware version file.

  Parameters

  • version: string

    Version for which file download needs to be initiated.

  • Optional authorization: undefined | string

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

downloadFirmwareUpdaterAsync

• downloadFirmwareUpdaterAsync(authorization?: undefined | string): Promise<void>

• Downloads the latest FW updater relevant for this device

  Parameters

  • Optional authorization: undefined | string

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

enableDevLogAsync

• enableDevLogAsync(enable: boolean): Promise<void>

• Enable/disable logging for a device.

  Parameters

  • enable: boolean

    whether to enable device log.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

enableEqualizerAsync

• enableEqualizerAsync(enable: boolean): Promise<void>

• Enable/disable equalizer.

  Parameters

  • enable: boolean

    Enable or disable equalizer.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

enableFirmwareLockAsync

• enableFirmwareLockAsync(enable: boolean): Promise<void>

• Enable/disable the firmware lock. if the firmware is locked the device should not be upgraded.

  Parameters

  • enable: boolean

    whether to lock the firmware in the device.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

enableRemoteManagementAsync

• enableRemoteManagementAsync(enable: boolean, timeout: number): Promise<void>

• Enables/disables remote management

  Parameters

  • enable: boolean

    True to enable remote management, false to disable it

  • timeout: number

    Time in ms to wait for a valid network connection Set to 0 to disable network connection check.

  Returns Promise<void>

  • Resolves to void on success, rejects with JabraError if an error occurs.

getAudioFileParametersForUploadAsync

• getAudioFileParametersForUploadAsync(): Promise<{ audioFileType: AudioFileFormatEnum; bitsPerSample: number; maxFileSize: number; numChannels: number; sampleRate: number }>

• Get details of audio file for uploading to device.

  Returns Promise<{ audioFileType: AudioFileFormatEnum; bitsPerSample: number; maxFileSize: number; numChannels: number; sampleRate: number }>

  , JabraError>} - Resolve Audio File Detail object if successful otherwise Reject with error.

getAutoPairingAsync

• getAutoPairingAsync(): Promise<boolean>

• Get Bluetooth auto pairing mode.

  Returns Promise<boolean>

  • Resolve boolean if successful otherwise Reject with error.
  • true if auto pairing mode is enabled, false otherwise.

getBatteryStatusAsync

• getBatteryStatusAsync(): Promise<{ isBatteryLow?: undefined | false | true; isCharging?: undefined | false | true; levelInPercent?: undefined | number }>

• Get battery status, if supported by device.

  Returns Promise<{ isBatteryLow?: undefined | false | true; isCharging?: undefined | false | true; levelInPercent?: undefined | number }>

  • Resolve batteryInfo object if successful otherwise Reject with error.

getBrightnessLevelAsync

• getBrightnessLevelAsync(): Promise<number>

• Gets the current brightness level on a camera device

  Returns Promise<number>

  • Resolves to number level on success, rejects with JabraError on error.

getBrightnessLimitsAsync

• getBrightnessLimitsAsync(): Promise<VideoLimits>

• Gets the brightness limits on a camera device

  Returns Promise<VideoLimits>

  • Resolves to VideoLimits limits on success, rejects with JabraError on error.

getBusyLightStatusAsync

• getBusyLightStatusAsync(): Promise<boolean>

• Checks the status of busylight.

  Returns Promise<boolean>

  • Resolve boolean if successful otherwise Reject with error.
  • true if busylight is on, false if busylight is off or if it is not supported.

getButtonFocusAsync

• getButtonFocusAsync(btnEvents: Array<{ buttonEventType: Array<{ key: number; value: string }>; buttonTypeKey: number; buttonTypeValue: string }>): Promise<void>

• Configures the remote MMI events for a device.

  Parameters

  • btnEvents: Array<{ buttonEventType: Array<{ key: number; value: string }>; buttonTypeKey: number; buttonTypeValue: string }>

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

getConnectedBTDeviceNameAsync

• getConnectedBTDeviceNameAsync(): Promise<string>

• Get name of connected Bluetooth device for Bluetooth adapter.

  Returns Promise<string>

  • Resolve deviceName string if successful otherwise Reject with error.

getConnectedHeadsetNamesAsync

• getConnectedHeadsetNamesAsync(getAssetTag: boolean, readFromHeadset: whichHeadsetNamesToRead): Promise<dongleConnectedHeadsetName>

• Reads the device name(s) of connected BT or DECT headsets. getAssetTag indicates whether to read user-configurable device asset tags (true) or product name (false). readFromHeadset indicates which connected devices should be included in the read.

  Parameters

  • getAssetTag: boolean

  • readFromHeadset: whichHeadsetNamesToRead

  Returns Promise<dongleConnectedHeadsetName>

  • Resolve dongleConnectedHeadsetName if all requested device names could be read otherwise Reject with JabraError.

getConstantsAsync

• getConstantsAsync(key: string): Promise<DeviceConstants>

• Get DeviceConstants object to be used for acquiring device constants.

  Parameters

  • key: string

  Returns Promise<DeviceConstants>

  • Resolve DeviceConstants if successful otherwise Reject with Error.

getContrastLevelAsync

• getContrastLevelAsync(): Promise<number>

• Gets the current contrast level on a camera device

  Returns Promise<number>

  • Resolves to number level on success, rejects with JabraError on error.

getContrastLimitsAsync

• getContrastLimitsAsync(): Promise<VideoLimits>

• Gets the contrast limits on a camera device

  Returns Promise<VideoLimits>

  • Resolves to VideoLimits limits on success, rejects with JabraError on error.

getDECTPairingKeyAsync

• getDECTPairingKeyAsync(): Promise<number>

• Read the secure pairing key from a DECT base/dongle.

  Returns Promise<number>

  • Resolve number if successful otherwise Reject with JabraError.

getDateTimeAsync

• getDateTimeAsync(): Promise<DateTime>

• Gets the current date and time setting from device (Async).

  Returns Promise<DateTime>

  • Resolve DateTime if successful otherwise Reject with error.

getDiagnosticLogFileAsync

• getDiagnosticLogFileAsync(filename: string): Promise<void>

• Gets the pre-generated diagnostic log file on supported devices

  see

  triggerDiagnosticLogGenerationAsync

  Parameters

  • filename: string

    Destination filename on local file system

  Returns Promise<void>

  • Resolves to void on success, rejects with JabraError if an error occurs.

getESNAsync

• getESNAsync(): Promise<string>

• Get ESN (electronic serial number).

  Returns Promise<string>

  • Resolve string if successful otherwise Reject with error.

getEqualizerParametersAsync

• getEqualizerParametersAsync(maxNBands?: undefined | number): Promise<Array<{ centerFrequency: number; currentGain: number; max_gain: number }>>

• Get equalizer parameters.

  Parameters

  • Optional maxNBands: undefined | number

  Returns Promise<Array<{ centerFrequency: number; currentGain: number; max_gain: number }>>

  • Resolve equalizerBand object if successful otherwise Reject with error.

getEthernetIPv4StatusAsync

• getEthernetIPv4StatusAsync(): Promise<IPv4Status>

• Returns the status of the Ethernet connection.

  Returns Promise<IPv4Status>

  • Resolves to IPv4Status on success, rejects with JabraError on error.

getFailedSettingNamesAsync

• getFailedSettingNamesAsync(): Promise<Array<string>>

• Returns error description for the error code

  Returns Promise<Array<string>>

  • Resolve failedSetting array if successful otherwise Reject with error.
  • return FailedSettings if one or more settings are failed while writing to device.
  • return empty array if all settings are written successfully.
  • Note: This API should be called if setSettingsAsync API does not return void.

getFirmwareFilePathAsync

• getFirmwareFilePathAsync(version: string): Promise<string>

• Get the file path of the downloaded file.

  Parameters

  • version: string

    Version for which the path is required.

  Returns Promise<string>

  • Resolve firmware file path string if successful otherwise Reject with error.
  • Note: Call downloadFirmwareAsync first to ensure that data is current

getFirmwareVersionAsync

• getFirmwareVersionAsync(): Promise<string>

• Get firmware version of the device.

  Returns Promise<string>

  • Resolve version string if successful otherwise Reject with error.

getFirmwareVersionBundleAsync

• getFirmwareVersionBundleAsync(): Promise<FirmwareVersionBundleType>

• Get firmware version bundle of the parent and child device set.

  Returns Promise<FirmwareVersionBundleType>

  • Resolve version string if successful otherwise Reject with error.

getHidWorkingStateAsync

• getHidWorkingStateAsync(): Promise<enumHidState>

• Gets the HID working state.

  Returns Promise<enumHidState>

  • Resolve hidState (enumHidState) if successful otherwise Reject with error.

getImagePathAsync

• getImagePathAsync(): Promise<string>

• Gets the device image path.

  Returns Promise<string>

  • Resolve imagePath string if successful otherwise Reject with error.

getImageThumbnailPathAsync

• getImageThumbnailPathAsync(): Promise<string>

• Gets the device image thumbnail path.

  Returns Promise<string>

  • Resolve image Thumbnail Path string if successful otherwise Reject with error.

getIntelligentZoomLatencyAsync

• getIntelligentZoomLatencyAsync(): Promise<enumIntelligentZoomLatency>

• Gets the minimum time in seconds to stay with a participant before being allowed to change zoom/direction.

  Returns Promise<enumIntelligentZoomLatency>

  • Resolve setting enumIntelligentZoomLatency if successful otherwise Reject with error.

getIsCameraStreamingAsync

• getIsCameraStreamingAsync(): Promise<boolean>

• Gets whether the camera is actively streaming.

  Returns Promise<boolean>

  • Resolve boolean if successful otherwise Reject with error.

getLanguagePackInformationAsync

• getLanguagePackInformationAsync(pack: enumLanguagePack): Promise<LanguagePackStats>

• Get detailed information regarding specified language pack installed on device

  Parameters

  • pack: enumLanguagePack

  Returns Promise<LanguagePackStats>

  • Resolve LanguagePackStats if successful otherwise Reject with error.

getLatestFirmwareInformationAsync

• getLatestFirmwareInformationAsync(authorization?: undefined | string): Promise<FirmwareInfoType>

• Gets details of the latest firmware present in cloud.

  Parameters

  • Optional authorization: undefined | string

  Returns Promise<FirmwareInfoType>

  • Resolve firminfo object if successful otherwise Reject with error.

getLocalManifestVersionAsync

• getLocalManifestVersionAsync(): Promise<string>

• Gets the Manifest Files' version that are found locally in the Resources folder for a given device.

  Returns Promise<string>

  • Returns a string with the version number if successful, otherwise reject with JabraError.

getLockAsync

• getLockAsync(): Promise<void>

• Get call lock for a particular device.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

getMACAddressAsync

• getMACAddressAsync(selectedInterface: enumNetworkInterface): Promise<Uint8Array>

• Get MAC address of specified interface

  Parameters

  • selectedInterface: enumNetworkInterface

  Returns Promise<Uint8Array>

  • Resolve MAC address as Uint8Array if successful otherwise Reject with error.

getMeta

• getMeta(): ClassEntry

• Get meta information about methods, properties etc. that can be used for reflective usage of this class.

  Returns ClassEntry

getNamedAssetAsync

• getNamedAssetAsync(assetName: string): Promise<NamedAsset>

• Get asset with name.

  Parameters

  • assetName: string

  Returns Promise<NamedAsset>

  • Resolve NamedAsset object if successful otherwise Reject with error.

getNetworkAuthenticationModeAsync

• getNetworkAuthenticationModeAsync(interf: enumNetworkInterface): Promise<enumNetworkAuthMode>

• Get the current IEEE 802.1x network authentication mode for a given interface

  Parameters

  • interf: enumNetworkInterface

    The interface (Ethernet / WLAN)

  Returns Promise<enumNetworkAuthMode>

  • Resolves auth mode on success, rejects with JabraError if an error occurs.

getNotificationStyleAsync

• getNotificationStyleAsync(): Promise<enumNotificationStyle>

• Gets the style of notifications on a video device

  Returns Promise<enumNotificationStyle>

  • Resolves to enumNotificationStyle on success, rejects with JabraError on error.

getNotificationUsageAsync

• getNotificationUsageAsync(): Promise<enumNotificationUsage>

• Gets when notifications are active on a video device

  Returns Promise<enumNotificationUsage>

  • Resolves to enumNotificationUsage on success, rejects with JabraError on error.

getPairingListAsync

• getPairingListAsync(): Promise<Array<{ deviceBTAddr: string; deviceName: string; isConnected: boolean }>>

• Gets the list of devices which are paired previously.

  Returns Promise<Array<{ deviceBTAddr: string; deviceName: string; isConnected: boolean }>>

  • Resolve pairList array if successful otherwise Reject with error.

getPanTiltAsync

• getPanTiltAsync(): Promise<PanTilt>

• Returns the current pan-tilt values from the device's camera.

  Returns Promise<PanTilt>

  • Resolves to the current pan-tilt parameters on success, else rejects with JabraError

getPanTiltLimitsAsync

• getPanTiltLimitsAsync(): Promise<PanTiltLimits>

• Returns the current pan-tilt limits values from the device's camera.

  Returns Promise<PanTiltLimits>

  • Resolves to the pan-tilt limits on success, else rejects with JabraError

getPanicsAsync

• getPanicsAsync(): Promise<Array<string>>

• Get the panic list.

  Returns Promise<Array<string>>

  • Resolve paniclist 'array' if successful otherwise Reject with error.
  • panic code will be hex string

getPasswordProvisioningAsync

• getPasswordProvisioningAsync(): Promise<string>

• Get the password for provisioning

  Returns Promise<string>

  • Resolves to password string on success, rejects with JabraError if an error occurs.

getPictureInPictureAsync

• getPictureInPictureAsync(): Promise<boolean>

• Gets whether Picture-In-Picture is active on a supported video device

  Returns Promise<boolean>

  • Resolves to boolean result on success, rejects with JabraError on error.

getRemoteControlBatteryStatusAsync

• getRemoteControlBatteryStatusAsync(): Promise<{ isBatteryLow?: undefined | false | true; isCharging?: undefined | false | true; levelInPercent?: undefined | number }>

• Get remote control battery status, if supported by device.

  Returns Promise<{ isBatteryLow?: undefined | false | true; isCharging?: undefined | false | true; levelInPercent?: undefined | number }>

  • Resolve batteryInfo object if successful otherwise Reject with error.

getRemoteControlFirmwareVersionAsync

• getRemoteControlFirmwareVersionAsync(): Promise<string>

• Get remote control version

  Returns Promise<string>

  • Resolve version string if successful otherwise Reject with error.

getRemoteMmiFocusAsync

• getRemoteMmiFocusAsync(type: enumRemoteMmiType, input: enumRemoteMmiInput, priority: enumRemoteMmiPriority): Promise<void>

• Gets the focus of the remote MMI specified. Once a remote MMI has focus, the normal functionality of the MMI (button/LED) is suppressed until #releaseRemoteMmiFocusAsync is called. If only the LED output MMI functionality is required, action can be specified as MMI_ACTION_NONE.

  Parameters

  • type: enumRemoteMmiType

    Type of remote MMI to get focus of.

  • input: enumRemoteMmiInput

    Action to get focus of, acts as a filter/mask for the actions on the RemoteMmiCallback callback

  • priority: enumRemoteMmiPriority

    Priority of focus.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

getRoomCapacityAsync

• getRoomCapacityAsync(): Promise<number>

• Gets the room capacity setting on a video device

  Returns Promise<number>

  • Resolves to number room capacity on success, rejects with JabraError on error.

getRoomCapacityNotificationEnabledAsync

• getRoomCapacityNotificationEnabledAsync(): Promise<boolean>

• Gets whether capacity notifications are enabled on a video device

  Returns Promise<boolean>

  • Resolves to boolean enable state on success, rejects with JabraError on error.

getSaturationLevelAsync

• getSaturationLevelAsync(): Promise<number>

• Gets the current saturation level on a camera device

  Returns Promise<number>

  • Resolves to number level on success, rejects with JabraError on error.

getSaturationLimitsAsync

• getSaturationLimitsAsync(): Promise<VideoLimits>

• Gets the saturation limits on a camera device

  Returns Promise<VideoLimits>

  • Resolves to VideoLimits limits on success, rejects with JabraError on error.

getSearchDeviceListAsync

• getSearchDeviceListAsync(): Promise<Array<{ deviceBTAddr: string; deviceName: string; isConnected: boolean }>>

• Gets the list of new Bluetooth devices which are available to pair & connect.

  Returns Promise<Array<{ deviceBTAddr: string; deviceName: string; isConnected: boolean }>>

  • Resolve pairList array if successful otherwise Reject with error.
  • Note: isConnected, flag in Pairing List Object, will always be false as device does not give connection status for the found device.

getSecondVideoStreamAsync

• getSecondVideoStreamAsync(): Promise<enumSecondaryStreamContent>

• Returns which stream is shown in the secondary video stream.

  Returns Promise<enumSecondaryStreamContent>

  • Resolves to enumSecondaryStreamContent on success, rejects with JabraError on error.

getSecureConnectionModeAsync

• getSecureConnectionModeAsync(): Promise<enumSecureConnectionMode>

• Reads the secure connection status (whether it is in legacy mode, secure mode or restricted)

  Returns Promise<enumSecureConnectionMode>

  • Resolve enumSecureCommectionMode secure connection mode (one of SecureConnectionModes) number if successful otherwise Reject with error.

getSensorRegionsAsync

• getSensorRegionsAsync(): Promise<SensorRegionType>

• Returns the sensor regions positions from the sensors on the device

  Returns Promise<SensorRegionType>

  • Resolves to the current sensor regions values on success, else rejects with JabraError

getSerialNumberAsync

• getSerialNumberAsync(): Promise<string>

• Get serial number.

  Returns Promise<string>

  • Resolve string if successful otherwise Reject with error.

getSettingAsync

• getSettingAsync(guid: string): Promise<DeviceSettings>

• Gets the unique setting identified by a GUID of a device.

  Parameters

  • guid: string

    the unique setting identifier.

  Returns Promise<DeviceSettings>

  • Resolve setting array if successful otherwise Reject with error.

getSettingsAsync

• getSettingsAsync(): Promise<DeviceSettings>

• Gets the complete settings details (all groups and its settings) for a device.

  Returns Promise<DeviceSettings>

  • Resolve setting array if successful otherwise Reject with error.

getSharpnessLevelAsync

• getSharpnessLevelAsync(): Promise<number>

• Gets the current sharpness level on a camera device

  Returns Promise<number>

  • Resolves to number level on success, rejects with JabraError on error.

getSharpnessLimitsAsync

• getSharpnessLimitsAsync(): Promise<VideoLimits>

• Gets the sharpness limits on a camera device

  Returns Promise<VideoLimits>

  • Resolves to VideoLimits limits on success, rejects with JabraError on error.

getSubDevicePropertyAsync

• getSubDevicePropertyAsync(subDevice: enumSubDevice, property: enumDeviceProperty): Promise<string>

• Returns a specific property from a sub device if it exists.

  Parameters

  • subDevice: enumSubDevice

  • property: enumDeviceProperty

  Returns Promise<string>

  • Resolves to string on success, rejects with JabraError on error.

getSupportedButtonEventsAsync

• getSupportedButtonEventsAsync(): Promise<Array<{ buttonEventType: Array<{ key: number; value: string }>; buttonTypeKey: number; buttonTypeValue: string }>>

• Gets the supported remote MMI for a device.

  Returns Promise<Array<{ buttonEventType: Array<{ key: number; value: string }>; buttonTypeKey: number; buttonTypeValue: string }>>

  • Resolve btnEvent array if successful otherwise Reject with error.

getSupportedFeaturesAsync

• getSupportedFeaturesAsync(): Promise<Array<enumDeviceFeature>>

• Get array of features supported by a device

  Returns Promise<Array<enumDeviceFeature>>

  • Resolve array of supported features, should be enumDeviceFeature array if successful otherwise Reject with error.

getTimestampAsync

• getTimestampAsync(): Promise<number>

• Gets the static timestamp in the device.

  Returns Promise<number>

  • Resolve Date in milliseconds number if successful otherwise Reject with error.

getUSBStateAsync

• getUSBStateAsync(): Promise<enumUSBState>

• Returns the state and speed of the device's USB connection.

  Returns Promise<enumUSBState>

  • Resolves to enumUSBState on success, rejects with JabraError on error.

getUserDefinedDeviceNameAsync

• getUserDefinedDeviceNameAsync(): Promise<string>

• Returns the user defined device name if supported.

  Returns Promise<string>

  • Resolves to string on success, rejects with JabraError on error.

getVideoHDRAsync

• getVideoHDRAsync(): Promise<boolean>

• Gets the active HDR enable setting on a video device

  Returns Promise<boolean>

  • Resolves to boolean on success, rejects with JabraError on error.

getVideoHDRDefaultAsync

• getVideoHDRDefaultAsync(): Promise<boolean>

• Gets the default HDR enable setting on a video device

  Returns Promise<boolean>

  • Resolves to boolean on success, rejects with JabraError on error.

getVideoModeAsync

• getVideoModeAsync(): Promise<enumVideoMode>

• Gets how the video viewport is managed (runtime).

  Returns Promise<enumVideoMode>

  • Resolve enumVideoMode if successful otherwise Reject with error.

getVideoTransitionStyleAsync

• getVideoTransitionStyleAsync(): Promise<enumVideoTransitionStyle>

• Returns the active video transition style with Intelligent Zoom.

  Returns Promise<enumVideoTransitionStyle>

  • Resolves to enumVideoTransitionStyle on success, rejects with JabraError on error.

getWLANIPv4StatusAsync

• getWLANIPv4StatusAsync(): Promise<IPv4Status>

• Returns the status of the WLAN connection.

  Returns Promise<IPv4Status>

  • Resolves to IPv4Status on success, rejects with JabraError on error.

getWhiteBalanceAsync

• getWhiteBalanceAsync(): Promise<WhiteBalance>

• Gets the current white balance on a camera device

  Returns Promise<WhiteBalance>

  • Resolves to WhiteBalance result on success, rejects with JabraError on error.

getWhiteBalanceLimitsAsync

• getWhiteBalanceLimitsAsync(): Promise<VideoLimits>

• Gets the white balance limits on a camera device

  Returns Promise<VideoLimits>

  • Resolves to VideoLimits limits on success, rejects with JabraError on error.

getWhiteboardOnMainStreamAsync

• getWhiteboardOnMainStreamAsync(): Promise<boolean>

• Get whether the main stream shows the whiteboard.

  Returns Promise<boolean>

  • Resolves to bool on success, rejects with JabraError on error.

getWhiteboardPositionAsync

• getWhiteboardPositionAsync(whiteboardId: number): Promise<WhiteboardPosition>

• Returns the position of the provided whiteboard corners as coordinates.

  Parameters

  • whiteboardId: number

    The whiteboard id number.

  Returns Promise<WhiteboardPosition>

  • Resolves to the whiteboard corners position on success, rejects with JabraError if an error occurs.

getWizardModeAsync

• getWizardModeAsync(): Promise<enumWizardMode>

• Reads the current wizard mode (whether a full setup wizard, a limited setup wizard or none will run on next power-on). Use isFeatureSupportedAsync to query feature support enumDeviceFeature.FullWizardMode or enumDeviceFeature.LimitedWizardMode.

  Returns Promise<enumWizardMode>

  • Resolve enumWizardMode Current wizard mode (one of WizardModes) number if successful otherwise Reject with error.

getXpressManagementNetworkStatusAsync

• getXpressManagementNetworkStatusAsync(): Promise<libcurlError>

• Gets the error code/message from the last failed configuration attempt using configureXpressManagementAsync().

  Returns Promise<libcurlError>

  • Resolves to libcurlError if an error code could be read (will be 0 if the last operation was successful), otherwise rejects with JabraError.

getXpressUrlAsync

• getXpressUrlAsync(): Promise<string>

• Returns the Jabra Xpress URL

  Returns Promise<string>

  • Resolves to the Xpress url on success, rejects with JabraError if an error occurs.

getZoomAsync

• getZoomAsync(): Promise<number>

• Returns the current zoom value from the device's camera.

  Returns Promise<number>

  • Resolves to the current zoom value on success, else rejects with JabraError

getZoomLimitsAsync

• getZoomLimitsAsync(): Promise<VideoLimits>

• Returns the zoom limit values from the device's camera.

  Returns Promise<VideoLimits>

  • Resolves to the current zoom limit values on success, else rejects with JabraError

holdAsync

• holdAsync(): Promise<void>

• Set device's hold state to true.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

isBatterySupportedAsync

• isBatterySupportedAsync(): Promise<boolean>

• Check if battery is supported.

  Returns Promise<boolean>

  • Resolve boolean if successful otherwise Reject with error.

isBusyLightSupportedAsync

• isBusyLightSupportedAsync(): Promise<boolean>

• Checks if busylight is supported by the device.

  Returns Promise<boolean>

  • Resolve boolean if successful otherwise Reject with error.
  • Returns true if supported, otherwise false.

isCertifiedForSkypeForBusinessAsync

• isCertifiedForSkypeForBusinessAsync(): Promise<boolean>

• Returns whether the device is certified for Skype For Business

  Returns Promise<boolean>

  • Resolves to a boolean telling if the device is certified

isDevLogEnabledAsync

• isDevLogEnabledAsync(): Promise<boolean>

• Is logging enabled on device.

  Returns Promise<boolean>

  • Resolve boolean if successful otherwise Reject with error.

isEqualizerEnabledAsync

• isEqualizerEnabledAsync(): Promise<boolean>

• Checks if equalizer is enabled.

  Returns Promise<boolean>

  • Resolve True if equalizer is enabled, false if equalizer is disabled or not supported by the device otherwise Reject with error.

isEqualizerSupportedAsync

• isEqualizerSupportedAsync(): Promise<boolean>

• Checks if equalizer is supported by the device.

  Returns Promise<boolean>

  • Resolve True if equalizer is supported, false if device does not support equalizer otherwise Reject with error.

isFactoryResetSupportedAsync

• isFactoryResetSupportedAsync(): Promise<boolean>

• Checks if supports factory reset.

  Returns Promise<boolean>

  • Resolve boolean if successful otherwise Reject with error.
  • Returns true if device supports factory reset, false if device does not support factory reset.

isFeatureSupportedAsync

• isFeatureSupportedAsync(deviceFeature: number): Promise<boolean>

• Check if a feature is supported by a device.

  Parameters

  • deviceFeature: number

    the feature to check, should be enumDeviceFeature

  Returns Promise<boolean>

  • Resolve isfeatureSupports boolean if successful otherwise Reject with error.

isFirmwareLockEnabledAsync

• isFirmwareLockEnabledAsync(): Promise<boolean>

• Checks if firmware lock is enabled. If the firmware lock is enabled it is not possible to upgrade nor downgrade the firmware. In this situation the firmware can only be changed to the same version e.g. if you want to change the language.

  Returns Promise<boolean>

  • Resolve isFirmwareLockEnabled boolean if successful otherwise Reject with error.

isGnHidStdHidSupportedAsync

• isGnHidStdHidSupportedAsync(): Promise<boolean>

• Check if GN or Std HID state is supported by a device.

  Returns Promise<boolean>

  • Resolve isGnHidStdHidSupported boolean if successful otherwise Reject with error.

isHoldSupportedAsync

• isHoldSupportedAsync(): Promise<boolean>

• Checks for Hold support by the device.

  Returns Promise<boolean>

  • Resolve boolean if successful otherwise Reject with error.
  • Returns true if supported, otherwise false.

isLockedAsync

• isLockedAsync(): Promise<boolean>

• Check if we have call lock on device.

  Returns Promise<boolean>

  • Resolve boolean if successful otherwise Reject with error.

isMuteSupportedAsync

• isMuteSupportedAsync(): Promise<boolean>

• Checks for Mute command support by the device (Async).

  Returns Promise<boolean>

  • Resolve boolean if successful otherwise Reject with error.
  • Returns true if supported, otherwise false.

isOffHookSupportedAsync

• isOffHookSupportedAsync(): Promise<boolean>

• Checks for OffHook command support by the device.

  Returns Promise<boolean>

  • Resolve boolean if successful otherwise Reject with error.
  • Returns true if supported, otherwise false.

isOnlineSupportedAsync

• isOnlineSupportedAsync(): Promise<boolean>

• Checks for Online mode support by the device.

  Returns Promise<boolean>

  • Resolve boolean if successful otherwise Reject with error.
  • Returns true if supported, otherwise false.

isPairingListSupportedAsync

• isPairingListSupportedAsync(): Promise<boolean>

• Checks if pairing list is supported by the device.

  Returns Promise<boolean>

  • Resolve boolean if successful otherwise Reject with error.
  • Returns true if pairing list is supported, false if device does not support pairing list.

isRemoteManagementEnabledAsync

• isRemoteManagementEnabledAsync(): Promise<boolean>

• Checks whether remote management is enabled

  Returns Promise<boolean>

  • Resolves to true if remote management is enabled, false if it is not. Rejects to JabraError in case of errors.

isRemoteMmiInFocusaAsync

• isRemoteMmiInFocusaAsync(type: enumRemoteMmiType): Promise<boolean>

• Gets the status of the remote MMI focus.

  Parameters

  • type: enumRemoteMmiType

    Type of remote MMI to get focus status of.

  Returns Promise<boolean>

  returns true if in focus, false if not.

isRingerSupportedAsync

• isRingerSupportedAsync(): Promise<boolean>

• Checks for Ringer command support by the device.

  Returns Promise<boolean>

  • Resolve boolean if successful otherwise Reject with error.
  • Returns true if supported, otherwise false.

isSetDateTimeSupportedAsync

• isSetDateTimeSupportedAsync(): Promise<boolean>

• Checks if date and time can be configured to device.

  Returns Promise<boolean>

  • Resolve boolean if successful otherwise Reject with error.
  • Returns true if configuring time for device is supported, false if device does not support date and time configuration.

isSettingProtectionEnabledAsync

• isSettingProtectionEnabledAsync(): Promise<boolean>

• Checks if setting protection is enabled.

  Returns Promise<boolean>

  • Resolve boolean if successful otherwise Reject with error.
  • Returns true if setting protection is enabled otherwise false.

isUploadImageSupportedAsync

• isUploadImageSupportedAsync(): Promise<boolean>

• Checks if image upload is supported by the device.

  Returns Promise<boolean>

  • Resolve boolean if successful otherwise Reject with error.
  • Returns true if device supports image upload otherwise false.

isUploadRingtoneSupportedAsync

• isUploadRingtoneSupportedAsync(): Promise<boolean>

• Checks if Upload Ringtone to the device is supported by the device.

  Returns Promise<boolean>

  • Resolve boolean if successful otherwise Reject with error.
  • Returns true if Upload Ringtone to the device is supported, false if device does not support the ringtone upload to the device.

isVideoDeviceStreamingAsync

• isVideoDeviceStreamingAsync(): Promise<VideoDeviceStreamingStatus>

• Gets whether a video is actively streaming video and/or audio.

  Returns Promise<VideoDeviceStreamingStatus>

  • Resolve VideoDeviceStreamingStatus if successful otherwise Reject with error.

muteAsync

• muteAsync(): Promise<void>

• Set device's mute state to true i.e., device gets muted.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

off

• off(event: "btnPress", listener: btnPress): this
• off(event: "busyLightChange", listener: busyLightChange): this
• off(event: "downloadFirmwareProgress", listener: downloadFirmwareProgress): this
• off(event: "onBTParingListChange", listener: onBTParingListChange): this
• off(event: "onGNPBtnEvent", listener: onGNPBtnEvent): this
• off(event: "onDevLogEvent", listener: onDevLogEvent): this
• off(event: "onDiagLogEvent", listener: onDiagLogEvent): this
• off(event: "onBatteryStatusUpdate", listener: onBatteryStatusUpdate): this
• off(event: "onRemoteMmiEvent", listener: onRemoteMmiEvent): this
• off(event: "onxpressConnectionStatusEvent", listener: onxpressConnectionStatusEvent): this
• off(event: "onUploadProgress", listener: onUploadProgress): this
• off(event: "onDectInfoEvent", listener: onDectInfoEvent): this
• off(event: "onCameraStatusEvent", listener: onCameraStatusEvent): this
• off(event: "onNetworkStatusChangedEvent", listener: onNetworkStatusChangedEvent): this
• off(event: "onBluetoothLinkQualityChangeEvent", listener: onBluetoothLinkQualityChangeEvent): this

• Remove event handler for previosly setup btnPress device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "btnPress"

  • listener: btnPress

  Returns this

• Remove event handler for previosly setup busyLightChange device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "busyLightChange"

  • listener: busyLightChange

  Returns this

• Remove event handler for previosly setup downloadFirmwareProgress device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "downloadFirmwareProgress"

  • listener: downloadFirmwareProgress

  Returns this

• Remove event handler for previosly setup onBTParingListChange device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onBTParingListChange"

  • listener: onBTParingListChange

  Returns this

• Remove event handler for previosly setup onGNPBtnEvent device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onGNPBtnEvent"

  • listener: onGNPBtnEvent

  Returns this

• Remove event handler for previosly setup onDevLogEvent device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onDevLogEvent"

  • listener: onDevLogEvent

  Returns this

• Remove event handler for previosly setup onDiagLogEvent device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onDiagLogEvent"

  • listener: onDiagLogEvent

  Returns this

• Remove event handler for previosly setup onBatteryStatusUpdate device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onBatteryStatusUpdate"

  • listener: onBatteryStatusUpdate

  Returns this

• Remove event handler for previosly setup onRemoteMmiEvent device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onRemoteMmiEvent"

  • listener: onRemoteMmiEvent

  Returns this

• Remove event handler for onxpressConnectionStatusEvent.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onxpressConnectionStatusEvent"

  • listener: onxpressConnectionStatusEvent

  Returns this

• Remove event handler for previosly setup onUploadProgress device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onUploadProgress"

  • listener: onUploadProgress

  Returns this

• Remove event handler for previosly setup onDectInfo device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onDectInfoEvent"

  • listener: onDectInfoEvent

  Returns this

• Remove event handler for previosly setup onCameraStatusEvent device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onCameraStatusEvent"

  • listener: onCameraStatusEvent

  Returns this

• Remove event handler for previosly setup onNetworkStatusChangedEvent device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onNetworkStatusChangedEvent"

  • listener: onNetworkStatusChangedEvent

  Returns this

• Remove event handler for previosly setup onBluetoothLinkQualityChangeEvent device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onBluetoothLinkQualityChangeEvent"

  • listener: onBluetoothLinkQualityChangeEvent

  Returns this

offhookAsync

• offhookAsync(): Promise<void>

• Set device's offhook state to true (Async).

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

on

• on(event: "btnPress", listener: btnPress): this
• on(event: "busyLightChange", listener: busyLightChange): this
• on(event: "downloadFirmwareProgress", listener: downloadFirmwareProgress): this
• on(event: "onBTParingListChange", listener: onBTParingListChange): this
• on(event: "onGNPBtnEvent", listener: onGNPBtnEvent): this
• on(event: "onDevLogEvent", listener: onDevLogEvent): this
• on(event: "onDiagLogEvent", listener: onDiagLogEvent): this
• on(event: "onBatteryStatusUpdate", listener: onBatteryStatusUpdate): this
• on(event: "onRemoteMmiEvent", listener: onRemoteMmiEvent): this
• on(event: "onxpressConnectionStatusEvent", listener: onxpressConnectionStatusEvent): this
• on(event: "onUploadProgress", listener: onUploadProgress): this
• on(event: "onDectInfoEvent", listener: onDectInfoEvent): this
• on(event: "onCameraStatusEvent", listener: onCameraStatusEvent): this
• on(event: "onBluetoothLinkQualityChangeEvent", listener: onBluetoothLinkQualityChangeEvent): this
• on(event: "onNetworkStatusChangedEvent", listener: onNetworkStatusChangedEvent): this

• Add event handler for btnPress device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "btnPress"

  • listener: btnPress

  Returns this

• Add event handler for busyLightChange device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "busyLightChange"

  • listener: busyLightChange

  Returns this

• Add event handler for downloadFirmwareProgress device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "downloadFirmwareProgress"

  • listener: downloadFirmwareProgress

  Returns this

• Add event handler for onBTParingListChange device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onBTParingListChange"

  • listener: onBTParingListChange

  Returns this

• Add event handler for onGNPBtnEvent device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onGNPBtnEvent"

  • listener: onGNPBtnEvent

  Returns this

• Add event handler for onDevLogEvent device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onDevLogEvent"

  • listener: onDevLogEvent

  Returns this

• Add event handler for onDiagLogEvent device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onDiagLogEvent"

  • listener: onDiagLogEvent

  Returns this

• Add event handler for onBatteryStatusUpdate device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onBatteryStatusUpdate"

  • listener: onBatteryStatusUpdate

  Returns this

• Add event handler for remoteMmi events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onRemoteMmiEvent"

  • listener: onRemoteMmiEvent

  Returns this

• Add event handler for when the Xpress connection status is changed

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onxpressConnectionStatusEvent"

  • listener: onxpressConnectionStatusEvent

  Returns this

• Add event handler for onUploadProgress device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onUploadProgress"

  • listener: onUploadProgress

  Returns this

• Add event handler for onDectInfo device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onDectInfoEvent"

  • listener: onDectInfoEvent

  Returns this

• Add event handler for onCameraStatusEvent device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onCameraStatusEvent"

  • listener: onCameraStatusEvent

  Returns this

• Add event handler for onBluetoothLinkQualityChangeEvent device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onBluetoothLinkQualityChangeEvent"

  • listener: onBluetoothLinkQualityChangeEvent

  Returns this

• Add event handler for onNetworkStatusChangedEvent device events.

  Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

  Parameters

  • event: "onNetworkStatusChangedEvent"

  • listener: onNetworkStatusChangedEvent

  Returns this

onhookAsync

• onhookAsync(): Promise<void>

• Set device's offhook state to false.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

playRingtoneAsync

• playRingtoneAsync(level: number, type: number): Promise<void>

• Play Ringtone in Device.

  Parameters

  • level: number

    volume Level to Play.

  • type: number

    ringtone Type to Play.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

preloadAttachedDeviceInfoAsync

• preloadAttachedDeviceInfoAsync(zipFileName: string): Promise<void>

• Preloads the resources with the content of the specified archive for a specific device after this being attached.

  Parameters

  • zipFileName: string

  Returns Promise<void>

  • if operation failed, reject with JabraError.

rebootDeviceAsync

• rebootDeviceAsync(): Promise<void>

• Reboot device.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

releaseButtonFocusAsync

• releaseButtonFocusAsync(btnEvents: Array<{ buttonEventType: Array<{ key: number; value: string }>; buttonTypeKey: number; buttonTypeValue: string }>): Promise<void>

• Releases the remote MMI events configured in the device.

  Parameters

  • btnEvents: Array<{ buttonEventType: Array<{ key: number; value: string }>; buttonTypeKey: number; buttonTypeValue: string }>

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

releaseLockAsync

• releaseLockAsync(): Promise<void>

• Release our call lock for a particular device.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

releaseRemoteMmiFocusAsync

• releaseRemoteMmiFocusAsync(type: enumRemoteMmiType): Promise<void>

• Releases the focus of the remote MMI specified. Note that focus on all actions are removed.

  Parameters

  • type: enumRemoteMmiType

    Type of remote MMI to release focus of.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

resetImageQualityControls

• resetImageQualityControls(): Promise<void>

• Resets runtime image quality settings to factory defaults on a video device. IQ is Brightness+Contrast+Sharpness+Saturation+White Balance.

  Returns Promise<void>

  • Resolves to void on success, rejects with JabraError on error.

resetPanTiltZoom

• resetPanTiltZoom(): Promise<void>

• Resets runtime pan, tilt and zoom settings to factory defaults on a video device.

  Returns Promise<void>

  • Resolves to void on success, rejects with JabraError on error.

resetSettingsAsync

• resetSettingsAsync(): Promise<void>

• Restore factory settings to device.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

restoreVideoRoomDefaultsAsync

• restoreVideoRoomDefaultsAsync(): Promise<void>

• Restores the video settings to room defaults like when a new call is started

  Returns Promise<void>

  • Resolves to void on success, rejects with JabraError on error.

resumeAsync

• resumeAsync(): Promise<void>

• Set device's hold state to false.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

ringAsync

• ringAsync(): Promise<void>

• Set device's ringer state to true.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

searchNewDevicesAsync

• searchNewDevicesAsync(): Promise<void>

• Search for available Bluetooth devices which are switched on, within range and ready to connect.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

setAutoPairingAsync

• setAutoPairingAsync(value: boolean): Promise<void>

• When Bluetooth adapter is plugged into the PC it will attempt to connect with the last connected Bluetooth device. If it cannot connect, it will automatically search for new Bluetooth devices to connect to.

  Parameters

  • value: boolean

    enable or disable for auto pairing.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

setBTLinkQualityChangeEventsEnabledAsync

• setBTLinkQualityChangeEventsEnabledAsync(enable: boolean): Promise<void>

• Enables or disables Bluetooth Link Quality Change Events (onBluetoothLinkQualityChangeEvent).

  Parameters

  • enable: boolean

  Returns Promise<void>

  • Resolves to void on success, rejects with JabraError on error.

setBTPairingAsync

• setBTPairingAsync(): Promise<void>

• Set the Bluetooth device in pairing mode.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

setBrightnessLevelAsync

• setBrightnessLevelAsync(Level: number): Promise<void>

• Sets the brightness level on a camera device

  Parameters

  • Level: number

  Returns Promise<void>

  • Resolves to void on success, rejects with JabraError on error.

setBusyLightStatusAsync

• setBusyLightStatusAsync(status: boolean): Promise<void>

• Set busylight status (Async).

  Parameters

  • status: boolean

    Boolean value to set busylight on / off.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

setContrastLevelAsync

• setContrastLevelAsync(Level: number): Promise<void>

• Sets the contrast level on a camera device

  Parameters

  • Level: number

  Returns Promise<void>

  • Resolves to void on success, rejects with JabraError on error.

setDECTPairingKeyAsync

• setDECTPairingKeyAsync(pairingKey: number): Promise<void>

• Write the secure DECT pairing key to a USB connected headset.

  Parameters

  • pairingKey: number

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with JabraError.

setDateTimeAsync

• setDateTimeAsync(timedate: DateTime): Promise<void>

• Sets the defined date and time on device (Async).

  Parameters

  • timedate: DateTime

    Date/time setting to be set on device

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

setEqualizerParametersAsync

• setEqualizerParametersAsync(bands: Array<number>): Promise<void>

• Set equalizer parameters

  Parameters

  • bands: Array<number>

    Caller-owned array containing the band gains to set in dB (must be within range of +/- max_gain).

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

setHidWorkingStateAsync

• setHidWorkingStateAsync(hidState: enumHidState): Promise<void>

• Sets the HID working state to either standard HID (usb.org HID specification) or GN HID.

  Parameters

  • hidState: enumHidState

    state HID working state (enumHidState)

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

setIntelligentZoomLatencyAsync

• setIntelligentZoomLatencyAsync(latency: enumIntelligentZoomLatency): Promise<void>

• Controls how often the camera is allowed to change speaker focus.

  Parameters

  • latency: enumIntelligentZoomLatency

    The minimum time in seconds to stay with a participant before being allowed to change zoom/direction. Valid range 0-30 seconds.

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error

setNetworkAuthenticationIdentityAsync

• setNetworkAuthenticationIdentityAsync(interf: enumNetworkInterface, username: string, password: string): Promise<void>

• Set the current IEEE 802.1x network authentication identity (username/password) for a given interface

  Parameters

  • interf: enumNetworkInterface

    The interface (Ethernet / WLAN)

  • username: string

    The username / identity

  • password: string

    The password

  Returns Promise<void>

  • Resolves void on success, rejects with JabraError if an error occurs.

setNetworkAuthenticationModeAsync

• setNetworkAuthenticationModeAsync(interf: enumNetworkInterface, mode: enumNetworkAuthMode): Promise<void>

• Set the current IEEE 802.1x network authentication mode for a given interface

  Parameters

  • interf: enumNetworkInterface

    The interface (Ethernet / WLAN)

  • mode: enumNetworkAuthMode

    The authentication mode

  Returns Promise<void>

  • Resolves void on success, rejects with JabraError if an error occurs.

setNotificationStyleAsync

• setNotificationStyleAsync(style: enumNotificationStyle): Promise<void>

• Sets the style of notifications on a video device

  Parameters

  • style: enumNotificationStyle

  Returns Promise<void>

  • Resolves to void on success, rejects with JabraError on error.

setNotificationUsageAsync

• setNotificationUsageAsync(style: enumNotificationUsage): Promise<void>

• Sets when notifications are active on a video device

  Parameters

  • style: enumNotificationUsage

  Returns Promise<void>

  • Resolves to void on success, rejects with JabraError on error.

setOnlineAsync

• setOnlineAsync(online: boolean): Promise<void>

• It opens radio link between base/dongle and device.

  Parameters

  • online: boolean

    Boolean value to set Online On/Off

  Returns Promise<void>

  • Resolve void if successful otherwise Reject with error.

setPanTiltAsync

• setPanTiltAsync(panTilt: PanTilt): Promise<void>

• Controls the device's camera pan-tilt functionality.

  Parameters

  • panTilt: PanTilt

  Returns Promise<void>

  • Resolves to void on success, rejects with JabraError on error.

setPanTiltRelativeActionAsync

• setPanTiltRelativeActionAsync(action: PanTiltRelative): Promise<void>

• Starts or stops the relative pan and/or tilt action of the camera lens. Note that this method should be used in pairs: Initially to start the action (button down), next to stop the action (button up).

  Parameters

  • action: PanTiltRelative

  Returns Promise<void>

  • Resolves to void on success, rejects with JabraError on error.

setPasswordProvisioningAsync

• setPasswordProvisioningAsync(password: string): Promise<void>

• Sets the password for provisioning

  Parameters

  • password: string

    The password

  Returns Promise<void>

  • Resolves to void on success, rejects with JabraError if an error occurs.

setPictureInPictureAsync