BluetoothLEAdvertisementWatcher.SignalStrengthFilter Property

Reference

Definition

Namespace:: Windows.Devices.Bluetooth.Advertisement

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Gets or sets a BluetoothSignalStrengthFilter object used for configuration of Bluetooth LE advertisement filtering that uses signal strength-based filtering.

public:
 property BluetoothSignalStrengthFilter ^ SignalStrengthFilter { BluetoothSignalStrengthFilter ^ get(); void set(BluetoothSignalStrengthFilter ^ value); };

BluetoothSignalStrengthFilter SignalStrengthFilter();

void SignalStrengthFilter(BluetoothSignalStrengthFilter value);

public BluetoothSignalStrengthFilter SignalStrengthFilter { get; set; }

var bluetoothSignalStrengthFilter = bluetoothLEAdvertisementWatcher.signalStrengthFilter;
bluetoothLEAdvertisementWatcher.signalStrengthFilter = bluetoothSignalStrengthFilter;

Public Property SignalStrengthFilter As BluetoothSignalStrengthFilter

Property Value

BluetoothSignalStrengthFilter

Configuration of Bluetooth LE advertisement filtering that uses signal strength-based filtering.

Windows requirements

App capabilities

bluetooth

Remarks

The SignalStrengthFilter has additional limitations on its properties when used by the BluetoothLEAdvertisementWatcher class. An exception will be thrown when the watcher is started with parameters outside of the valid range. If the properties are left as NULL, a default value is selected.

The additional restrictions and default values are as follows:

InRangeThresholdInDBm - The maximum value for RSSI for Bluetooth LE is +20. The minimum value for RSSI for BR/EDR is -127 (default when NULL is -127.
OutOfRangeThresholdInDBm - The maximum value for RSSI for Bluetooth LE is +20. The minimum value for RSSI for BR/EDR is -127 (default when NULL is -127).
OutOfRangeTimeout - Equal or greater than 1 second and less than or equal to 60 seconds (default when NULL is 60 seconds).
SamplingInterval - Equal or greater than 0. Any sampling interval greater or equal to 25.5 seconds will disable sampling entirely. In that special case, the filtering is trigger-based. For more information about the behavior of the RSSI filtering, refer to the BluetoothSignalStrengthFilter.

Applies to