DreamManagerInternal.java revision f6d466895b74d620d646abbec1c8911f3a0ce0bb 
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
17package android.service.dreams;
18
19/**
20 * Dream manager local system service interface.
21 *
22 * @hide Only for use within the system server.
23 */
24public abstract class DreamManagerInternal {
25    /**
26     * Called by the power manager to start a dream.
27     *
28     * @param doze If true, starts the doze dream component if one has been configured,
29     * otherwise starts the user-specified dream.
30     */
31    public abstract void startDream(boolean doze);
32
33    /**
34     * Called by the power manager to stop a dream.
35     *
36     * @param immediate If true, ends the dream summarily, otherwise gives it some time
37     * to perform a proper exit transition.
38     */
39    public abstract void stopDream(boolean immediate);
40
41    /**
42     * Called by the power manager to determine whether a dream is running.
43     */
44    public abstract boolean isDreaming();
45}
46