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 17 package android.service.dreams; 18 19 import android.content.ComponentName; 20 21 /** 22 * Dream manager local system service interface. 23 * 24 * @hide Only for use within the system server. 25 */ 26 public abstract class DreamManagerInternal { 27 /** 28 * Called by the power manager to start a dream. 29 * 30 * @param doze If true, starts the doze dream component if one has been configured, 31 * otherwise starts the user-specified dream. 32 */ startDream(boolean doze)33 public abstract void startDream(boolean doze); 34 35 /** 36 * Called by the power manager to stop a dream. 37 * 38 * @param immediate If true, ends the dream summarily, otherwise gives it some time 39 * to perform a proper exit transition. 40 */ stopDream(boolean immediate)41 public abstract void stopDream(boolean immediate); 42 43 /** 44 * Called by the power manager to determine whether a dream is running. 45 */ isDreaming()46 public abstract boolean isDreaming(); 47 48 /** 49 * Called by the ActivityTaskManagerService to verify that the startDreamActivity 50 * request comes from the current active dream component. 51 * 52 * This function and its call path should not acquire the DreamManagerService lock 53 * to avoid deadlock with the ActivityTaskManager lock. 54 * 55 * TODO: Make this interaction push-based - the DreamManager should inform the 56 * ActivityTaskManager whenever the active dream component changes. 57 * 58 * @param doze If true returns the current active doze component. Otherwise, returns the 59 * active dream component. 60 */ getActiveDreamComponent(boolean doze)61 public abstract ComponentName getActiveDreamComponent(boolean doze); 62 } 63