androidaudioplugin/org.androidaudioplugin/PluginInformation

PluginInformation

class PluginInformation(var packageName: String, var localName: String, var displayName: String, var version: String?, var category: String?, var developer: String?, var pluginId: String?, var sharedLibraryName: String?, var libraryEntryPoint: String?, var uiViewFactory: String? = null, var uiActivity: String? = null, var uiWeb: String? = null, var isOutProcess: Boolean = true)

Plugin information structure. The members mostly correspond to attributes and content elements in a <plugin> element in aap_metadata.xml.

Constructors

PluginInformation

constructor(packageName: String, localName: String, displayName: String, version: String?, category: String?, developer: String?, pluginId: String?, sharedLibraryName: String?, libraryEntryPoint: String?, uiViewFactory: String? = null, uiActivity: String? = null, uiWeb: String? = null, isOutProcess: Boolean = true)

Types

object Companion

Properties

var category: String?

category label. Right now Instrument or Effect are the expected values.

var developer: String?

developer name (such as personal name, company name, team name)

var displayName: String

human readable name of the plugin

var extensions: MutableList<ExtensionInformation>

var isOutProcess: Boolean

indicates if it is in-process plugin or not

libraryEntryPoint

var libraryEntryPoint: String?

AAP factory entrypoint function name

var localName: String

Android class name

var packageName: String

Android package name

var parameters: MutableList<ParameterInformation>

var pluginId: String?

plugin identifier, typically a URN

var ports: MutableList<PortInformation>

sharedLibraryName

var sharedLibraryName: String?

the shared library name that needs to be loaded when AudioPluginService is initialized.

var uiActivity: String?

in-plugin-process UI Activity class name

var uiViewFactory: String?

in-plugin-process UI View factory class name

var uiWeb: String?

in-host-process Web UI archive name

var version: String?

human readable version code

Functions

getDeclaredParameter

fun getDeclaredParameter(index: Int): ParameterInformation

getDeclaredParameterCount

fun getDeclaredParameterCount(): Int

getDeclaredPort

fun getDeclaredPort(index: Int): PortInformation

getDeclaredPortCount

fun getDeclaredPortCount(): Int

fun getExtension(index: Int): ExtensionInformation

getExtensionCount

fun getExtensionCount(): Int