History

harvey186 b79bdfd15b v122		2024-02-18 09:20:44 +01:00
..
docs	first commit	2023-11-28 09:10:03 +01:00
src	v122	2024-02-18 09:20:44 +01:00
README.md	first commit	2023-11-28 09:10:03 +01:00
build.gradle	v122	2024-02-18 09:20:44 +01:00
geckoview.fml.yaml	first commit	2023-11-28 09:10:03 +01:00
metrics.yaml	first commit	2023-11-28 09:10:03 +01:00
proguard-rules.pro	first commit	2023-11-28 09:10:03 +01:00

README.md

Engine-Gecko

Engine implementation based on GeckoView.

Usage

Setting up the dependency

Use Gradle to download the library from maven.mozilla.org (Setup repository):

implementation "org.mozilla.components:browser-engine-gecko:{latest-version}"

Integration with the Glean SDK

Before using this component

Products sending telemetry and using this component must request a data-review following this process.

The Glean SDK can be used to collect Gecko Telemetry. Applications using both this component and the Glean SDK should setup the Gecko Telemetry delegate as shown below:

    val builder = GeckoRuntimeSettings.Builder()
    val runtimeSettings = builder
        .telemetryDelegate(GeckoGleanAdapter()) // Sets up the delegate!
        .build()
    // Create the Gecko runtime.
    GeckoRuntime.create(context, runtimeSettings)

Adding new metrics

New Gecko metrics can be added as described in the Firefox Telemetry docs.

License

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/