Class LogitechDeviceProvider

Represents the abstract base implementation for a IRGBDeviceProvider.

Inheritance

object

AbstractRGBDeviceProvider

LogitechDeviceProvider

Implements

IRGBDeviceProvider

IDisposable

Inherited Members

AbstractRGBDeviceProvider.IsInitialized

AbstractRGBDeviceProvider.ThrowsExceptions

AbstractRGBDeviceProvider.InternalDevices

AbstractRGBDeviceProvider.Devices

AbstractRGBDeviceProvider.UpdateTriggerMapping

AbstractRGBDeviceProvider.UpdateTriggers

AbstractRGBDeviceProvider.Exception

AbstractRGBDeviceProvider.DevicesChanged

AbstractRGBDeviceProvider.Initialize(RGBDeviceType, bool)

AbstractRGBDeviceProvider.GetUpdateTrigger(int, double?)

AbstractRGBDeviceProvider.CreateUpdateTrigger(int, double)

AbstractRGBDeviceProvider.Reset()

AbstractRGBDeviceProvider.AddDevice(IRGBDevice)

AbstractRGBDeviceProvider.RemoveDevice(IRGBDevice)

AbstractRGBDeviceProvider.Throw(Exception, bool)

AbstractRGBDeviceProvider.OnException(ExceptionEventArgs)

AbstractRGBDeviceProvider.OnDevicesChanged(DevicesChangedEventArgs)

AbstractRGBDeviceProvider.Dispose()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: RGB.NET.Devices.Logitech

Assembly: RGB.NET.Devices.Logitech.dll

Syntax

public class LogitechDeviceProvider : AbstractRGBDeviceProvider, IRGBDeviceProvider, IDisposable

Constructors

| Edit this page View Source

LogitechDeviceProvider()

Initializes a new instance of the LogitechDeviceProvider class.

Declaration

public LogitechDeviceProvider()

Exceptions

Type	Condition
InvalidOperationException	Thrown if this constructor is called even if there is already an instance of this class.

Properties

| Edit this page View Source

Instance

Gets the singleton LogitechDeviceProvider instance.

Declaration

public static LogitechDeviceProvider Instance { get; }

Property Value

Type	Description
LogitechDeviceProvider

| Edit this page View Source

PerDeviceDeviceDefinitions

Gets the HID-definitions for wired per-device-devices.

Declaration

public static HIDLoader<int, int> PerDeviceDeviceDefinitions { get; }

Property Value

Type	Description
HIDLoader<int, int>

| Edit this page View Source

PerDeviceWirelessDeviceDefinitions

Gets the HID-definitions for wireless per-device-devices.

Declaration

public static LightspeedHIDLoader<int, int> PerDeviceWirelessDeviceDefinitions { get; }

Property Value

Type	Description
LightspeedHIDLoader<int, int>

| Edit this page View Source

PerKeyDeviceDefinitions

Gets the HID-definitions for wired per-key-devices.

Declaration

public static HIDLoader<LogitechLedId, int> PerKeyDeviceDefinitions { get; }

Property Value

Type	Description
HIDLoader<LogitechLedId, int>

| Edit this page View Source

PerKeyWirelessDeviceDefinitions

Gets the HID-definitions for wireless per-key-devices.

Declaration

public static LightspeedHIDLoader<LogitechLedId, int> PerKeyWirelessDeviceDefinitions { get; }

Property Value

Type	Description
LightspeedHIDLoader<LogitechLedId, int>

| Edit this page View Source

PerZoneDeviceDefinitions

Gets the HID-definitions for wired per-zone-devices.

Declaration

public static HIDLoader<int, (LogitechDeviceType deviceType, int zones, int zoneOffset)> PerZoneDeviceDefinitions { get; }

Property Value

Type	Description
HIDLoader<int, (LogitechDeviceType deviceType, int zones, int zoneOffset)>

| Edit this page View Source

PerZoneWirelessDeviceDefinitions

Gets the HID-definitions for wireless per-zone-devices.

Declaration

public static LightspeedHIDLoader<int, (LogitechDeviceType deviceType, int zones, int zoneOffset)> PerZoneWirelessDeviceDefinitions { get; }

Property Value

Type	Description
LightspeedHIDLoader<int, (LogitechDeviceType deviceType, int zones, int zoneOffset)>

| Edit this page View Source

PossibleX64NativePaths

Gets a modifiable list of paths used to find the native SDK-dlls for x64 applications. The first match will be used.

Declaration

public static List<string> PossibleX64NativePaths { get; }

Property Value

Type	Description
List<string>

| Edit this page View Source

PossibleX86NativePaths

Gets a modifiable list of paths used to find the native SDK-dlls for x86 applications. The first match will be used.

Declaration

public static List<string> PossibleX86NativePaths { get; }

Property Value

Type	Description
List<string>

Methods

| Edit this page View Source

Dispose(bool)

Disposes the object and frees all resources.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	`true` if explicitely called through the Dispose-Method, `false` if called by the destructor.

Overrides

AbstractRGBDeviceProvider.Dispose(bool)

| Edit this page View Source

GetLoadedDevices(RGBDeviceType)

Loads devices and returns a filtered list of them.

Declaration

protected override IEnumerable<IRGBDevice> GetLoadedDevices(RGBDeviceType loadFilter)

Parameters

Type	Name	Description
RGBDeviceType	loadFilter	RGBDeviceType-flags to filter the device with.

Returns

Type	Description
IEnumerable<IRGBDevice>	The filtered collection of loaded devices.

Overrides

AbstractRGBDeviceProvider.GetLoadedDevices(RGBDeviceType)

Remarks

The underlying loading of the devices happens in LoadDevices().

| Edit this page View Source

InitializeSDK()

Initializes the underlying SDK.

Declaration

protected override void InitializeSDK()

Overrides

AbstractRGBDeviceProvider.InitializeSDK()

| Edit this page View Source

LoadDevices()

Loads all devices this device provider is capable of loading.

Declaration

protected override IEnumerable<IRGBDevice> LoadDevices()

Returns

Type	Description
IEnumerable<IRGBDevice>	A collection of loaded devices.