• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 
20 import java.util.List;
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;
61 
62     /**
63      * A2DP profile.
64      */
65     public static final int A2DP = 2;
66 
67     /**
68      * Health Profile
69      */
70     public static final int HEALTH = 3;
71 
72     /**
73      * Input Device Profile
74      * @hide
75      */
76     public static final int INPUT_DEVICE = 4;
77 
78     /**
79      * PAN Profile
80      * @hide
81      */
82     public static final int PAN = 5;
83 
84     /**
85      * PBAP
86      * @hide
87      */
88     public static final int PBAP = 6;
89 
90     /**
91      * Default priority for devices that we try to auto-connect to and
92      * and allow incoming connections for the profile
93      * @hide
94      **/
95     public static final int PRIORITY_AUTO_CONNECT = 1000;
96 
97     /**
98      *  Default priority for devices that allow incoming
99      * and outgoing connections for the profile
100      * @hide
101      **/
102     public static final int PRIORITY_ON = 100;
103 
104     /**
105      * Default priority for devices that does not allow incoming
106      * connections and outgoing connections for the profile.
107      * @hide
108      **/
109     public static final int PRIORITY_OFF = 0;
110 
111     /**
112      * Default priority when not set or when the device is unpaired
113      * @hide
114      * */
115     public static final int PRIORITY_UNDEFINED = -1;
116 
117     /**
118      * Get connected devices for this specific profile.
119      *
120      * <p> Return the set of devices which are in state {@link #STATE_CONNECTED}
121      *
122      * <p>Requires {@link android.Manifest.permission#BLUETOOTH} permission.
123      *
124      * @return List of devices. The list will be empty on error.
125      */
getConnectedDevices()126     public List<BluetoothDevice> getConnectedDevices();
127 
128     /**
129      * Get a list of devices that match any of the given connection
130      * states.
131      *
132      * <p> If none of the devices match any of the given states,
133      * an empty list will be returned.
134      *
135      * <p>Requires {@link android.Manifest.permission#BLUETOOTH} permission.
136      *
137      * @param states Array of states. States can be one of
138      *              {@link #STATE_CONNECTED}, {@link #STATE_CONNECTING},
139      *              {@link #STATE_DISCONNECTED}, {@link #STATE_DISCONNECTING},
140      * @return List of devices. The list will be empty on error.
141      */
getDevicesMatchingConnectionStates(int[] states)142     public List<BluetoothDevice> getDevicesMatchingConnectionStates(int[] states);
143 
144     /**
145      * Get the current connection state of the profile
146      *
147      * <p>Requires {@link android.Manifest.permission#BLUETOOTH} permission.
148      *
149      * @param device Remote bluetooth device.
150      * @return State of the profile connection. One of
151      *               {@link #STATE_CONNECTED}, {@link #STATE_CONNECTING},
152      *               {@link #STATE_DISCONNECTED}, {@link #STATE_DISCONNECTING}
153      */
getConnectionState(BluetoothDevice device)154     public int getConnectionState(BluetoothDevice device);
155 
156     /**
157      * An interface for notifying BluetoothProfile IPC clients when they have
158      * been connected or disconnected to the service.
159      */
160     public interface ServiceListener {
161         /**
162          * Called to notify the client when the proxy object has been
163          * connected to the service.
164          * @param profile - One of {@link #HEALTH}, {@link #HEADSET} or
165          *                  {@link #A2DP}
166          * @param proxy - One of {@link BluetoothHealth}, {@link BluetoothHeadset} or
167          *                {@link BluetoothA2dp}
168          */
onServiceConnected(int profile, BluetoothProfile proxy)169         public void onServiceConnected(int profile, BluetoothProfile proxy);
170 
171         /**
172          * Called to notify the client that this proxy object has been
173          * disconnected from the service.
174          * @param profile - One of {@link #HEALTH}, {@link #HEADSET} or
175          *                  {@link #A2DP}
176          */
onServiceDisconnected(int profile)177         public void onServiceDisconnected(int profile);
178     }
179 }
180