uapmd-binding/dev.atsushieno.uapmd/ScanTool

ScanTool

interface ScanTool : AutoCloseable

Inheritors

AndroidScanTool

JsScanTool

JvmScanTool

NativeScanTool

WasmJsScanTool

Properties

abstract val blocklistCount: UInt

abstract var cacheFile: String

catalogEntryCount

abstract val catalogEntryCount: UInt

abstract val formatCount: UInt

abstract val lastScanError: String

searchPathSettingsFile

abstract val searchPathSettingsFile: String

Functions

addFormatSearchPath

abstract fun addFormatSearchPath(formatIndex: UInt, path: String)

abstract fun addToBlocklist(formatName: String, pluginId: String, reason: String)

abstract fun clearBlocklist()

expect abstract fun close()

abstract fun flushBlocklist()

formatUsesSearchPaths

abstract fun formatUsesSearchPaths(formatIndex: UInt): Boolean

False for a format enumerated by the OS (AU); the rest below then do nothing.

getBlocklistEntry

abstract fun getBlocklistEntry(index: UInt): BlocklistEntry?

getFormatDefaultSearchPaths

abstract fun getFormatDefaultSearchPaths(formatIndex: UInt): List<String>

abstract fun getFormatName(index: UInt): String

getFormatSearchPaths

abstract fun getFormatSearchPaths(formatIndex: UInt): List<String>

getFormatUseDefaultSearchPaths

abstract fun getFormatUseDefaultSearchPaths(formatIndex: UInt): Boolean

loadSearchPathSettings

abstract fun loadSearchPathSettings()

Run after the formats are registered and before the first scan.

performScanning

abstract fun performScanning(requireFastScanning: Boolean, observer: ScanObserver? = null)

requireFastScanning mirrors the C API parameter (false = full slow scan).

abstract fun saveCache()

abstract fun saveCacheTo(path: String)

saveSearchPathSettings

abstract fun saveSearchPathSettings()

setFormatSearchPaths

abstract fun setFormatSearchPaths(formatIndex: UInt, paths: List<String>)

setFormatUseDefaultSearchPaths

abstract fun setFormatUseDefaultSearchPaths(formatIndex: UInt, value: Boolean)

abstract fun unblockBundle(entryId: String): Boolean