Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2014 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 | |
Tyler Gunn | ef9f6f9 | 2014-09-12 22:16:17 -0700 | [diff] [blame] | 17 | package android.telecom; |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 18 | |
Tyler Gunn | 711d876fd | 2014-09-19 11:17:02 -0700 | [diff] [blame] | 19 | import android.annotation.SystemApi; |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 20 | import android.os.Parcel; |
| 21 | import android.os.Parcelable; |
| 22 | |
| 23 | import java.util.Locale; |
| 24 | |
| 25 | /** |
Santos Cordon | d3a0b16 | 2014-10-28 13:10:36 -0700 | [diff] [blame] | 26 | * Encapsulates the telecom audio state, including the current audio routing, supported audio |
| 27 | * routing and mute. |
Tyler Gunn | 711d876fd | 2014-09-19 11:17:02 -0700 | [diff] [blame] | 28 | * @hide |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 29 | */ |
Tyler Gunn | 711d876fd | 2014-09-19 11:17:02 -0700 | [diff] [blame] | 30 | @SystemApi |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 31 | public final class AudioState implements Parcelable { |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 32 | /** Direct the audio stream through the device's earpiece. */ |
Yorke Lee | 1426048 | 2014-08-20 16:16:26 -0700 | [diff] [blame] | 33 | public static final int ROUTE_EARPIECE = 0x00000001; |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 34 | |
| 35 | /** Direct the audio stream through Bluetooth. */ |
Yorke Lee | 1426048 | 2014-08-20 16:16:26 -0700 | [diff] [blame] | 36 | public static final int ROUTE_BLUETOOTH = 0x00000002; |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 37 | |
| 38 | /** Direct the audio stream through a wired headset. */ |
Yorke Lee | 1426048 | 2014-08-20 16:16:26 -0700 | [diff] [blame] | 39 | public static final int ROUTE_WIRED_HEADSET = 0x00000004; |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 40 | |
Nancy Chen | ea38cca | 2014-09-05 16:38:49 -0700 | [diff] [blame] | 41 | /** Direct the audio stream through the device's speakerphone. */ |
Yorke Lee | 1426048 | 2014-08-20 16:16:26 -0700 | [diff] [blame] | 42 | public static final int ROUTE_SPEAKER = 0x00000008; |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 43 | |
| 44 | /** |
| 45 | * Direct the audio stream through the device's earpiece or wired headset if one is |
| 46 | * connected. |
| 47 | */ |
Yorke Lee | 1426048 | 2014-08-20 16:16:26 -0700 | [diff] [blame] | 48 | public static final int ROUTE_WIRED_OR_EARPIECE = ROUTE_EARPIECE | ROUTE_WIRED_HEADSET; |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 49 | |
Nancy Chen | ea38cca | 2014-09-05 16:38:49 -0700 | [diff] [blame] | 50 | /** Bit mask of all possible audio routes. |
| 51 | * |
| 52 | * @hide |
| 53 | */ |
Yorke Lee | 1426048 | 2014-08-20 16:16:26 -0700 | [diff] [blame] | 54 | public static final int ROUTE_ALL = ROUTE_EARPIECE | ROUTE_BLUETOOTH | ROUTE_WIRED_HEADSET | |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 55 | ROUTE_SPEAKER; |
| 56 | |
Divya Sharma | 1cb8f69 | 2015-02-24 16:25:55 -0800 | [diff] [blame] | 57 | /** Note: Deprecated, please do not use if possible. */ |
| 58 | @SystemApi public final boolean isMuted; |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 59 | |
Divya Sharma | 1cb8f69 | 2015-02-24 16:25:55 -0800 | [diff] [blame] | 60 | /** Note: Deprecated, please do not use if possible. */ |
| 61 | @SystemApi public final int route; |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 62 | |
Divya Sharma | 1cb8f69 | 2015-02-24 16:25:55 -0800 | [diff] [blame] | 63 | /** Note: Deprecated, please do not use if possible. */ |
| 64 | @SystemApi public final int supportedRouteMask; |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 65 | |
Ihab Awad | 4a0d272 | 2014-11-12 13:41:16 -0800 | [diff] [blame] | 66 | public AudioState(boolean muted, int route, int supportedRouteMask) { |
| 67 | this.isMuted = muted; |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 68 | this.route = route; |
| 69 | this.supportedRouteMask = supportedRouteMask; |
| 70 | } |
| 71 | |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 72 | public AudioState(AudioState state) { |
Ihab Awad | 4a0d272 | 2014-11-12 13:41:16 -0800 | [diff] [blame] | 73 | isMuted = state.isMuted(); |
| 74 | route = state.getRoute(); |
| 75 | supportedRouteMask = state.getSupportedRouteMask(); |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 76 | } |
| 77 | |
| 78 | @Override |
| 79 | public boolean equals(Object obj) { |
| 80 | if (obj == null) { |
| 81 | return false; |
| 82 | } |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 83 | if (!(obj instanceof AudioState)) { |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 84 | return false; |
| 85 | } |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 86 | AudioState state = (AudioState) obj; |
Ihab Awad | 4a0d272 | 2014-11-12 13:41:16 -0800 | [diff] [blame] | 87 | return isMuted() == state.isMuted() && getRoute() == state.getRoute() && |
| 88 | getSupportedRouteMask() == state.getSupportedRouteMask(); |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 89 | } |
| 90 | |
| 91 | @Override |
| 92 | public String toString() { |
| 93 | return String.format(Locale.US, |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 94 | "[AudioState isMuted: %b, route; %s, supportedRouteMask: %s]", |
Ihab Awad | 4a0d272 | 2014-11-12 13:41:16 -0800 | [diff] [blame] | 95 | isMuted, |
| 96 | audioRouteToString(route), |
| 97 | audioRouteToString(supportedRouteMask)); |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 98 | } |
| 99 | |
| 100 | /** @hide */ |
| 101 | public static String audioRouteToString(int route) { |
| 102 | if (route == 0 || (route & ~ROUTE_ALL) != 0x0) { |
| 103 | return "UNKNOWN"; |
| 104 | } |
| 105 | |
| 106 | StringBuffer buffer = new StringBuffer(); |
| 107 | if ((route & ROUTE_EARPIECE) == ROUTE_EARPIECE) { |
| 108 | listAppend(buffer, "EARPIECE"); |
| 109 | } |
| 110 | if ((route & ROUTE_BLUETOOTH) == ROUTE_BLUETOOTH) { |
| 111 | listAppend(buffer, "BLUETOOTH"); |
| 112 | } |
| 113 | if ((route & ROUTE_WIRED_HEADSET) == ROUTE_WIRED_HEADSET) { |
| 114 | listAppend(buffer, "WIRED_HEADSET"); |
| 115 | } |
| 116 | if ((route & ROUTE_SPEAKER) == ROUTE_SPEAKER) { |
| 117 | listAppend(buffer, "SPEAKER"); |
| 118 | } |
| 119 | |
| 120 | return buffer.toString(); |
| 121 | } |
| 122 | |
| 123 | private static void listAppend(StringBuffer buffer, String str) { |
| 124 | if (buffer.length() > 0) { |
| 125 | buffer.append(", "); |
| 126 | } |
| 127 | buffer.append(str); |
| 128 | } |
| 129 | |
| 130 | /** |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 131 | * Responsible for creating AudioState objects for deserialized Parcels. |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 132 | */ |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 133 | public static final Parcelable.Creator<AudioState> CREATOR = |
| 134 | new Parcelable.Creator<AudioState> () { |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 135 | |
| 136 | @Override |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 137 | public AudioState createFromParcel(Parcel source) { |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 138 | boolean isMuted = source.readByte() == 0 ? false : true; |
| 139 | int route = source.readInt(); |
| 140 | int supportedRouteMask = source.readInt(); |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 141 | return new AudioState(isMuted, route, supportedRouteMask); |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 142 | } |
| 143 | |
| 144 | @Override |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 145 | public AudioState[] newArray(int size) { |
| 146 | return new AudioState[size]; |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 147 | } |
| 148 | }; |
| 149 | |
| 150 | /** |
| 151 | * {@inheritDoc} |
| 152 | */ |
| 153 | @Override |
| 154 | public int describeContents() { |
| 155 | return 0; |
| 156 | } |
| 157 | |
| 158 | /** |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 159 | * Writes AudioState object into a serializeable Parcel. |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 160 | */ |
| 161 | @Override |
| 162 | public void writeToParcel(Parcel destination, int flags) { |
| 163 | destination.writeByte((byte) (isMuted ? 1 : 0)); |
| 164 | destination.writeInt(route); |
| 165 | destination.writeInt(supportedRouteMask); |
| 166 | } |
Ihab Awad | 4a0d272 | 2014-11-12 13:41:16 -0800 | [diff] [blame] | 167 | |
| 168 | /** |
| 169 | * @return {@code true} if the call is muted, false otherwise. |
| 170 | */ |
| 171 | public boolean isMuted() { |
| 172 | return isMuted; |
| 173 | } |
| 174 | |
| 175 | /** |
| 176 | * @return The current audio route being used. |
| 177 | */ |
| 178 | public int getRoute() { |
| 179 | return route; |
| 180 | } |
| 181 | |
| 182 | /** |
| 183 | * @return Bit mask of all routes supported by this call. |
| 184 | */ |
| 185 | public int getSupportedRouteMask() { |
| 186 | return supportedRouteMask; |
| 187 | } |
Sailesh Nepal | 4cff392 | 2014-03-19 10:15:37 -0700 | [diff] [blame] | 188 | } |