WIP
DirectOutput framework for virtual pinball cabinets WIP
Go to:
Overview 
DirectOutput.Cab.Out.AdressableLedStrip.DirectStripControllerApi Class Reference

This class handles all communication with Direct StripControllers. More...

Public Member Functions

void ClearData ()
 Sends a clear data buffer command to the Ledstrip controller More...
 
void DisplayData (int Length)
 Sends a display data command to the ledstrip controller. More...
 
void SetAndDisplayData (byte[] Data)
 Sends the specified data to the ledstrip controller and displays the data. More...
 
void SetData (byte[] Data)
 Sends the specified data to the ledstripn controller. More...
 
byte[] ReadData (int Length)
 
void SetAndDisplayPackedData (byte[] Data)
 Packs the specified data, sends the data to the controller and displays the data. More...
 
void SetPackedData (byte[] Data)
 Packs the specified data using a IFF like compression and send the data to the ledstrip controller. More...
 
 DirectStripControllerApi ()
 Initializes a new instance of the DirectStripControllerApi class. More...
 
 DirectStripControllerApi (int ControllerNumber)
 Initializes a new instance of the DirectStripControllerApi class and opens a connection to the specified controller. More...
 
void Open (int ControllerNumber)
 Opens a connection to the ledstrip controller with the specified controller number. More...
 
void Close ()
 Closes a currently open connection to a ledstrip controller. More...
 

Static Public Member Functions

static List< int > GetAvailableControllerNumbers ()
 Gets a list of available ledstrip controller numbers. More...
 

Properties

int ControllerNumber [get]
 Gets the controller number. More...
 
bool DeviceIsPresent [get]
 Gets a value indicating whether the ledstrip controller is present. More...
 

Detailed Description

This class handles all communication with Direct StripControllers.

Definition at line 14 of file DirectStripControllerApi.cs.

Constructor & Destructor Documentation

DirectOutput.Cab.Out.AdressableLedStrip.DirectStripControllerApi.DirectStripControllerApi ( )

Initializes a new instance of the DirectStripControllerApi class.

Definition at line 237 of file DirectStripControllerApi.cs.

DirectOutput.Cab.Out.AdressableLedStrip.DirectStripControllerApi.DirectStripControllerApi ( int  ControllerNumber)

Initializes a new instance of the DirectStripControllerApi class and opens a connection to the specified controller.

Parameters
ControllerNumberThe controller number.

Definition at line 243 of file DirectStripControllerApi.cs.

Member Function Documentation

void DirectOutput.Cab.Out.AdressableLedStrip.DirectStripControllerApi.ClearData ( )

Sends a clear data buffer command to the Ledstrip controller

Definition at line 22 of file DirectStripControllerApi.cs.

void DirectOutput.Cab.Out.AdressableLedStrip.DirectStripControllerApi.Close ( )

Closes a currently open connection to a ledstrip controller.

Definition at line 469 of file DirectStripControllerApi.cs.

void DirectOutput.Cab.Out.AdressableLedStrip.DirectStripControllerApi.DisplayData ( int  Length)

Sends a display data command to the ledstrip controller.

Parameters
LengthThe length of the data to be displayed.

Definition at line 42 of file DirectStripControllerApi.cs.

static List<int> DirectOutput.Cab.Out.AdressableLedStrip.DirectStripControllerApi.GetAvailableControllerNumbers ( )
static

Gets a list of available ledstrip controller numbers.

Returns

Definition at line 497 of file DirectStripControllerApi.cs.

void DirectOutput.Cab.Out.AdressableLedStrip.DirectStripControllerApi.Open ( int  ControllerNumber)

Opens a connection to the ledstrip controller with the specified controller number.

Parameters
ControllerNumberThe controller number.

Definition at line 289 of file DirectStripControllerApi.cs.

byte [] DirectOutput.Cab.Out.AdressableLedStrip.DirectStripControllerApi.ReadData ( int  Length)

Definition at line 96 of file DirectStripControllerApi.cs.

void DirectOutput.Cab.Out.AdressableLedStrip.DirectStripControllerApi.SetAndDisplayData ( byte[]  Data)

Sends the specified data to the ledstrip controller and displays the data.

Parameters
DataThe data.

Definition at line 62 of file DirectStripControllerApi.cs.

void DirectOutput.Cab.Out.AdressableLedStrip.DirectStripControllerApi.SetAndDisplayPackedData ( byte[]  Data)

Packs the specified data, sends the data to the controller and displays the data.

Parameters
DataThe data.

Definition at line 130 of file DirectStripControllerApi.cs.

void DirectOutput.Cab.Out.AdressableLedStrip.DirectStripControllerApi.SetData ( byte[]  Data)

Sends the specified data to the ledstripn controller.

Parameters
DataThe data.

Definition at line 77 of file DirectStripControllerApi.cs.

void DirectOutput.Cab.Out.AdressableLedStrip.DirectStripControllerApi.SetPackedData ( byte[]  Data)

Packs the specified data using a IFF like compression and send the data to the ledstrip controller.

Parameters
DataThe data.

Definition at line 143 of file DirectStripControllerApi.cs.

Property Documentation

int DirectOutput.Cab.Out.AdressableLedStrip.DirectStripControllerApi.ControllerNumber
get

Gets the controller number.

The controller number.

Definition at line 258 of file DirectStripControllerApi.cs.

bool DirectOutput.Cab.Out.AdressableLedStrip.DirectStripControllerApi.DeviceIsPresent
get

Gets a value indicating whether the ledstrip controller is present.

true if device is present; otherwise, false.

Definition at line 271 of file DirectStripControllerApi.cs.


The documentation for this class was generated from the following file: