FlutterEngine() Category Reference

#import <FlutterEngine_Internal.h>

Inheritance diagram for FlutterEngine():

Instance Methods
(flutter::Shell &)	- shell
(void)	- updateViewportMetrics:
(void)	- dispatchPointerDataPacket:
(fml::RefPtr< fml::TaskRunner >)	- platformTaskRunner
(fml::RefPtr< fml::TaskRunner >)	- uiTaskRunner
(fml::RefPtr< fml::TaskRunner >)	- rasterTaskRunner
(fml::WeakPtr< flutter::PlatformView >)	- platformView
(flutter::Rasterizer::Screenshot)	- screenshot:base64Encode:
(FlutterPlatformPlugin *)	- platformPlugin
(std::shared_ptr< flutter::PlatformViewsController > &)	- platformViewsController
(FlutterTextInputPlugin *)	- textInputPlugin
(FlutterRestorationPlugin *)	- restorationPlugin
(void)	- launchEngine:libraryURI:entrypointArgs:
(BOOL)	- createShell:libraryURI:initialRoute:
(void)	- attachView
(void)	- notifyLowMemory
(flutter::PlatformViewIOS *)	- iosPlatformView
(void)	- waitForFirstFrame:callback:
(FlutterEngine *)	- spawnWithEntrypoint:libraryURI:initialRoute:entrypointArgs:
(void)	- sendKeyEvent:callback:userData:
(nonnull FlutterTextInputPlugin *)	- textInputPlugin
(FlutterTextInputPlugin *)	- textInputPlugin
(void)	- sendKeyEvent:callback:userData:
(fml::RefPtr< fml::TaskRunner >)	- uiTaskRunner
(BOOL)	- createShell:libraryURI:initialRoute:
(void)	- dispatchPointerDataPacket:
(void)	- updateViewportMetrics:
(void)	- attachView
Instance Methods inherited from <FlutterIndirectScribbleDelegate>
(void)	- flutterTextInputPlugin:focusElement:atPoint:result:
(void)	- flutterTextInputPlugin:requestElementsInRect:result:
Instance Methods inherited from <FlutterUndoManagerDelegate>
(void)	- handleUndoWithDirection:
Instance Methods inherited from <FlutterTextInputDelegate>
(void)	- flutterTextInputView:updateEditingClient:withState:
(void)	- flutterTextInputView:updateEditingClient:withState:withTag:
(void)	- flutterTextInputView:updateEditingClient:withDelta:
(void)	- flutterTextInputView:performAction:withClient:
(void)	- flutterTextInputView:updateFloatingCursor:withClient:withPosition:
(void)	- flutterTextInputView:showAutocorrectionPromptRectForStart:end:withClient:
(void)	- flutterTextInputView:showToolbar:
(void)	- flutterTextInputViewScribbleInteractionBegan:
(void)	- flutterTextInputViewScribbleInteractionFinished:
(void)	- flutterTextInputView:insertTextPlaceholderWithSize:withClient:
(void)	- flutterTextInputView:removeTextPlaceholder:
(void)	- flutterTextInputView:didResignFirstResponderWithTextInputClient:
(void)	- flutterTextInputView:willDismissEditMenuWithTextInputClient:
Instance Methods inherited from <FlutterBinaryMessenger>
(NSObject< FlutterTaskQueue > *)	- makeBackgroundTaskQueue
	TODO(gaaclarke): Remove optional when macos supports Background Platform Channels. More...
(FlutterBinaryMessengerConnection)	- setMessageHandlerOnChannel:binaryMessageHandler:taskQueue:
(void)	- sendOnChannel:message:
(void)	- sendOnChannel:message:binaryReply:
(FlutterBinaryMessengerConnection)	- setMessageHandlerOnChannel:binaryMessageHandler:
(void)	- cleanUpConnection:
Instance Methods inherited from <FlutterTextureRegistry>
(int64_t)	- registerTexture:
(void)	- textureFrameAvailable:
(void)	- unregisterTexture:

Properties
NSMutableDictionary *	pluginPublications
NSMutableDictionary< NSString *, FlutterEngineRegistrar * > *	registrars
NSString *	isolateId
NSString *	initialRoute
id< NSObject >	flutterViewControllerWillDeallocObserver
BOOL	enableEmbedderAPI
FlutterEngineProcTable &	embedderAPI
FlutterDartProject *	project
Properties inherited from <FlutterUndoManagerDelegate>
NSUndoManager *	undoManager
UIView< UITextInput > *	activeTextInputView

Detailed Description

Definition at line 95 of file FlutterEngine.mm.

Method Documentation

attachView [1/2]

- (void) attachView

attachView [2/2]

- (void) attachView

createShell:libraryURI:initialRoute: [1/2]

- (BOOL) createShell:		(NSString *)	entrypoint
libraryURI:		(NSString *)	libraryURI
initialRoute:		(NSString *)	initialRoute

createShell:libraryURI:initialRoute: [2/2]

- (BOOL) createShell:		(nullable NSString *)	entrypoint
libraryURI:		(nullable NSString *)	libraryOrNil
initialRoute:		(nullable NSString *)	initialRoute

dispatchPointerDataPacket: [1/2]

- (void) dispatchPointerDataPacket:

(std::unique_ptr< flutter::PointerDataPacket >)

packet

dispatchPointerDataPacket: [2/2]

- (void) dispatchPointerDataPacket:

(std::unique_ptr< flutter::PointerDataPacket >)

packet

iosPlatformView

- (PlatformViewIOS* FlutterEngine()):

launchEngine:libraryURI:entrypointArgs:

- (void) launchEngine:		(nullable NSString *)	entrypoint
libraryURI:		(nullable NSString *)	libraryOrNil
entrypointArgs:		(nullable NSArray< NSString * > *)	entrypointArgs

notifyLowMemory

- (void) notifyLowMemory

platformPlugin

- (FlutterPlatformPlugin*) platformPlugin

platformTaskRunner

- (RefPtr<)fml:

platformView

- (WeakPtr<)flutter:

platformViewsController

- (shared_ptr<)flutter:

rasterTaskRunner

- (RefPtr<)fml:

restorationPlugin

- (FlutterRestorationPlugin*) restorationPlugin

screenshot:base64Encode:

- Rasterizer:		(flutter::Rasterizer::ScreenshotType)	type
base64Encode:		(bool)	base64Encode

sendKeyEvent:callback:userData: [1/2]

- (void) sendKeyEvent:		(const FlutterKeyEvent &)	event
callback:		(nullable FlutterKeyEventCallback)	callback
userData:		(nullable void *)	userData

Dispatches the given key event data to the framework through the engine. The callback is called once the response from the framework is received.

sendKeyEvent:callback:userData: [2/2]

- (void) sendKeyEvent:		(const FlutterKeyEvent &)	event
callback:		(nullable FlutterKeyEventCallback)	callback
userData:		(nullable void *)	userData

shell

- (Shell& FlutterEngine()):

spawnWithEntrypoint:libraryURI:initialRoute:entrypointArgs:

- (FlutterEngine*) spawnWithEntrypoint:		(nullable NSString *)	entrypoint
libraryURI:		(nullable NSString *)	libraryURI
initialRoute:		(nullable NSString *)	initialRoute
entrypointArgs:		(nullable NSArray< NSString * > *)	entrypointArgs

Creates one running FlutterEngine from another, sharing components between them.

This results in a faster creation time and a smaller memory footprint engine. This should only be called on a FlutterEngine that is running.

textInputPlugin [1/3]

- (nonnull FlutterTextInputPlugin*) textInputPlugin

textInputPlugin [2/3]

- (FlutterTextInputPlugin*) textInputPlugin

textInputPlugin [3/3]

- (FlutterTextInputPlugin*) textInputPlugin

uiTaskRunner [1/2]

- (RefPtr<)fml:

uiTaskRunner [2/2]

- (RefPtr<)fml:

updateViewportMetrics: [1/2]

- (void) updateViewportMetrics:

(flutter::ViewportMetrics)

viewportMetrics

updateViewportMetrics: [2/2]

- (void) updateViewportMetrics:

(flutter::ViewportMetrics)

viewportMetrics

waitForFirstFrame:callback:

- (void) waitForFirstFrame:		(NSTimeInterval)	timeout
callback:		(void(^)(BOOL didTimeout))	callback

Property Documentation

embedderAPI

- (FlutterEngineProcTable&) embedderAPI

readwritenonatomicassign

Definition at line 113 of file FlutterEngine.mm.

enableEmbedderAPI

- (BOOL) enableEmbedderAPI

readwritenonatomicassign

Definition at line 111 of file FlutterEngine.mm.

flutterViewControllerWillDeallocObserver

- (id<NSObject>) flutterViewControllerWillDeallocObserver

readwritenonatomicretain

Definition at line 107 of file FlutterEngine.mm.

initialRoute

- (NSString*) initialRoute

readwritenonatomiccopy

Definition at line 106 of file FlutterEngine.mm.

isolateId

- (NSString*) isolateId

readwritenonatomiccopy

Definition at line 105 of file FlutterEngine.mm.

pluginPublications

- (NSMutableDictionary*) pluginPublications

readnonatomicassign

Definition at line 102 of file FlutterEngine.mm.

project

- (FlutterDartProject*) project

readnonatomicassign

Definition at line 85 of file FlutterEngine_Internal.h.

registrars

- (NSMutableDictionary<NSString*, FlutterEngineRegistrar*>*) registrars

readnonatomicassign

Definition at line 103 of file FlutterEngine.mm.

---

The documentation for this category was generated from the following files:

• shell/platform/darwin/ios/framework/Source/FlutterEngine.mm
• shell/platform/darwin/ios/framework/Source/FlutterEngine_Internal.h
• shell/platform/darwin/ios/framework/Source/FlutterTextInputPluginTest.mm
• shell/platform/darwin/ios/framework/Source/FlutterViewControllerTest.mm