diff options
Diffstat (limited to 'framework/java/android/bluetooth/le/ScanCallback.java')
-rw-r--r-- | framework/java/android/bluetooth/le/ScanCallback.java | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/framework/java/android/bluetooth/le/ScanCallback.java b/framework/java/android/bluetooth/le/ScanCallback.java new file mode 100644 index 0000000000..53d9310a12 --- /dev/null +++ b/framework/java/android/bluetooth/le/ScanCallback.java @@ -0,0 +1,88 @@ +/* + * Copyright (C) 2014 The Android Open Source Project + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package android.bluetooth.le; + +import java.util.List; + +/** + * Bluetooth LE scan callbacks. Scan results are reported using these callbacks. + * + * @see BluetoothLeScanner#startScan + */ +public abstract class ScanCallback { + /** + * Fails to start scan as BLE scan with the same settings is already started by the app. + */ + public static final int SCAN_FAILED_ALREADY_STARTED = 1; + + /** + * Fails to start scan as app cannot be registered. + */ + public static final int SCAN_FAILED_APPLICATION_REGISTRATION_FAILED = 2; + + /** + * Fails to start scan due an internal error + */ + public static final int SCAN_FAILED_INTERNAL_ERROR = 3; + + /** + * Fails to start power optimized scan as this feature is not supported. + */ + public static final int SCAN_FAILED_FEATURE_UNSUPPORTED = 4; + + /** + * Fails to start scan as it is out of hardware resources. + * + * @hide + */ + public static final int SCAN_FAILED_OUT_OF_HARDWARE_RESOURCES = 5; + + /** + * Fails to start scan as application tries to scan too frequently. + * @hide + */ + public static final int SCAN_FAILED_SCANNING_TOO_FREQUENTLY = 6; + + static final int NO_ERROR = 0; + + /** + * Callback when a BLE advertisement has been found. + * + * @param callbackType Determines how this callback was triggered. Could be one of {@link + * ScanSettings#CALLBACK_TYPE_ALL_MATCHES}, {@link ScanSettings#CALLBACK_TYPE_FIRST_MATCH} or + * {@link ScanSettings#CALLBACK_TYPE_MATCH_LOST} + * @param result A Bluetooth LE scan result. + */ + public void onScanResult(int callbackType, ScanResult result) { + } + + /** + * Callback when batch results are delivered. + * + * @param results List of scan results that are previously scanned. + */ + public void onBatchScanResults(List<ScanResult> results) { + } + + /** + * Callback when scan could not be started. + * + * @param errorCode Error code (one of SCAN_FAILED_*) for scan failure. + */ + public void onScanFailed(int errorCode) { + } +} |