Flutter iOS Embedder
Instance Methods | Properties | List of all members
FlutterEngine() Category Reference

#import <FlutterEngine_Internal.h>

Inheritance diagram for FlutterEngine():
<FlutterIndirectScribbleDelegate> <FlutterUndoManagerDelegate> <FlutterTextInputDelegate> <FlutterBinaryMessenger> <FlutterTextureRegistry>

Instance Methods

(void) - updateViewportMetrics:
 
(void) - dispatchPointerDataPacket:
 
(fml::RefPtr< fml::TaskRunner >) - platformTaskRunner
 
(fml::RefPtr< fml::TaskRunner >) - uiTaskRunner
 
(fml::RefPtr< fml::TaskRunner >) - rasterTaskRunner
 
(void) - installFirstFrameCallback:
 
(void) - enableSemantics:withFlags:
 
(void) - notifyViewCreated
 
(void) - notifyViewDestroyed
 
(flutter::Rasterizer::Screenshot) - screenshot:base64Encode:
 
(FlutterPlatformPlugin *) - platformPlugin
 
(FlutterTextInputPlugin *) - textInputPlugin
 
(FlutterRestorationPlugin *) - restorationPlugin
 
(void) - launchEngine:libraryURI:entrypointArgs:
 
(BOOL) - createShell:libraryURI:initialRoute:
 
(void) - attachView
 
(void) - notifyLowMemory
 
(void) - waitForFirstFrameSync:callback:
 Blocks until the first frame is presented or the timeout is exceeded, then invokes callback. More...
 
(void) - waitForFirstFrame:callback:
 
(FlutterEngine *) - spawnWithEntrypoint:libraryURI:initialRoute:entrypointArgs:
 
(void) - sendKeyEvent:callback:userData:
 
(nonnull FlutterTextInputPlugin *) - textInputPlugin
 
(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

FlutterDartProject * dartProject
 
NSString * labelPrefix
 
BOOL allowHeadlessExecution
 
BOOL restorationEnabled
 
FlutterPlatformViewsController * platformViewsController
 
NSMutableDictionary * pluginPublications
 
NSMutableDictionary< NSString *, FlutterEngineRegistrar * > * registrars
 
NSString * isolateId
 
NSString * initialRoute
 
id< NSObject > flutterViewControllerWillDeallocObserver
 
FlutterDartVMServicePublisher * publisher
 
int64_t nextTextureId
 
FlutterPlatformPlugin * platformPlugin
 
FlutterTextInputPlugin * textInputPlugin
 
FlutterUndoManagerPlugin * undoManagerPlugin
 
FlutterSpellCheckPlugin * spellCheckPlugin
 
FlutterRestorationPlugin * restorationPlugin
 
FlutterMethodChannel * localizationChannel
 
FlutterMethodChannel * navigationChannel
 
FlutterMethodChannel * restorationChannel
 
FlutterMethodChannel * platformChannel
 
FlutterMethodChannel * platformViewsChannel
 
FlutterMethodChannel * textInputChannel
 
FlutterMethodChannel * undoManagerChannel
 
FlutterMethodChannel * scribbleChannel
 
FlutterMethodChannel * spellCheckChannel
 
FlutterBasicMessageChannel * lifecycleChannel
 
FlutterBasicMessageChannel * systemChannel
 
FlutterBasicMessageChannel * settingsChannel
 
FlutterBasicMessageChannel * keyEventChannel
 
FlutterMethodChannel * screenshotChannel
 
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

◆ enableSemantics:withFlags:

- (void) enableSemantics: (BOOL)  enabled
withFlags: (int64_t)  flags 

◆ installFirstFrameCallback:

- (void) installFirstFrameCallback: (void(^)(void))  block

◆ launchEngine:libraryURI:entrypointArgs:

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

◆ notifyLowMemory

- (void) notifyLowMemory

◆ notifyViewCreated

- (void) notifyViewCreated

◆ notifyViewDestroyed

- (void) notifyViewDestroyed

◆ platformPlugin

- (FlutterPlatformPlugin*) platformPlugin

◆ platformTaskRunner

- (RefPtr<)fml:

◆ rasterTaskRunner

- (RefPtr<)fml:

◆ restorationPlugin

- (FlutterRestorationPlugin*) restorationPlugin

◆ screenshot:base64Encode:

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

◆ sendKeyEvent:callback:userData:

- (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.

◆ 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/2]

- (nonnull FlutterTextInputPlugin*) textInputPlugin

◆ textInputPlugin [2/2]

- (FlutterTextInputPlugin*) textInputPlugin

◆ uiTaskRunner

- (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 

Asynchronously waits until the first frame is presented or the timeout is exceeded, then invokes callback.

◆ waitForFirstFrameSync:callback:

- (void) waitForFirstFrameSync: (NSTimeInterval)  timeout
callback: (NS_NOESCAPE void(^)(BOOL didTimeout))  callback 

Blocks until the first frame is presented or the timeout is exceeded, then invokes callback.

Property Documentation

◆ allowHeadlessExecution

- (BOOL) allowHeadlessExecution
readnonatomicassign

Definition at line 105 of file FlutterEngine.mm.

◆ dartProject

- (FlutterDartProject*) dartProject
readnonatomicassign

Definition at line 103 of file FlutterEngine.mm.

◆ embedderAPI

- (FlutterEngineProcTable&) embedderAPI
readwritenonatomicassign

Definition at line 147 of file FlutterEngine.mm.

◆ enableEmbedderAPI

- (BOOL) enableEmbedderAPI
readwritenonatomicassign

Definition at line 145 of file FlutterEngine.mm.

◆ flutterViewControllerWillDeallocObserver

- (id<NSObject>) flutterViewControllerWillDeallocObserver
readwritenonatomicstrong

Definition at line 117 of file FlutterEngine.mm.

◆ initialRoute

- (NSString*) initialRoute
readwritenonatomiccopy

Definition at line 116 of file FlutterEngine.mm.

◆ isolateId

- (NSString*) isolateId
readwritenonatomiccopy

Definition at line 115 of file FlutterEngine.mm.

◆ keyEventChannel

- (FlutterBasicMessageChannel*) keyEventChannel
readwritenonatomicstrong

Definition at line 140 of file FlutterEngine.mm.

◆ labelPrefix

- (NSString*) labelPrefix
readnonatomiccopy

Definition at line 104 of file FlutterEngine.mm.

◆ lifecycleChannel

- (FlutterBasicMessageChannel*) lifecycleChannel
readwritenonatomicstrong

Definition at line 137 of file FlutterEngine.mm.

◆ localizationChannel

- (FlutterMethodChannel*) localizationChannel
readwritenonatomicstrong

Definition at line 128 of file FlutterEngine.mm.

◆ navigationChannel

- (FlutterMethodChannel*) navigationChannel
readwritenonatomicstrong

Definition at line 129 of file FlutterEngine.mm.

◆ nextTextureId

- (int64_t) nextTextureId
readwritenonatomicassign

Definition at line 119 of file FlutterEngine.mm.

◆ platformChannel

- (FlutterMethodChannel*) platformChannel
readwritenonatomicstrong

Definition at line 131 of file FlutterEngine.mm.

◆ platformPlugin

- (FlutterPlatformPlugin*) platformPlugin
readwritenonatomicstrong

Definition at line 123 of file FlutterEngine.mm.

◆ platformViewsChannel

- (FlutterMethodChannel*) platformViewsChannel
readwritenonatomicstrong

Definition at line 132 of file FlutterEngine.mm.

◆ platformViewsController

- (FlutterPlatformViewsController*) platformViewsController
readwritenonatomicstrong

Definition at line 108 of file FlutterEngine.mm.

◆ pluginPublications

- (NSMutableDictionary*) pluginPublications
readnonatomicassign

Definition at line 112 of file FlutterEngine.mm.

◆ project

- (FlutterDartProject*) project
readnonatomicassign

Definition at line 88 of file FlutterEngine_Internal.h.

◆ publisher

- (FlutterDartVMServicePublisher*) publisher
readwritenonatomicstrong

Definition at line 118 of file FlutterEngine.mm.

◆ registrars

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

Definition at line 113 of file FlutterEngine.mm.

◆ restorationChannel

- (FlutterMethodChannel*) restorationChannel
readwritenonatomicstrong

Definition at line 130 of file FlutterEngine.mm.

◆ restorationEnabled

- (BOOL) restorationEnabled
readnonatomicassign

Definition at line 106 of file FlutterEngine.mm.

◆ restorationPlugin

- (FlutterRestorationPlugin*) restorationPlugin
readwritenonatomicstrong

Definition at line 127 of file FlutterEngine.mm.

◆ screenshotChannel

- (FlutterMethodChannel*) screenshotChannel
readwritenonatomicstrong

Definition at line 141 of file FlutterEngine.mm.

◆ scribbleChannel

- (FlutterMethodChannel*) scribbleChannel
readwritenonatomicstrong

Definition at line 135 of file FlutterEngine.mm.

◆ settingsChannel

- (FlutterBasicMessageChannel*) settingsChannel
readwritenonatomicstrong

Definition at line 139 of file FlutterEngine.mm.

◆ spellCheckChannel

- (FlutterMethodChannel*) spellCheckChannel
readwritenonatomicstrong

Definition at line 136 of file FlutterEngine.mm.

◆ spellCheckPlugin

- (FlutterSpellCheckPlugin*) spellCheckPlugin
readwritenonatomicstrong

Definition at line 126 of file FlutterEngine.mm.

◆ systemChannel

- (FlutterBasicMessageChannel*) systemChannel
readwritenonatomicstrong

Definition at line 138 of file FlutterEngine.mm.

◆ textInputChannel

- (FlutterMethodChannel*) textInputChannel
readwritenonatomicstrong

Definition at line 133 of file FlutterEngine.mm.

◆ textInputPlugin

- (FlutterTextInputPlugin*) textInputPlugin
readwritenonatomicstrong

Definition at line 124 of file FlutterEngine.mm.

◆ undoManagerChannel

- (FlutterMethodChannel*) undoManagerChannel
readwritenonatomicstrong

Definition at line 134 of file FlutterEngine.mm.

◆ undoManagerPlugin

- (FlutterUndoManagerPlugin*) undoManagerPlugin
readwritenonatomicstrong

Definition at line 125 of file FlutterEngine.mm.

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