Interface IDeviceController

Namespace

Jabra.NET.Sdk.ButtonCustomization

Assembly

Jabra.NET.Sdk.ButtonCustomization.dll

The device controller supports customizing a specific Jabra device. It provides access to buttons and LEDs that can be controlled on the device. Please note that LEDs that are part of a button must be controlled as a button through the IButton interface. This is the case even if it is only the LED that is controlled.

public interface IDeviceController

Methods

CloseAsync()

Close the device controller and release all opened buttons and LEDs.

Task CloseAsync()

Returns

Task

A task that completes when all open buttons and LEDs have been released.

GetButtonAsync(ButtonId)

Get the button with the specified ID. If the button is not supported by the device, an error is thrown.

Task<IButton> GetButtonAsync(ButtonId buttonId)

Parameters

buttonId ButtonId

The ID of the button to get.

Returns

Task<IButton>

The button represented by the specified ID, if it exists on the device.

GetControllableButtons()

Query the device about support for predefined button IDs. The returned observable will emit all buttons that can be controlled on the device and then complete.

IObservable<ButtonId> GetControllableButtons()

Returns

IObservable<ButtonId>

An observable that emits all buttons that can be controlled on the device.

GetControllableLeds()

Query the device about support for predefined LED IDs. The returned observable will emit all LEDs that can be controlled on the device and then complete.

IObservable<LedId> GetControllableLeds()

Returns

IObservable<LedId>

An observable that emits all LEDs that can be controlled on the device.

GetLedAsync(LedId)

Get the LED with the specified ID. If the LED is not supported by the device, an error is thrown.

Task<ILed> GetLedAsync(LedId ledId)

Parameters

ledId LedId

The ID of the LED to get.

Returns

Task<ILed>

The LED represented by the specified ID, if it exists on the device.

TryGetButtonAsync(ButtonId)

Try to get the button with the specified ID. If the button is not supported by the device, null is returned.

Task<IButton?> TryGetButtonAsync(ButtonId buttonId)

Parameters

buttonId ButtonId

The ID of the button to get.

Returns

Task<IButton>

The button represented by the specified ID, if it exists on the device. Otherwise, null.

TryGetLedAsync(LedId)

Try to get the LED with the specified ID. If the LED is not supported by the device, null is returned.

Task<ILed?> TryGetLedAsync(LedId ledId)

Parameters

ledId LedId

The ID of the LED to get.

Returns

Task<ILed>

The LED represented by the specified ID, if it exists on the device. Otherwise, null.