Library Interfaces
Common.h: Common interfaces for devices
| API Name | Description |
|---|---|
| Jabra_GetVersion | Gets the version of the SDK library |
| Jabra_SetAppID | Application should set the application name using this interface. The Client ID/App ID must be obtained by registering to Jabra portal by App developers. This is a mandatory step, which needs to be done before initialization, failing which, callbacks will not be registered with SDK |
| Jabra_InitializeV2 | Initializes the Jabra library. Argument details to the function are described here: Library Initialization. |
| Jabra_Uninitialize | Performs library memory cleanup |
| Jabra_IsFirstScanForDevicesDone | Checks if device scan during initialization is done. It is recommended to register for the corresponding callback during initialization |
| Jabra_IsDeviceAttached | Checks if a device is attached. It is recommended to register for the corresponding callback during initialization |
| Jabra_GetAttachedJabraDevices | Gets the list of attached Jabra devices |
| Jabra_GetBatteryStatus | Queries the current battery status with info of charging state and low battery indication. Only supported by devices with a battery |
| Jabra_GetRemoteControlBatteryStatus | Get remote control battery status, if supported by device |
| Jabra_GetDeviceImagePath | Gets the path for the image of the device. The image is provided by Jabra Cloud service (and stored in the device’s local directory) and hence requires network access for the first time |
| Jabra_GetDeviceImageThumbnailPath | Gets the path for the thumbnail image of the device. The image is provided by Jabra Cloud service (and stored in the device’s local directory) and hence requires network access for the first time |
| Jabra_GetDeviceHiresImagePath | Gets the path for the high resolution image of the device. The image is provided by Jabra Cloud service (and stored in the device’s local directory) and hence requires network access for the first time |
| Jabra_FreeDeviceInfo | Frees the device information structure members. This is called right after handling device attach event by the application |
| Jabra_ConnectToJabraApplication | Integrates softphone app to Jabra applications like Jabra Direct (JD) |
| Jabra_DisconnectFromJabraApplication | Disconnects the Jabra SDK application from Jabra Direct |
| Jabra_SetSoftphoneReady | Sets the softphone to ready |
| Jabra_IsSoftphoneInFocus | Indicates whether the softphone is in focus |
| Jabra_GetErrorString | Returns the error string from the error status |
| Jabra_IsBusylightSupported | Checks if busylight is supported by the device |
| Jabra_GetBusylightStatus | Checks the status of busylight |
| Jabra_SetBusylightStatus | Enables/Disables the busylight status |
| Jabra_RegisterBusylightEvent | Registration of callback to receive busylight events |
| Jabra_IsManualBusylightSupported | Checks if manual busy lights is supported |
| Jabra_GetManualBusylightStatus | Gets the value of the manual busy lights |
| Jabra_SetManualBusylightStatus | Sets the value of the manual busy lights |
| Jabra_RegisterManualBusylightEvent | Register a callback for busy lights events |
| Jabra_IsRemoteMMISupported | Checks if remote MMI feature is supported by the device |
| Jabra_GetButtonFocus | Configures the remote MMI events for a device |
| Jabra_ReleaseButtonFocus | Releases the remote MMI events configured in the device |
| Jabra_GetSupportedButtonEvents | Gets the supported remote MMI for a device |
| Jabra_FreeButtonEvents | Free the memory allocated for the button events |
| Jabra_RegisterForGNPButtonEvent | Register callback function to get notified on GNP Button events |
| Jabra_ConfigureLogging | API to configure the logging of events |
| Jabra_RegisterLoggingCallback | Register callback function for logging |
| Jabra_GetESN | Gets ESN (electronic serial number) of the device |
| Jabra_GetCurrentLanguageCode | Gets the language code for the current language of the device |
| Jabra_IsLeftEarbudStatusSupported | Checks if left earbud status supported by the device |
| Jabra_GetLeftEarbudStatus | Gets left earbud connection status of the device |
| Jabra_RegisterLeftEarbudStatus | Registers left earbud connection status event. Can only be called when a device is attached |
| Jabra_RegisterHearThroughSettingChangeHandler | Registers HearThrough setting change event. Can only be called when a device is attached |
| Jabra_IsEqualizerSupported | Checks if equalizer is supported by the device |
| Jabra_IsEqualizerEnabled | Checks if equalizer is enabled in the device |
| Jabra_EnableEqualizer | Enables/disables equalizer in the device |
| Jabra_GetEqualizerParameters | Gets equalizer parameters for a device |
| Jabra_SetEqualizerParameters | Set equalizer parameters for a device |
| Jabra_GetNpsUrl | Get the NPS URL based on device, app name and app version |
| Jabra_ProductRegistration | Registers a product with the provided information |
| Jabra_ExecuteAVRCPCommand | Tells the device to execute a AVRCP command |
| Jabra_Reconnect | Recreates the session, Input and Output streams for all devices which are connected to the phone and not to the app |
| Jabra_IsFeatureSupported | Checks if a feature is supported by a device |
| Jabra_GetSupportedFeatures | Gets array of features supported by a device |
| Jabra_FreeSupportedFeatures | Frees a list of features obtained by calling Jabra_GetSupportedFeatures |
| Jabra_GetMultiESN | Get ESN for all device components |
| Jabra_FreeMap | Release memory allocated by functions returning a Map_Int_String* |
| Jabra_RequestNoHangupToneNextTime | Request that the headset does not play its 'end of call' tone when the SCO closes next time |
| Jabra_IsCertifiedForSkypeForBusiness | Indicates whether the device is certified for Skype for Business |
| Jabra_FreeCharArray | Free a char array |
| Jabra_IsUploadRingtoneSupported | Checks if ringtone upload is supported by the device |
| Jabra_UploadRingtone | Upload ringtone to device |
| Jabra_RegisterUploadProgress | Registration for upload progress event |
| Jabra_IsUploadImageSupported | Checks if image upload is supported by the device |
| Jabra_UploadImage | Upload image to device |
| Jabra_IsSetDateTimeSupported | Checks if date and time synchronization is supported by the device |
| Jabra_SetDateTime | Set date and time to device |
| Jabra_GetDateTime | Get date and time from device |
| Jabra_GetSupportedDeviceEvents | Supported events by device |
| Jabra_SetSubscribedDeviceEvents | Set device events to subscribe to |
| Jabra_GetAudioFileParametersForUpload | Get details of audio file for uploading to device |
| Jabra_UploadWavRingtone | Upload ringtone to device in .wav format |
| Jabra_GetReturnCodeString | Returns the descriptive string from the return code |
| Jabra_RegisterBatteryStatusUpdateCallback | Registers for battery status update callback |
| Jabra_IsSettingProtectionEnabled | Checks if setting protection is enabled in the device |
| Jabra_GetNpsUrlForApplication | Get the NPS URL for the application only |
| Jabra_EnableDevLog | Enables/disables logging for a device |
| Jabra_IsDevLogEnabled | Checks if logging is enabled in device |
| Jabra_RegisterDevLogCallback | Register callback function to get notified on device events |
| Jabra_GetRemoteMmiTypes | Gets a list of supported remote MMIs |
| Jabra_FreeRemoteMmiTypes | Frees/deallocates the memory area allocated by Jabra_GetRemoteMmiTypes() |
| Jabra_IsRemoteMmiInFocus | Gets the status of the remote MMI focus |
| Jabra_GetRemoteMmiFocus | Gets the focus of the remote MMI specified |
| Jabra_ReleaseRemoteMmiFocus | Releases the focus of the remote MMI specified |
| Jabra_SetRemoteMmiAction | Sets an output action on the remote MMI |
| Jabra_RegisterRemoteMmiCallback | Registers for remote MMI event callback |
| Jabra_GetPanics | Get the panic list |
| Jabra_FreePanicListType | Frees the Jabra_PanicListType structure |
| Jabra_SetTimestamp | Sets a static timestamp in the device |
| Jabra_GetTimestamp | Gets the static timestamp in the device |
| Jabra_PreloadDeviceInfo | Preloads the configuration cache with the content of the specified archive |
| Jabra_PreloadAttachedDeviceInfo | Preloads the resources of a specific attached device with the contents of the specified archive |
| Jabra_GetLocalManifestVersion | Gets the Manifest Files' version that are locally |
| Jabra_PlayRingtone | Play Ringtone in Device |
| Jabra_SetWizardMode | Sets the wizard mode |
| Jabra_GetWizardMode | Reads the current wizard mode |
| Jabra_SetHidEventsFromNonJabraDevices | Enable Hid events from non Jabra devices |
| Jabra_IsHidEventsFromNonJabraDevicesEnabled | Is Hid events from non Jabra devices enabled |
| Jabra_SetStdHidEventsFromJabraDevices | Enable Hid events from Jabra devices |
| Jabra_IsStdHidEventsFromJabraDevicesEnabled | Is Hid events from Jabra devices enabled |
| Jabra_GetCustomerSupportUrl | Get the URL for contacting Jabra customer support |
| Jabra_GetSku | Get device SKU (stock keeping unit) |
| Jabra_GetBatteryStatusV2 | Get battery status, if supported by device |
| Jabra_CopyJabraBatteryStatus | Copy the content of a Jabra_BatteryStatus struct |
| Jabra_FreeBatteryStatus | Frees the Jabra_BatteryStatus |
| Jabra_RegisterBatteryStatusUpdateCallbackV2 | Register for battery status update callback |
| Jabra_SetJackConnectorStatusListener | Subscribe/unsubscribe to JackStatus events |
| Jabra_SetHeadDetectionStatusListener | Subscribe/unsubscribe to HeadDetectionStatus events |
| Jabra_SetLinkConnectionStatusListener | Subscribe/unsubscribe to LinkConnectionStatus events |
| Jabra_RebootDevice | Reboot the device |
| Jabra_GetLock | Get lock for a particular device |
| Jabra_ReleaseLock | Release the lock for a particular device |
| Jabra_IsLocked | Check if the lock on device is acquired by us |
| Jabra_DectPair | Start insecure pairing mode, equivalent to pushing the pair button on the DECT base |
| Jabra_DectPairSecure | Start DECT secure pairing on USB connected DECT headset. To be used after keys have been exchanged using Jabra_GetDectPairKey and Jabra_SetDectPairKey |
| Jabra_GetDectPairKey | Read the secure pairing key from a DECT base/dongle |
| Jabra_SetDectPairKey | Write the secure DECT pairing key to a USB connected headset |
| Jabra_GetConnectedHeadsetNames | Reads the device name(s) of all connected BT or DECT headsets |
| Jabra_GetUserDefinedDeviceName | Gets the user-defined device name |
| Jabra_GetPanicCodes | Gets the panic codes stored in the device |
| Jabra_ClearPanicCodes | Clear the list of panic codes stored in the device |
| Jabra_GetSubDeviceProperty | Gets a specific property from the device or a sub device (i.e. a connected headset) |
Interface_AmbienceModes.h: Ambience mode interfaces
| API Name | Description |
|---|---|
| Jabra_GetAmbienceMode | Get the ambience mode |
| Jabra_SetAmbienceMode | Set the ambience mode |
| Jabra_GetSupportedAmbienceModes | Get the list of supported ambience levels for a device |
| Jabra_GetSupportedAmbienceModeLevels | Get the levels supported by a specific ambience mode |
| Jabra_GetAmbienceModeLevel | Get the level for a specific ambience mode |
| Jabra_SetAmbienceModeLevel | Set the level for a specific ambience mode |
| Jabra_GetSupportedAmbienceModeBalance | Get the supported range for left/right balance for a specific ambience mode |
| Jabra_GetAmbienceModeBalance | Get the left/right balance for a specific ambience mode |
| Jabra_SetAmbienceModeBalance | Set the left/right balance for a specific ambience mode |
| Jabra_GetAmbienceModeNoiseLevel | Get the noise level for the currently active ambience mode |
| Jabra_GetAmbienceModeSetting | Get whether a specific setting is enabled for a given ambience mode |
| Jabra_SetAmbienceModeSetting | Enable or diasable a specific setting for a given ambience mode |
| Jabra_GetAmbienceModeLoop | Get the current ambience mode loop |
| Jabra_SetAmbienceModeLoop | Set the current ambience mode loop |
| Jabra_SetAmbienceModeChangeListener | Register a listener for the ambience mode change event |
Interface_Bluetooth.h: Bluetooth interfaces
| API Name | Description |
|---|---|
| Jabra_SetBTPairing | Sets the Bluetooth device into pairing mode |
| Jabra_SearchNewDevices | Query for available Bluetooth devices which are switched on, within range and ready to connect |
| Jabra_GetSearchDeviceList | Gets the list of new devices which are available to pair & connect |
| Jabra_StopBTPairing | Stops the search for available Bluetooth devices |
| Jabra_SetAutoPairing | Enables/disables auto pairing. 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 if auto pairing is set |
| Jabra_GetAutoPairing | Queries whether auto pairing mode is enabled or disabled |
| Jabra_ClearPairingList | Clears the list of paired Bluetooth devices to the Bluetooth adapter |
| Jabra_ConnectBTDevice | Connect/Reconnect Bluetooth device to the Jabra Bluetooth adapter. Ensure the Bluetooth device is switched on and within range |
| Jabra_ConnectNewDevice | Connects to Bluetooth device with specified device details |
| Jabra_DisconnectBTDevice | Disconnects Bluetooth device from Bluetooth adapter |
| Jabra_GetConnectedBTDeviceName | Queries the name of connected Bluetooth device with Bluetooth Adapter |
| Jabra_ConnectPairedDevice | Connect a device which was already paired |
| Jabra_RegisterPairingListCallback | Register callback to receive list of paired devices with BT adapter |
| Jabra_IsPairingListSupported | Checks if pairing list is supported by the device |
| Jabra_GetPairingList | Gets the list of devices which are paired previously to Bluetooth adapter |
| Jabra_FreePairingList | Frees the memory allocated for the list of paired devices |
| Jabra_DisConnectPairedDevice | Disconnect a paired device |
| Jabra_ClearPairedDevice | Clears the specified device from paired device list |
| Jabra_GetSecureConnectionMode | Gets the secure connection mode for a dongle device |
| Jabra_SetLinkQualityStatusListener | Subscribe/unsubscribe to Bluetooth link quality change events |
Interface_Firmware.h: Firmware interfaces
| API Name | Description |
|---|---|
| Jabra_GetDetailedDeviceLanguageInformation | Get detailed information regarding language packs installed on device |
| Jabra_FreeLanguagePackStats | Free memory allocated by Jabra_GetDetailedDeviceLanguageInformation |
| Jabra_GetFirmwareVersionBundle | Get firmware versions of the dongle/base and the connected headset |
| Jabra_GetFirmwareVersion | Returns the firmware version of the specified Jabra device |
| Jabra_GetRemoteControlFirmwareVersion | Get firmware version of a device remote control |
| Jabra_IsFirmwareLockEnabled | Checks if firmware lock is enabled in the device |
| Jabra_EnableFirmwareLock | Enable or disable firmware up-and-downgrade lock |
| Jabra_CheckForFirmwareUpdate | Checks if any latest firmware is available on the server |
| Jabra_GetLatestFirmwareInformation | Gives the latest available firmware on the server based on user request |
| Jabra_FreeFirmwareInfo | Frees the memory allocated for the firmware information |
| Jabra_DownloadFirmware | Downloads the selected firmware version |
| Jabra_GetFirmwareFilePath | Gets the file path where the firmware file for the respective version has been downloaded |
| Jabra_UpdateFirmware | Updates the firmware of the device to the firmware version specified |
| Jabra_CancelFirmwareDownload | Cancels the firmware download |
| Jabra_RegisterFirmwareProgressCallBack | Registers firmware progress callback to get notified about firmware download progress |
| Jabra_GetAllFirmwareInformation | Gets information of all the firmwares present in cloud for the specific device |
| Jabra_FreeFirmwareInfoList | Frees the list of firmware information structure |
| Jabra_DownloadFirmwareUpdater | Downloads the latest FW updater relevant for this device |
Interface_Video.h: Video interfaces
| API Name | Description |
|---|---|
| Jabra_SetPanTilt | Sets the current pan and tilt positions |
| Jabra_GetPanTilt | Gets the current pan and tilt positions |
| Jabra_GetPanTiltLimits | Gets the pan and tilt limits |
| Jabra_SetPanTiltRelativeAction | Starts or stops the relative pan/tilt action of the camera lens |
| Jabra_SetZoomRelativeAction | Starts or stops the relative zoom action of the camera lens |
| Jabra_SetZoom | Sets the zoom level |
| Jabra_GetZoom | Gets the zoom level |
| Jabra_GetZoomLimits | Gets the zoom limit values |
| Jabra_SetIntelligentZoomLatency | Controls how often the camera is allowed to change speaker focus |
| Jabra_GetIntelligentZoomLatency | Gets how often the camera is allowed to change speaker focus |
| Jabra_NextIntelligentZoomMode | Cycles to the next Intelligent Zoom mode |
| Jabra_SetSecondVideoStream | Controls what is shown on the secondary video stream |
| Jabra_GetSecondVideoStream | Gets what is shown on the secondary video stream |
| Jabra_SetVideoHDRDefault | Enables or disables the default HDR mode |
| Jabra_GetVideoHDRDefault | Gets the default HDR enable state |
| Jabra_SetVideoHDR | Enables or disables the active HDR mode |
| Jabra_GetVideoHDR | Gets the active HDR enable state |
| Jabra_RestoreVideoRoomDefaults | Resets the video controls like when a new call is started |
| Jabra_SetContrastLevel | Sets the contrast level |
| Jabra_SetSharpnessLevel | Sets the sharpness level |
| Jabra_SetBrightnessLevel | Sets the brightness level |
| Jabra_SetSaturationLevel | Sets the saturation level |
| Jabra_SetWhiteBalance | Sets the white balance |
| Jabra_GetContrastLevel | Gets the contrast level |
| Jabra_GetSharpnessLevel | Gets the sharpness level |
| Jabra_GetBrightnessLevel | Gets the brightness level |
| Jabra_GetSaturationLevel | Gets the saturation level |
| Jabra_GetWhiteBalance | Gets the white balance |
| Jabra_GetContrastLimits | Gets the limits of the contrast setting |
| Jabra_GetSharpnessLimits | Gets the limits of the sharpness setting |
| Jabra_GetWhiteBalanceLimits | Gets the limits of the white balance setting |
| Jabra_GetSaturationLimits | Gets the limits of the saturation setting |
| Jabra_GetBrightnessLimits | Gets the limits of the brightness setting |
| Jabra_SetVideoTransitionStyle | Sets the active video transition style when using Intelligent Zoom |
| Jabra_GetVideoTransitionStyle | Gets the active video transition style when using Intelligent Zoom |
| Jabra_SetRoomCapacity | Sets the room capacity |
| Jabra_GetRoomCapacity | Gets the room capacity |
| Jabra_SetRoomCapacityNotificationEnabled | Enables/disables room capacity notifications |
| Jabra_GetRoomCapacityNotificationEnabled | Gets whether room capacity notifications are enabled |
| Jabra_GetPeopleCount | Gets the current people count |
| Jabra_GetPeopleCountSettings | Gets the current mode for people count and people count notifications |
| Jabra_SetPeopleCountSettings | Sets the current mode for people count and people count notifications |
| Jabra_SetNotificationStyle | Sets the notification style |
| Jabra_GetNotificationStyle | Gets the notification style |
| Jabra_SetNotificationUsage | Sets when notifications are enabled |
| Jabra_GetNotificationUsage | Gets when notifications are enabled |
| Jabra_SetVideoMode | Select how the video viewport is managed (runtime) |
| Jabra_GetVideoMode | Gets how the video viewport is managed (runtime) |
| Jabra_IsVideoDeviceStreaming | Get whether the device is currently streaming video or audio |
| Jabra_StorePTZPreset | To store a PTZ (Pan, Tilt and Zoom) preset to the designated slot on the device |
| Jabra_ApplyPTZPreset | To apply the PTZ preset from the designated slot on the device |
| Jabra_StoreColorControlPreset | To store the color control preset on the device |
| Jabra_ApplyColorControlPreset | To apply the color control preset from the device |
| Jabra_GetPictureInPicture | Gets the Picture-In-Picture enable state (runtime) |
| Jabra_SetPictureInPicture | Sets the Picture-In-Picture enable state (runtime) |
| Jabra_ResetImageQualityControls | Resets the color controls (brightness, contrast, sharpness, saturation and white balance) |
| Jabra_ResetPanTiltZoom | Resets the values for pan, tilt and zoom |
| Jabra_GetSensorRegions | Gets the regions/boundaries of the individual camera sensors. These are relevant in order to set up the white board |
| Jabra_RegisterCameraStatusCallback | Registration for camera status event callback |
| Jabra_GetUSBState | Gets USB connection state for video device |
Interface_Whiteboard.h: Whiteboard interfaces
| API Name | Description |
|---|---|
| Jabra_SetWhiteboardPosition | Set the positions in pixels of a whiteboard's corners |
| Jabra_GetWhiteboardPosition | Gets the positions in pixels of a whiteboard's corners |
| Jabra_SetWhiteboardOnMainStream | Set whether the main stream shows the whiteboard |
| Jabra_GetWhiteboardOnMainStream | Get whether the main stream shows the whiteboard |
Interface_Network.h: Network interfaces
| API Name | Description |
|---|---|
| Jabra_EnableRemoteManagement | Enables or disables remote management |
| Jabra_IsRemoteManagementEnabled | Get whether remote management is enabled |
| Jabra_GetXpressManagementNetworkStatus | Gets the resulting libcurl errorcode and message from the last call to Jabra_ConfigureXpressManagement if it returned NetworkRequest_Fail |
| Jabra_ConfigureXpressManagement | Configures Xpress management related settings on a network-capable device |
| Jabra_SetXpressUrl | Set Xpress server URL |
| Jabra_GetXpressUrl | Get Xpress server URL |
| Jabra_SetPasswordProvisioning | Set password for password provisioning |
| Jabra_GetPasswordProvisioning | Get the password for provisioning |
| Jabra_NotifyXpressConnectionStatus | Notify the app connected to an Xpress capable device whether device is being remotely managed |
| Jabra_NotifyXpressConnectionStatusExtended | Notify the app connected to an Xpress capable device whether device is being remotely managed |
| Jabra_RegisterXpressConnectionStatusCallback | Registration for Xpress connection status change callback |
| Jabra_RegisterXpressConnectionStatusExtendedCallback | Registration for Xpress connection status change callback |
| Jabra_GetEthernetIPv4Status | Gets the status of the Ethernet connection; Enable, DHCP, Connected states and IP + subnet mask |
| Jabra_GetWLANIPv4Status | Gets the status of the WLAN connection; Enable, DHCP, Connected states and IP + subnet mask |
| Jabra_RegisterNetworkStatusChangedCallback | Registration for network interface status change callback |
| Jabra_GetMACAddress | Gets the MAC address of an interface |
| Jabra_GetDiagnosticLogFile | Gets the diagnostic log file and writes it to a file on local file system |
| Jabra_TriggerDiagnosticLogGeneration | Trigger generation of diagnostic log |
| Jabra_RegisterDiagnosticLogCallback | Registration for diagnostic log event |
| Jabra_SetNetworkAuthenticationMode | Configure IEEE 802.1X network authentication mode for network interface |
| Jabra_GetNetworkAuthenticationMode | Get current IEEE 802.1X network authentication mode for network interface |
| Jabra_SetNetworkAuthenticationIdentity | Configure IEEE 802.1X identity for a network interface |
Interface_Constants.h: Device constants
| API Name | Description |
|---|---|
| Jabra_GetConstants | Get the constants defined for a device |
| Jabra_GetConst | Get a Jabra_Const value from the Jabra_Constants collection |
| Jabra_ReleaseConst | Release the data inside a Jabra_Const |
| Jabra_IsInt | Returns true if argument is an integer |
| Jabra_IsBool | Returns true if argument is a boolean |
| Jabra_IsString | Returns true if argument is a string |
| Jabra_IsStruct | Returns true if argument is a struct |
| Jabra_IsList | Returns true if argument is a list |
| Jabra_AsInt | Interprets a Jabra_Const as an integer |
| Jabra_AsBool | Interprets a Jabra_Const as a boolean |
| Jabra_AsString | Gets the string content of a Jabra_Const |
| Jabra_GetField | Get a field from a Jabra_Const struct |
| Jabra_ListElement | Get an element by index from a Jabra_Const list |
JabraDeviceConfig.h: Device setting interfaces
| API Name | Description |
|---|---|
| Jabra_GetSettings | Gets the attached Jabra device setting. Returns pointer to the device settings structure containing all settings for a particular device |
| Jabra_FreeDeviceSettings | Once the device setting is requested by the application, memory needs to be freed by calling this API by the application |
| Jabra_SetSettings | Updates/Sets the setting details of the attached Jabra device. Returns a return code to indicate if settings were applied successfully or not |
| Jabra_FreeString | Once the device image path is requested, application needs to release the memory by calling this API to prevent memory leak |
| Jabra_GetFailedSettingNames | Queries the list of failed setting names |
| Jabra_FreeFailedSettings | Memory of failed setting names can be released by the application using this interface to prevent memory leak |
| Jabra_SetSettingsChangeListener | Add a listener for changes to the device settings. The listener will be called when a setting is changed in the device, regardless of who changed it (this instance, another instance, or the user through MMI). |
| Jabra_IsFactoryResetSupported | Returns whether the device supports factory reset |
| Jabra_FactoryReset | Restores to factory settings of the device |
| Jabra_FreeDeviceSettings | Memory allocated to device settings can be released by the application using this interface to prevent memory leak |
| Jabra_GetSetting | Gets the unique setting identified by a GUID of a device |
| Jabra_GetNamedAsset | Requests a named asset for the specified device |
| Jabra_FreeAsset | Releases an asset previously obtained with Jabra_GetNamedAsset() |
JabraNativeHID.h: Interfaces for Call Control
| API Name | Description |
|---|---|
| Jabra_IsOffhookSupported | Returns true if off hook is supported for a specific Jabra device |
| Jabra_SetOffhook | Set the specified device off hook/on hook |
| Jabra_IsRingerSupported | Returns true if ringer is supported for a specific Jabra device |
| Jabra_SetRinger | Set ringer on/off for the specified device |
| Jabra_IsMuteSupported | Returns true if ringer is supported for a specific Jabra device |
| Jabra_SetMute | Set mute on/off for the specified device |
| Jabra_IsHoldSupported | Returns true if hold is supported for a specific Jabra device |
| Jabra_SetHold | Set hold on/off for the specified device |
| Jabra_IsOnlineSupported | Returns true if online mode is supported for a specific Jabra device |
| Jabra_SetOnline | Turn online mode on/off for a wireless headset. Online mode opens an audio link (radio link) between a base/dongle and a headset |
| Jabra_WriteHIDCommand | Interface for sending HID output reports with device ID, Usage Page and Usage. This function is for advanced users. It is recommended to use the dedicated functions: Jabra_SetOffHook, Jabra_SetRinger, Jabra_SetMute, Jabra_SetHold, and Jabra_SetOnline |
| Jabra_IsGnHidStdHidSupported | Returns true if the device supports Gn HID and Std HID and able to switch between them |
| Jabra_GetHidWorkingState | Gets the HID working state |
| Jabra_SetHidWorkingState | Sets the HID working state to either standard HID (usb.org HID specification) or GN HID. HID Events will (default) NOT be triggered for standard HID to avoid conflicts |