UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
AndroidJNI.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3#pragma once
4
5#include "CoreMinimal.h"
6
7#if USE_ANDROID_JNI
8#include <jni.h>
9#include <android/log.h>
10
11extern JavaVM* GJavaVM;
12
13DECLARE_MULTICAST_DELEGATE_SixParams(FOnActivityResult, JNIEnv *, jobject, jobject, jint, jint, jobject);
14
15DECLARE_MULTICAST_DELEGATE_ThreeParams(FOnSafetyNetAttestationResult, bool, const FString&, int32);
16
17DECLARE_MULTICAST_DELEGATE_TwoParams(FOnRouteServiceIntent, const FString&, const FString&);
18
19// Define all the Java classes/methods that the game will need to access to
20class FJavaWrapper
21{
22public:
23
24 // Nonstatic methods
25 static jclass GameActivityClassID;
26 static jobject GameActivityThis;
27 static jmethodID AndroidThunkJava_ShowConsoleWindow;
28 static jmethodID AndroidThunkJava_ShowVirtualKeyboardInputDialog;
29 static jmethodID AndroidThunkJava_HideVirtualKeyboardInputDialog;
30 static jmethodID AndroidThunkJava_ShowVirtualKeyboardInput;
31 static jmethodID AndroidThunkJava_HideVirtualKeyboardInput;
32 static jmethodID AndroidThunkJava_LaunchURL;
33 static jmethodID AndroidThunkJava_GetAssetManager;
34 static jmethodID AndroidThunkJava_Minimize;
35 static jmethodID AndroidThunkJava_ClipboardCopy;
36 static jmethodID AndroidThunkJava_ClipboardPaste;
37 static jmethodID AndroidThunkJava_ForceQuit;
38 static jmethodID AndroidThunkJava_GetFontDirectory;
39 static jmethodID AndroidThunkJava_Vibrate;
40 static jmethodID AndroidThunkJava_IsMusicActive;
41 static jmethodID AndroidThunkJava_IsScreensaverEnabled;
42 static jmethodID AndroidThunkJava_KeepScreenOn;
43 static jmethodID AndroidThunkJava_InitHMDs;
44 static jmethodID AndroidThunkJava_DismissSplashScreen;
45 static jmethodID AndroidThunkJava_ShowProgressDialog;
46 static jmethodID AndroidThunkJava_UpdateProgressDialog;
47 static jmethodID AndroidThunkJava_GetInputDeviceInfo;
48 static jmethodID AndroidThunkJava_SetInputDeviceVibrators;
49 static jmethodID AndroidThunkJava_IsGamepadAttached;
50 static jmethodID AndroidThunkJava_HasMetaDataKey;
51 static jmethodID AndroidThunkJava_GetMetaDataBoolean;
52 static jmethodID AndroidThunkJava_GetMetaDataInt;
53 static jmethodID AndroidThunkJava_GetMetaDataLong;
54 static jmethodID AndroidThunkJava_GetMetaDataFloat;
55 static jmethodID AndroidThunkJava_GetMetaDataString;
56 static jmethodID AndroidThunkJava_IsOculusMobileApplication;
57 static jmethodID AndroidThunkJava_ShowHiddenAlertDialog;
58 static jmethodID AndroidThunkJava_LocalNotificationScheduleAtTime;
59 static jmethodID AndroidThunkJava_LocalNotificationClearAll;
60 static jmethodID AndroidThunkJava_LocalNotificationExists;
61 static jmethodID AndroidThunkJava_LocalNotificationGetLaunchNotification;
62 static jmethodID AndroidThunkJava_LocalNotificationDestroyIfExists;
63 static jmethodID AndroidThunkJava_GetNetworkConnectionType;
64 static jmethodID AndroidThunkJava_GetAndroidId;
65 static jmethodID AndroidThunkJava_ShareURL;
66 static jmethodID AndroidThunkJava_LaunchPackage;
67 static jmethodID AndroidThunkJava_IsPackageInstalled;
68 static jmethodID AndroidThunkJava_SendBroadcast;
69 static jmethodID AndroidThunkJava_HasIntentExtrasKey;
70 static jmethodID AndroidThunkJava_GetIntentExtrasBoolean;
71 static jmethodID AndroidThunkJava_GetIntentExtrasInt;
72 static jmethodID AndroidThunkJava_GetIntentExtrasString;
73 static jmethodID AndroidThunkJava_GetIntentDataAsString;
74 static jmethodID AndroidThunkJava_SetSustainedPerformanceMode;
75 static jmethodID AndroidThunkJava_PushSensorEvents;
76 static jmethodID AndroidThunkJava_SetOrientation;
77 static jmethodID AndroidThunkJava_HasSharedPreference;
78 static jmethodID AndroidThunkJava_SetSharedPreferenceBoolean;
79 static jmethodID AndroidThunkJava_GetSharedPreferenceBoolean;
80 static jmethodID AndroidThunkJava_SetSharedPreferenceInt;
81 static jmethodID AndroidThunkJava_GetSharedPreferenceInt;
82 static jmethodID AndroidThunkJava_SetSharedPreferenceString;
83 static jmethodID AndroidThunkJava_GetSharedPreferenceString;
84 static jmethodID AndroidThunkJava_DeleteSharedPreference;
85 static jmethodID AndroidThunkJava_DeleteSharedPreferenceGroup;
86 static jmethodID AndroidThunkJava_GetCacheDir;
87
88
89 // Screen capture/recording permission
90 static jmethodID AndroidThunkJava_IsScreenCaptureDisabled;
91 static jmethodID AndroidThunkJava_DisableScreenCapture;
92
93 // Native view click filtering
94 static jmethodID AndroidThunkJava_HasExtraIgnoreView;
95
96 // InputDeviceInfo member field ids
97 static jclass InputDeviceInfoClass;
98 static jfieldID InputDeviceInfo_VendorId;
99 static jfieldID InputDeviceInfo_ProductId;
100 static jfieldID InputDeviceInfo_ControllerId;
101 static jfieldID InputDeviceInfo_Name;
102 static jfieldID InputDeviceInfo_Descriptor;
103 static jfieldID InputDeviceInfo_FeedbackMotorCount;
104 static jfieldID InputDeviceInfo_IsExternal;
105
106 // IDs related to google play services
107 static jclass GoogleServicesClassID;
108 static jobject GoogleServicesThis;
109 static jmethodID AndroidThunkJava_ShowAdBanner;
110 static jmethodID AndroidThunkJava_HideAdBanner;
111 static jmethodID AndroidThunkJava_CloseAdBanner;
112 static jmethodID AndroidThunkJava_LoadInterstitialAd;
113 static jmethodID AndroidThunkJava_IsInterstitialAdAvailable;
114 static jmethodID AndroidThunkJava_IsInterstitialAdRequested;
115 static jmethodID AndroidThunkJava_ShowInterstitialAd;
116 static jmethodID AndroidThunkJava_GetAdvertisingId;
117
118 // Optionally added if GCM plugin (or other remote notification system) enabled
119 static jmethodID AndroidThunkJava_RegisterForRemoteNotifications;
120 static jmethodID AndroidThunkJava_UnregisterForRemoteNotifications;
121 static jmethodID AndroidThunkJava_IsAllowedRemoteNotifications;
122
123 // In app purchase functionality
124 static jclass JavaStringClass;
125 static jmethodID AndroidThunkJava_IapSetupService;
126 static jmethodID AndroidThunkJava_IapQueryInAppPurchases;
127 static jmethodID AndroidThunkJava_IapBeginPurchase;
128 static jmethodID AndroidThunkJava_IapIsAllowedToMakePurchases;
129 static jmethodID AndroidThunkJava_IapQueryExistingPurchases;
130 static jmethodID AndroidThunkJava_IapAcknowledgePurchase;
131 static jmethodID AndroidThunkJava_IapConsumePurchase;
132
133 // SurfaceView functionality for view scaling on some devices
134 static jmethodID AndroidThunkJava_UseSurfaceViewWorkaround;
135 static jmethodID AndroidThunkJava_SetDesiredViewSize;
136 static jmethodID AndroidThunkJava_VirtualInputIgnoreClick;
137 static jmethodID AndroidThunkJava_RestartApplication;
138
139 // Screen refresh rate
140 static jmethodID AndroidThunkJava_GetNativeDisplayRefreshRate;
141 static jmethodID AndroidThunkJava_SetNativeDisplayRefreshRate;
142 static jmethodID AndroidThunkJava_GetSupportedNativeDisplayRefreshRates;
143
144 // Motion controls
145 static jmethodID AndroidThunkJava_EnableMotion;
146
147 // Network Connection Listener
148 static jmethodID AndroidThunkJava_AddNetworkListener;
149 static jmethodID AndroidThunkJava_RemoveNetworkListener;
150
151 // member fields for getting the launch notification
152 static jclass LaunchNotificationClass;
153 static jfieldID LaunchNotificationUsed;
154 static jfieldID LaunchNotificationEvent;
155 static jfieldID LaunchNotificationFireDate;
156
157 // method and classes for thread name change
158 static jclass ThreadClass;
159 static jmethodID CurrentThreadMethod;
160 static jmethodID SetNameMethod;
161
162 // WifiManager's Multicastlock handling
163 static jmethodID AndroidThunkJava_AcquireWifiManagerMulticastLock;
164 static jmethodID AndroidThunkJava_ReleaseWifiManagerMulticastLock;
165
169 static void FindClassesAndMethods(JNIEnv* Env);
170
174 static jclass FindClass(JNIEnv* Env, const ANSICHAR* ClassName, bool bIsOptional);
175 static jclass FindClassGlobalRef(JNIEnv* Env, const ANSICHAR* ClassName, bool bIsOptional);
176 static jmethodID FindMethod(JNIEnv* Env, jclass Class, const ANSICHAR* MethodName, const ANSICHAR* MethodSignature, bool bIsOptional);
177 static jmethodID FindStaticMethod(JNIEnv* Env, jclass Class, const ANSICHAR* MethodName, const ANSICHAR* MethodSignature, bool bIsOptional);
178 static jfieldID FindField(JNIEnv* Env, jclass Class, const ANSICHAR* FieldName, const ANSICHAR* FieldType, bool bIsOptional);
179
180 static void CallVoidMethod(JNIEnv* Env, jobject Object, jmethodID Method, ...);
181 static jobject CallObjectMethod(JNIEnv* Env, jobject Object, jmethodID Method, ...);
182 static int32 CallIntMethod(JNIEnv* Env, jobject Object, jmethodID Method, ...);
183 static int64 CallLongMethod(JNIEnv* Env, jobject Object, jmethodID Method, ...);
184 static float CallFloatMethod(JNIEnv* Env, jobject Object, jmethodID Method, ...);
185 static double CallDoubleMethod(JNIEnv* Env, jobject Object, jmethodID Method, ...);
186 static bool CallBooleanMethod(JNIEnv* Env, jobject Object, jmethodID Method, ...);
187
188 static void CallStaticVoidMethod(JNIEnv* Env, jclass Clazz, jmethodID Method, ...);
189 static jobject CallStaticObjectMethod(JNIEnv* Env, jclass Clazz, jmethodID Method, ...);
190 static int32 CallStaticIntMethod(JNIEnv* Env, jclass Clazz, jmethodID Method, ...);
191 static int64 CallStaticLongMethod(JNIEnv* Env, jclass Clazz, jmethodID Method, ...);
192 static float CallStaticFloatMethod(JNIEnv* Env, jclass Clazz, jmethodID Method, ...);
193 static double CallStaticDoubleMethod(JNIEnv* Env, jclass Clazz, jmethodID Method, ...);
194 static bool CallStaticBooleanMethod(JNIEnv* Env, jclass Clazz, jmethodID Method, ...);
195
196 // Delegate that can be registered to that is called when an activity is finished
197 static FOnActivityResult OnActivityResultDelegate;
198
199 // Delegate that can be registered to that is called when an SafetyNet Attestation is finished
200 static FOnSafetyNetAttestationResult OnSafetyNetAttestationResultDelegate;
201
202 // Delegate that can be registered to be called when a service intent is received
203 static FOnRouteServiceIntent OnRouteServiceIntentDelegate;
204
205private:
206
208 static void FindGooglePlayMethods(JNIEnv* Env);
210 static void FindGooglePlayBillingMethods(JNIEnv* Env);
211
212 // Setup communication with wrapper apps
213 static void SetupEmbeddedCommunication(JNIEnv* Env);
214};
215#endif
GJavaVM
JavaVM * GJavaVM
int64
FPlatformTypes::int64 int64
A 64-bit signed integer.
Definition Platform.h:1127
int32
FPlatformTypes::int32 int32
A 32-bit signed integer.
Definition Platform.h:1125
ANSICHAR
FPlatformTypes::ANSICHAR ANSICHAR
An ANSI character. Normally a signed type.
Definition Platform.h:1131
StaticCastSharedRef
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
DECLARE_MULTICAST_DELEGATE_TwoParams
#define DECLARE_MULTICAST_DELEGATE_TwoParams(DelegateName, Param1Type, Param2Type)
Definition DelegateCombinations.h:58
DECLARE_MULTICAST_DELEGATE_SixParams
#define DECLARE_MULTICAST_DELEGATE_SixParams(DelegateName, Param1Type, Param2Type, Param3Type, Param4Type, Param5Type, Param6Type)
Definition DelegateCombinations.h:94
DECLARE_MULTICAST_DELEGATE_ThreeParams
#define DECLARE_MULTICAST_DELEGATE_ThreeParams(DelegateName, Param1Type, Param2Type, Param3Type)
Definition DelegateCombinations.h:67
StructDeserializer::FindClass
UStruct * FindClass(const FReadState &State)
Definition StructDeserializer.cpp:40