Class WS281XDeviceProvider

Represents the abstract base implementation for a IRGBDeviceProvider.

Inheritance
object
AbstractRGBDeviceProvider
WS281XDeviceProvider
Implements
Inherited Members
Namespace: RGB.NET.Devices.WS281X
Assembly: RGB.NET.Devices.WS281X.dll
Syntax
public sealed class WS281XDeviceProvider : AbstractRGBDeviceProvider, IRGBDeviceProvider, IDisposable

Constructors

| Edit this page View Source

WS281XDeviceProvider()

Initializes a new instance of the WS281XDeviceProvider class.

Declaration
public WS281XDeviceProvider()
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

DeviceDefinitions

Gets a list of all defined device-definitions.

Declaration
public List<IWS281XDeviceDefinition> DeviceDefinitions { get; }
Property Value
Type Description
List<IWS281XDeviceDefinition>
| Edit this page View Source

Instance

Gets the singleton WS281XDeviceProvider instance.

Declaration
public static WS281XDeviceProvider Instance { get; }
Property Value
Type Description
WS281XDeviceProvider

Methods

| Edit this page View Source

AddDeviceDefinition(IWS281XDeviceDefinition)

Adds the specified IWS281XDeviceDefinition to this device-provider.

Declaration
public void AddDeviceDefinition(IWS281XDeviceDefinition deviceDefinition)
Parameters
Type Name Description
IWS281XDeviceDefinition deviceDefinition

The IWS281XDeviceDefinition to add.
| 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
| Edit this page View Source

InitializeSDK()

Initializes the underlying SDK.

Declaration
protected override void InitializeSDK()
Overrides
| 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.
Overrides
Remarks

Filtering happens in GetLoadedDevices(RGBDeviceType).

Implements