Jaikumar Ganesh | 62c37ef | 2010-08-24 17:36:13 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2010 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | |
| 18 | package android.bluetooth; |
| 19 | |
Jaikumar Ganesh | 03cd78c | 2010-10-18 16:41:53 -0700 | [diff] [blame] | 20 | import java.util.List; |
Jaikumar Ganesh | 62c37ef | 2010-08-24 17:36:13 -0700 | [diff] [blame] | 21 | |
| 22 | /** |
| 23 | * Public APIs for the Bluetooth Profiles. |
| 24 | * |
| 25 | * <p> Clients should call {@link BluetoothAdapter#getProfileProxy}, |
| 26 | * to get the Profile Proxy. Each public profile implements this |
| 27 | * interface. |
| 28 | */ |
| 29 | public interface BluetoothProfile { |
| 30 | |
| 31 | /** |
| 32 | * Extra for the connection state intents of the individual profiles. |
| 33 | * |
| 34 | * This extra represents the current connection state of the profile of the |
| 35 | * Bluetooth device. |
| 36 | */ |
| 37 | public static final String EXTRA_STATE = "android.bluetooth.profile.extra.STATE"; |
| 38 | |
| 39 | /** |
| 40 | * Extra for the connection state intents of the individual profiles. |
| 41 | * |
| 42 | * This extra represents the previous connection state of the profile of the |
| 43 | * Bluetooth device. |
| 44 | */ |
| 45 | public static final String EXTRA_PREVIOUS_STATE = |
| 46 | "android.bluetooth.profile.extra.PREVIOUS_STATE"; |
| 47 | |
| 48 | /** The profile is in disconnected state */ |
| 49 | public static final int STATE_DISCONNECTED = 0; |
| 50 | /** The profile is in connecting state */ |
| 51 | public static final int STATE_CONNECTING = 1; |
| 52 | /** The profile is in connected state */ |
| 53 | public static final int STATE_CONNECTED = 2; |
| 54 | /** The profile is in disconnecting state */ |
| 55 | public static final int STATE_DISCONNECTING = 3; |
| 56 | |
| 57 | /** |
| 58 | * Headset and Handsfree profile |
| 59 | */ |
| 60 | public static final int HEADSET = 1; |
Jaikumar Ganesh | 74ef119 | 2011-02-23 10:22:15 -0800 | [diff] [blame] | 61 | |
Jaikumar Ganesh | 62c37ef | 2010-08-24 17:36:13 -0700 | [diff] [blame] | 62 | /** |
| 63 | * A2DP profile. |
| 64 | */ |
| 65 | public static final int A2DP = 2; |
Jaikumar Ganesh | 74ef119 | 2011-02-23 10:22:15 -0800 | [diff] [blame] | 66 | |
Jaikumar Ganesh | 4ab0e77 | 2011-02-18 14:52:32 -0800 | [diff] [blame] | 67 | /** |
Jaikumar Ganesh | 2ea1e85 | 2011-04-01 16:33:09 -0700 | [diff] [blame] | 68 | * Health Profile |
| 69 | * @hide |
| 70 | */ |
| 71 | public static final int HEALTH = 3; |
| 72 | |
| 73 | /** |
Jaikumar Ganesh | 4ab0e77 | 2011-02-18 14:52:32 -0800 | [diff] [blame] | 74 | * Input Device Profile |
| 75 | * @hide |
| 76 | */ |
Jaikumar Ganesh | 2ea1e85 | 2011-04-01 16:33:09 -0700 | [diff] [blame] | 77 | public static final int INPUT_DEVICE = 4; |
Jaikumar Ganesh | 62c37ef | 2010-08-24 17:36:13 -0700 | [diff] [blame] | 78 | |
| 79 | /** |
Jaikumar Ganesh | 74ef119 | 2011-02-23 10:22:15 -0800 | [diff] [blame] | 80 | * PAN Profile |
| 81 | * @hide |
| 82 | */ |
Jaikumar Ganesh | 2ea1e85 | 2011-04-01 16:33:09 -0700 | [diff] [blame] | 83 | public static final int PAN = 5; |
Jaikumar Ganesh | 74ef119 | 2011-02-23 10:22:15 -0800 | [diff] [blame] | 84 | |
| 85 | /** |
Jaikumar Ganesh | 62c37ef | 2010-08-24 17:36:13 -0700 | [diff] [blame] | 86 | * Default priority for devices that we try to auto-connect to and |
| 87 | * and allow incoming connections for the profile |
| 88 | * @hide |
| 89 | **/ |
| 90 | public static final int PRIORITY_AUTO_CONNECT = 1000; |
| 91 | |
| 92 | /** |
| 93 | * Default priority for devices that allow incoming |
| 94 | * and outgoing connections for the profile |
| 95 | * @hide |
| 96 | **/ |
| 97 | public static final int PRIORITY_ON = 100; |
| 98 | |
| 99 | /** |
| 100 | * Default priority for devices that does not allow incoming |
| 101 | * connections and outgoing connections for the profile. |
| 102 | * @hide |
| 103 | **/ |
| 104 | public static final int PRIORITY_OFF = 0; |
| 105 | |
| 106 | /** |
| 107 | * Default priority when not set or when the device is unpaired |
| 108 | * @hide |
| 109 | * */ |
| 110 | public static final int PRIORITY_UNDEFINED = -1; |
| 111 | |
| 112 | /** |
Jaikumar Ganesh | 62c37ef | 2010-08-24 17:36:13 -0700 | [diff] [blame] | 113 | * Get connected devices for this specific profile. |
| 114 | * |
| 115 | * <p> Return the set of devices which are in state {@link #STATE_CONNECTED} |
| 116 | * |
Jaikumar Ganesh | c8fa4ff | 2011-01-25 16:03:13 -0800 | [diff] [blame] | 117 | * <p>Requires {@link android.Manifest.permission#BLUETOOTH} permission. |
Jaikumar Ganesh | 62c37ef | 2010-08-24 17:36:13 -0700 | [diff] [blame] | 118 | * |
Jaikumar Ganesh | 03cd78c | 2010-10-18 16:41:53 -0700 | [diff] [blame] | 119 | * @return List of devices. The list will be empty on error. |
Jaikumar Ganesh | 62c37ef | 2010-08-24 17:36:13 -0700 | [diff] [blame] | 120 | */ |
Jaikumar Ganesh | 03cd78c | 2010-10-18 16:41:53 -0700 | [diff] [blame] | 121 | public List<BluetoothDevice> getConnectedDevices(); |
Jaikumar Ganesh | 62c37ef | 2010-08-24 17:36:13 -0700 | [diff] [blame] | 122 | |
| 123 | /** |
Jaikumar Ganesh | c8fa4ff | 2011-01-25 16:03:13 -0800 | [diff] [blame] | 124 | * Get a list of devices that match any of the given connection |
Jaikumar Ganesh | 62c37ef | 2010-08-24 17:36:13 -0700 | [diff] [blame] | 125 | * states. |
| 126 | * |
Jaikumar Ganesh | c8fa4ff | 2011-01-25 16:03:13 -0800 | [diff] [blame] | 127 | * <p> If none of the devices match any of the given states, |
| 128 | * an empty list will be returned. |
Jaikumar Ganesh | 62c37ef | 2010-08-24 17:36:13 -0700 | [diff] [blame] | 129 | * |
Jaikumar Ganesh | c8fa4ff | 2011-01-25 16:03:13 -0800 | [diff] [blame] | 130 | * <p>Requires {@link android.Manifest.permission#BLUETOOTH} permission. |
Jaikumar Ganesh | 62c37ef | 2010-08-24 17:36:13 -0700 | [diff] [blame] | 131 | * |
| 132 | * @param states Array of states. States can be one of |
| 133 | * {@link #STATE_CONNECTED}, {@link #STATE_CONNECTING}, |
| 134 | * {@link #STATE_DISCONNECTED}, {@link #STATE_DISCONNECTING}, |
Jaikumar Ganesh | 03cd78c | 2010-10-18 16:41:53 -0700 | [diff] [blame] | 135 | * @return List of devices. The list will be empty on error. |
Jaikumar Ganesh | 62c37ef | 2010-08-24 17:36:13 -0700 | [diff] [blame] | 136 | */ |
Jaikumar Ganesh | 03cd78c | 2010-10-18 16:41:53 -0700 | [diff] [blame] | 137 | public List<BluetoothDevice> getDevicesMatchingConnectionStates(int[] states); |
Jaikumar Ganesh | 62c37ef | 2010-08-24 17:36:13 -0700 | [diff] [blame] | 138 | |
| 139 | /** |
| 140 | * Get the current connection state of the profile |
| 141 | * |
Jaikumar Ganesh | c8fa4ff | 2011-01-25 16:03:13 -0800 | [diff] [blame] | 142 | * <p>Requires {@link android.Manifest.permission#BLUETOOTH} permission. |
Jaikumar Ganesh | 62c37ef | 2010-08-24 17:36:13 -0700 | [diff] [blame] | 143 | * |
| 144 | * @param device Remote bluetooth device. |
| 145 | * @return State of the profile connection. One of |
| 146 | * {@link #STATE_CONNECTED}, {@link #STATE_CONNECTING}, |
| 147 | * {@link #STATE_DISCONNECTED}, {@link #STATE_DISCONNECTING} |
| 148 | */ |
| 149 | public int getConnectionState(BluetoothDevice device); |
| 150 | |
| 151 | /** |
Jaikumar Ganesh | 62c37ef | 2010-08-24 17:36:13 -0700 | [diff] [blame] | 152 | * An interface for notifying BluetoothProfile IPC clients when they have |
| 153 | * been connected or disconnected to the service. |
| 154 | */ |
| 155 | public interface ServiceListener { |
| 156 | /** |
| 157 | * Called to notify the client when the proxy object has been |
| 158 | * connected to the service. |
| 159 | * @param profile - One of {@link #HEADSET} or |
| 160 | * {@link #A2DP} |
| 161 | * @param proxy - One of {@link BluetoothHeadset} or |
| 162 | * {@link BluetoothA2dp} |
| 163 | */ |
| 164 | public void onServiceConnected(int profile, BluetoothProfile proxy); |
| 165 | |
| 166 | /** |
| 167 | * Called to notify the client that this proxy object has been |
| 168 | * disconnected from the service. |
| 169 | * @param profile - One of {@link #HEADSET} or |
| 170 | * {@link #A2DP} |
| 171 | */ |
| 172 | public void onServiceDisconnected(int profile); |
| 173 | } |
| 174 | } |