To call Java code from C# scripts, Unity provides C# APIs that communicate with the Android Java Native Interface (JNI) through C++. Unity provides both a low level and a high level API that you can use to interact with Java code using JNI.
The low-level AndroidJNI class wraps JNI calls and provides static methods that directly map to JNI methods. The AndroidJNIHelper API provides helper functionality that is primarily used by the high-level API, but they can be useful in certain situations.
The high-level AndroidJavaObject, AndroidJavaClass, and AndroidJavaProxy APIs automate a lot of tasks required for JNI calls. They also use caching to make calls to Java faster. The combination of AndroidJavaObject
and AndroidJavaClass
is built on top of AndroidJNI
and AndroidJNIHelper
, but they also contain additional functionality such as static methods that you can use to access static members of Java classes.
Instances of AndroidJavaObject
and AndroidJavaClass
have a one-to-one mapping to an instance of java.lang.Object and java.lang.Class respectively. They provide three types of interactions with Java/Kotlin code:
Each interaction also has a static version:
When you get the value of a field or call a method that returns a value, you use generics to specify the return type. When you set the value of a field, you also use generics to specify the type of the field that you are setting. For methods that don’t return a value, there is a regular, non-generic, version of Call.
Important: You must access any non-primitive type as an AndroidJavaObject
. The only exception is a string which you access directly, even though they don’t represent a primitive type in Java.
This section contains code samples that show how to use the high-level AndroidJavaObject
and AndroidJavaClass
APIs.
The following code sample creates an instance of java.lang.String initialized with a string, and retrieves the hash value for that string.
using UnityEngine;
public class JavaExamples
{
public static int GetJavaStringHashCode(string text)
{
using (AndroidJavaObject jo = new AndroidJavaObject("java.lang.String", text))
{
int hash = jo.Call<int>("hashCode");
return hash;
}
}
}
This example:
AndroidJavaObject
that represents a java.lang.String. The AndroidJavaObject
constructor takes at least one parameter, which is the name of the class to construct an instance of. Any parameters after the class name are for the constructor call on the object, in this case the text
parameter from GetJavaStringHashCode
.int
generic type parameter for Call
because hashCode()
returns the hash code as an integer.
Note: You can’t use dotted notation to instantiate a nested Java class. You must use the $
separator to instantiate inner classes. For example, Use android.view.ViewGroup$LayoutParams
or android/view/ViewGroup$LayoutParams
, where the LayoutParams
class is nested in the ViewGroup
class.
The following code sample shows how to get the cache directory for the current application in C# without using plug-insA set of code created outside of Unity that creates functionality in Unity. There are two kinds of plug-ins you can use in Unity: Managed plug-ins (managed .NET assemblies created with tools like Visual Studio) and Native plug-ins (platform-specific native code libraries). More info
See in Glossary.
using UnityEngine;
public class JavaExamples
{
public static string GetApplicationCacheDirectory()
{
using (AndroidJavaClass unityPlayer = new AndroidJavaClass("com.unity3d.player.UnityPlayer"))
using (AndroidJavaObject currentActivity = unityPlayer.GetStatic<AndroidJavaObject>("currentActivity"))
using (AndroidJavaObject javaFile = currentActivity.Call<AndroidJavaObject>("getCacheDir"))
{
string cacheDirectory = javaFile.Call<string>("getCanonicalPath");
return cacheDirectory;
}
}
}
This example:
AndroidJavaClass
to represent com.unity3d.player.UnityPlayer
. It’s best practice to use AndroidJavaClass
instead of AndroidJavaObject
to access static members.AndroidJavaObject
to represent the current activity, which is a static member of com.unity3d.player.UnityPlayer
.Note: This example is for reference purposes. Instead, to access the application’s cache and file directory use the Application.temporaryCachePath and Application.persistentDataPath APIs.
The following code sample shows how to pass data from Java to Unity using UnitySendMessage
.
using UnityEngine;
public class JavaExamples : MonoBehaviour
{
private void Start()
{
AndroidJNIHelper.debug = true;
using (AndroidJavaClass jc = new AndroidJavaClass("com.unity3d.player.UnityPlayer"))
{
jc.CallStatic("UnitySendMessage", "My GameObject", "JavaMessage", "NewMessage");
}
}
private void JavaMessage(string message)
{
Debug.Log("message from java: " + message);
}
}
This example:
AndroidJavaClass
to represent com.unity3d.player.UnityPlayer
.UnitySendMessage
method that is a member of com.unity3d.player.UnityPlayer
.Although you call UnitySendMessage
from within Unity, it relays the message using Java, then Java calls back to the native/Unity code to deliver the message to the object, in this example it is the GameObjectThe fundamental object in Unity scenes, which can represent characters, props, scenery, cameras, waypoints, and more. A GameObject’s functionality is defined by the Components attached to it. More info
See in Glossary named “My GameObject” which has an attached script that contains a method called JavaMessage
.
This section describes best practices to be aware of when you call Java and Kotlin plug-in code from C# scriptsA piece of code that allows you to create your own Components, trigger game events, modify Component properties over time and respond to user input in any way you like. More info
See in Glossary.
Using the Java Native Interface (JNI), through either the high-level or low-level C# API is resource intensive and can be slow. To improve performance, and also code clarity, it’s best practice to keep the number of JNI calls low.
To avoid unnecessary JNI calls, the high-level C# API caches the ID of each Java method that you call. This means that subsequent calls to the same method are not as resource intensive as the first call. The calls don’t need to be during the same frame or even from the same AndroidJavaObject/AndroidJavaClass instance. If you use the low-level API and want this performance benefit, you must cache method ID yourself. Otherwise, it’s best practice to use the high-level API.
Note: Unity maintains the cache until the application closes. This includes while the application is in the background.
You should wrap any instance of AndroidJavaObject
or AndroidJavaClass
with a using
statement to ensure Unity destroys them as soon as possible. If you don’t use using
, Unity’s garbage collector should still release all created instances, but you lose control of when this will be.
The following code sample shows how to use using
statements to get the system language in an optimal way:
using UnityEngine;
public class LocaleExample : MonoBehaviour
{
void Start()
{
using (AndroidJavaClass cls = new AndroidJavaClass("java.util.Locale"))
using (AndroidJavaObject locale = cls.CallStatic<AndroidJavaObject>("getDefault"))
{
if (locale != null)
{
Debug.Log("current lang = " + locale.Call<string>("getDisplayLanguage"));
}
}
}
}
Note: To see a record of the garbage collector’s activity in Android Logcat, set AndroidJNIHelper.debug to true
.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.