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.service.dreams; 18 19 import android.service.dreams.IDreamOverlayCallback; 20 import android.view.WindowManager.LayoutParams; 21 22 /** 23 * {@link IDreamOverlayClient} allows {@link DreamService} instances to act upon the dream overlay. 24 * 25 * @hide 26 */ 27 interface IDreamOverlayClient { 28 /** 29 * @param params The {@link LayoutParams} for the associated DreamWindow, including the window 30 token of the Dream Activity. 31 * @param callback The {@link IDreamOverlayCallback} for requesting actions such as exiting the 32 * dream. 33 * @param dreamComponent The component name of the dream service requesting overlay. 34 * @param isPreview Whether the dream is in preview mode. 35 * @param shouldShowComplications Whether the dream overlay should show complications, e.g. clock 36 * and weather. 37 */ startDream(in LayoutParams params, in IDreamOverlayCallback callback, in String dreamComponent, in boolean isPreview, in boolean shouldShowComplications)38 void startDream(in LayoutParams params, in IDreamOverlayCallback callback, 39 in String dreamComponent, in boolean isPreview, in boolean shouldShowComplications); 40 41 /** Called when the dream is waking, to do any exit animations */ wakeUp()42 void wakeUp(); 43 44 /** Called when the dream has ended. */ endDream()45 void endDream(); 46 47 /** Called when wake up has been redirected to the overlay. */ onWakeRequested()48 void onWakeRequested(); 49 50 /** Called when the dream is coming to the front. */ comeToFront()51 void comeToFront(); 52 } 53