- addBeacon(Beacon) - Method in class org.altbeacon.beacon.service.RangeState
-
- addExtraDataParser(BeaconParser) - Method in class org.altbeacon.beacon.BeaconParser
-
Adds a BeaconParser used for parsing extra BLE beacon advertisement packets for
beacons that send multiple different advertisement packets (for example, Eddystone-TLM)
- addLocalRegion(Region) - Method in class org.altbeacon.beacon.service.MonitoringStatus
-
- addMeasurement(Integer) - Method in class org.altbeacon.beacon.service.ArmaRssiFilter
-
- addMeasurement(Integer) - Method in class org.altbeacon.beacon.service.RangedBeacon
-
- addMeasurement(Integer) - Method in interface org.altbeacon.beacon.service.RssiFilter
-
- addMeasurement(Integer) - Method in class org.altbeacon.beacon.service.RunningAverageRssiFilter
-
- addMonitorNotifier(MonitorNotifier) - Method in class org.altbeacon.beacon.BeaconManager
-
Specifies a class that should be called each time the BeaconService sees or
stops seeing a Region of beacons.
- addRangeNotifier(RangeNotifier) - Method in class org.altbeacon.beacon.BeaconManager
-
Specifies a class that should be called each time the BeaconService gets ranging
data, which is nominally once per second when beacons are detected.
- addRegion(Region, Callback) - Method in class org.altbeacon.beacon.service.MonitoringStatus
-
- addRegion(Region) - Method in class org.altbeacon.beacon.startup.RegionBootstrap
-
Add a new region
- AltBeacon - Class in org.altbeacon.beacon
-
The AltBeacon class represents a single hardware AltBeacon detected by
an Android device.
- AltBeacon(Beacon) - Constructor for class org.altbeacon.beacon.AltBeacon
-
Copy constructor from base class
- AltBeacon() - Constructor for class org.altbeacon.beacon.AltBeacon
-
- AltBeacon(Parcel) - Constructor for class org.altbeacon.beacon.AltBeacon
-
Required for making object Parcelable
- AltBeacon.Builder - Class in org.altbeacon.beacon
-
Builder class for AltBeacon objects.
- ALTBEACON_LAYOUT - Static variable in class org.altbeacon.beacon.BeaconParser
-
- AltBeaconParser - Class in org.altbeacon.beacon
-
A specific beacon parser designed to parse only AltBeacons from raw BLE packets detected by
Android.
- AltBeaconParser() - Constructor for class org.altbeacon.beacon.AltBeaconParser
-
Constructs an AltBeacon Parser and sets its layout
- ANDROID_N_MAX_SCAN_DURATION_MILLIS - Static variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- AndroidModel - Class in org.altbeacon.beacon.distance
-
Represents a specific Android device model based on the available device build information
Created by dyoung on 8/28/14.
- AndroidModel(String, String, String, String) - Constructor for class org.altbeacon.beacon.distance.AndroidModel
-
- applyChanges(BeaconManager) - Method in class org.altbeacon.beacon.service.ScanState
-
- applySettings() - Method in class org.altbeacon.beacon.BeaconManager
-
Call this method if you are running the scanner service in a different process in order to
synchronize any configuration settings, including BeaconParsers to the scanner
- applySettingsToScheduledJob(Context, BeaconManager) - Method in class org.altbeacon.beacon.service.ScanJobScheduler
-
- ArmaRssiFilter - Class in org.altbeacon.beacon.service
-
This filter calculates its rssi on base of an auto regressive moving average (ARMA)
It needs only the current value to do this; the general formula is n(t) = n(t-1) - c * (n(t-1) - n(t))
where c is a coefficient, that denotes the smoothness - the lower the value, the smoother the average
Note: a smoother average needs longer to "settle down"
Note: For signals, that change rather frequently (say, 1Hz or faster) and tend to vary more a recommended
value would be 0,1 (that means the actual value is changed by 10% of the difference between the
actual measurement and the actual average)
For signals at lower rates (10Hz) a value of 0.25 to 0.5 would be appropriate
- ArmaRssiFilter() - Constructor for class org.altbeacon.beacon.service.ArmaRssiFilter
-
- BackgroundPowerSaver - Class in org.altbeacon.beacon.powersave
-
Simply creating an instance of this class and holding a reference to it in your Application can
improve battery life by 60% by slowing down scans when your app is in the background.
- BackgroundPowerSaver(Context, boolean) - Constructor for class org.altbeacon.beacon.powersave.BackgroundPowerSaver
-
- BackgroundPowerSaver(Context) - Constructor for class org.altbeacon.beacon.powersave.BackgroundPowerSaver
-
Constructs a new BackgroundPowerSaver using the default background determination strategy
- Beacon - Class in org.altbeacon.beacon
-
The Beacon class represents a single hardware Beacon detected by
an Android device.
- Beacon(Parcel) - Constructor for class org.altbeacon.beacon.Beacon
-
Deprecated.
- Beacon(Beacon) - Constructor for class org.altbeacon.beacon.Beacon
-
Copy constructor
- Beacon() - Constructor for class org.altbeacon.beacon.Beacon
-
Basic constructor that simply allocates fields
- Beacon.Builder - Class in org.altbeacon.beacon
-
Builder class for Beacon objects.
- BeaconConsumer - Interface in org.altbeacon.beacon
-
An interface for an Android Activity or Service
that wants to interact with beacons.
- BeaconData - Interface in org.altbeacon.beacon
-
Server-side data associated with a beacon.
- beaconDataFactory - Static variable in class org.altbeacon.beacon.Beacon
-
Used to attach data to individual Beacons, either locally or in the cloud
- BeaconDataFactory - Interface in org.altbeacon.beacon.client
-
This can be configured for the public beacon data store, or a private beacon data store.
- BeaconDataNotifier - Interface in org.altbeacon.beacon
-
Notifies when server-side beacon data are available from a web service.
- beaconDataUpdate(Beacon, BeaconData, DataProviderException) - Method in interface org.altbeacon.beacon.BeaconDataNotifier
-
This method is called after a request to get or sync beacon data
If fetching data was successful, the data is returned and the exception is null.
- BeaconLayoutException(String) - Constructor for exception org.altbeacon.beacon.BeaconParser.BeaconLayoutException
-
- BeaconManager - Class in org.altbeacon.beacon
-
A class used to set up interaction with beacons from an Activity or Service.
- BeaconManager(Context) - Constructor for class org.altbeacon.beacon.BeaconManager
-
- BeaconParser - Class in org.altbeacon.beacon
-
Created by dyoung on 7/21/14.
- BeaconParser() - Constructor for class org.altbeacon.beacon.BeaconParser
-
Makes a new BeaconParser.
- BeaconParser(String) - Constructor for class org.altbeacon.beacon.BeaconParser
-
Makes a new BeaconParser with an identifier that can be used to identify beacons decoded with
this parser
- BeaconParser.BeaconLayoutException - Exception in org.altbeacon.beacon
-
- beacons - Variable in class org.altbeacon.beacon.simulator.StaticBeaconSimulator
-
- beaconSimulator - Static variable in class org.altbeacon.beacon.BeaconManager
-
- BeaconSimulator - Interface in org.altbeacon.beacon.simulator
-
Created by dyoung on 4/18/14.
- BeaconTransmitter - Class in org.altbeacon.beacon
-
Provides a mechanism for transmitting as a beacon.
- BeaconTransmitter(Context, BeaconParser) - Constructor for class org.altbeacon.beacon.BeaconTransmitter
-
Creates a new beacon transmitter capable of transmitting beacons with the format
specified in the BeaconParser and with the data fields specified in the Beacon object
- bind(BeaconConsumer) - Method in class org.altbeacon.beacon.BeaconManager
-
Binds an Android Activity or Service to the BeaconService.
- bindService(Intent, ServiceConnection, int) - Method in interface org.altbeacon.beacon.BeaconConsumer
-
Called by the BeaconManager to bind your BeaconConsumer to the BeaconService.
- BleAdvertisement - Class in org.altbeacon.bluetooth
-
Parses a byte array representing a BLE advertisement into
a number of "Payload Data Units" (PDUs).
- BleAdvertisement(byte[]) - Constructor for class org.altbeacon.bluetooth.BleAdvertisement
-
- BleNotAvailableException - Exception in org.altbeacon.beacon
-
Indicates that Bluetooth Low Energy is not available on this device
- BleNotAvailableException(String) - Constructor for exception org.altbeacon.beacon.BleNotAvailableException
-
- BootstrapNotifier - Interface in org.altbeacon.beacon.startup
-
- build() - Method in class org.altbeacon.beacon.AltBeacon.Builder
-
- build() - Method in class org.altbeacon.beacon.Beacon.Builder
-
Builds an instance of this beacon based on parameters set in the Builder
- Builder() - Constructor for class org.altbeacon.beacon.AltBeacon.Builder
-
- Builder() - Constructor for class org.altbeacon.beacon.Beacon.Builder
-
Creates a builder instance
- bytesToHex(byte[]) - Static method in class org.altbeacon.beacon.BeaconParser
-
- d(String, String, Object...) - Method in interface org.altbeacon.beacon.logging.Logger
-
Send a debug log message.
- d(Throwable, String, String, Object...) - Method in interface org.altbeacon.beacon.logging.Logger
-
Send a debug log message.
- d(String, String, Object...) - Static method in class org.altbeacon.beacon.logging.LogManager
-
Send a debug log message to the logger.
- d(Throwable, String, String, Object...) - Static method in class org.altbeacon.beacon.logging.LogManager
-
Send a debug log message to the logger.
- DataProviderException - Exception in org.altbeacon.beacon.client
-
- DataProviderException() - Constructor for exception org.altbeacon.beacon.client.DataProviderException
-
- DataProviderException(String) - Constructor for exception org.altbeacon.beacon.client.DataProviderException
-
- DataProviderException(String, Throwable) - Constructor for exception org.altbeacon.beacon.client.DataProviderException
-
- dataRequestNotifier - Variable in class org.altbeacon.beacon.BeaconManager
-
- DEFAULT_BACKGROUND_BETWEEN_SCAN_PERIOD - Static variable in class org.altbeacon.beacon.BeaconManager
-
The default duration in milliseconds spent not scanning between each Bluetooth scan cycle when no ranging/monitoring clients are in the foreground
- DEFAULT_BACKGROUND_SCAN_PERIOD - Static variable in class org.altbeacon.beacon.BeaconManager
-
The default duration in milliseconds of the Bluetooth scan cycle when no ranging/monitoring clients are in the foreground
- DEFAULT_EXIT_PERIOD - Static variable in class org.altbeacon.beacon.BeaconManager
-
The default duration in milliseconds of region exit time
- DEFAULT_FOREGROUND_BETWEEN_SCAN_PERIOD - Static variable in class org.altbeacon.beacon.BeaconManager
-
The default duration in milliseconds spent not scanning between each Bluetooth scan cycle
- DEFAULT_FOREGROUND_SCAN_PERIOD - Static variable in class org.altbeacon.beacon.BeaconManager
-
The default duration in milliseconds of the Bluetooth scan cycle
- DEFAULT_MAX_TRACKING_AGE - Static variable in class org.altbeacon.beacon.service.RangedBeacon
-
- DEFAULT_SAMPLE_EXPIRATION_MILLISECONDS - Static variable in class org.altbeacon.beacon.service.RangedBeacon
-
- DEFAULT_SAMPLE_EXPIRATION_MILLISECONDS - Static variable in class org.altbeacon.beacon.service.RunningAverageRssiFilter
-
- deferScanIfNeeded() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- deferScanIfNeeded() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScannerForLollipop
-
- describeContents() - Method in class org.altbeacon.beacon.AltBeacon
-
Required for making object Parcelable
- describeContents() - Method in class org.altbeacon.beacon.Beacon
-
Deprecated.
- describeContents() - Method in class org.altbeacon.beacon.Region
-
- describeContents() - Method in class org.altbeacon.beacon.service.StartRMData
-
- destroy() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- detectionCount - Variable in class org.altbeacon.beacon.service.Stats.Sample
-
- DetectionTracker - Class in org.altbeacon.beacon.service
-
Created by dyoung on 1/10/15.
- didDetermineStateForRegion(int, Region) - Method in interface org.altbeacon.beacon.MonitorNotifier
-
Called with a state value of MonitorNotifier.INSIDE when at least one beacon in a Region is visible.
- didEnterRegion(Region) - Method in interface org.altbeacon.beacon.MonitorNotifier
-
Called when at least one beacon in a Region is visible.
- didExitRegion(Region) - Method in interface org.altbeacon.beacon.MonitorNotifier
-
Called when no beacons in a Region are visible.
- didRangeBeaconsInRegion(Collection<Beacon>, Region) - Method in interface org.altbeacon.beacon.RangeNotifier
-
Called once per second to give an estimate of the mDistance to visible beacons
- disable() - Method in class org.altbeacon.beacon.startup.RegionBootstrap
-
Used to disable additional bootstrap callbacks after the first is received.
- disableForegroundServiceScanning() - Method in class org.altbeacon.beacon.BeaconManager
-
Disables a foreground scanning service, if previously configured.
- distance - Variable in class org.altbeacon.beacon.Region
-
- DistanceCalculator - Interface in org.altbeacon.beacon.distance
-
Interface for a class that can estimate the distance between a mobile
device and a beacon based on the measured RSSI and a reference txPower
calibration value.
- DistanceConfigFetcher - Class in org.altbeacon.beacon.distance
-
Created by dyoung on 12/11/13.
- DistanceConfigFetcher(String, String) - Constructor for class org.altbeacon.beacon.distance.DistanceConfigFetcher
-
- distanceModelUpdateUrl - Static variable in class org.altbeacon.beacon.BeaconManager
-
- DistinctPacketDetector - Class in org.altbeacon.beacon.service.scanner
-
Created by dyoung on 4/8/17.
- DistinctPacketDetector() - Constructor for class org.altbeacon.beacon.service.scanner.DistinctPacketDetector
-
- doInBackground(Void...) - Method in class org.altbeacon.beacon.distance.ModelSpecificDistanceUpdater
-
- GATT_SERVICE_UUID_PDU_TYPE - Static variable in class org.altbeacon.bluetooth.Pdu
-
- get(String) - Method in interface org.altbeacon.beacon.BeaconData
-
- getActualLength() - Method in class org.altbeacon.bluetooth.Pdu
-
Actual PDU length (may be less than declared length if fewer bytes are actually available.)
- getAdvertiseMode() - Method in class org.altbeacon.beacon.BeaconTransmitter
-
- getAdvertiseTxPowerLevel() - Method in class org.altbeacon.beacon.BeaconTransmitter
-
- getApplicationContext() - Method in interface org.altbeacon.beacon.BeaconConsumer
-
Called by the BeaconManager to get the context of your Service or Activity.
- getApplicationContext() - Method in interface org.altbeacon.beacon.startup.BootstrapNotifier
-
- getBackgroundBetweenScanPeriod() - Method in class org.altbeacon.beacon.BeaconManager
-
- getBackgroundBetweenScanPeriod() - Method in class org.altbeacon.beacon.service.ScanState
-
- getBackgroundFlag() - Method in class org.altbeacon.beacon.service.StartRMData
-
- getBackgroundMode() - Method in class org.altbeacon.beacon.BeaconManager
-
- getBackgroundMode() - Method in class org.altbeacon.beacon.service.ScanState
-
- getBackgroundScanPeriod() - Method in class org.altbeacon.beacon.BeaconManager
-
- getBackgroundScanPeriod() - Method in class org.altbeacon.beacon.service.ScanState
-
- getBase64EncodedTelemetry(Beacon) - Method in class org.altbeacon.beacon.utils.EddystoneTelemetryAccessor
-
Extracts the raw Eddystone telemetry bytes from the extra data fields of an associated beacon
and base64 encodes them.
- getBeacon() - Method in class org.altbeacon.beacon.service.RangedBeacon
-
- getBeaconAdvertisementData(Beacon) - Method in class org.altbeacon.beacon.BeaconParser
-
Get BLE advertisement bytes for a Beacon
- getBeaconParsers() - Method in class org.altbeacon.beacon.BeaconManager
-
Gets a list of the active beaconParsers.
- getBeaconParsers() - Method in class org.altbeacon.beacon.service.ScanState
-
- getBeacons() - Method in class org.altbeacon.beacon.service.RangingData
-
- getBeacons() - Method in interface org.altbeacon.beacon.simulator.BeaconSimulator
-
- getBeacons() - Method in class org.altbeacon.beacon.simulator.StaticBeaconSimulator
-
- getBeaconSimulator() - Static method in class org.altbeacon.beacon.BeaconManager
-
- getBeaconTypeCode() - Method in class org.altbeacon.beacon.Beacon
-
- getBetweenScanPeriod() - Method in class org.altbeacon.beacon.service.StartRMData
-
- getBluetoothAdapter() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- getBluetoothAddress() - Method in class org.altbeacon.beacon.Beacon
-
- getBluetoothAddress() - Method in class org.altbeacon.beacon.Region
-
Returns the mac address used to filter for beacons
- getBluetoothName() - Method in class org.altbeacon.beacon.Beacon
-
- getBuildNumber() - Method in class org.altbeacon.beacon.distance.AndroidModel
-
- getByteCount() - Method in class org.altbeacon.beacon.Identifier
-
Returns the byte length of this identifier.
- getCallback() - Method in class org.altbeacon.beacon.service.RangeState
-
- getCallback() - Method in class org.altbeacon.beacon.service.RegionMonitoringState
-
- getCallbackPackageName() - Method in class org.altbeacon.beacon.service.StartRMData
-
- getDataFieldCount() - Method in class org.altbeacon.beacon.BeaconParser
-
- getDataFields() - Method in class org.altbeacon.beacon.Beacon
-
Returns the list of data fields transmitted with the advertisement
- getDataRequestNotifier() - Method in class org.altbeacon.beacon.BeaconManager
-
- getDeclaredLength() - Method in class org.altbeacon.bluetooth.Pdu
-
PDU length from header
- getDistance() - Method in class org.altbeacon.beacon.Beacon
-
Provides a calculated estimate of the distance to the beacon based on a running average of
the RSSI and the transmitted power calibration value included in the beacon advertisement.
- getDistance() - Method in class org.altbeacon.beacon.Region
-
Returns the distance when enter region
- getDistanceCalculator() - Static method in class org.altbeacon.beacon.Beacon
-
Gets the DistanceCalculator to use with this beacon
- getDistanceModelUpdateUrl() - Static method in class org.altbeacon.beacon.BeaconManager
-
- getDistinctPacketsDetectedPerScan() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- getEndIndex() - Method in class org.altbeacon.bluetooth.Pdu
-
End index within byte buffer of PDU
- getException() - Method in class org.altbeacon.beacon.distance.DistanceConfigFetcher
-
- getExtraBeaconDataTracker() - Method in class org.altbeacon.beacon.service.ScanState
-
- getExtraDataFields() - Method in class org.altbeacon.beacon.Beacon
-
Returns the list of data fields transmitted with the advertisement
- getExtraDataParsers() - Method in class org.altbeacon.beacon.BeaconParser
-
Gets a list of extra parsers configured for this BeaconParser.
- getFirstCycleDetectionTimestamp() - Method in class org.altbeacon.beacon.Beacon
-
Returns the timestamp of the first packet detected
- getForegroundBetweenScanPeriod() - Method in class org.altbeacon.beacon.BeaconManager
-
- getForegroundBetweenScanPeriod() - Method in class org.altbeacon.beacon.service.ScanState
-
- getForegroundScanPeriod() - Method in class org.altbeacon.beacon.BeaconManager
-
- getForegroundScanPeriod() - Method in class org.altbeacon.beacon.service.ScanState
-
- getForegroundServiceNotification() - Method in class org.altbeacon.beacon.BeaconManager
-
- getForegroundServiceNotificationId() - Method in class org.altbeacon.beacon.BeaconManager
-
- getHardwareAssistManufacturers() - Method in class org.altbeacon.beacon.BeaconParser
-
Returns a list of Bluetooth manufacturer codes which will be used for hardware-assisted
accelerated looking for this beacon type
The possible codes are defined on this list:
https://www.bluetooth.org/en-us/specification/assigned-numbers/company-identifiers
- getHardwareEqualityEnforced() - Static method in class org.altbeacon.beacon.Beacon
-
- getId1() - Method in class org.altbeacon.beacon.Beacon
-
Convenience method to get the first identifier
- getId1() - Method in class org.altbeacon.beacon.Region
-
Convenience method to get the first identifier
- getId2() - Method in class org.altbeacon.beacon.Beacon
-
Convenience method to get the second identifier
- getId2() - Method in class org.altbeacon.beacon.Region
-
Convenience method to get the second identifier
- getId3() - Method in class org.altbeacon.beacon.Beacon
-
Convenience method to get the third identifier
- getId3() - Method in class org.altbeacon.beacon.Region
-
Convenience method to get the third identifier
- getIdentifier(int) - Method in class org.altbeacon.beacon.Beacon
-
Returns the specified identifier - 0 indexed
Note: to read id1, call getIdentifier(0);
- getIdentifier() - Method in class org.altbeacon.beacon.BeaconParser
-
Gets an optional identifier field that may be used to identify this parser.
- getIdentifier(int) - Method in class org.altbeacon.beacon.Region
-
Returns the 0-indexed identifier
Note: IMPORTANT: to get id1, you would call getIdentifier(0);
- getIdentifierByteCount(int) - Method in class org.altbeacon.beacon.BeaconParser
-
Caclculates the byte size of the specified identifier in this format
- getIdentifierCount() - Method in class org.altbeacon.beacon.BeaconParser
-
- getIdentifiers() - Method in class org.altbeacon.beacon.Beacon
-
Returns the list of identifiers transmitted with the advertisement
- getImmediateScanJobId(Context) - Static method in class org.altbeacon.beacon.service.ScanJob
-
Returns the job id to be used to schedule this job.
- getInside() - Method in class org.altbeacon.beacon.service.RegionMonitoringState
-
- getInstance() - Static method in class org.altbeacon.beacon.service.DetectionTracker
-
- getInstance() - Static method in class org.altbeacon.beacon.service.ScanJobScheduler
-
- getInstance() - Static method in class org.altbeacon.beacon.service.Stats
-
- getInstanceForApplication(Context) - Static method in class org.altbeacon.beacon.BeaconManager
-
An accessor for the singleton instance of this class.
- getInstanceForApplication(Context) - Static method in class org.altbeacon.beacon.service.MonitoringStatus
-
- getLastCycleDetectionTimestamp() - Method in class org.altbeacon.beacon.Beacon
-
Returns the timestamp of the last packet detected
- getLastDetectionTime() - Method in class org.altbeacon.beacon.service.DetectionTracker
-
- getLastMonitoringStatusUpdateTime() - Method in class org.altbeacon.beacon.service.MonitoringStatus
-
- getLastScanStartTimeMillis() - Method in class org.altbeacon.beacon.service.ScanState
-
- getLatitude() - Method in interface org.altbeacon.beacon.BeaconData
-
- getLayout() - Method in class org.altbeacon.beacon.BeaconParser
-
- getLogger() - Static method in class org.altbeacon.beacon.logging.LogManager
-
Gets the currently set logger
- getLongitude() - Method in interface org.altbeacon.beacon.BeaconData
-
- getManifestCheckingDisabled() - Static method in class org.altbeacon.beacon.BeaconManager
-
Returns whether manifest checking is disabled
- getManufacturer() - Method in class org.altbeacon.beacon.Beacon
-
- getManufacturer() - Method in class org.altbeacon.beacon.distance.AndroidModel
-
- getMatchingBeaconTypeCode() - Method in class org.altbeacon.beacon.BeaconParser
-
- getMatchingBeaconTypeCodeEndOffset() - Method in class org.altbeacon.beacon.BeaconParser
-
see #mMatchingBeaconTypeCodeEndOffset
- getMatchingBeaconTypeCodeStartOffset() - Method in class org.altbeacon.beacon.BeaconParser
-
see #mMatchingBeaconTypeCodeStartOffset
- getMeasurementCount() - Method in class org.altbeacon.beacon.Beacon
-
Returns the number of packet detections that went in to the runningAverageRssi, if known.
- getMeasurementCount() - Method in class org.altbeacon.beacon.service.ArmaRssiFilter
-
- getMeasurementCount() - Method in interface org.altbeacon.beacon.service.RssiFilter
-
- getMeasurementCount() - Method in class org.altbeacon.beacon.service.RunningAverageRssiFilter
-
- getMfgReserved() - Method in class org.altbeacon.beacon.AltBeacon
-
Returns a field with a value from 0-255 that can be used for the purposes specified by the
manufacturer.
- getModel() - Method in class org.altbeacon.beacon.distance.AndroidModel
-
- getModel() - Method in class org.altbeacon.beacon.distance.ModelSpecificDistanceCalculator
-
- getMonitoredRegions() - Method in class org.altbeacon.beacon.BeaconManager
-
- getMonitoringNotifier() - Method in class org.altbeacon.beacon.BeaconManager
-
- getMonitoringNotifiers() - Method in class org.altbeacon.beacon.BeaconManager
-
- getMonitoringStatus() - Method in class org.altbeacon.beacon.service.ScanState
-
- getMServiceUuidStartOffset() - Method in class org.altbeacon.beacon.BeaconParser
-
see #mServiceUuidStartOffset
- getNonBeaconLeScanCallback() - Method in class org.altbeacon.beacon.BeaconManager
-
- getPackageName() - Method in class org.altbeacon.beacon.utils.ProcessUtils
-
- getPacketCount() - Method in class org.altbeacon.beacon.Beacon
-
Returns the number of packet detections in the last ranging cycle
- getParserIdentifier() - Method in class org.altbeacon.beacon.Beacon
-
- getPdus() - Method in class org.altbeacon.bluetooth.BleAdvertisement
-
The list of PDUs inside the advertisement
- getPeriodicScanJobId(Context) - Static method in class org.altbeacon.beacon.service.ScanJob
-
Returns the job id to be used to schedule this job.
- getPid() - Method in class org.altbeacon.beacon.utils.ProcessUtils
-
- getPowerCorrection() - Method in class org.altbeacon.beacon.BeaconParser
-
- getProcessName() - Method in class org.altbeacon.beacon.utils.ProcessUtils
-
- getRangedRegions() - Method in class org.altbeacon.beacon.BeaconManager
-
- getRangedRegionState() - Method in class org.altbeacon.beacon.service.ScanState
-
- getRangingNotifier() - Method in class org.altbeacon.beacon.BeaconManager
-
- getRangingNotifiers() - Method in class org.altbeacon.beacon.BeaconManager
-
- getRegion() - Method in class org.altbeacon.beacon.service.MonitoringData
-
- getRegion() - Method in class org.altbeacon.beacon.service.RangingData
-
- getRegionData() - Method in class org.altbeacon.beacon.service.StartRMData
-
- getRegionExitPeriod() - Static method in class org.altbeacon.beacon.BeaconManager
-
Get region exit milliseconds
- getRegions() - Method in class org.altbeacon.beacon.service.MonitoringStatus
-
- getRequestedModel() - Method in class org.altbeacon.beacon.distance.ModelSpecificDistanceCalculator
-
- getResponseCode() - Method in class org.altbeacon.beacon.distance.DistanceConfigFetcher
-
- getResponseString() - Method in class org.altbeacon.beacon.distance.DistanceConfigFetcher
-
- getRssi() - Method in class org.altbeacon.beacon.Beacon
-
- getRssiFilterImplClass() - Static method in class org.altbeacon.beacon.BeaconManager
-
- getRunningAverageRssi(double) - Method in class org.altbeacon.beacon.Beacon
-
- getRunningAverageRssi() - Method in class org.altbeacon.beacon.Beacon
-
Returns the running average rssi
- getSamples() - Method in class org.altbeacon.beacon.service.Stats
-
- getScanJobIntervalMillis() - Method in class org.altbeacon.beacon.service.ScanState
-
- getScanJobRuntimeMillis() - Method in class org.altbeacon.beacon.service.ScanState
-
- getScanPeriod() - Method in class org.altbeacon.beacon.service.StartRMData
-
- getScheduledScanJobsEnabled() - Method in class org.altbeacon.beacon.BeaconManager
-
- getServiceUuid() - Method in class org.altbeacon.beacon.Beacon
-
- getServiceUuid() - Method in class org.altbeacon.beacon.BeaconParser
-
- getServiceUuidEndOffset() - Method in class org.altbeacon.beacon.BeaconParser
-
see #mServiceUuidEndOffset
- getStartIndex() - Method in class org.altbeacon.bluetooth.Pdu
-
Start index within byte buffer of PDU
This is the start of the payload data that starts after the length and the type, so the PDU
actually starts two bytes earlier
- getTelemetryBytes(Beacon) - Method in class org.altbeacon.beacon.utils.EddystoneTelemetryAccessor
-
Extracts the raw Eddystone telemetry bytes from the extra data fields of an associated beacon.
- getTrackingAge() - Method in class org.altbeacon.beacon.service.RangedBeacon
-
- getTxPower() - Method in class org.altbeacon.beacon.Beacon
-
- getType() - Method in class org.altbeacon.bluetooth.Pdu
-
PDU type field
- getUniqueId() - Method in class org.altbeacon.beacon.Region
-
Returns the identifier used to start or stop ranging/monitoring this region when calling
the BeaconManager methods.
- getUseTrackingCache() - Static method in class org.altbeacon.beacon.service.RangeState
-
- getVersion() - Method in class org.altbeacon.beacon.distance.AndroidModel
-
- getWakeUpOperation() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- i(String, String, Object...) - Method in interface org.altbeacon.beacon.logging.Logger
-
Send a info log message.
- i(Throwable, String, String, Object...) - Method in interface org.altbeacon.beacon.logging.Logger
-
Send a info log message.
- i(String, String, Object...) - Static method in class org.altbeacon.beacon.logging.LogManager
-
Send a info log message to the logger.
- i(Throwable, String, String, Object...) - Static method in class org.altbeacon.beacon.logging.LogManager
-
Send a info log message to the logger.
- Identifier - Class in org.altbeacon.beacon
-
Encapsulates a beacon identifier of arbitrary byte length.
- Identifier(Identifier) - Constructor for class org.altbeacon.beacon.Identifier
-
- Identifier(byte[]) - Constructor for class org.altbeacon.beacon.Identifier
-
Creates a new instance of Identifier
- infoLogger() - Static method in class org.altbeacon.beacon.logging.Loggers
-
- INSIDE - Static variable in interface org.altbeacon.beacon.MonitorNotifier
-
Indicates the Android device is inside the Region of beacons
- IntentHandler - Class in org.altbeacon.beacon
-
Converts internal Intents for ranging/monitoring to notifier callbacks.
- IntentHandler() - Constructor for class org.altbeacon.beacon.IntentHandler
-
- isAndroidLScanningDisabled() - Static method in class org.altbeacon.beacon.BeaconManager
-
Determines if Android L Scanning is disabled by user selection
- isAnyConsumerBound() - Method in class org.altbeacon.beacon.BeaconManager
-
Tells you if the any beacon consumer is bound to the service
- isBackgroundModeUninitialized() - Method in class org.altbeacon.beacon.BeaconManager
-
- isBound(BeaconConsumer) - Method in class org.altbeacon.beacon.BeaconManager
-
Tells you if the passed beacon consumer is bound to the service
- isConnectable() - Method in class org.altbeacon.beacon.BeaconTransmitter
-
- isDirty() - Method in interface org.altbeacon.beacon.BeaconData
-
- isEnabled() - Method in class org.altbeacon.beacon.service.Stats
-
- isExpired() - Method in class org.altbeacon.beacon.service.RangedBeacon
-
- isExtraBeaconData() - Method in class org.altbeacon.beacon.Beacon
-
Indicates whether this beacon is an "Extra data beacon," meaning one that has no identifiers
but has data fields.
- isInside() - Method in class org.altbeacon.beacon.service.MonitoringData
-
- isMainProcess() - Method in class org.altbeacon.beacon.BeaconManager
-
Determines if this BeaconManager instance is associated with the main application process that
hosts the user interface.
- isMainProcess() - Method in class org.altbeacon.beacon.utils.ProcessUtils
-
- isMainThread() - Static method in class org.altbeacon.beacon.utils.ProcessUtils
-
- isMultiFrameBeacon() - Method in class org.altbeacon.beacon.Beacon
-
- isPacketDistinct(String, byte[]) - Method in class org.altbeacon.beacon.service.scanner.DistinctPacketDetector
-
- isRegionStatePersistenceEnabled() - Method in class org.altbeacon.beacon.BeaconManager
-
Indicates whether region state preservation is enabled
- isScannerInDifferentProcess() - Method in class org.altbeacon.beacon.BeaconManager
-
Determines if this BeaconManager instance is not part of the process hosting the beacon scanning
service.
- isStarted() - Method in class org.altbeacon.beacon.BeaconTransmitter
-
Tells if transmission has started
- isStatePreservationOn() - Method in class org.altbeacon.beacon.service.MonitoringStatus
-
- isTracked() - Method in class org.altbeacon.beacon.service.RangedBeacon
-
- isVerboseLoggingEnabled() - Static method in class org.altbeacon.beacon.logging.LogManager
-
Indicates whether verbose logging is enabled.
- mAllowPduOverflow - Variable in class org.altbeacon.beacon.BeaconParser
-
- MANUFACTURER_DATA_PDU_TYPE - Static variable in class org.altbeacon.bluetooth.Pdu
-
- markInside() - Method in class org.altbeacon.beacon.service.RegionMonitoringState
-
- markOutside() - Method in class org.altbeacon.beacon.service.RegionMonitoringState
-
- markOutsideIfExpired() - Method in class org.altbeacon.beacon.service.RegionMonitoringState
-
- matchesBeacon(Beacon) - Method in class org.altbeacon.beacon.Region
-
Checks to see if an Beacon object is included in the matching criteria of this Region
- matchScore(AndroidModel) - Method in class org.altbeacon.beacon.distance.AndroidModel
-
Calculates a qualitative match score between two different Android device models for the
purposes of how likely they are to have similar Bluetooth signal level responses
- maxMillisBetweenDetections - Variable in class org.altbeacon.beacon.service.Stats.Sample
-
- maxTrackingAge - Static variable in class org.altbeacon.beacon.service.RangedBeacon
-
- mBackgroundFlag - Variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- mBeacon - Variable in class org.altbeacon.beacon.Beacon.Builder
-
- mBeaconLayout - Variable in class org.altbeacon.beacon.BeaconParser
-
- mBeaconTypeCode - Variable in class org.altbeacon.beacon.Beacon
-
The two byte value indicating the type of beacon that this is, which is used for figuring
out the byte layout of the beacon advertisement
- mBetweenScanPeriod - Variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- mBluetoothAddress - Variable in class org.altbeacon.beacon.Beacon
-
The Bluetooth mac address
- mBluetoothAddress - Variable in class org.altbeacon.beacon.Region
-
- mBluetoothName - Variable in class org.altbeacon.beacon.Beacon
-
The Bluetooth device name.
- mContext - Variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- mCycledLeScanCallback - Variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- mDataEndOffsets - Variable in class org.altbeacon.beacon.BeaconParser
-
- mDataFields - Variable in class org.altbeacon.beacon.Beacon
-
A list of generic non-identifying data fields included in the beacon advertisement.
- mDataLittleEndianFlags - Variable in class org.altbeacon.beacon.BeaconParser
-
- mDataStartOffsets - Variable in class org.altbeacon.beacon.BeaconParser
-
- mDBmCorrection - Variable in class org.altbeacon.beacon.BeaconParser
-
- mDistance - Variable in class org.altbeacon.beacon.Beacon
-
A double that is an estimate of how far the Beacon is away in meters.
- mException - Variable in class org.altbeacon.beacon.distance.DistanceConfigFetcher
-
- mExtraDataFields - Variable in class org.altbeacon.beacon.Beacon
-
A list of generic non-identifying data fields included in a secondary beacon advertisement
and merged into this beacon.
- mExtraFrame - Variable in class org.altbeacon.beacon.BeaconParser
-
- mFilter - Variable in class org.altbeacon.beacon.service.RangedBeacon
-
- mFirstCycleDetectionTimestamp - Variable in class org.altbeacon.beacon.Beacon
-
The timestamp of the first packet detected in milliseconds.
- mHandler - Variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
Main thread handle for scheduling scan cycle tasks.
- mHardwareAssistManufacturers - Variable in class org.altbeacon.beacon.BeaconParser
-
- mIdentifier - Variable in class org.altbeacon.beacon.BeaconParser
-
- mIdentifierEndOffsets - Variable in class org.altbeacon.beacon.BeaconParser
-
- mIdentifierLittleEndianFlags - Variable in class org.altbeacon.beacon.BeaconParser
-
- mIdentifiers - Variable in class org.altbeacon.beacon.Beacon
-
The a list of the multi-part identifiers of the beacon.
- mIdentifiers - Variable in class org.altbeacon.beacon.Region
-
- mIdentifierStartOffsets - Variable in class org.altbeacon.beacon.BeaconParser
-
- mIdentifierVariableLengthFlags - Variable in class org.altbeacon.beacon.BeaconParser
-
- MIN_SCAN_JOB_INTERVAL_MILLIS - Static variable in class org.altbeacon.beacon.service.ScanState
-
- mLastCycleDetectionTimestamp - Variable in class org.altbeacon.beacon.Beacon
-
The timestamp of the last packet detected in milliseconds.
- mLayoutSize - Variable in class org.altbeacon.beacon.BeaconParser
-
- mManufacturer - Variable in class org.altbeacon.beacon.Beacon
-
A two byte code indicating the beacon manufacturer.
- mMatchingBeaconTypeCodeEndOffset - Variable in class org.altbeacon.beacon.BeaconParser
-
- mMatchingBeaconTypeCodeStartOffset - Variable in class org.altbeacon.beacon.BeaconParser
-
- mMultiFrameBeacon - Variable in class org.altbeacon.beacon.Beacon
-
An indicator marking this beacon as a potential multi frame beacon.
- mNextScanCycleStartTime - Variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- ModelSpecificDistanceCalculator - Class in org.altbeacon.beacon.distance
-
Obtains a DistanceCalculator appropriate for a specific Android model.
- ModelSpecificDistanceCalculator(Context, String) - Constructor for class org.altbeacon.beacon.distance.ModelSpecificDistanceCalculator
-
Obtains the best possible DistanceCalculator for the Android device calling
the constructor
- ModelSpecificDistanceCalculator(Context, String, AndroidModel) - Constructor for class org.altbeacon.beacon.distance.ModelSpecificDistanceCalculator
-
Obtains the best possible DistanceCalculator for the Android device passed
as an argument
- ModelSpecificDistanceUpdater - Class in org.altbeacon.beacon.distance
-
Created by dyoung on 9/12/14.
- ModelSpecificDistanceUpdater(Context, String, ModelSpecificDistanceUpdater.CompletionHandler) - Constructor for class org.altbeacon.beacon.distance.ModelSpecificDistanceUpdater
-
- MonitoringData - Class in org.altbeacon.beacon.service
-
- MonitoringData(boolean, Region) - Constructor for class org.altbeacon.beacon.service.MonitoringData
-
- MonitoringStatus - Class in org.altbeacon.beacon.service
-
- MonitoringStatus(Context) - Constructor for class org.altbeacon.beacon.service.MonitoringStatus
-
- MonitorNotifier - Interface in org.altbeacon.beacon
-
This interface is implemented by classes that receive beacon monitoring notifications
- monitorNotifiers - Variable in class org.altbeacon.beacon.BeaconManager
-
- mParserIdentifier - Variable in class org.altbeacon.beacon.Beacon
-
The identifier of the beaconParser used to create this beacon.
- mPowerEndOffset - Variable in class org.altbeacon.beacon.BeaconParser
-
- mPowerStartOffset - Variable in class org.altbeacon.beacon.BeaconParser
-
- mResponse - Variable in class org.altbeacon.beacon.distance.DistanceConfigFetcher
-
- mRestartNeeded - Variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- mRssi - Variable in class org.altbeacon.beacon.Beacon
-
The measured signal strength of the Bluetooth packet that led do this Beacon detection.
- mScanHandler - Variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
Handler to background thread for interacting with the low-level Android BLE scanner.
- mScanningPaused - Variable in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- mServiceUuid - Variable in class org.altbeacon.beacon.Beacon
-
A 32 bit service uuid for the beacon
This is valid only for GATT-based beacons.
- mServiceUuid - Variable in class org.altbeacon.beacon.BeaconParser
-
- mServiceUuidEndOffset - Variable in class org.altbeacon.beacon.BeaconParser
-
- mServiceUuidStartOffset - Variable in class org.altbeacon.beacon.BeaconParser
-
- mTxPower - Variable in class org.altbeacon.beacon.Beacon
-
The calibrated measured Tx power of the Beacon in RSSI
This value is baked into an Beacon when it is manufactured, and
it is transmitted with each packet to aid in the mDistance estimate
- mUniqueId - Variable in class org.altbeacon.beacon.Region
-
- RangedBeacon - Class in org.altbeacon.beacon.service
-
- RangedBeacon(Beacon) - Constructor for class org.altbeacon.beacon.service.RangedBeacon
-
- RangeNotifier - Interface in org.altbeacon.beacon
-
This interface is implemented by classes that receive beacon ranging notifications
- rangeNotifiers - Variable in class org.altbeacon.beacon.BeaconManager
-
- RangeState - Class in org.altbeacon.beacon.service
-
- RangeState(Callback) - Constructor for class org.altbeacon.beacon.service.RangeState
-
- RangingData - Class in org.altbeacon.beacon.service
-
Internal class used to transfer ranging data between the BeaconService and the client
- RangingData(Collection<Beacon>, Region) - Constructor for class org.altbeacon.beacon.service.RangingData
-
- recordDetection() - Method in class org.altbeacon.beacon.service.DetectionTracker
-
- Region - Class in org.altbeacon.beacon
-
This class represents a criteria of fields used to match beacons.
- Region(String, Identifier, Identifier, Identifier) - Constructor for class org.altbeacon.beacon.Region
-
Constructs a new Region object to be used for Ranging or Monitoring
- Region(String, List<Identifier>) - Constructor for class org.altbeacon.beacon.Region
-
Constructs a new Region object to be used for Ranging or Monitoring
- Region(String, List<Identifier>, String, double) - Constructor for class org.altbeacon.beacon.Region
-
Constructs a new Region object to be used for Ranging or Monitoring
- Region(String, String) - Constructor for class org.altbeacon.beacon.Region
-
Constructs a new Region object to be used for Ranging or Monitoring
- Region(Parcel) - Constructor for class org.altbeacon.beacon.Region
-
- RegionBootstrap - Class in org.altbeacon.beacon.startup
-
Class allowing a user to set up background launching of an app when a user enters a beacon Region.
- RegionBootstrap(Context, MonitorNotifier, Region) - Constructor for class org.altbeacon.beacon.startup.RegionBootstrap
-
Constructor to bootstrap your Application on an entry/exit from a single region.
- RegionBootstrap(Context, MonitorNotifier, List<Region>) - Constructor for class org.altbeacon.beacon.startup.RegionBootstrap
-
Constructor to bootstrap your Application on an entry/exit from multiple regions
- RegionBootstrap(BootstrapNotifier, Region) - Constructor for class org.altbeacon.beacon.startup.RegionBootstrap
-
Constructor to bootstrap your Application on an entry/exit from a single region.
- RegionBootstrap(BootstrapNotifier, List<Region>) - Constructor for class org.altbeacon.beacon.startup.RegionBootstrap
-
Constructor to bootstrap your Application on an entry/exit from multiple regions
- RegionMonitoringState - Class in org.altbeacon.beacon.service
-
- RegionMonitoringState(Callback) - Constructor for class org.altbeacon.beacon.service.RegionMonitoringState
-
- regions() - Method in class org.altbeacon.beacon.service.MonitoringStatus
-
- regionsCount() - Method in class org.altbeacon.beacon.service.MonitoringStatus
-
- removeAllMonitorNotifiers() - Method in class org.altbeacon.beacon.BeaconManager
-
Remove all the Monitor Notifiers.
- removeAllRangeNotifiers() - Method in class org.altbeacon.beacon.BeaconManager
-
Remove all the Range Notifiers.
- removeLocalRegion(Region) - Method in class org.altbeacon.beacon.service.MonitoringStatus
-
- removeMonitoreNotifier(MonitorNotifier) - Method in class org.altbeacon.beacon.BeaconManager
-
- removeMonitorNotifier(MonitorNotifier) - Method in class org.altbeacon.beacon.BeaconManager
-
Specifies a class to remove from the array of MonitorNotifier.
- removeRangeNotifier(RangeNotifier) - Method in class org.altbeacon.beacon.BeaconManager
-
Specifies a class to remove from the array of RangeNotifier
- removeRegion(Region) - Method in class org.altbeacon.beacon.service.MonitoringStatus
-
- removeRegion(Region) - Method in class org.altbeacon.beacon.startup.RegionBootstrap
-
Remove a given region
- request() - Method in class org.altbeacon.beacon.distance.DistanceConfigFetcher
-
- requestBeaconData(Beacon, BeaconDataNotifier) - Method in interface org.altbeacon.beacon.client.BeaconDataFactory
-
Asynchronous call
When data is available, it is passed back to the beaconDataNotifier interface
- requestBeaconData(Beacon, BeaconDataNotifier) - Method in class org.altbeacon.beacon.client.NullBeaconDataFactory
-
- requestData(BeaconDataNotifier) - Method in class org.altbeacon.beacon.Beacon
-
Requests server-side data for this beacon.
- requestStateForRegion(Region) - Method in class org.altbeacon.beacon.BeaconManager
-
Requests the current in/out state on the specified region.
- restore(Context) - Static method in class org.altbeacon.beacon.service.ScanState
-
- restoreMonitoringStatus() - Method in class org.altbeacon.beacon.service.MonitoringStatus
-
- RssiFilter - Interface in org.altbeacon.beacon.service
-
Interface that can be implemented to overwrite measurement and filtering
of RSSI values
- rssiFilterImplClass - Static variable in class org.altbeacon.beacon.BeaconManager
-
Default class for rssi filter/calculation implementation
- RunningAverageRssiFilter - Class in org.altbeacon.beacon.service
-
Calculate a RSSI value on base of an arbitrary list of measured RSSI values
The list is clipped by a certain length at start and end and the average
is calculate by simple arithmetic average
- RunningAverageRssiFilter() - Constructor for class org.altbeacon.beacon.service.RunningAverageRssiFilter
-
- Sample() - Constructor for class org.altbeacon.beacon.service.Stats.Sample
-
- sampleStartTime - Variable in class org.altbeacon.beacon.service.Stats.Sample
-
- sampleStopTime - Variable in class org.altbeacon.beacon.service.Stats.Sample
-
- save() - Method in class org.altbeacon.beacon.service.ScanState
-
- saveMonitoringStatusIfOn() - Method in class org.altbeacon.beacon.service.MonitoringStatus
-
- ScanFilterUtils - Class in org.altbeacon.beacon.service.scanner
-
Created by dyoung on 1/12/15.
- ScanFilterUtils() - Constructor for class org.altbeacon.beacon.service.scanner.ScanFilterUtils
-
- ScanJob - Class in org.altbeacon.beacon.service
-
Used to perform scans periodically using the JobScheduler
Only one instance of this will be active, even with multiple jobIds.
- ScanJob() - Constructor for class org.altbeacon.beacon.service.ScanJob
-
- ScanJobScheduler - Class in org.altbeacon.beacon.service
-
Schedules two types of ScanJobs:
1.
- scanLeDevice(Boolean) - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- ScanState - Class in org.altbeacon.beacon.service
-
Stores the full state of scanning for the libary, including all settings so it can be ressurrected easily
for running from a scheduled job
Created by dyoung on 3/26/17.
- ScanState(Context) - Constructor for class org.altbeacon.beacon.service.ScanState
-
- scheduleAfterBackgroundWakeup(Context, List<ScanResult>) - Method in class org.altbeacon.beacon.service.ScanJobScheduler
-
- scheduleScanCycleStop() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- sDistanceCalculator - Static variable in class org.altbeacon.beacon.Beacon
-
- SDKNotifier - Interface in org.altbeacon.beacon
-
- set(String, String) - Method in interface org.altbeacon.beacon.BeaconData
-
- setAdvertiseMode(int) - Method in class org.altbeacon.beacon.BeaconTransmitter
-
AdvertiseSettings.ADVERTISE_MODE_BALANCED 3 Hz
AdvertiseSettings.ADVERTISE_MODE_LOW_LATENCY 10 Hz
AdvertiseSettings.ADVERTISE_MODE_LOW_POWER 1 Hz
- setAdvertiseTxPowerLevel(int) - Method in class org.altbeacon.beacon.BeaconTransmitter
-
AdvertiseSettings.ADVERTISE_TX_POWER_HIGH -56 dBm @ 1 meter with Nexus 5
AdvertiseSettings.ADVERTISE_TX_POWER_LOW -75 dBm @ 1 meter with Nexus 5
AdvertiseSettings.ADVERTISE_TX_POWER_MEDIUM -66 dBm @ 1 meter with Nexus 5
AdvertiseSettings.ADVERTISE_TX_POWER_ULTRA_LOW not detected with Nexus 5
- setAllowPduOverflow(Boolean) - Method in class org.altbeacon.beacon.BeaconParser
-
Setting to true indicates that packets should be rejected if the PDU length is too short for
the fields.
- setAndroidLScanningDisabled(boolean) - Static method in class org.altbeacon.beacon.BeaconManager
-
Allows disabling use of Android L BLE Scanning APIs on devices with API 21+
If set to false (default), devices with API 21+ will use the Android L APIs to
scan for beacons
- setBackgroundBetweenScanPeriod(long) - Method in class org.altbeacon.beacon.BeaconManager
-
Sets the duration in milliseconds spent not scanning between each Bluetooth LE scan cycle when no ranging/monitoring clients are in the foreground
- setBackgroundBetweenScanPeriod(Long) - Method in class org.altbeacon.beacon.service.ScanState
-
- setBackgroundMode(boolean) - Method in class org.altbeacon.beacon.BeaconManager
-
This method notifies the beacon service that the application is either moving to background
mode or foreground mode.
- setBackgroundMode(Boolean) - Method in class org.altbeacon.beacon.service.ScanState
-
- setBackgroundScanPeriod(long) - Method in class org.altbeacon.beacon.BeaconManager
-
Sets the duration in milliseconds of each Bluetooth LE scan cycle to look for beacons.
- setBackgroundScanPeriod(Long) - Method in class org.altbeacon.beacon.service.ScanState
-
- setBeacon(Beacon) - Method in class org.altbeacon.beacon.BeaconTransmitter
-
Sets the beacon whose fields will be transmitted
- setBeaconLayout(String) - Method in class org.altbeacon.beacon.BeaconParser
-
Defines a beacon field parsing algorithm based on a string designating the zero-indexed
offsets to bytes within a BLE advertisement.
- setBeaconParser(BeaconParser) - Method in class org.altbeacon.beacon.BeaconTransmitter
-
Sets the beaconParsser used for formatting the transmission
- setBeaconParsers(Set<BeaconParser>) - Method in class org.altbeacon.beacon.service.ScanState
-
- setBeacons(List<Beacon>) - Method in class org.altbeacon.beacon.simulator.StaticBeaconSimulator
-
- setBeaconSimulator(BeaconSimulator) - Static method in class org.altbeacon.beacon.BeaconManager
-
- setBeaconTypeCode(int) - Method in class org.altbeacon.beacon.Beacon.Builder
-
- setBluetoothAddress(String) - Method in class org.altbeacon.beacon.Beacon.Builder
-
- setBluetoothName(String) - Method in class org.altbeacon.beacon.Beacon.Builder
-
- setBuildNumber(String) - Method in class org.altbeacon.beacon.distance.AndroidModel
-
- setConnectable(boolean) - Method in class org.altbeacon.beacon.BeaconTransmitter
-
Whether the advertisement should indicate the device is connectable.
- setDataFields(List<Long>) - Method in class org.altbeacon.beacon.Beacon.Builder
-
- setDataRequestNotifier(RangeNotifier) - Method in class org.altbeacon.beacon.BeaconManager
-
- setDebug(boolean) - Static method in class org.altbeacon.beacon.BeaconManager
-
Set to true if you want to show library debugging.
- setDEFAULT_ARMA_SPEED(double) - Static method in class org.altbeacon.beacon.service.ArmaRssiFilter
-
- setDistanceCalculator(DistanceCalculator) - Static method in class org.altbeacon.beacon.Beacon
-
Sets the DistanceCalculator to use with this beacon
- setDistanceModelUpdateUrl(String) - Static method in class org.altbeacon.beacon.BeaconManager
-
- setDistinctPacketsDetectedPerScan(boolean) - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- setEnabled(boolean) - Method in class org.altbeacon.beacon.service.Stats
-
- setEnableScheduledScanJobs(boolean) - Method in class org.altbeacon.beacon.BeaconManager
-
Configures using a `ScanJob` run with the `JobScheduler` to perform scans rather than using a
long-running `BeaconService` to do so.
- setExtraBeaconDataTracker(ExtraDataBeaconTracker) - Method in class org.altbeacon.beacon.service.ScanState
-
- setExtraDataFields(List<Long>) - Method in class org.altbeacon.beacon.Beacon.Builder
-
- setExtraDataFields(List<Long>) - Method in class org.altbeacon.beacon.Beacon
-
Sets extra data fields
- setFirstCycleDetectionTimestamp(long) - Method in class org.altbeacon.beacon.Beacon
-
Sets the timestamp of the first packet detected
- setForegroundBetweenScanPeriod(long) - Method in class org.altbeacon.beacon.BeaconManager
-
Sets the duration in milliseconds between each Bluetooth LE scan cycle to look for beacons.
- setForegroundBetweenScanPeriod(Long) - Method in class org.altbeacon.beacon.service.ScanState
-
- setForegroundScanPeriod(long) - Method in class org.altbeacon.beacon.BeaconManager
-
Sets the duration in milliseconds of each Bluetooth LE scan cycle to look for beacons.
- setForegroundScanPeriod(Long) - Method in class org.altbeacon.beacon.service.ScanState
-
- setHardwareAssistManufacturerCodes(int[]) - Method in class org.altbeacon.beacon.BeaconParser
-
Sets a list of Bluetooth manufacturer codes which will be used for hardware-assisted
accelerated looking for this beacon type
The possible codes are defined on this list:
https://www.bluetooth.org/en-us/specification/assigned-numbers/company-identifiers
- setHardwareEqualityEnforced(boolean) - Static method in class org.altbeacon.beacon.Beacon
-
Configures whether a the bluetoothAddress (mac address) must be the same for two Beacons
to be configured equal.
- setHistoricalLoggingEnabled(boolean) - Method in class org.altbeacon.beacon.service.Stats
-
- setId1(String) - Method in class org.altbeacon.beacon.Beacon.Builder
-
Convenience method allowing the first beacon identifier to be set as a String.
- setId2(String) - Method in class org.altbeacon.beacon.Beacon.Builder
-
Convenience method allowing the second beacon identifier to be set as a String.
- setId3(String) - Method in class org.altbeacon.beacon.Beacon.Builder
-
Convenience method allowing the third beacon identifier to be set as a String.
- setIdentifiers(List<Identifier>) - Method in class org.altbeacon.beacon.Beacon.Builder
-
- setLastCycleDetectionTimestamp(long) - Method in class org.altbeacon.beacon.Beacon
-
Sets the timestamp of the last packet detected
- setLastScanStartTimeMillis(long) - Method in class org.altbeacon.beacon.service.ScanState
-
- setLatitude(Double) - Method in interface org.altbeacon.beacon.BeaconData
-
- setLogger(Logger) - Static method in class org.altbeacon.beacon.logging.LogManager
-
Set the logger that the Altbeacon library will use to send it's log messages to.
- setLoggingEnabled(boolean) - Method in class org.altbeacon.beacon.service.Stats
-
- setLongitude(Double) - Method in interface org.altbeacon.beacon.BeaconData
-
- setLongScanForcingEnabled(boolean) - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
Enables the scanner to go to extra lengths to keep scans going for longer than would
otherwise be allowed.
- setManifestCheckingDisabled(boolean) - Static method in class org.altbeacon.beacon.BeaconManager
-
Allows disabling check of manifest for proper configuration of service.
- setManufacturer(int) - Method in class org.altbeacon.beacon.Beacon.Builder
-
- setManufacturer(String) - Method in class org.altbeacon.beacon.distance.AndroidModel
-
- setMatchingBeaconTypeCode(Long) - Method in class org.altbeacon.beacon.BeaconParser
-
- setMaxTrackinAge(int) - Static method in class org.altbeacon.beacon.service.RangedBeacon
-
- setMaxTrackingAge(int) - Method in class org.altbeacon.beacon.BeaconManager
-
Set the period of time, in which a beacon did not receive new
measurements
- setMfgReserved(int) - Method in class org.altbeacon.beacon.AltBeacon.Builder
-
- setModel(String) - Method in class org.altbeacon.beacon.distance.AndroidModel
-
- setMonitoringStatus(MonitoringStatus) - Method in class org.altbeacon.beacon.service.ScanState
-
- setMonitorNotifier(MonitorNotifier) - Method in class org.altbeacon.beacon.BeaconManager
-
- setMultiFrameBeacon(boolean) - Method in class org.altbeacon.beacon.Beacon.Builder
-
- setNonBeaconLeScanCallback(NonBeaconLeScanCallback) - Method in class org.altbeacon.beacon.BeaconManager
-
- setOverrideImmediateScanJobId(int) - Static method in class org.altbeacon.beacon.service.ScanJob
-
Allows configuration of the job id for the Android Job Scheduler.
- setOverridePeriodicScanJobId(int) - Static method in class org.altbeacon.beacon.service.ScanJob
-
Allows configuration of the job id for the Android Job Scheduler.
- setPacketCount(int) - Method in class org.altbeacon.beacon.Beacon
-
Sets the packet detections in the last ranging cycle
- setParserIdentifier(String) - Method in class org.altbeacon.beacon.Beacon.Builder
-
- setRangedRegionState(Map<Region, RangeState>) - Method in class org.altbeacon.beacon.service.ScanState
-
- setRangeNotifier(RangeNotifier) - Method in class org.altbeacon.beacon.BeaconManager
-
- setRegionExitPeriod(long) - Static method in class org.altbeacon.beacon.BeaconManager
-
Set region exit period in milliseconds
- setRegionStatePeristenceEnabled(boolean) - Method in class org.altbeacon.beacon.BeaconManager
-
- setRegionStatePersistenceEnabled(boolean) - Method in class org.altbeacon.beacon.BeaconManager
-
Turns off saving the state of monitored regions to persistent storage so it is retained over
app restarts.
- setRssi(int) - Method in class org.altbeacon.beacon.Beacon.Builder
-
- setRssi(int) - Method in class org.altbeacon.beacon.Beacon
-
Sets the most recently measured rssi for use in distance calculations if a running average is
not available
- setRssiFilterImplClass(Class) - Static method in class org.altbeacon.beacon.BeaconManager
-
- setRssiMeasurementCount(int) - Method in class org.altbeacon.beacon.Beacon
-
Sets the measurement count that went into the rssi sample
- setRunningAverageRssi(double) - Method in class org.altbeacon.beacon.Beacon.Builder
-
- setRunningAverageRssi(double) - Method in class org.altbeacon.beacon.Beacon
-
Sets the running average rssi for use in distance calculations
- setSampleExpirationMilliseconds(long) - Static method in class org.altbeacon.beacon.service.RangedBeacon
-
- setSampleExpirationMilliseconds(long) - Static method in class org.altbeacon.beacon.service.RunningAverageRssiFilter
-
- setSampleIntervalMillis(long) - Method in class org.altbeacon.beacon.service.Stats
-
- setScannerInSameProcess(boolean) - Method in class org.altbeacon.beacon.BeaconManager
-
Reserved for internal use by the library.
- setScanPeriods(long, long, boolean) - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
Tells the cycler the scan rate and whether it is in operating in background mode.
- setSdkNotifier(SDKNotifier) - Method in class org.altbeacon.beacon.BeaconManager
-
- setServiceUuid(int) - Method in class org.altbeacon.beacon.Beacon.Builder
-
- setsManifestCheckingDisabled(boolean) - Static method in class org.altbeacon.beacon.BeaconManager
-
Deprecated.
- setTracked(boolean) - Method in class org.altbeacon.beacon.service.RangedBeacon
-
- setTxPower(int) - Method in class org.altbeacon.beacon.Beacon.Builder
-
- setUseTrackingCache(boolean) - Static method in class org.altbeacon.beacon.BeaconManager
-
Allow the library to use a tracking cache
- setUseTrackingCache(boolean) - Static method in class org.altbeacon.beacon.service.RangeState
-
- setVerboseLoggingEnabled(boolean) - Static method in class org.altbeacon.beacon.logging.LogManager
-
Sets whether verbose logging is enabled.
- setVersion(String) - Method in class org.altbeacon.beacon.distance.AndroidModel
-
- setWakeUpAlarm() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- sHardwareEqualityEnforced - Static variable in class org.altbeacon.beacon.Beacon
-
Determines whether a the bluetoothAddress (mac address) must be the same for two Beacons
to be configured equal.
- sInstance - Static variable in class org.altbeacon.beacon.BeaconManager
-
- start() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- startAdvertising(Beacon) - Method in class org.altbeacon.beacon.BeaconTransmitter
-
Starts advertising with fields from the passed beacon
- startAdvertising(Beacon, AdvertiseCallback) - Method in class org.altbeacon.beacon.BeaconTransmitter
-
Starts advertising with fields from the passed beacon
- startAdvertising() - Method in class org.altbeacon.beacon.BeaconTransmitter
-
Starts this beacon advertising
- startMonitoringBeaconsInRegion(List<Region>) - Method in class org.altbeacon.beacon.BeaconManager
-
- startMonitoringBeaconsInRegion(Region) - Method in class org.altbeacon.beacon.BeaconManager
-
Tells the BeaconService to start looking for beacons that match the passed
Region object.
- startRangingBeaconsInRegion(List<Region>) - Method in class org.altbeacon.beacon.BeaconManager
-
- startRangingBeaconsInRegion(Region) - Method in class org.altbeacon.beacon.BeaconManager
-
Tells the BeaconService to start looking for beacons that match the passed
Region object, and providing updates on the estimated mDistance every seconds while
beacons in the Region are visible.
- StartRMData - Class in org.altbeacon.beacon.service
-
Internal class used to transfer ranging and monitoring data between the BeaconService and client
- StartRMData(Region, String) - Constructor for class org.altbeacon.beacon.service.StartRMData
-
- StartRMData(long, long, boolean) - Constructor for class org.altbeacon.beacon.service.StartRMData
-
- StartRMData(Region, String, long, long, boolean) - Constructor for class org.altbeacon.beacon.service.StartRMData
-
- startScan() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- startScan() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScannerForLollipop
-
- startStatusPreservation() - Method in class org.altbeacon.beacon.service.MonitoringStatus
-
Client applications should not call directly.
- StartupBroadcastReceiver - Class in org.altbeacon.beacon.startup
-
- StartupBroadcastReceiver() - Constructor for class org.altbeacon.beacon.startup.StartupBroadcastReceiver
-
- stateOf(Region) - Method in class org.altbeacon.beacon.service.MonitoringStatus
-
- StaticBeaconSimulator - Class in org.altbeacon.beacon.simulator
-
Created by dyoung on 4/18/14.
- StaticBeaconSimulator() - Constructor for class org.altbeacon.beacon.simulator.StaticBeaconSimulator
-
- Stats - Class in org.altbeacon.beacon.service
-
Stats module used for internal performance testing of the library
Created by dyoung on 10/16/14.
- Stats.Sample - Class in org.altbeacon.beacon.service
-
- STATUS_PRESERVATION_FILE_NAME - Static variable in class org.altbeacon.beacon.service.MonitoringStatus
-
- stop() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- stop() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScannerForLollipop
-
- stopAdvertising() - Method in class org.altbeacon.beacon.BeaconTransmitter
-
Stops this beacon from advertising
- stopAllMonitoringBeaconsInRegion() - Method in class org.altbeacon.beacon.BeaconManager
-
- stopAllRangingBeaconsInRegion() - Method in class org.altbeacon.beacon.BeaconManager
-
- stopMonitoringBeaconsInRegion(List<Region>) - Method in class org.altbeacon.beacon.BeaconManager
-
- stopMonitoringBeaconsInRegion(Region) - Method in class org.altbeacon.beacon.BeaconManager
-
Tells the BeaconService to stop looking for beacons that match the passed
Region object.
- stopRangingBeaconsInRegion(List<Region>) - Method in class org.altbeacon.beacon.BeaconManager
-
- stopRangingBeaconsInRegion(Region) - Method in class org.altbeacon.beacon.BeaconManager
-
Tells the BeaconService to stop looking for beacons that match the passed
Region object and providing mDistance information for them.
- stopScan() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScanner
-
- stopScan() - Method in class org.altbeacon.beacon.service.scanner.CycledLeScannerForLollipop
-
- stopStatusPreservation() - Method in class org.altbeacon.beacon.service.MonitoringStatus
-
Client applications should not call directly.
- SUPPORTED - Static variable in class org.altbeacon.beacon.BeaconTransmitter
-
- sync(BeaconDataNotifier) - Method in interface org.altbeacon.beacon.BeaconData
-
- syncSettingsToService() - Method in class org.altbeacon.beacon.BeaconManager
-