suvitruf / unity-android-native

A Unity plugin to work with Android native sdk

Unity wrappers for android classes

This is a Unity plugin to work with some Android native sdk classes.

Introduction

Assume, you want to get your game version name and code. Yes, you will write something like this using AndroidJavaClass and AndroidJavaObject:

public static int GetVersionCode() {
  AndroidJavaClass contextCls = new AndroidJavaClass("com.unity3d.player.UnityPlayer");
  AndroidJavaObject context = contextCls.GetStatic<AndroidJavaObject>("currentActivity"); 
  AndroidJavaObject packageMngr = context.Call<AndroidJavaObject>("getPackageManager");
  string packageName = context.Call<string>("getPackageName");
  AndroidJavaObject packageInfo = packageMngr.Call<AndroidJavaObject>("getPackageInfo", packageName, 0);
  return packageInfo.Get<int>("versionCode");
}

public static string GetVersionName() {
  AndroidJavaClass contextCls = new AndroidJavaClass("com.unity3d.player.UnityPlayer");
  AndroidJavaObject context = contextCls.GetStatic<AndroidJavaObject>("currentActivity"); 
  AndroidJavaObject packageMngr = context.Call<AndroidJavaObject>("getPackageManager");
  string packageName = context.Call<string>("getPackageName");
  AndroidJavaObject packageInfo = packageMngr.Call<AndroidJavaObject>("getPackageInfo", packageName, 0);
  return packageInfo.Get<string>("versionName");
}

This is kinda ugly. I'm crying internally, when I have to work with this classes. So, the idea behind this repo was to create comfy lib to work with native java classes. Example from above with this lib:

var activity = Internal.GetCurrentActivity();
var pm = activity.GetPackageManager();
var pi = pm.GetPackageInfo(activity.GetPackageName(), 0);
int code = pi.VersionCode;
string name = pi.VersionName;

Looks like the code you write when working directly with Java classes. That's it.

Some Theory

There is JavaObject class with some internal methods for JNI access. For example, we want to create C# representation of Java class Intent.

1. Namespace should be to Java full class name with prefix UnityAndroidNative. So, it will be UnityAndroidNative.Android.Content.
2. Derive it from our Object class (which derived from JavaObject).
3. Implement base constructor:

   public Intent(IntPtr obj) : base(obj) {
   }

   Or constructor which takes action:

   public Intent(string action) : base(IntentClassFullName, action) {
   }

   So, now you can instantiate this class:

   Intent intent = new Intent(Intent.ACTION_SEND);

4. Now we can implement methods using methods of JavaObject. For example, setAction:

   public Intent SetAction(string action) {
       Call<Intent>("setAction", action);
   
       return this;
   }

   You can instantiate Intent with default constructor and set action:

   Intent intent = new Intent();
   intent.SetAction(Intent.ACTION_SEND);

5. Need method too return field value? Easy:

   public Uri GetData() {
       return Get<Uri>("getData");
   }

Real world example

Assume you want to start sharing Intent and filter app to show. Easy:

  public static void Share(string body, string subject, string mimeType = "text/plain", string chooserTitle = "Choose application") {
      Intent intent = new Intent(Intent.ACTION_SEND);
      intent.SetType(mimeType)
          .PutExtra(Intent.EXTRA_SUBJECT, subject)
          .PutExtra(Intent.EXTRA_TEXT, body);

      var intentList = new List<Intent>();

      var activity = Internal.GetCurrentActivity();
      var pm = activity.GetPackageManager();
      var resInfo = pm.QueryIntentActivities(intent, 0);


      for (int i = 0; i < resInfo.Count; i++) {
          ResolveInfo ri = resInfo[i];
          string packageName = ri.ActivityInfo.GetPackageName();
          if (packageName.Contains("vkontakte")  || packageName.Contains("instagram") || packageName.Contains("skype")) {
              Intent newIntent = new Intent(Intent.ACTION_SEND);
              newIntent.SetPackage(packageName)
                  .PutExtra(Intent.EXTRA_SUBJECT, subject)
                  .PutExtra(Intent.EXTRA_TEXT, body)
                  .SetType(mimeType);

              intentList.Add(newIntent);
          }
      }

      Intent intentt = intentList[0];
      intentList.RemoveAt(0);
      Parcelable[] extraIntents = new Parcelable[intentList.Count];

      for (int i = 0; i < intentList.Count; i++) {
          extraIntents[i] = intentList[i];
      }

      var chooser = Intent.CreateChooser(intentt, chooserTitle);
      chooser.PutExtra(Intent.EXTRA_INITIAL_INTENTS, extraIntents);
      activity.StartActivity(chooser);
  }

P.S.

There are not much you can do with this lib right now. But I'm going add new classes/methods from time to time.

unity-android-native's Issues

Enums

Hello,

I want to use Bitmap#BitmapConfig (https://developer.android.com/reference/android/graphics/Bitmap.Config) which is an enum.
Can you tell me, how I would integrate this?

Thank you,
Manfred

Proxy classes

Need to implement some sort of proxy classes to be able to pass C# callbacks into Java.

• Basic proxy class.
• Example. AlertDialog.

Caching fields on C# side

Do we need to cache fields on C# side?

Caching ref fields like PackageInfo https://github.com/Suvitruf/unity-android-native/blob/master/Assets/UnityAndroidNative/Android/Content/Pm/PackageManager.cs#L11 in PackageManager is not the bad idea, 'cause this ref will not be changed.

But what's about primitive types, like mAction field of Intent? It would be a nice to reduce jni calls. But if something changes this field in native object, it will not be automatically changed on C# side.