VrManagerInternal.java revision b5cbecb16a53e74edd626b1571a47aa261482efd 
1/**
2 * Copyright (C) 2015 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 */
16package com.android.server.vr;
17
18import android.annotation.NonNull;
19import android.app.Vr2dDisplayProperties;
20import android.content.ComponentName;
21import android.service.vr.IPersistentVrStateCallbacks;
22
23/**
24 * Service for accessing the VR mode manager.
25 *
26 * @hide Only for use within system server.
27 */
28public abstract class VrManagerInternal {
29
30    /**
31     * The error code returned on success.
32     */
33    public static final int NO_ERROR = 0;
34
35    /**
36     * Return {@code true} if the given package is the currently bound VrListenerService for the
37     * given user.
38     *
39     * @param packageName The package name to check.
40     * @param userId the user ID to check the package name for.
41     *
42     * @return {@code true} if the given package is the currently bound VrListenerService.
43     */
44    public abstract boolean isCurrentVrListener(String packageName, int userId);
45
46    /**
47     * Set the current VR mode state.
48     * <p/>
49     * This may delay the mode change slightly during application transitions to avoid frequently
50     * tearing down VrListenerServices unless necessary.
51     *
52     * @param enabled {@code true} to enable VR mode.
53     * @param packageName The package name of the requested VrListenerService to bind.
54     * @param userId the user requesting the VrListenerService component.
55     * @param processId the process the component is running in.
56     * @param calling the component currently using VR mode, or null to leave unchanged.
57     */
58    public abstract void setVrMode(boolean enabled, @NonNull ComponentName packageName,
59            int userId, int processId, @NonNull ComponentName calling);
60
61    /**
62     * Set whether the system has acquired a sleep token.
63     *
64     * @param isAsleep is {@code true} if the device is asleep, or {@code false} otherwise.
65     */
66    public abstract void onSleepStateChanged(boolean isAsleep);
67
68    /**
69     * Set whether the display used for VR output is on.
70     *
71     * @param isScreenOn is {@code true} if the display is on and can receive commands,
72     *      or {@code false} otherwise.
73     */
74    public abstract void onScreenStateChanged(boolean isScreenOn);
75
76    /**
77     * Set whether the keyguard is currently active/showing.
78     *
79     * @param isShowing is {@code true} if the keyguard is active/showing.
80     */
81    public abstract void onKeyguardStateChanged(boolean isShowing);
82
83    /**
84     * Return NO_ERROR if the given package is installed on the device and enabled as a
85     * VrListenerService for the given current user, or a negative error code indicating a failure.
86     *
87     * @param packageName the name of the package to check, or null to select the default package.
88     * @return NO_ERROR if the given package is installed and is enabled, or a negative error code
89     *       given in {@link android.service.vr.VrModeException} on failure.
90     */
91    public abstract int hasVrPackage(@NonNull ComponentName packageName, int userId);
92
93    /**
94     * Sets the resolution and DPI of the vr2d virtual display used to display
95     * 2D applications in VR mode.
96     *
97     * <p>Requires {@link android.Manifest.permission#ACCESS_VR_MANAGER} permission.</p>
98     *
99     * @param vr2dDisplayProp Properties of the virtual display for 2D applications
100     * in VR mode.
101     */
102    public abstract void setVr2dDisplayProperties(
103            Vr2dDisplayProperties vr2dDisplayProp);
104
105    /**
106     * Sets the persistent VR mode state of a device. When a device is in persistent VR mode it will
107     * remain in VR mode even if the foreground does not specify Vr mode being enabled. Mainly used
108     * by VR viewers to indicate that a device is placed in a VR viewer.
109     *
110     * @param enabled true if the device should be placed in persistent VR mode.
111     */
112    public abstract void setPersistentVrModeEnabled(boolean enabled);
113
114    /**
115     * Return {@link android.view.Display.INVALID_DISPLAY} if there exists no virtual display
116     * currently or the display id of the current virtual display.
117     *
118     * @return {@link android.view.Display.INVALID_DISPLAY} if there is no virtual display
119     * currently, else return the display id of the virtual display
120     */
121    public abstract int getVr2dDisplayId();
122
123    /**
124     * Adds listener that reports state changes to persistent VR mode.
125     */
126    public abstract void addPersistentVrModeStateListener(IPersistentVrStateCallbacks listener);
127}
128