Interface PixelScannerOptions

Available options for usePixelScannerNotify.

interface PixelScannerOptions {
    autoStart?: boolean;
    keepAliveDuration?: number;
    minUpdateInterval?: number;
    scanFilter?: ((item: ScannedDevice) => boolean);
}

Properties

autoStart? keepAliveDuration? minUpdateInterval? scanFilter?

Properties

OptionalautoStart

autoStart?: boolean

If true, the scanner will start automatically on mount.

Default

true.

OptionalkeepAliveDuration

keepAliveDuration?: number

The duration in milliseconds for which a Scanned Pixel should be considered available since the last received advertisement. A value of 0 keeps the dice forever.

Default

5000 ms.

OptionalminUpdateInterval

minUpdateInterval?: number

Minimum interval in milliseconds between two React state updates. A value of 0 will generate a state update on every scan event.

Default

200 ms.

OptionalscanFilter

scanFilter?: ((item: ScannedDevice) => boolean)

Optional filter to only keep certain Pixels in the list.

Settings

Member Visibility

On This Page

Properties