Class DeviceScannerModule

Namespace

NixUniversalSDK.Wrapper

Assembly

NixUniversalSDK.Wrapper.dll

Wrapper around a single IDeviceScanner instance

public class DeviceScannerModule

Inheritance

object

DeviceScannerModule

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Fields

DefaultMaxReportCount

Default / fallback value for the max report length from the ScanResultDelegate callback.

public const int DefaultMaxReportCount = 25

Field Value

int

DefaultMaxReportIntervalMs

Default / fallback value for the max reporting interval from the ScanResultDelegate callback.

public const int DefaultMaxReportIntervalMs = 250

Field Value

int

Properties

ScanResultDelegate

Delegate linked to the internal ScanResult event

public Delegates.StringValue? ScanResultDelegate { get; }

Property Value

Delegates.StringValue

Examples

An example handler is shown below:

void OnScanResult(string senderName, string resultsJson)
{
    // - `senderName` is "ScanResult"
    // - `resultsJson` is a JSON array of scan results
    // ...
}

The scan results are JSON formatted in the same manner as Scanner_GetSortedResults(int).

ScannerCreatedDelegate

Delegate linked to the internal ScannerCreated event

public Delegates.IntValue? ScannerCreatedDelegate { get; }

Property Value

Delegates.IntValue

Examples

An example handler is shown below:

void OnScannerCreated(string senderName, int deviceScannerState)
{
    // - `senderName` is "ScannerCreated"
    // - `deviceScannerState` is one of the 
    //   `DeviceScannerState` values
    // ...
}

ScannerStartedDelegate

Delegate linked to the internal ScannerStarted event

public Delegates.Empty? ScannerStartedDelegate { get; }

Property Value

Delegates.Empty

Examples

An example handler is shown below:

void OnScannerStarted(string senderName)
{
    // - `senderName` is "ScannerStarted"
    // ...
}

ScannerStoppedDelegate

Delegate linked to the internal ScannerStopped event

public Delegates.Empty? ScannerStoppedDelegate { get; }

Property Value

Delegates.Empty

Examples

An example handler is shown below:

void OnScannerStopped(string senderName)
{
    // - `senderName` is "ScannerStopped"
    // ...
}