IVrManager.aidl revision 3a47ec2edd04546d82ba1df331c7af778858a281 
1/**
2 * Copyright (c) 2016, 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.vr;
18
19import android.service.vr.IVrStateCallbacks;
20
21/** @hide */
22interface IVrManager {
23
24    /**
25     * Add a callback to be notified when VR mode state changes.
26     *
27     * @param cb the callback instance to add.
28     */
29    void registerListener(in IVrStateCallbacks cb);
30
31    /**
32     * Remove the callack from the current set of registered callbacks.
33     *
34     * @param cb the callback to remove.
35     */
36    void unregisterListener(in IVrStateCallbacks cb);
37
38    /**
39     * Return current VR mode state.
40     *
41     * @return {@code true} if VR mode is enabled.
42     */
43    boolean getVrModeState();
44
45    /**
46     * Sets the persistent VR mode state of a device. When a device is in persistent VR mode it will
47     * remain in VR mode even if the foreground does not specify VR mode being enabled. Mainly used
48     * by VR viewers to indicate that a device is placed in a VR viewer.
49     *
50     * @param enabled true if the device should be placed in persistent VR mode.
51     */
52    void setPersistentVrModeEnabled(in boolean enabled);
53
54    /**
55     * Return current virtual display id.
56     *
57     * @return {@link android.view.Display.INVALID_DISPLAY} if there is no virtual display
58     * currently, else return the display id of the virtual display
59     */
60    int getCompatibilityDisplayId();
61}
62
63