FlutterHeadlessDartRunner


@interface FlutterHeadlessDartRunner : FlutterEngine

The FlutterHeadlessDartRunner runs Flutter Dart code with a null rasterizer, and no native drawing surface. It is appropriate for use in running Dart code e.g. in the background from a plugin.

Most callers should prefer using FlutterEngine directly; this interface exists for legacy support.

  • Iniitalize this FlutterHeadlessDartRunner with a FlutterDartProject.

    If the FlutterDartProject is not specified, the FlutterHeadlessDartRunner will attempt to locate the project in a default location.

    A newly initialized engine will not run the FlutterDartProject until either -runWithEntrypoint: or -runWithEntrypoint:libraryURI is called.

    Declaration

    Objective-C

    - (instancetype)initWithName:(NSString *)labelPrefix
                         project:(FlutterDartProject *)projectOrNil;

    Parameters

    labelPrefix

    The label prefix used to identify threads for this instance. Should be unique across FlutterEngine instances

    projectOrNil

    The FlutterDartProject to run.

  • Not recommended for use - will initialize with a default label (io.flutter.headless) and the default FlutterDartProject.

    Declaration

    Objective-C

    - (instancetype)init;