Maps SDK for Android/com.magiclane.sdk.sensordatasource/ExternalDataSource

ExternalDataSource

class ExternalDataSource(address: Long) : DataSource

Class through which user can set its own sensors data (e.g. GPS positions)

Constructors

ExternalDataSource

constructor(address: Long)

Properties

address

val address: Long

Address of native referenced object. nullptr if not referencing any native allocated object. Note native allocation will happen only once.

availableDataTypes

val availableDataTypes: ArrayList<EDataType>

Available data types.

dataSourceType

val dataSourceType: EDataSourceType

Data source type. It can be live or playback.

origin

val origin: EOrigin

Origin of the data source

playback

val playback: Playback?

Playback If data source has no playback capabilities the interface return null

Functions

addListener

fun addListener(listener: DataSourceListener, types: ArrayList<Pair<EDataType, ParameterList?>>, critical: Boolean = true)

fun addListener(listener: DataSourceListener, type: EDataType, preferences: ParameterList? = null, critical: Boolean = true): Int

Adds a listener to a specific 'dataType'

addSurfaceToCamera

external fun addSurfaceToCamera(previewSurface: Surface): Pair<Int, Int>?

Attaches the surface to be rendered into directly by the camera.

finalize

fun finalize()

Overrides finalize that garbage collector will call when needed.

getDataTypeDescription

fun getDataTypeDescription(type: EDataType): String?

getLatestData

fun getLatestData(dataType: EDataType): SenseData?

getPreferences

fun getPreferences(type: EDataType): ParameterList?

Provides access to the current configuration specified to that data type.

isDataTypeAvailable

fun isDataTypeAvailable(type: EDataType): Boolean

Test if a data type is provided by the data source.

isMockData

fun isMockData(type: EDataType): Boolean

Check if mock data is enabled for the given type

isReference

fun isReference(): Boolean

True if keeps a reference to a C++ SDK object False if keeps a C++ SDK object

isStopped

external fun isStopped(): Boolean

Checks if the source is stopped

not

operator fun not(): Boolean

Checks if this object is valid.

pushData

external fun pushData(data: SenseData)

Push data in external data source

release

fun release()

Releases the native referenced value of this object if:

removeCameraSurface

external fun removeCameraSurface(surfaceID: Int): Int

Detaches the surface with provided Id from the camera.

removeListener

external fun removeListener(listener: DataSourceListener)

fun removeListener(listener: DataSourceListener, type: EDataType): Int

Removes the listener

setMockData

fun setMockData(type: EDataType, data: SenseData): Int

Set mock data

setPreferences

fun setPreferences(type: EDataType, config: ParameterList?): Int

Updates the configuration for the specified dataType.

start

external fun start(): Int

Starts the source

stop

external fun stop(): Int

Stops the source