1 /* -*- Mode: Java; c-basic-offset: 4; tab-width: 20; indent-tabs-mode: nil; -*-
2  * This Source Code Form is subject to the terms of the Mozilla Public
3  * License, v. 2.0. If a copy of the MPL was not distributed with this
4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
5 
6 /**
7  * This package contains the public interfaces for the library.
8  *
9  * <ul>
10  * <li>
11  *     {@link org.mozilla.geckoview.GeckoRuntime} is the entry point for starting and initializing
12  *     Gecko. You can use this to preload Gecko before you need to load a page or to configure features
13  *     such as crash reporting.
14  * </li>
15  *
16  * <li>
17  *     {@link org.mozilla.geckoview.GeckoSession} is where most interesting work happens, such as
18  *     loading pages. It relies on {@link org.mozilla.geckoview.GeckoRuntime}
19  *     to talk to Gecko.
20  * </li>
21  *
22  * <li>
23  *     {@link org.mozilla.geckoview.GeckoView} is the embeddable {@link android.view.View}. This is
24  *     the most common way of getting a {@link org.mozilla.geckoview.GeckoSession} onto the screen.
25  * </li>
26  * </ul>
27  *
28  * <p>
29  * <strong>Permissions</strong>
30  * <p>
31  * This library does not request any dangerous permissions in the manifest, though it's possible
32  * that some web features may require them. For instance, WebRTC video calls would need the
33  * {@link android.Manifest.permission#CAMERA} and {@link android.Manifest.permission#RECORD_AUDIO}
34  * permissions. Declaring these are at the application's discretion. If you want full web
35  * functionality, the following permissions should be declared:
36  *
37  * <ul>
38  *     <li>{@link android.Manifest.permission#ACCESS_COARSE_LOCATION}</li>
39  *     <li>{@link android.Manifest.permission#ACCESS_FINE_LOCATION}</li>
40  *     <li>{@link android.Manifest.permission#READ_EXTERNAL_STORAGE}</li>
41  *     <li>{@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE}</li>
42  *     <li>{@link android.Manifest.permission#CAMERA}</li>
43  *     <li>{@link android.Manifest.permission#RECORD_AUDIO}</li>
44  * </ul>
45  *
46  * For a detailed change log of the API see: <a href="./doc-files/CHANGELOG" target="_blank">CHANGELOG</a>.
47  */
48 package org.mozilla.geckoview;
49