Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tuarua/frekotlin-android-ane
Example Air Native Extension written in Kotlin 1.6 for Android
https://github.com/tuarua/frekotlin-android-ane
adobe-air air-native-extensions android ane kotlin-android
Last synced: about 2 months ago
JSON representation
Example Air Native Extension written in Kotlin 1.6 for Android
- Host: GitHub
- URL: https://github.com/tuarua/frekotlin-android-ane
- Owner: tuarua
- License: apache-2.0
- Created: 2017-08-03T23:52:33.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-14T17:56:12.000Z (almost 2 years ago)
- Last Synced: 2024-05-02T02:22:32.643Z (8 months ago)
- Topics: adobe-air, air-native-extensions, android, ane, kotlin-android
- Language: ActionScript
- Homepage:
- Size: 82.5 MB
- Stars: 16
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# FreKotlin
Example Android Studio project showing how to create Air Native Extensions for Android using Kotlin.
This project is used as the basis for the following ANEs
[Google Maps ANE](https://github.com/tuarua/Google-Maps-ANE)
[AdMob ANE](https://github.com/tuarua/AdMob-ANE)
[WebViewANE](https://github.com/tuarua/WebViewANE)
[FirebaseANE](https://github.com/tuarua/Firebase-ANE)
[ZipANE](https://github.com/tuarua/Zip-ANE)
-------------
### Getting Started
A basic Hello World [starter project](/starter_project) is included
### How to use
###### Converting from FREObject args into Kotlin types, returning FREObjects
The following table shows the primitive as3 types which can easily be converted to/from Kotlin types
| AS3 type | Kotlin type | AS3 param->Kotlin | return Kotlin->AS3 |
|:--------:|:--------:|:--------------|:-----------|
| String | String | `val s = String(argv[0])` | `return s.toFREObject()`|
| int | Int | `val i = Int(argv[0])` | `return i.toFREObject()`|
| Boolean | Boolean | `val b = Boolean(argv[0])` | `return b.toFREObject()`|
| Number | Double | `val d = Double(argv[0])` | `return d.toFREObject()`|
| Number | Float | `val fl = Float(argv[0])` | `return fl.toFREObject()`|
| Date | Date | `val dt = Date(argv[0])` | `return dt.toFREObject()`|
| Rectangle | Rect | `val r = Rect(argv[0])` | `return r.toFREObject()`|
| Rectangle | RectF | `val r = RectF(argv[0])` | `return r.toFREObject()`|
| Point | Point | `val pnt = Point(argv[0])` | `return pnt.toFREObject()`|
| Point | PointF | `val pnt = PointF(argv[0])` | `return pnt.toFREObject()`|
| Vector Int | IntArray | `val arr = IntArray(argv[0])` | `return arr.toFREObject()`|
| Vector Boolean | BooleanArray | `val arr = BooleanArray(argv[0])` | `return arr.toFREObject()`|
| Vector Number | DoubleArray | `val arr = DoubleArray(argv[0])` | `return arr.toFREObject()`|
| Vector String | List | `val al = List(argv[0])` | `return al.toFREObject()`|
| Object | Map? | `val dict: Map? = Map(argv[0])` | |
| null | null | | return null |
#### Basic Types
```kotlin
val myString: String? = String(argv[0])
val myInt = Int(argv[1])
val myBool = Boolean(argv[2])
val kotlinString = "I am a string from Kotlin"
return kotlinString.toFREObject()
```
#### Creating new FREObjects
```kotlin
val newPerson = FREObject("com.tuarua.Person")
// create a FREObject passing args
//
// The following param types are allowed:
// String, Int, Double, Float, Long, Short, Boolean, Date, FREObject
val frePerson = FREObject("com.tuarua.Person", "Bob", "Doe", 28, myFREObject)
```
#### Calling Methods
```kotlin
// call a FREObject method passing args
//
// The following param types are allowed:
// String, Int, Double, Float, Long, Short, Boolean, Date, FREObject
val addition = freCalculator.call("add", 100, 31)
```
#### Getting / Setting Properties
```kotlin
val oldAge = Int(person["age"])
val newAge = oldAge + 10
// Set property using braces access
person["age"] = newAge
```
#### Arrays
```kotlin
val airArray: FREArray? = FREArray(argv[0])
// convert to a Kotlin List
val airStringVector = List(argv[0])
// create a Vector. with fixed length of 5
val newFreArray = FREArray("com.tuarua.Person", 5, true)
val len = newFreArray.length
// loop over FREArray
for (fre: FREObject? in airArray) {
trace(Int(fre))
}
// set element 0 to 123
airArray[0] = 123
// append element FREArray
airArray.push(456)
// return Kotlin IntArray to AIR
val kotArr = intArrayOf(99, 98, 92, 97, 95)
return kotArr.toFREArray()
```
#### Sending Events back to AIR
```kotlin
trace("Hi", "There")
// with interpolation
trace("My name is: $name")
dispatchEvent("MY_EVENT", "this is a test")
```
#### Bitmapdata
```kotlin
val icon: Bitmap? = Bitmap(argv[0])
return icon.toFREObject()
```
#### ByteArrays
```kotlin
val byteArray = ByteArray(argv[0])
if (byteArray != null) {
val str = String(Base64.encode(byteArray, Base64.NO_WRAP), Charset.forName("utf-8"))
}
```
#### Error Handling
```kotlin
FreKotlinLogger.context = this.context
if (inFRE1.type != FreObjectTypeKotlin.INT) {
return FreException("Oops, we expected the FREObject to be passed as an int but it's not").getError();
}
```
Advanced Example - Extending. Convert to/from LatLng
```kotlin
package com.tuarua.frekotlin
import com.adobe.fre.FREObject
import com.google.android.gms.maps.model.LatLng
fun LatLng(freObject: FREObject?): LatLng {
return LatLng(Double(freObject["latitude"]) ?: 0.0,
Double(freObject["longitude"]) ?: 0.0)
}
fun LatLng.toFREObject(): FREObject? {
return FREObject("com.tuarua.googlemaps.Coordinate", this.latitude, this.longitude)
}
```
### Prerequisites
You will need
- Android Studio 2022+
- IntelliJ IDEA
- AIR 50.1+