1 /* 2 * Copyright (C) 2023 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 package android.telecom; 18 19 import android.annotation.FlaggedApi; 20 import android.annotation.NonNull; 21 import android.os.Bundle; 22 23 import com.android.server.telecom.flags.Flags; 24 25 import java.util.List; 26 27 /** 28 * CallEventCallback relays call updates (that do not require any action) from the Telecom framework 29 * out to the application. This can include operations which the app must implement on a Call due to 30 * the presence of other calls on the device, requests relayed from a Bluetooth device, 31 * or from another calling surface. 32 */ 33 public interface CallEventCallback { 34 /** 35 * Telecom is informing the client the current {@link CallEndpoint} changed. 36 * 37 * @param newCallEndpoint The new {@link CallEndpoint} through which call media flows 38 * (i.e. speaker, bluetooth, etc.). 39 */ onCallEndpointChanged(@onNull CallEndpoint newCallEndpoint)40 void onCallEndpointChanged(@NonNull CallEndpoint newCallEndpoint); 41 42 /** 43 * Telecom is informing the client that the available {@link CallEndpoint}s have changed. 44 * 45 * @param availableEndpoints The set of available {@link CallEndpoint}s reported by Telecom. 46 */ onAvailableCallEndpointsChanged(@onNull List<CallEndpoint> availableEndpoints)47 void onAvailableCallEndpointsChanged(@NonNull List<CallEndpoint> availableEndpoints); 48 49 /** 50 * Called when the mute state changes. 51 * 52 * @param isMuted The current mute state. 53 */ onMuteStateChanged(boolean isMuted)54 void onMuteStateChanged(boolean isMuted); 55 56 /** 57 * Called when the video state changes. 58 * 59 * @param videoState The current video state. 60 */ 61 @FlaggedApi(Flags.FLAG_TRANSACTIONAL_VIDEO_STATE) onVideoStateChanged(@allAttributes.CallType int videoState)62 default void onVideoStateChanged(@CallAttributes.CallType int videoState) {} 63 64 /** 65 * Telecom is informing the client user requested call streaming but the stream can't be 66 * started. 67 * 68 * @param reason Code to indicate the reason of this failure 69 */ onCallStreamingFailed(@allStreamingService.StreamingFailedReason int reason)70 void onCallStreamingFailed(@CallStreamingService.StreamingFailedReason int reason); 71 72 /** 73 * Informs this {@link android.telecom.CallEventCallback} on events raised from a 74 * {@link android.telecom.InCallService} presenting this call. These events and the 75 * associated extra keys for the {@code Bundle} parameter are mutually defined by a VoIP 76 * application and {@link android.telecom.InCallService}. This enables alternative calling 77 * surfaces, such as an automotive UI, to relay requests to perform other non-standard call 78 * actions to the app. For example, an automotive calling solution may offer the ability for 79 * the user to raise their hand during a meeting. 80 * 81 * @param event a string event identifier agreed upon between a VoIP application and an 82 * {@link android.telecom.InCallService} 83 * @param extras a {@link android.os.Bundle} containing information about the event, as agreed 84 * upon between a VoIP application and {@link android.telecom.InCallService}. 85 */ onEvent(@onNull String event, @NonNull Bundle extras)86 void onEvent(@NonNull String event, @NonNull Bundle extras); 87 } 88