Flutter Engine
flutter::PlatformViewAndroidJNI Class Referenceabstract

#include <platform_view_android_jni.h>

Inheritance diagram for flutter::PlatformViewAndroidJNI:
flutter::JNIMock flutter::PlatformViewAndroidJNIImpl

Classes

struct  OverlayMetadata
 

Public Member Functions

virtual ~PlatformViewAndroidJNI ()
 
virtual void FlutterViewHandlePlatformMessage (fml::RefPtr< flutter::PlatformMessage > message, int responseId)=0
 Sends a platform message. The message may be empty. More...
 
virtual void FlutterViewHandlePlatformMessageResponse (int responseId, std::unique_ptr< fml::Mapping > data)=0
 Responds to a platform message. The data may be a nullptr. More...
 
virtual void FlutterViewUpdateSemantics (std::vector< uint8_t > buffer, std::vector< std::string > strings)=0
 Sends semantics tree updates. More...
 
virtual void FlutterViewUpdateCustomAccessibilityActions (std::vector< uint8_t > actions_buffer, std::vector< std::string > strings)=0
 Sends new custom accessibility events. More...
 
virtual void FlutterViewOnFirstFrame ()=0
 Indicates that FlutterView should start painting pixels. More...
 
virtual void FlutterViewOnPreEngineRestart ()=0
 Indicates that a hot restart is about to happen. More...
 
virtual void SurfaceTextureAttachToGLContext (JavaWeakGlobalRef surface_texture, int textureId)=0
 Attach the SurfaceTexture to the OpenGL ES context that is current on the calling thread. More...
 
virtual void SurfaceTextureUpdateTexImage (JavaWeakGlobalRef surface_texture)=0
 Updates the texture image to the most recent frame from the image stream. More...
 
virtual void SurfaceTextureGetTransformMatrix (JavaWeakGlobalRef surface_texture, SkMatrix &transform)=0
 Gets the transform matrix from the SurfaceTexture. Then, it updates the transform matrix, so it fill the canvas and preserve the aspect ratio. More...
 
virtual void SurfaceTextureDetachFromGLContext (JavaWeakGlobalRef surface_texture)=0
 Detaches a SurfaceTexture from the OpenGL ES context. More...
 
virtual void FlutterViewOnDisplayPlatformView (int view_id, int x, int y, int width, int height, int viewWidth, int viewHeight, MutatorsStack mutators_stack)=0
 Positions and sizes a platform view if using hybrid composition. More...
 
virtual void FlutterViewDisplayOverlaySurface (int surface_id, int x, int y, int width, int height)=0
 Positions and sizes an overlay surface in hybrid composition. More...
 
virtual void FlutterViewBeginFrame ()=0
 Initiates a frame if using hybrid composition. More...
 
virtual void FlutterViewEndFrame ()=0
 Indicates that the current frame ended. It's used to clean up state. More...
 
virtual std::unique_ptr< PlatformViewAndroidJNI::OverlayMetadataFlutterViewCreateOverlaySurface ()=0
 Instantiates an overlay surface in hybrid composition and provides the necessary metadata to operate the surface in C. More...
 
virtual void FlutterViewDestroyOverlaySurfaces ()=0
 Destroys the overlay surfaces. More...
 
virtual std::unique_ptr< std::vector< std::string > > FlutterViewComputePlatformResolvedLocale (std::vector< std::string > supported_locales_data)=0
 Computes the locale Android would select. More...
 
virtual double GetDisplayRefreshRate ()=0
 

Detailed Description

Allows to call Java code running in the JVM from any thread. However, most methods can only be called from the platform thread as that is where the Java code runs.

This interface must not depend on the Android toolchain directly, so it can be used in unit tests compiled with the host toolchain.

Definition at line 36 of file platform_view_android_jni.h.

Constructor & Destructor Documentation

◆ ~PlatformViewAndroidJNI()

flutter::PlatformViewAndroidJNI::~PlatformViewAndroidJNI ( )
virtualdefault

Member Function Documentation

◆ FlutterViewBeginFrame()

virtual void flutter::PlatformViewAndroidJNI::FlutterViewBeginFrame ( )
pure virtual

Initiates a frame if using hybrid composition.

Note
Must be called from the platform thread.

Implemented in flutter::PlatformViewAndroidJNIImpl.

◆ FlutterViewComputePlatformResolvedLocale()

virtual std::unique_ptr<std::vector<std::string> > flutter::PlatformViewAndroidJNI::FlutterViewComputePlatformResolvedLocale ( std::vector< std::string >  supported_locales_data)
pure virtual

Computes the locale Android would select.

Implemented in flutter::PlatformViewAndroidJNIImpl.

◆ FlutterViewCreateOverlaySurface()

virtual std::unique_ptr<PlatformViewAndroidJNI::OverlayMetadata> flutter::PlatformViewAndroidJNI::FlutterViewCreateOverlaySurface ( )
pure virtual

Instantiates an overlay surface in hybrid composition and provides the necessary metadata to operate the surface in C.

Note
Must be called from the platform thread.

Implemented in flutter::PlatformViewAndroidJNIImpl.

◆ FlutterViewDestroyOverlaySurfaces()

virtual void flutter::PlatformViewAndroidJNI::FlutterViewDestroyOverlaySurfaces ( )
pure virtual

Destroys the overlay surfaces.

Note
Must be called from the platform thread.

Implemented in flutter::PlatformViewAndroidJNIImpl.

◆ FlutterViewDisplayOverlaySurface()

virtual void flutter::PlatformViewAndroidJNI::FlutterViewDisplayOverlaySurface ( int  surface_id,
int  x,
int  y,
int  width,
int  height 
)
pure virtual

Positions and sizes an overlay surface in hybrid composition.

Note
Must be called from the platform thread.

Implemented in flutter::PlatformViewAndroidJNIImpl.

◆ FlutterViewEndFrame()

virtual void flutter::PlatformViewAndroidJNI::FlutterViewEndFrame ( )
pure virtual

Indicates that the current frame ended. It's used to clean up state.

Note
Must be called from the platform thread.

Implemented in flutter::PlatformViewAndroidJNIImpl.

◆ FlutterViewHandlePlatformMessage()

virtual void flutter::PlatformViewAndroidJNI::FlutterViewHandlePlatformMessage ( fml::RefPtr< flutter::PlatformMessage message,
int  responseId 
)
pure virtual

Sends a platform message. The message may be empty.

Implemented in flutter::PlatformViewAndroidJNIImpl.

Referenced by flutter::testing::TEST().

◆ FlutterViewHandlePlatformMessageResponse()

virtual void flutter::PlatformViewAndroidJNI::FlutterViewHandlePlatformMessageResponse ( int  responseId,
std::unique_ptr< fml::Mapping data 
)
pure virtual

Responds to a platform message. The data may be a nullptr.

Implemented in flutter::PlatformViewAndroidJNIImpl.

◆ FlutterViewOnDisplayPlatformView()

virtual void flutter::PlatformViewAndroidJNI::FlutterViewOnDisplayPlatformView ( int  view_id,
int  x,
int  y,
int  width,
int  height,
int  viewWidth,
int  viewHeight,
MutatorsStack  mutators_stack 
)
pure virtual

Positions and sizes a platform view if using hybrid composition.

Note
Must be called from the platform thread.

Implemented in flutter::PlatformViewAndroidJNIImpl.

◆ FlutterViewOnFirstFrame()

virtual void flutter::PlatformViewAndroidJNI::FlutterViewOnFirstFrame ( )
pure virtual

Indicates that FlutterView should start painting pixels.

Note
Must be called from the platform thread.

Implemented in flutter::PlatformViewAndroidJNIImpl.

◆ FlutterViewOnPreEngineRestart()

virtual void flutter::PlatformViewAndroidJNI::FlutterViewOnPreEngineRestart ( )
pure virtual

Indicates that a hot restart is about to happen.

Implemented in flutter::PlatformViewAndroidJNIImpl.

◆ FlutterViewUpdateCustomAccessibilityActions()

virtual void flutter::PlatformViewAndroidJNI::FlutterViewUpdateCustomAccessibilityActions ( std::vector< uint8_t >  actions_buffer,
std::vector< std::string >  strings 
)
pure virtual

Sends new custom accessibility events.

Note
Must be called from the platform thread.

Implemented in flutter::PlatformViewAndroidJNIImpl.

◆ FlutterViewUpdateSemantics()

virtual void flutter::PlatformViewAndroidJNI::FlutterViewUpdateSemantics ( std::vector< uint8_t >  buffer,
std::vector< std::string >  strings 
)
pure virtual

Sends semantics tree updates.

Note
Must be called from the platform thread.

Implemented in flutter::PlatformViewAndroidJNIImpl.

◆ GetDisplayRefreshRate()

virtual double flutter::PlatformViewAndroidJNI::GetDisplayRefreshRate ( )
pure virtual

◆ SurfaceTextureAttachToGLContext()

virtual void flutter::PlatformViewAndroidJNI::SurfaceTextureAttachToGLContext ( JavaWeakGlobalRef  surface_texture,
int  textureId 
)
pure virtual

Attach the SurfaceTexture to the OpenGL ES context that is current on the calling thread.

Implemented in flutter::PlatformViewAndroidJNIImpl.

◆ SurfaceTextureDetachFromGLContext()

virtual void flutter::PlatformViewAndroidJNI::SurfaceTextureDetachFromGLContext ( JavaWeakGlobalRef  surface_texture)
pure virtual

Detaches a SurfaceTexture from the OpenGL ES context.

Implemented in flutter::PlatformViewAndroidJNIImpl.

◆ SurfaceTextureGetTransformMatrix()

virtual void flutter::PlatformViewAndroidJNI::SurfaceTextureGetTransformMatrix ( JavaWeakGlobalRef  surface_texture,
SkMatrix &  transform 
)
pure virtual

Gets the transform matrix from the SurfaceTexture. Then, it updates the transform matrix, so it fill the canvas and preserve the aspect ratio.

Implemented in flutter::PlatformViewAndroidJNIImpl.

◆ SurfaceTextureUpdateTexImage()

virtual void flutter::PlatformViewAndroidJNI::SurfaceTextureUpdateTexImage ( JavaWeakGlobalRef  surface_texture)
pure virtual

Updates the texture image to the most recent frame from the image stream.

Implemented in flutter::PlatformViewAndroidJNIImpl.


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