Documentation
    Preparing search index...

    Interface PixelScannerOptions

    Available options for usePixelScannerNotify.

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

    Properties

    autoStart? keepAliveDuration? minUpdateInterval? scanFilter?

    Properties

    autoStart?: boolean

    If true, the scanner will start automatically on mount.

    true.
    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.

    5000 ms.
    minUpdateInterval?: number

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

    200 ms.
    scanFilter?: (item: ScannedDevice) => boolean

    Optional filter to only keep certain Pixels in the list.

    Settings

    Member Visibility

    On This Page

    Properties