Maps SDK for Android/com.magiclane.sdk.core/GemSdk

GemSdk

object GemSdk : SoundUtils.ITTSPlayerInitializationListener

GEM sdk global functions

Types

EBackgroundEvent

enum EBackgroundEvent : Enum<GemSdk.EBackgroundEvent>

Background related events

EDataSavePolicy

enum EDataSavePolicy : Enum<GemSdk.EDataSavePolicy>

Enumerates the possible places where new data can be saved

ENativeConfiguration

enum ENativeConfiguration : Enum<GemSdk.ENativeConfiguration>

Sdk native code configuration

enum ESdCardEvent : Enum<GemSdk.ESdCardEvent>

Memory card related events

ESdkCapabilities

enum ESdkCapabilities : Enum<GemSdk.ESdkCapabilities>

Sdk capabilities

Properties

var appLogPath: String?

SDK log path

val appVariant: Int

The app variant

val capabilities: Long

SDK capabilities

var dataSavePolicy: GemSdk.EDataSavePolicy

SDK data save policy

externalStoragePath

var externalStoragePath: String

SDK external storage path

internalStoragePath

var internalStoragePath: String

SDK internal storage path

nativeConfiguration

val nativeConfiguration: GemSdk.ENativeConfiguration

GEM sdk native code build configuration

val sdkVersion: SdkVersion?

SDK version

transferStatistics

val transferStatistics: TransferStatistics?

Transfer statistics for Sdk manager

Functions

external fun generateGPSLog(generate: Boolean)

Generate GPS log

getErrorDetails

fun getErrorDetails(error: ErrorCode): String

Get error details as string

getErrorDetailsInt

external fun getErrorDetailsInt(error: Int): String?

Get error details as string

getTokenFromManifest

fun getTokenFromManifest(context: Context): String?

Gets SDK token from manifest. Returns the String found in manifest else null

fun initialize(context: Context, activity: Activity?, timer: TimerService? = null, internalPath: String? = null, externalPath: String? = null, language: String? = null, languageTts: String? = null, savePolicy: GemSdk.EDataSavePolicy? = null, listener: ProgressListener? = null, appVariant: Int? = null, useApiExceptions: Boolean = false, logger: ApiCallLogger? = ApiCallLogger(), autoInitLiveDataSource: Boolean? = null, breakpadCallback: (Boolean) -> Unit? = null, token: String? = null, generateGPSLog: Boolean = false): Int

Initialize GEM sdk. All GEM sdk objects must be used after a successful call to this function.

initSdkWithDefaults

fun initSdkWithDefaults(context: Context, token: String? = null, timer: TimerService? = null, internalPath: String? = null, externalPath: String? = null, language: String? = null, languageTts: String? = null, savePolicy: GemSdk.EDataSavePolicy? = null, listener: ProgressListener? = null, appVariant: Int? = null, useApiExceptions: Boolean = false, logger: ApiCallLogger? = ApiCallLogger(), autoInitLiveDataSource: Boolean? = null, breakpadCallback: (Boolean) -> Unit? = null, allowOnline: Boolean = true, generateGPSLog: Boolean = false): Boolean

Initializes the sdk with DefaultNetworkManager If no token provided then will use GemSdk.getTokenFromManifest instead.

external fun isInitialized(): Boolean

Checks if SDK is initialized.

notifyBackgroundEvent

fun notifyBackgroundEvent(event: GemSdk.EBackgroundEvent)

Notifies GEM SDK about the hosting app background / foreground state.

notifyEngineInit

external fun notifyEngineInit(): Boolean

Call this when the engine is initialized. Needed for Flutter communication.

notifySDCardEvent

fun notifySDCardEvent(event: GemSdk.ESdCardEvent)

Notifies the Magic Earth Engine about SdCard inserted/removed.

onTTSPlayerInitializationFailed

open override fun onTTSPlayerInitializationFailed()

onTTSPlayerInitialized

open override fun onTTSPlayerInitialized()

Notification called when TTS engine is initialized

produceDefaultLiveDataSource

fun produceDefaultLiveDataSource(): DataSource?

Produces a preset live DataSource.

fun release(): Unit?

Releases the service manager if already created.

setNativeLibraryDir

external fun setNativeLibraryDir(nativeLibraryDir: String)

Set native library dir, used by deep learning API Called only once when library loaded MUST BE USED ONLY BY ANDROID IMPLEMENTATIONS OVER THIS API