Inheritance diagram for io.flutter.embedding.engine.FlutterEngine:

Classes
interface	EngineLifecycleListener

Public Member Functions
	FlutterEngine (@NonNull Context context)

	FlutterEngine (@NonNull Context context, @Nullable String[] dartVmArgs)

	FlutterEngine ( @NonNull Context context, @Nullable String[] dartVmArgs, boolean automaticallyRegisterPlugins)

	FlutterEngine ( @NonNull Context context, @Nullable String[] dartVmArgs, boolean automaticallyRegisterPlugins, boolean waitForRestorationData)

	FlutterEngine ( @NonNull Context context, @Nullable FlutterLoader flutterLoader, @NonNull FlutterJNI flutterJNI)

	FlutterEngine ( @NonNull Context context, @Nullable FlutterLoader flutterLoader, @NonNull FlutterJNI flutterJNI, @Nullable String[] dartVmArgs, boolean automaticallyRegisterPlugins)

	FlutterEngine ( @NonNull Context context, @Nullable FlutterLoader flutterLoader, @NonNull FlutterJNI flutterJNI, @NonNull PlatformViewsController platformViewsController, @Nullable String[] dartVmArgs, boolean automaticallyRegisterPlugins)

	FlutterEngine ( @NonNull Context context, @Nullable FlutterLoader flutterLoader, @NonNull FlutterJNI flutterJNI, @NonNull PlatformViewsController platformViewsController, @Nullable String[] dartVmArgs, boolean automaticallyRegisterPlugins, boolean waitForRestorationData)

	FlutterEngine ( @NonNull Context context, @Nullable FlutterLoader flutterLoader, @NonNull FlutterJNI flutterJNI, @NonNull PlatformViewsController platformViewsController, @Nullable String[] dartVmArgs, boolean automaticallyRegisterPlugins, boolean waitForRestorationData, @Nullable FlutterEngineGroup group)

void	destroy ()

void	addEngineLifecycleListener (@NonNull EngineLifecycleListener listener)

void	removeEngineLifecycleListener (@NonNull EngineLifecycleListener listener)

DartExecutor	getDartExecutor ()

FlutterRenderer	getRenderer ()

AccessibilityChannel	getAccessibilityChannel ()

LifecycleChannel	getLifecycleChannel ()

LocalizationChannel	getLocalizationChannel ()

NavigationChannel	getNavigationChannel ()

BackGestureChannel	getBackGestureChannel ()

PlatformChannel	getPlatformChannel ()

ProcessTextChannel	getProcessTextChannel ()

RestorationChannel	getRestorationChannel ()

SettingsChannel	getSettingsChannel ()

DeferredComponentChannel	getDeferredComponentChannel ()

SystemChannel	getSystemChannel ()

MouseCursorChannel	getMouseCursorChannel ()

TextInputChannel	getTextInputChannel ()

SpellCheckChannel	getSpellCheckChannel ()

PluginRegistry	getPlugins ()

LocalizationPlugin	getLocalizationPlugin ()

PlatformViewsController	getPlatformViewsController ()

ActivityControlSurface	getActivityControlSurface ()

ServiceControlSurface	getServiceControlSurface ()

BroadcastReceiverControlSurface	getBroadcastReceiverControlSurface ()

ContentProviderControlSurface	getContentProviderControlSurface ()

void	updateDisplayMetrics (float width, float height, float density)

void	updateDisplayMetrics (float width, float height, float density)

Package Functions
FlutterEngine	spawn ( @NonNull Context context, @NonNull DartEntrypoint dartEntrypoint, @Nullable String initialRoute, @Nullable List< String > dartEntrypointArgs, @Nullable PlatformViewsController platformViewsController, boolean automaticallyRegisterPlugins, boolean waitForRestorationData)

Detailed Description

A single Flutter execution environment.

The FlutterEngine is the container through which Dart code can be run in an Android application.

Dart code in a FlutterEngine can execute in the background, or it can be render to the screen by using the accompanying FlutterRenderer and Dart code using the Flutter framework on the Dart side. Rendering can be started and stopped, thus allowing a FlutterEngine to move from UI interaction to data-only processing and then back to UI interaction.

Multiple FlutterEngines may exist, execute Dart code, and render UIs within a single Android app. For better memory performance characteristics, construct multiple FlutterEngines via io.flutter.embedding.engine.FlutterEngineGroup rather than via FlutterEngine's constructor directly.

To start running Dart and/or Flutter within this FlutterEngine, get a reference to this engine's DartExecutor and then use DartExecutor#executeDartEntrypoint(DartExecutor.DartEntrypoint). The DartExecutor#executeDartEntrypoint(DartExecutor.DartEntrypoint) method must not be invoked twice on the same FlutterEngine.

To start rendering Flutter content to the screen, use getRenderer() to obtain a FlutterRenderer and then attach a RenderSurface. Consider using a io.flutter.embedding.android.FlutterView as a RenderSurface.

Instatiating the first FlutterEngine per process will also load the Flutter engine's native library and start the Dart VM. Subsequent FlutterEngines will run on the same VM instance but will have their own Dart Isolate when the DartExecutor is run. Each Isolate is a self-contained Dart environment and cannot communicate with each other except via Isolate ports.

Definition at line 83 of file FlutterEngine.java.

Constructor & Destructor Documentation

◆ FlutterEngine() [1/9]

io.flutter.embedding.engine.FlutterEngine.FlutterEngine ( @NonNull Context context )

inline

Constructs a new FlutterEngine.

A new FlutterEngine does not execute any Dart code automatically. See getDartExecutor() and DartExecutor#executeDartEntrypoint(DartExecutor.DartEntrypoint) to begin executing Dart code within this FlutterEngine.

A new FlutterEngine will not display any UI until a RenderSurface is registered. See getRenderer() and FlutterRenderer#startRenderingToSurface(Surface, boolean).

A new FlutterEngine automatically attaches all plugins. See getPlugins().

A new FlutterEngine does come with all default system channels attached.

The first FlutterEngine instance constructed per process will also load the Flutter native library and start a Dart VM.

In order to pass Dart VM initialization arguments (see io.flutter.embedding.engine.FlutterShellArgs) when creating the VM, manually set the initialization arguments by calling io.flutter.embedding.engine.loader.FlutterLoader#startInitialization(Context) and io.flutter.embedding.engine.loader.FlutterLoader#ensureInitializationComplete(Context, String[]) before constructing the engine.

Definition at line 160 of file FlutterEngine.java.

                                                 {
    this(context, null);
  }

◆ FlutterEngine() [2/9]

io.flutter.embedding.engine.FlutterEngine.FlutterEngine	(	@NonNull Context	context,
		@Nullable String[]	dartVmArgs
	)

inline

Same as FlutterEngine(Context) with added support for passing Dart VM arguments.

If the Dart VM has already started, the given arguments will have no effect.

Definition at line 169 of file FlutterEngine.java.

                                                                                {
    this(context, /* flutterLoader */ null, /* flutterJNI */ null, dartVmArgs, true);
  }

◆ FlutterEngine() [3/9]

io.flutter.embedding.engine.FlutterEngine.FlutterEngine	(	@NonNull Context	context,
		@Nullable String[]	dartVmArgs,
		boolean	automaticallyRegisterPlugins
	)

inline

Same as FlutterEngine(Context) with added support for passing Dart VM arguments and avoiding automatic plugin registration.

If the Dart VM has already started, the given arguments will have no effect.

Definition at line 179 of file FlutterEngine.java.

                                            {
    this(
        context,
        /* flutterLoader */ null,
        /* flutterJNI */ null,
        dartVmArgs,
        automaticallyRegisterPlugins);
  }

◆ FlutterEngine() [4/9]

io.flutter.embedding.engine.FlutterEngine.FlutterEngine	(	@NonNull Context	context,
		@Nullable String[]	dartVmArgs,
		boolean	automaticallyRegisterPlugins,
		boolean	waitForRestorationData
	)

inline

Same as FlutterEngine(Context, String[], boolean) with added support for configuring whether the engine will receive restoration data.

The waitForRestorationData flag controls whether the engine delays responding to requests from the framework for restoration data until that data has been provided to the engine via RestorationChannel.setRestorationData(byte[] data). If the flag is false, the framework may temporarily initialize itself to default values before the restoration data has been made available to the engine. Setting waitForRestorationData to true avoids this extra work by delaying initialization until the data is available.

When waitForRestorationData is set, RestorationChannel.setRestorationData(byte[] data) must be called at a later point in time. If it later turns out that no restoration data is available to restore the framework from, that method must still be called with null as an argument to indicate "no data".

If the framework never requests the restoration data, this flag has no effect.

Definition at line 209 of file FlutterEngine.java.

                                      {
    this(
        context,
        /* flutterLoader */ null,
        /* flutterJNI */ null,
        new PlatformViewsController(),
        dartVmArgs,
        automaticallyRegisterPlugins,
        waitForRestorationData);
  }

◆ FlutterEngine() [5/9]

io.flutter.embedding.engine.FlutterEngine.FlutterEngine	(	@NonNull Context	context,
		@Nullable FlutterLoader	flutterLoader,
		@NonNull FlutterJNI	flutterJNI
	)

inline

Same as FlutterEngine(Context, FlutterLoader, FlutterJNI, String[], boolean) but with no Dart VM flags and automatically registers plugins.

flutterJNI should be a new instance that has never been attached to an engine before.

Definition at line 231 of file FlutterEngine.java.

                                      {
    this(context, flutterLoader, flutterJNI, null, true);
  }

◆ FlutterEngine() [6/9]

io.flutter.embedding.engine.FlutterEngine.FlutterEngine	(	@NonNull Context	context,
		@Nullable FlutterLoader	flutterLoader,
		@NonNull FlutterJNI	flutterJNI,
		@Nullable String[]	dartVmArgs,
		boolean	automaticallyRegisterPlugins
	)

inline

Same as FlutterEngine(Context, FlutterLoader, FlutterJNI), plus Dart VM flags in dartVmArgs, and control over whether plugins are automatically registered with this FlutterEngine in automaticallyRegisterPlugins. If plugins are automatically registered, then they are registered during the execution of this constructor.

Definition at line 244 of file FlutterEngine.java.

                                            {
    this(
        context,
        flutterLoader,
        flutterJNI,
        new PlatformViewsController(),
        dartVmArgs,
        automaticallyRegisterPlugins);
  }

◆ FlutterEngine() [7/9]

io.flutter.embedding.engine.FlutterEngine.FlutterEngine	(	@NonNull Context	context,
		@Nullable FlutterLoader	flutterLoader,
		@NonNull FlutterJNI	flutterJNI,
		@NonNull PlatformViewsController	platformViewsController,
		@Nullable String[]	dartVmArgs,
		boolean	automaticallyRegisterPlugins
	)

inline

Same as FlutterEngine(Context, FlutterLoader, FlutterJNI, String[], boolean), plus the ability to provide a custom PlatformViewsController.

Definition at line 263 of file FlutterEngine.java.

                                            {
    this(
        context,
        flutterLoader,
        flutterJNI,
        platformViewsController,
        dartVmArgs,
        automaticallyRegisterPlugins,
        false);
  }

◆ FlutterEngine() [8/9]

io.flutter.embedding.engine.FlutterEngine.FlutterEngine	(	@NonNull Context	context,
		@Nullable FlutterLoader	flutterLoader,
		@NonNull FlutterJNI	flutterJNI,
		@NonNull PlatformViewsController	platformViewsController,
		@Nullable String[]	dartVmArgs,
		boolean	automaticallyRegisterPlugins,
		boolean	waitForRestorationData
	)

inline

Fully configurable FlutterEngine constructor.

Definition at line 281 of file FlutterEngine.java.

                                      {
    this(
        context,
        flutterLoader,
        flutterJNI,
        platformViewsController,
        dartVmArgs,
        automaticallyRegisterPlugins,
        waitForRestorationData,
        null);
  }

◆ FlutterEngine() [9/9]

io.flutter.embedding.engine.FlutterEngine.FlutterEngine	(	@NonNull Context	context,
		@Nullable FlutterLoader	flutterLoader,
		@NonNull FlutterJNI	flutterJNI,
		@NonNull PlatformViewsController	platformViewsController,
		@Nullable String[]	dartVmArgs,
		boolean	automaticallyRegisterPlugins,
		boolean	waitForRestorationData,
		@Nullable FlutterEngineGroup	group
	)

inline

Definition at line 301 of file FlutterEngine.java.

                                          {
    AssetManager assetManager;
    try {
      assetManager = context.createPackageContext(context.getPackageName(), 0).getAssets();
    } catch (NameNotFoundException e) {
      assetManager = context.getAssets();
    }
 
    FlutterInjector injector = FlutterInjector.instance();
 
    if (flutterJNI == null) {
      flutterJNI = injector.getFlutterJNIFactory().provideFlutterJNI();
    }
    this.flutterJNI = flutterJNI;
 
    this.dartExecutor = new DartExecutor(flutterJNI, assetManager);
    this.dartExecutor.onAttachedToJNI();
 
    DeferredComponentManager deferredComponentManager =
        FlutterInjector.instance().deferredComponentManager();
 
    accessibilityChannel = new AccessibilityChannel(dartExecutor, flutterJNI);
    deferredComponentChannel = new DeferredComponentChannel(dartExecutor);
    lifecycleChannel = new LifecycleChannel(dartExecutor);
    localizationChannel = new LocalizationChannel(dartExecutor);
    mouseCursorChannel = new MouseCursorChannel(dartExecutor);
    navigationChannel = new NavigationChannel(dartExecutor);
    backGestureChannel = new BackGestureChannel(dartExecutor);
    platformChannel = new PlatformChannel(dartExecutor);
    processTextChannel = new ProcessTextChannel(dartExecutor, context.getPackageManager());
    restorationChannel = new RestorationChannel(dartExecutor, waitForRestorationData);
    settingsChannel = new SettingsChannel(dartExecutor);
    spellCheckChannel = new SpellCheckChannel(dartExecutor);
    systemChannel = new SystemChannel(dartExecutor);
    textInputChannel = new TextInputChannel(dartExecutor);
 
    if (deferredComponentManager != null) {
      deferredComponentManager.setDeferredComponentChannel(deferredComponentChannel);
    }
 
    this.localizationPlugin = new LocalizationPlugin(context, localizationChannel);
 
    if (flutterLoader == null) {
      flutterLoader = injector.flutterLoader();
    }
 
    if (!flutterJNI.isAttached()) {
      flutterLoader.startInitialization(context.getApplicationContext());
      flutterLoader.ensureInitializationComplete(context, dartVmArgs);
    }
 
    flutterJNI.addEngineLifecycleListener(engineLifecycleListener);
    flutterJNI.setPlatformViewsController(platformViewsController);
    flutterJNI.setLocalizationPlugin(localizationPlugin);
    flutterJNI.setDeferredComponentManager(injector.deferredComponentManager());
 
    // It should typically be a fresh, unattached JNI. But on a spawned engine, the JNI instance
    // is already attached to a native shell. In that case, the Java FlutterEngine is created around
    // an existing shell.
    if (!flutterJNI.isAttached()) {
      attachToJni();
    }
 
    // TODO(mattcarroll): FlutterRenderer is temporally coupled to attach(). Remove that coupling if
    // possible.
    this.renderer = new FlutterRenderer(flutterJNI);
 
    this.platformViewsController = platformViewsController;
    this.platformViewsController.onAttachedToJNI();
 
    this.pluginRegistry =
        new FlutterEngineConnectionRegistry(
            context.getApplicationContext(), this, flutterLoader, group);
 
    localizationPlugin.sendLocalesToFlutter(context.getResources().getConfiguration());
 
    // Only automatically register plugins if both constructor parameter and
    // loaded AndroidManifest config turn this feature on.
    if (automaticallyRegisterPlugins && flutterLoader.automaticallyRegisterPlugins()) {
      GeneratedPluginRegister.registerGeneratedPlugins(this);
    }
 
    ViewUtils.calculateMaximumDisplayMetrics(context, this);
 
    ProcessTextPlugin processTextPlugin = new ProcessTextPlugin(this.getProcessTextChannel());
    this.pluginRegistry.add(processTextPlugin);
  }

Member Function Documentation

◆ addEngineLifecycleListener()

void io.flutter.embedding.engine.FlutterEngine.addEngineLifecycleListener ( @NonNull EngineLifecycleListener listener )

inline

Adds a listener to be notified of Flutter engine lifecycle events, e.g., onPreEngineStart().

Definition at line 486 of file FlutterEngine.java.

                                                                                    {
    engineLifecycleListeners.add(listener);
  }

◆ destroy()

void io.flutter.embedding.engine.FlutterEngine.destroy ( )

inline

Cleans up all components within this FlutterEngine and destroys the associated Dart Isolate. All state held by the Dart Isolate, such as the Flutter Elements tree, is lost.

This FlutterEngine instance should be discarded after invoking this method.

Definition at line 464 of file FlutterEngine.java.

                        {
    Log.v(TAG, "Destroying.");
    for (EngineLifecycleListener listener : engineLifecycleListeners) {
      listener.onEngineWillDestroy();
    }
    // The order that these things are destroyed is important.
    pluginRegistry.destroy();
    platformViewsController.onDetachedFromJNI();
    dartExecutor.onDetachedFromJNI();
    flutterJNI.removeEngineLifecycleListener(engineLifecycleListener);
    flutterJNI.setDeferredComponentManager(null);
    flutterJNI.detachFromNativeAndReleaseResources();
    if (FlutterInjector.instance().deferredComponentManager() != null) {
      FlutterInjector.instance().deferredComponentManager().destroy();
      deferredComponentChannel.setDeferredComponentManager(null);
    }
  }

◆ getAccessibilityChannel()

AccessibilityChannel io.flutter.embedding.engine.FlutterEngine.getAccessibilityChannel ( )

inline

System channel that sends accessibility requests and events from Flutter to Android.

Definition at line 525 of file FlutterEngine.java.

                                                        {
    return accessibilityChannel;
  }

◆ getActivityControlSurface()

ActivityControlSurface io.flutter.embedding.engine.FlutterEngine.getActivityControlSurface ( )

inline

Definition at line 643 of file FlutterEngine.java.

                                                            {
    return pluginRegistry;
  }

◆ getBackGestureChannel()

BackGestureChannel io.flutter.embedding.engine.FlutterEngine.getBackGestureChannel ( )

inline

System channel that sends back gesture commands from Android to Flutter.

Definition at line 549 of file FlutterEngine.java.

                                                    {
    return backGestureChannel;
  }

◆ getBroadcastReceiverControlSurface()

BroadcastReceiverControlSurface io.flutter.embedding.engine.FlutterEngine.getBroadcastReceiverControlSurface ( )

inline

Definition at line 653 of file FlutterEngine.java.

                                                                              {
    return pluginRegistry;
  }

◆ getContentProviderControlSurface()

ContentProviderControlSurface io.flutter.embedding.engine.FlutterEngine.getContentProviderControlSurface ( )

inline

Definition at line 658 of file FlutterEngine.java.

                                                                          {
    return pluginRegistry;
  }

◆ getDartExecutor()

DartExecutor io.flutter.embedding.engine.FlutterEngine.getDartExecutor ( )

inline

The Dart execution context associated with this FlutterEngine.

The DartExecutor can be used to start executing Dart code from a given entrypoint. See DartExecutor#executeDartEntrypoint(DartExecutor.DartEntrypoint).

Use the DartExecutor to connect any desired message channels and method channels to facilitate communication between Android and Dart/Flutter.

Definition at line 508 of file FlutterEngine.java.

                                        {
    return dartExecutor;
  }

◆ getDeferredComponentChannel()

DeferredComponentChannel io.flutter.embedding.engine.FlutterEngine.getDeferredComponentChannel ( )

inline

System channel that allows manual installation and state querying of deferred components.

Definition at line 591 of file FlutterEngine.java.

                                                                {
    return deferredComponentChannel;
  }

◆ getLifecycleChannel()

LifecycleChannel io.flutter.embedding.engine.FlutterEngine.getLifecycleChannel ( )

inline

System channel that sends Android lifecycle events to Flutter.

Definition at line 531 of file FlutterEngine.java.

                                                {
    return lifecycleChannel;
  }

◆ getLocalizationChannel()

LocalizationChannel io.flutter.embedding.engine.FlutterEngine.getLocalizationChannel ( )

inline

System channel that sends locale data from Android to Flutter.

Definition at line 537 of file FlutterEngine.java.

                                                      {
    return localizationChannel;
  }

◆ getLocalizationPlugin()

LocalizationPlugin io.flutter.embedding.engine.FlutterEngine.getLocalizationPlugin ( )

inline

The LocalizationPlugin this FlutterEngine created.

Definition at line 629 of file FlutterEngine.java.

                                                    {
    return localizationPlugin;
  }

◆ getMouseCursorChannel()

MouseCursorChannel io.flutter.embedding.engine.FlutterEngine.getMouseCursorChannel ( )

inline

System channel that sends and receives text input requests and state.

Definition at line 603 of file FlutterEngine.java.

                                                    {
    return mouseCursorChannel;
  }

◆ getNavigationChannel()

NavigationChannel io.flutter.embedding.engine.FlutterEngine.getNavigationChannel ( )

inline

System channel that sends Flutter navigation commands from Android to Flutter.

Definition at line 543 of file FlutterEngine.java.

                                                  {
    return navigationChannel;
  }

◆ getPlatformChannel()

PlatformChannel io.flutter.embedding.engine.FlutterEngine.getPlatformChannel ( )

inline

System channel that sends platform-oriented requests and information to Flutter, e.g., requests to play sounds, requests for haptics, system chrome settings, etc.

Definition at line 558 of file FlutterEngine.java.

                                              {
    return platformChannel;
  }

◆ getPlatformViewsController()

PlatformViewsController io.flutter.embedding.engine.FlutterEngine.getPlatformViewsController ( )

inline

PlatformViewsController, which controls all platform views running within this FlutterEngine.

Definition at line 638 of file FlutterEngine.java.

                                                              {
    return platformViewsController;
  }

◆ getPlugins()

PluginRegistry io.flutter.embedding.engine.FlutterEngine.getPlugins ( )

inline

Plugin registry, which registers plugins that want to be applied to this FlutterEngine.

Definition at line 623 of file FlutterEngine.java.

                                     {
    return pluginRegistry;
  }

◆ getProcessTextChannel()

ProcessTextChannel io.flutter.embedding.engine.FlutterEngine.getProcessTextChannel ( )

inline

System channel that sends text processing requests from Flutter to Android.

Definition at line 564 of file FlutterEngine.java.

                                                    {
    return processTextChannel;
  }

◆ getRenderer()

FlutterRenderer io.flutter.embedding.engine.FlutterEngine.getRenderer ( )

inline

The rendering system associated with this FlutterEngine.

To render a Flutter UI that is produced by this FlutterEngine's Dart code, attach a RenderSurface to this FlutterRenderer.

Definition at line 519 of file FlutterEngine.java.

                                       {
    return renderer;
  }

◆ getRestorationChannel()

RestorationChannel io.flutter.embedding.engine.FlutterEngine.getRestorationChannel ( )

inline

System channel to exchange restoration data between framework and engine.

The engine can obtain the current restoration data from the framework via this channel to store it on disk and - when the app is relaunched - provide the stored data back to the framework to recreate the original state of the app.

Definition at line 576 of file FlutterEngine.java.

                                                    {
    return restorationChannel;
  }

◆ getServiceControlSurface()

ServiceControlSurface io.flutter.embedding.engine.FlutterEngine.getServiceControlSurface ( )

inline

Definition at line 648 of file FlutterEngine.java.

                                                          {
    return pluginRegistry;
  }

◆ getSettingsChannel()

SettingsChannel io.flutter.embedding.engine.FlutterEngine.getSettingsChannel ( )

inline

System channel that sends platform/user settings from Android to Flutter, e.g., time format, scale factor, etc.

Definition at line 585 of file FlutterEngine.java.

                                              {
    return settingsChannel;
  }

◆ getSpellCheckChannel()

SpellCheckChannel io.flutter.embedding.engine.FlutterEngine.getSpellCheckChannel ( )

inline

System channel that sends and receives spell check requests and results.

Definition at line 615 of file FlutterEngine.java.

                                                  {
    return spellCheckChannel;
  }

◆ getSystemChannel()

SystemChannel io.flutter.embedding.engine.FlutterEngine.getSystemChannel ( )

inline

System channel that sends memory pressure warnings from Android to Flutter.

Definition at line 597 of file FlutterEngine.java.

                                          {
    return systemChannel;
  }

◆ getTextInputChannel()

TextInputChannel io.flutter.embedding.engine.FlutterEngine.getTextInputChannel ( )

inline

System channel that sends and receives text input requests and state.

Definition at line 609 of file FlutterEngine.java.

                                                {
    return textInputChannel;
  }

◆ removeEngineLifecycleListener()

void io.flutter.embedding.engine.FlutterEngine.removeEngineLifecycleListener ( @NonNull EngineLifecycleListener listener )

inline

Removes a listener that was previously added with addEngineLifecycleListener(EngineLifecycleListener).

Definition at line 494 of file FlutterEngine.java.

                                                                                       {
    engineLifecycleListeners.remove(listener);
  }

◆ spawn()

FlutterEngine io.flutter.embedding.engine.FlutterEngine.spawn	(	@NonNull Context	context,
		@NonNull DartEntrypoint	dartEntrypoint,
		@Nullable String	initialRoute,
		@Nullable List< String >	dartEntrypointArgs,
		@Nullable PlatformViewsController	platformViewsController,
		boolean	automaticallyRegisterPlugins,
		boolean	waitForRestorationData
	)

inlinepackage

Create a second io.flutter.embedding.engine.FlutterEngine based on this current one by sharing as much resources together as possible to minimize startup latency and memory cost.

Parameters

context	is a Context used to create the `io.flutter.embedding.engine.FlutterEngine`. Could be the same Context as the current engine or a different one. Generally, only an application Context is needed for the `io.flutter.embedding.engine.FlutterEngine` and its dependencies.
dartEntrypoint	specifies the `DartEntrypoint` the new engine should run. It doesn't need to be the same entrypoint as the current engine but must be built in the same AOT or snapshot.
initialRoute	The name of the initial Flutter `Navigator` `Route` to load. If this is null, it will default to the "/" route.
dartEntrypointArgs	Arguments passed as a list of string to Dart's entrypoint function.

Returns: a new io.flutter.embedding.engine.FlutterEngine.

Definition at line 428 of file FlutterEngine.java.

                                      {
    if (!isAttachedToJni()) {
      throw new IllegalStateException(
          "Spawn can only be called on a fully constructed FlutterEngine");
    }
 
    FlutterJNI newFlutterJNI =
        flutterJNI.spawn(
            dartEntrypoint.dartEntrypointFunctionName,
            dartEntrypoint.dartEntrypointLibrary,
            initialRoute,
            dartEntrypointArgs);
    return new FlutterEngine(
        context, // Context.
        null, // FlutterLoader. A null value passed here causes the constructor to get it from the
        // FlutterInjector.
        newFlutterJNI, // FlutterJNI.
        platformViewsController, // PlatformViewsController.
        null, // String[]. The Dart VM has already started, this arguments will have no effect.
        automaticallyRegisterPlugins, // boolean.
        waitForRestorationData); // boolean
  }

◆ updateDisplayMetrics()

void io.flutter.embedding.engine.FlutterEngine.updateDisplayMetrics	(	float	width,
		float	height,
		float	density
	)

inline

Publishes display metrics to Dart code in Flutter.

Implements io.flutter.util.ViewUtils.DisplayUpdater.

Definition at line 675 of file FlutterEngine.java.

                                                                             {
    flutterJNI.updateDisplayMetrics(0 /* display ID */, width, height, density);
  }

The documentation for this class was generated from the following file:

shell/platform/android/io/flutter/embedding/engine/FlutterEngine.java

Classes

Public Member Functions

Package Functions

Detailed Description

Constructor & Destructor Documentation

◆ FlutterEngine() [1/9]

◆ FlutterEngine() [2/9]

◆ FlutterEngine() [3/9]

◆ FlutterEngine() [4/9]

◆ FlutterEngine() [5/9]

◆ FlutterEngine() [6/9]

◆ FlutterEngine() [7/9]

◆ FlutterEngine() [8/9]

◆ FlutterEngine() [9/9]

Member Function Documentation

◆ addEngineLifecycleListener()

◆ destroy()

◆ getAccessibilityChannel()

◆ getActivityControlSurface()

◆ getBackGestureChannel()

◆ getBroadcastReceiverControlSurface()

◆ getContentProviderControlSurface()

◆ getDartExecutor()

◆ getDeferredComponentChannel()

◆ getLifecycleChannel()

◆ getLocalizationChannel()

◆ getLocalizationPlugin()

◆ getMouseCursorChannel()

◆ getNavigationChannel()

◆ getPlatformChannel()

◆ getPlatformViewsController()

◆ getPlugins()

◆ getProcessTextChannel()

◆ getRenderer()

◆ getRestorationChannel()

◆ getServiceControlSurface()

◆ getSettingsChannel()

◆ getSpellCheckChannel()

◆ getSystemChannel()

◆ getTextInputChannel()

◆ removeEngineLifecycleListener()

◆ spawn()

◆ updateDisplayMetrics()