uapmd-binding/dev.atsushieno.uapmd

Package-level declarations

Types

data class AapUiHostDetails(val pluginPackageName: String, val pluginLocalName: String, val instanceId: Int)

data class AddinCommandInfo(val id: String, val title: String, val order: Int, val enabled: Boolean)

One command an addin contributed.

data class AddinInfo(val packageId: String, val addinId: String, val name: String, val path: String, val libraryPath: String, val builtIn: Boolean, val state: AddinState, val message: String)

AddinManager

interface AddinManager : AutoCloseable

Which call publishes which extension point, since they are split between the engine and the registries here:

AddinState

enum AddinState : Enum<AddinState>

AnchorOrigin

enum AnchorOrigin : Enum<AnchorOrigin>

uapmd_anchor_origin_t: which end of the anchor the offset is measured from.

AndroidAddinManager

class AndroidAddinManager : AddinManager

AndroidAppModel

class AndroidAppModel : AppModel

AndroidAudioDeviceManager

class AndroidAudioDeviceManager : AudioDeviceManager

AndroidAudioFileReader

class AndroidAudioFileReader : AudioFileReader

AndroidAudioIODevice

class AndroidAudioIODevice : AudioIODevice

AndroidClipCommandRegistry

class AndroidClipCommandRegistry : ClipCommandRegistry

AndroidClipEditorRegistry

class AndroidClipEditorRegistry : ClipEditorRegistry

AndroidClipFragment

class AndroidClipFragment : ClipFragment

AndroidCommandManager

class AndroidCommandManager : CommandManager

AndroidCommandRegistry

class AndroidCommandRegistry : CommandRegistry

AndroidDeviceIODispatcher

class AndroidDeviceIODispatcher : DeviceIODispatcher

AndroidFormatManager

class AndroidFormatManager : FormatManager

AndroidFunctionBlock

class AndroidFunctionBlock : FunctionBlock

AndroidFunctionBlockManager

class AndroidFunctionBlockManager : FunctionBlockManager

AndroidFunctionDevice

class AndroidFunctionDevice : FunctionDevice

AndroidMidiIO

class AndroidMidiIO : MidiIO

AndroidMidiIODevice

class AndroidMidiIODevice : MidiIODevice

AndroidMidiRecorder

class AndroidMidiRecorder : MidiRecorder

AndroidPianoRollSession

class AndroidPianoRollSession : PianoRollSession

AndroidPianoRollSnapshot

class AndroidPianoRollSnapshot : PianoRollSnapshot

AndroidPluginGraph

class AndroidPluginGraph : PluginGraph

AndroidPluginHost

class AndroidPluginHost : PluginHost

AndroidPluginInstance

class AndroidPluginInstance : PluginInstance

AndroidPluginInstancing

class AndroidPluginInstancing : PluginInstancing

AndroidPluginNode

class AndroidPluginNode : PluginNode

AndroidPreparedProject

class AndroidPreparedProject : PreparedProject

AndroidProjectAddressBook

class AndroidProjectAddressBook : ProjectAddressBook

AndroidProjectCommands

class AndroidProjectCommands : ProjectCommands

AndroidRealtimeSequencer

class AndroidRealtimeSequencer : RealtimeSequencer

AndroidScanTool

class AndroidScanTool : ScanTool

AndroidSequencerEngine

class AndroidSequencerEngine : SequencerEngine

AndroidSequencerTrack

class AndroidSequencerTrack : SequencerTrack

AndroidStemSeparatorRegistry

class AndroidStemSeparatorRegistry : StemSeparatorRegistry

AndroidTempoMap

class AndroidTempoMap : TempoMap

Borrows the timeline's own map: the handle is only valid until the project changes, so this is fetched fresh from TimelineFacade.masterTempoMap rather than cached.

AndroidTimelineFacade

class AndroidTimelineFacade : TimelineFacade

AndroidTimelineTrack

class AndroidTimelineTrack : TimelineTrack

AndroidTrackFragment

class AndroidTrackFragment : TrackFragment

AndroidTransportController

class AndroidTransportController : TransportController

AndroidUmpInputMapper

class AndroidUmpInputMapper : UmpInputMapper

AndroidUmpOutputMapper

class AndroidUmpOutputMapper : UmpOutputMapper

AppModel

interface AppModel

Host side of uapmd_app::AppModel (tools/uapmd-app-model) — the façade uapmd-app itself renders against, wrapped by c-api/uapmd-c-app.h.

AppProjectResult

data class AppProjectResult(val success: Boolean, val error: String?)

Mirrors uapmd_app_project_result_t.

AudioBusRole

enum AudioBusRole : Enum<AudioBusRole>

Mirrors remidy::AudioBusRole.

AudioDeviceInfo

data class AudioDeviceInfo(val directions: AudioIoDirection, val id: Int, val name: String, val sampleRate: UInt, val channels: UInt)

AudioDeviceManager

interface AudioDeviceManager

AudioFileProperties

data class AudioFileProperties(val numFrames: Long, val numChannels: UInt, val sampleRate: UInt)

AudioFileReader

interface AudioFileReader : AutoCloseable

AudioImportResult

data class AudioImportResult(val success: Boolean, val canceled: Boolean, val error: String?, val warnings: List<String>, val stems: List<AudioStemImport>)

AudioIODevice

interface AudioIODevice

AudioIoDirection

enum AudioIoDirection : Enum<AudioIoDirection>

AudioStemImport

data class AudioStemImport(val stemName: String, val filepath: String, val clipDisplayName: String)

One separated stem, ready to become a clip.

AudioWarpPointData

data class AudioWarpPointData(val clipPositionOffset: Double, val speedRatio: Double, val referenceType: WarpReferenceType = WarpReferenceType.Manual, val referenceClipId: String = "", val referenceMarkerId: String = "")

BlocklistEntry

data class BlocklistEntry(val id: String, val format: String, val pluginId: String, val reason: String)

CatalogEntry

data class CatalogEntry(val format: String, val pluginId: String, val displayName: String, val vendor: String = "")

ClipAddress

data class ClipAddress(val trackReferenceId: String, val clipReferenceId: String)

Stable document identity of one clip.

ClipAddResult

data class ClipAddResult(val clipId: Int, val sourceNodeId: Int, val success: Boolean, val error: String?)

ClipAudioEventsResult

data class ClipAudioEventsResult(val success: Boolean, val error: String?, val markers: List<ClipMarkerData>, val warps: List<AudioWarpPointData>)

Mirrors uapmd_clip_audio_events_result_t.

ClipCommandRegistry

interface ClipCommandRegistry : AutoCloseable

Commands scoped to one clip. Offer them wherever a clip is presented, asking appliesTo first: false hides the command for that clip entirely, while true with isEnabled false means show it greyed out.

ClipCommandTarget

data class ClipCommandTarget(val trackIndex: Int, val clipId: Int, val isMidiClip: Boolean = false, val isMasterTrack: Boolean = false)

The clip a clip-scoped command is being offered for. The identifiers are the ones the rest of this API takes, so a command resolves the clip through the engine rather than through anything carried here.

ClipData

data class ClipData(val clipId: Int, val positionSamples: Long, val positionLegacyBeats: Double, val durationSamples: Long, val gain: Double, val muted: Boolean, val name: String, val filepath: String, val clipType: ClipType, val referenceId: String = "", val anchorReferenceId: String = "", val anchorOrigin: AnchorOrigin = AnchorOrigin.Start, val anchorOffsetSamples: Long = 0)

ClipEditorInfo

data class ClipEditorInfo(val id: String, val name: String)

ClipEditorRegistry

interface ClipEditorRegistry : AutoCloseable

Timeline clip editors contributed by addins.

ClipFragment

interface ClipFragment : AutoCloseable

A clip detached from the document: the payload shared by an undo entry and a clipboard entry. Fragments obtained from TimelineFacade.captureClipFragment must be closed; those borrowed from a TrackFragment need not be.

ClipMarkerData

data class ClipMarkerData(val markerId: String, val clipPositionOffset: Double, val referenceType: WarpReferenceType = WarpReferenceType.Manual, val referenceClipId: String = "", val referenceMarkerId: String = "", val name: String = "")

ClipType

enum ClipType : Enum<ClipType>

CommandManager

interface CommandManager

The project's history: thread-affine and asynchronous. Its methods are called on the model thread; completions may arrive on any thread.

CommandRegistry

interface CommandRegistry : AutoCloseable

Application-wide commands contributed by addins.

ContentBounds

data class ContentBounds(val hasContent: Boolean, val firstSample: Long, val lastSample: Long, val firstSeconds: Double, val lastSeconds: Double)

DeviceEntry

data class DeviceEntry(val id: Int, val label: String, val apiName: String, val statusMessage: String, val running: Boolean, val instantiating: Boolean, val hasError: Boolean)

One UMP device the model has instantiated.

DeviceIODispatcher

interface DeviceIODispatcher

EffectiveSignature

data class EffectiveSignature(val startBeat: Double, val endBeat: Double, val numerator: Int, val denominator: Int)

One meter region of a TempoMap. endBeat is infinite for the last one.

FormatManager

interface FormatManager : AutoCloseable

Minimal format manager – exposes available plugin formats by name.

FreezePolicy

enum FreezePolicy : Enum<FreezePolicy>

FreezeRuntimeState

enum FreezeRuntimeState : Enum<FreezeRuntimeState>

FunctionBlock

interface FunctionBlock

FunctionBlockManager

interface FunctionBlockManager

FunctionDevice

interface FunctionDevice

Marker for a MIDI 2.0 function device (no public C API beyond retrieval).

GraphAudioBus

data class GraphAudioBus(val name: String, val role: AudioBusRole, val enabled: Boolean, val channelLayoutName: String, val channelCount: UInt)

One audio bus of a graph node — remidy::AudioBusConfiguration.

GraphBusType

enum GraphBusType : Enum<GraphBusType>

GraphConnection

data class GraphConnection(val id: Long, val busType: GraphBusType, val source: GraphEndpoint, val target: GraphEndpoint)

GraphConnectionsResult

data class GraphConnectionsResult(val success: Boolean, val error: String?, val connections: List<GraphConnection>)

GraphEndpoint

data class GraphEndpoint(val type: GraphEndpointType, val nodeId: String, val instanceId: Int, val busIndex: UInt)

One end of a graph connection.

GraphEndpointType

enum GraphEndpointType : Enum<GraphEndpointType>

GraphNode

data class GraphNode(val nodeId: String, val nodeType: String, val displayName: String, val instanceId: Int, val bypassed: Boolean, val latencyInSamples: UInt, val tailLengthInSeconds: Double, val hasAudioBuses: Boolean, val hasEventInputs: Boolean, val hasEventOutputs: Boolean, val audioInputBuses: List<GraphAudioBus>, val audioOutputBuses: List<GraphAudioBus>, val mainInputBusIndex: Int, val mainOutputBusIndex: Int)

One node of a track graph: uapmd_graph::AudioGraphNode plus the remidy::PluginAudioBuses facade it exposes.

GraphNodesResult

data class GraphNodesResult(val success: Boolean, val error: String?, val nodes: List<GraphNode>, val graphAudioInputBusCount: UInt, val graphAudioOutputBusCount: UInt, val graphEventInputBusCount: UInt, val graphEventOutputBusCount: UInt)

InputMonitoringPolicy

enum InputMonitoringPolicy : Enum<InputMonitoringPolicy>

InstancingState

enum InstancingState : Enum<InstancingState>

JniBridge

object JniBridge

JNI bridge object — every method corresponds to a C function in uapmd_jni.cpp. Handles are jlong (opaque C pointer cast to uintptr_t). Callback objects are plain Kotlin lambdas / SAM interfaces.

JsAddinManager

class JsAddinManager : AddinManager

JsAppModel

class JsAppModel : AppModel

JsAudioDeviceManager

class JsAudioDeviceManager : AudioDeviceManager

JsAudioFileReader

class JsAudioFileReader : AudioFileReader

JsAudioIODevice

class JsAudioIODevice : AudioIODevice

JsClipCommandRegistry

class JsClipCommandRegistry : ClipCommandRegistry

JsClipEditorRegistry

class JsClipEditorRegistry : ClipEditorRegistry

JsClipFragment

class JsClipFragment : ClipFragment

JsCommandManager

class JsCommandManager : CommandManager

JsCommandRegistry

class JsCommandRegistry : CommandRegistry

JsDeviceIODispatcher

class JsDeviceIODispatcher : DeviceIODispatcher

JsFormatManager

class JsFormatManager : FormatManager

JsFunctionBlock

class JsFunctionBlock : FunctionBlock

JsFunctionBlockManager

class JsFunctionBlockManager : FunctionBlockManager

JsFunctionDevice

class JsFunctionDevice : FunctionDevice

JsMidiIO

class JsMidiIO : MidiIO

JsMidiIODevice

class JsMidiIODevice : MidiIODevice

JsMidiRecorder

class JsMidiRecorder : MidiRecorder

JsPianoRollSession

class JsPianoRollSession : PianoRollSession

JsPianoRollSnapshot

class JsPianoRollSnapshot : PianoRollSnapshot

JsPluginGraph

class JsPluginGraph : PluginGraph

JsPluginHost

class JsPluginHost : PluginHost

JsPluginInstance

class JsPluginInstance : PluginInstance

JsPluginInstancing

class JsPluginInstancing : PluginInstancing

JsPluginNode

class JsPluginNode : PluginNode

JsProjectAddressBook

class JsProjectAddressBook : ProjectAddressBook

JsProjectCommands

class JsProjectCommands : ProjectCommands

JsRealtimeSequencer

class JsRealtimeSequencer : RealtimeSequencer

JsScanTool

class JsScanTool : ScanTool

JsSequencerEngine

class JsSequencerEngine : SequencerEngine

JsSequencerTrack

class JsSequencerTrack : SequencerTrack

JsStemSeparatorRegistry

class JsStemSeparatorRegistry : StemSeparatorRegistry

JsTempoMap

class JsTempoMap : TempoMap

Borrows the timeline's own map: the handle is only valid until the project changes, so this is fetched fresh from TimelineFacade.masterTempoMap rather than cached.

JsTimelineFacade

class JsTimelineFacade : TimelineFacade

JsTimelineTrack

class JsTimelineTrack : TimelineTrack

JsTrackFragment

class JsTrackFragment : TrackFragment

JsTransportController

class JsTransportController : TransportController

JvmAddinManager

class JvmAddinManager : AddinManager

JvmAppModel

class JvmAppModel : AppModel

JvmAudioDeviceManager

class JvmAudioDeviceManager : AudioDeviceManager

JvmAudioFileReader

class JvmAudioFileReader : AudioFileReader

JvmAudioIODevice

class JvmAudioIODevice : AudioIODevice

JvmClipCommandRegistry

class JvmClipCommandRegistry : ClipCommandRegistry

JvmClipEditorRegistry

class JvmClipEditorRegistry : ClipEditorRegistry

JvmClipFragment

class JvmClipFragment : ClipFragment

JvmCommandManager

class JvmCommandManager : CommandManager

JvmCommandRegistry

class JvmCommandRegistry : CommandRegistry

JvmDeviceIODispatcher

class JvmDeviceIODispatcher : DeviceIODispatcher

JvmFormatManager

class JvmFormatManager : FormatManager

JvmFunctionBlock

class JvmFunctionBlock : FunctionBlock

JvmFunctionBlockManager

class JvmFunctionBlockManager : FunctionBlockManager

JvmFunctionDevice

class JvmFunctionDevice : FunctionDevice

JvmMidiIO

class JvmMidiIO : MidiIO

JvmMidiIODevice

class JvmMidiIODevice : MidiIODevice

JvmMidiRecorder

class JvmMidiRecorder : MidiRecorder

JvmPianoRollSession

class JvmPianoRollSession : PianoRollSession

JvmPianoRollSnapshot

class JvmPianoRollSnapshot : PianoRollSnapshot

JvmPluginGraph

class JvmPluginGraph : PluginGraph

JvmPluginHost

class JvmPluginHost : PluginHost

JvmPluginInstance

class JvmPluginInstance : PluginInstance

JvmPluginInstancing

class JvmPluginInstancing : PluginInstancing

JvmPluginNode

class JvmPluginNode : PluginNode

JvmPreparedProject

class JvmPreparedProject : PreparedProject

JvmProjectAddressBook

class JvmProjectAddressBook : ProjectAddressBook

JvmProjectCommands

class JvmProjectCommands : ProjectCommands

JvmRealtimeSequencer

class JvmRealtimeSequencer : RealtimeSequencer

JvmScanTool

class JvmScanTool : ScanTool

JvmSequencerEngine

class JvmSequencerEngine : SequencerEngine

JvmSequencerTrack

class JvmSequencerTrack : SequencerTrack

JvmStemSeparatorRegistry

class JvmStemSeparatorRegistry : StemSeparatorRegistry

JvmTempoMap

class JvmTempoMap : TempoMap

Borrows the timeline's own map: the handle is only valid until the project changes, so this is fetched fresh from TimelineFacade.masterTempoMap rather than cached.

JvmTimelineFacade

class JvmTimelineFacade : TimelineFacade

JvmTimelineTrack

class JvmTimelineTrack : TimelineTrack

JvmTrackFragment

class JvmTrackFragment : TrackFragment

JvmTransportController

class JvmTransportController : TransportController

JvmUmpInputMapper

class JvmUmpInputMapper : UmpInputMapper

JvmUmpOutputMapper

class JvmUmpOutputMapper : UmpOutputMapper

LatencyCompensationSettings

data class LatencyCompensationSettings(val implementationId: String = "default", val playbackCompensationMode: PlaybackCompensationMode = PlaybackCompensationMode.Compensated, val inputMonitoringPolicy: InputMonitoringPolicy = InputMonitoringPolicy.Auto, val monitoredTrackIndexes: List<Int> = emptyList(), val recordArmedTrackIndexes: List<Int> = emptyList(), val implementationProperties: Map<String, String> = emptyMap())

MidiIO

interface MidiIO

MidiIODevice

interface MidiIODevice

Marker for a platform MIDI I/O device handle.

MidiNoteData

data class MidiNoteData(val startSeconds: Double, val durationSeconds: Double, val note: Int, val velocity: Float)

MidiPortInfo

data class MidiPortInfo(val id: String, val displayName: String)

MidiRecorder

interface MidiRecorder

uapmd::MidiRecorder — captures live MIDI input into a selected clip.

MidiTempoChange

data class MidiTempoChange(val tickPosition: ULong, val bpm: Double)

A tempo change inside a MIDI clip, positioned in the clip's own ticks.

MidiTimeSignatureChange

data class MidiTimeSignatureChange(val tickPosition: ULong, val numerator: UByte, val denominator: UByte, val clocksPerClick: UByte, val thirtySecondsPerQuarter: UByte)

A meter change inside a MIDI clip, positioned in the clip's own ticks.

MutationOrigin

enum MutationOrigin : Enum<MutationOrigin>

Who is making a change. User and Remote edits enter the undo history; Load, UndoRedo and Internal changes are applied without being recorded.

NativeAddinManager

class NativeAddinManager : AddinManager

NativeAppModel

class NativeAppModel : AppModel

NativeAudioDeviceManager

class NativeAudioDeviceManager : AudioDeviceManager

NativeAudioFileReader

class NativeAudioFileReader : AudioFileReader

NativeAudioIODevice

class NativeAudioIODevice : AudioIODevice

NativeClipCommandRegistry

class NativeClipCommandRegistry : ClipCommandRegistry

NativeClipEditorRegistry

class NativeClipEditorRegistry : ClipEditorRegistry

NativeClipFragment

class NativeClipFragment : ClipFragment

NativeCommandManager

class NativeCommandManager : CommandManager

NativeCommandRegistry

class NativeCommandRegistry : CommandRegistry

NativeDeviceIODispatcher

class NativeDeviceIODispatcher : DeviceIODispatcher

NativeFormatManager

class NativeFormatManager : FormatManager

NativeFunctionBlock

class NativeFunctionBlock : FunctionBlock

NativeFunctionBlockManager

class NativeFunctionBlockManager : FunctionBlockManager

NativeFunctionDevice

class NativeFunctionDevice : FunctionDevice

NativeMidiIO

class NativeMidiIO : MidiIO

NativeMidiIODevice

class NativeMidiIODevice : MidiIODevice

NativeMidiRecorder

class NativeMidiRecorder : MidiRecorder

NativePianoRollSession

class NativePianoRollSession : PianoRollSession

NativePianoRollSnapshot

class NativePianoRollSnapshot : PianoRollSnapshot

NativePluginGraph

class NativePluginGraph : PluginGraph

NativePluginHost

class NativePluginHost : PluginHost

NativePluginInstance

class NativePluginInstance : PluginInstance

NativePluginInstancing

class NativePluginInstancing : PluginInstancing

NativePluginNode

class NativePluginNode : PluginNode

NativePreparedProject

class NativePreparedProject : PreparedProject

NativeProjectAddressBook

class NativeProjectAddressBook : ProjectAddressBook

NativeProjectCommands

class NativeProjectCommands : ProjectCommands

NativeRealtimeSequencer

class NativeRealtimeSequencer : RealtimeSequencer

NativeScanTool

class NativeScanTool : ScanTool

NativeSequencerEngine

class NativeSequencerEngine : SequencerEngine

NativeSequencerTrack

class NativeSequencerTrack : SequencerTrack

NativeStemSeparatorRegistry

class NativeStemSeparatorRegistry : StemSeparatorRegistry

NativeTempoMap

class NativeTempoMap : TempoMap

Borrows the timeline's own map: the handle is only valid until the project changes, so this is fetched fresh from TimelineFacade.masterTempoMap rather than cached.

NativeTimelineFacade

class NativeTimelineFacade : TimelineFacade

NativeTimelineTrack

class NativeTimelineTrack : TimelineTrack

NativeTrackFragment

class NativeTrackFragment : TrackFragment

NativeTransportController

class NativeTransportController : TransportController

NativeUmpInputMapper

class NativeUmpInputMapper : UmpInputMapper

NativeUmpOutputMapper

class NativeUmpOutputMapper : UmpOutputMapper

ObjectIdPolicy

enum ObjectIdPolicy : Enum<ObjectIdPolicy>

Whether an object being attached to the document keeps the identifiers it already carries (Restore, which is what undoing a delete requires) or is given fresh ones (Mint, which is what paste and duplicate require).

OfflineRenderProgress

data class OfflineRenderProgress(val progress: Double, val renderedSeconds: Double, val totalSeconds: Double, val renderedFrames: Long, val totalFrames: Long)

OfflineRenderResult

data class OfflineRenderResult(val success: Boolean, val canceled: Boolean, val renderedSeconds: Double, val errorMessage: String?)

OfflineRenderSettings

data class OfflineRenderSettings(val outputPath: String, val startSeconds: Double, val endSeconds: Double? = null, val useContentFallback: Boolean = true, val contentBoundsValid: Boolean = false, val contentStartSeconds: Double = 0.0, val contentEndSeconds: Double = 0.0, val tailSeconds: Double = 0.0, val enableSilenceStop: Boolean = false, val silenceDurationSeconds: Double = 3.0, val silenceThresholdDb: Double = -60.0, val sampleRate: Int = 44100, val bufferSize: UInt, val outputChannels: UInt, val umpBufferSize: UInt)

OpResult

data class OpResult(val success: Boolean, val error: String?)

Mirrors uapmd_op_result_t.

ParameterMetadata

data class ParameterMetadata(val index: UInt, val stableId: String, val name: String, val path: String, val defaultPlainValue: Double, val minPlainValue: Double, val maxPlainValue: Double, val automatable: Boolean, val hidden: Boolean, val discrete: Boolean, val namedValues: List<ParameterNamedValue>)

ParameterNamedValue

data class ParameterNamedValue(val value: Double, val name: String)

PianoRollAction

enum PianoRollAction : Enum<PianoRollAction>

The clipboard actions a session performs on its selection.

PianoRollNote

data class PianoRollNote(val startSeconds: Double, val durationSeconds: Double, val velocity: Float, val note: Int, val channel: Int, val deleted: Boolean, val editId: Long, val umpGroup: Int, val releaseVelocity: Int, val attributeType: Int, val attributeValue: Int, val automationEventCount: Int)

One note as a session holds it.

PianoRollSession

interface PianoRollSession

A live editing session over one MIDI clip. Owned by the model — obtain one with AppModel.openPianoRollSession and release it with AppModel.closePianoRollSession.

PianoRollSnapshot

interface PianoRollSnapshot : AutoCloseable

A MIDI clip parsed into notes, ready to load into a PianoRollSession.

PlaybackCompensationMode

enum PlaybackCompensationMode : Enum<PlaybackCompensationMode>

PluginAddress

data class PluginAddress(val trackReferenceId: String, val nodeId: String)

Stable document identity of one plug-in node. A runtime instance id is not usable in history: removing and restoring a plug-in produces a new one.

PluginGraph

interface PluginGraph : AutoCloseable

PluginHost

interface PluginHost : AutoCloseable

PluginInstance

interface PluginInstance

PluginInstanceConfig

data class PluginInstanceConfig(val apiName: String = "default", val deviceName: String = "", val manufacturer: String = "UAPMD Project", val version: String = "0.1", val stateFile: String = "")

Mirrors uapmd_plugin_instance_config_t; empty strings take the C defaults.

PluginInstanceResult

data class PluginInstanceResult(val instanceId: Int, val pluginName: String, val error: String?)

Mirrors uapmd_plugin_instance_result_t.

PluginInstancing

interface PluginInstancing : AutoCloseable

Lifecycle manager for a single plugin's instantiation process. Created per (format, pluginId) pair via createPluginInstancing.

PluginNode

interface PluginNode

PluginStateResult

data class PluginStateResult(val instanceId: Int, val success: Boolean, val error: String, val filepath: String)

filepath is the path actually used for the save or load.

PluginUiCapabilities

data class PluginUiCapabilities(val hasUiSupport: Boolean, val supportsEmbeddedPresentations: Boolean = hasUiSupport, val supportsFloatingPresentations: Boolean = hasUiSupport, val supportsMultiplePresentations: Boolean = false)

PluginUiHost

sealed interface PluginUiHost

PluginUiPresentation

interface PluginUiPresentation

PluginUiPresentationMode

enum PluginUiPresentationMode : Enum<PluginUiPresentationMode>

PluginUiPresentationRequest

data class PluginUiPresentationRequest(val host: PluginUiHost = PluginUiHost.FloatingWindow, val role: PluginUiPresentationRole = PluginUiPresentationRole.FULL, val resizeHandler: (UInt, UInt) -> Boolean? = null)

PluginUiPresentationRole

enum PluginUiPresentationRole : Enum<PluginUiPresentationRole>

PreparedProject

interface PreparedProject : AutoCloseable

A project file made loadable. .uapmdz archives are unpacked to a temporary directory; a plain .uapmd resolves to itself. Close it after loading to remove any temporary files.

PresetMetadata

data class PresetMetadata(val bank: UByte, val index: UInt, val stableId: String, val name: String, val path: String)

ProjectAddressBook

interface ProjectAddressBook

Translation between the persistent identities a history step carries and the runtime indexes the engine works with. Not thread safe; call on the model thread only.

ProjectCommands

interface ProjectCommands

The undoable edits a project supports. Use TimelineFacade for reading the document and for changes that are not user edits; use this for anything a user could undo.

ProjectResult

data class ProjectResult(val success: Boolean, val error: String?)

RealtimeSequencer

interface RealtimeSequencer : AutoCloseable

RenderToFileSettings

data class RenderToFileSettings(val outputPath: String, val startSeconds: Double = 0.0, val endSeconds: Double = 0.0, val hasEndSeconds: Boolean = false, val useContentFallback: Boolean = true, val contentBoundsValid: Boolean = false, val contentStartSeconds: Double = 0.0, val contentEndSeconds: Double = 0.0, val tailSeconds: Double = 0.0, val enableSilenceStop: Boolean = false, val silenceDurationSeconds: Double = 2.0, val silenceThresholdDb: Double = -60.0)

What to render and when to stop.

RenderToFileStatus

data class RenderToFileStatus(val running: Boolean, val completed: Boolean, val success: Boolean, val progress: Double, val renderedSeconds: Double, val message: String, val outputPath: String)

ScanMode

enum ScanMode : Enum<ScanMode>

ScanObserver

interface ScanObserver

ScanTool

interface ScanTool : AutoCloseable

SequencerEngine

interface SequencerEngine

SequencerTrack

interface SequencerTrack

SlowScanProgress

data class SlowScanProgress(val running: Boolean = false, val processedBundles: UInt, val totalBundles: UInt, val currentBundle: String = "")

Progress of a slow plug-in scan, mirroring AppModel::SlowScanProgressState.

StateContextType

enum StateContextType : Enum<StateContextType>

StemSeparatorInfo

data class StemSeparatorInfo(val id: String, val name: String, val modelFileLabel: String, val modelFileExtensions: List<String>)

A stem separation backend contributed by an addin.

StemSeparatorRegistry

interface StemSeparatorRegistry : AutoCloseable

Stem separation backends contributed by addins.

StepEventBatching

enum StepEventBatching : Enum<StepEventBatching>

Whether one history step delivers its document events as a single batch.

TempoMap

interface TempoMap

A project's tempo curve: conversion between real-world seconds and quarter-note beats, plus the time signature in force over each beat range. "Beat" always means a quarter note, matching BPM and MIDI tick-resolution conventions.

TempoPoint

data class TempoPoint(val timeSeconds: Double, val tickPosition: Long, val bpm: Double)

A tempo change on the master track; uapmd_tempo_point_t.

TimelineClipDeleteResult

data class TimelineClipDeleteResult(val success: Boolean, val changedTracks: List<Int>, val error: String?)

changedTracks are the tracks that lost a clip.

TimelineClipTarget

data class TimelineClipTarget(val trackIndex: Int, val clipId: Int)

One clip, by the identifiers the rest of this API takes.

TimelineContentBounds

data class TimelineContentBounds(val hasContent: Boolean, val startSeconds: Double, val endSeconds: Double, val durationSeconds: Double)

TimelineFacade

interface TimelineFacade

TimelinePasteResult

data class TimelinePasteResult(val success: Boolean, val pasted: List<TimelineClipTarget>, val error: String?)

TimelinePosition

data class TimelinePosition(val samples: Long, val legacyBeats: Double)

TimelineState

data class TimelineState(val playheadPosition: TimelinePosition, val isPlaying: Boolean, val loopEnabled: Boolean, val loopStart: TimelinePosition, val loopEnd: TimelinePosition, val tempo: Double, val timeSignatureNumerator: Int, val timeSignatureDenominator: Int, val sampleRate: Int)

TimelineTrack

interface TimelineTrack

TimeReference

data class TimeReference(val type: TimeReferenceType = TimeReferenceType.ContainerStart, val referenceId: String = "", val offset: Double = 0.0)

TimeReferenceType

enum TimeReferenceType : Enum<TimeReferenceType>

TimeSignaturePoint

data class TimeSignaturePoint(val timeSeconds: Double, val tickPosition: Long, val numerator: Int, val denominator: Int)

A time-signature change on the master track; uapmd_time_signature_point_t.

TrackAttachOptions

data class TrackAttachOptions(val idPolicy: ObjectIdPolicy = ObjectIdPolicy.Mint, val insertionIndex: Int = -1, val includePlugins: Boolean = true, val includePluginState: Boolean = true, val includeClips: Boolean = true)

Which parts of a captured track are applied when it is attached.

TrackFragment

interface TrackFragment : AutoCloseable

A track detached from the document. Unlike a clip, a track owns live plug-in instances, so both capturing and attaching one are asynchronous.

TrackPluginFragment

data class TrackPluginFragment(val nodeId: String, val pluginId: String, val format: String, val displayName: String, val groupIndex: Int, val state: ByteArray)

TransportController

interface TransportController

uapmd_app::TransportController. Owned by the AppModel.

UapmdCApiModule

external interface UapmdCApiModule : JsAny

The Emscripten-compiled uapmd-c-api module. Call initUapmdWasm to initialize before using any functions.

UiSize

data class UiSize(val width: UInt, val height: UInt)

UmpEvent

data class UmpEvent(val tick: Long, val words: UIntArray)

One UMP event in a MIDI clip: a tick plus the 1-4 words of the message.

UmpEventsResult

data class UmpEventsResult(val success: Boolean, val error: String?, val events: List<UmpEvent>, val tickResolution: UInt, val clipTempo: Double = 0.0)

Mirrors uapmd_ump_events_result_t.

UmpInputMapper

interface UmpInputMapper

UmpOutputMapper

interface UmpOutputMapper

UndoResult

data class UndoResult(val status: UndoStatus, val error: String?)

UndoState

data class UndoState(val busy: Boolean, val compoundOpen: Boolean, val gestureOpen: Boolean, val canUndo: Boolean, val canRedo: Boolean, val dirty: Boolean, val compoundDescription: String, val undoDescription: String, val redoDescription: String, val historySizeInBytes: Long, val maximumHistorySizeInBytes: Long, val currentStateId: Long, val savedStateId: Long)

UndoStatus

enum UndoStatus : Enum<UndoStatus>

WarpReferenceType

enum WarpReferenceType : Enum<WarpReferenceType>

WasmJsAddinManager

class WasmJsAddinManager : AddinManager

WasmJsAppModel

class WasmJsAppModel : AppModel

WasmJsAudioDeviceManager

class WasmJsAudioDeviceManager : AudioDeviceManager

WasmJsAudioFileReader

class WasmJsAudioFileReader : AudioFileReader

WasmJsAudioIODevice

class WasmJsAudioIODevice : AudioIODevice

WasmJsClipCommandRegistry

class WasmJsClipCommandRegistry : ClipCommandRegistry

WasmJsClipEditorRegistry

class WasmJsClipEditorRegistry : ClipEditorRegistry

WasmJsClipFragment

class WasmJsClipFragment : ClipFragment

WasmJsCommandManager

class WasmJsCommandManager : CommandManager

WasmJsCommandRegistry

class WasmJsCommandRegistry : CommandRegistry

WasmJsDeviceIODispatcher

class WasmJsDeviceIODispatcher : DeviceIODispatcher

WasmJsFormatManager

class WasmJsFormatManager : FormatManager

WasmJsFunctionBlock

class WasmJsFunctionBlock : FunctionBlock

WasmJsFunctionBlockManager

class WasmJsFunctionBlockManager : FunctionBlockManager

WasmJsFunctionDevice

class WasmJsFunctionDevice : FunctionDevice

WasmJsMidiIO

class WasmJsMidiIO : MidiIO

WasmJsMidiIODevice

class WasmJsMidiIODevice : MidiIODevice

WasmJsMidiRecorder

class WasmJsMidiRecorder : MidiRecorder

WasmJsPianoRollSession

class WasmJsPianoRollSession : PianoRollSession

WasmJsPianoRollSnapshot

class WasmJsPianoRollSnapshot : PianoRollSnapshot

WasmJsPluginGraph

class WasmJsPluginGraph : PluginGraph

WasmJsPluginHost

class WasmJsPluginHost : PluginHost

WasmJsPluginInstance

class WasmJsPluginInstance : PluginInstance

WasmJsPluginInstancing

class WasmJsPluginInstancing : PluginInstancing

WasmJsPluginNode

class WasmJsPluginNode : PluginNode

WasmJsProjectAddressBook

class WasmJsProjectAddressBook : ProjectAddressBook

WasmJsProjectCommands

class WasmJsProjectCommands : ProjectCommands

WasmJsRealtimeSequencer

class WasmJsRealtimeSequencer : RealtimeSequencer

WasmJsScanTool

class WasmJsScanTool : ScanTool

WasmJsSequencerEngine

class WasmJsSequencerEngine : SequencerEngine

WasmJsSequencerTrack

class WasmJsSequencerTrack : SequencerTrack

WasmJsStemSeparatorRegistry

class WasmJsStemSeparatorRegistry : StemSeparatorRegistry

WasmJsTempoMap

class WasmJsTempoMap : TempoMap

Borrows the timeline's own map: the handle is only valid until the project changes, so this is fetched fresh from TimelineFacade.masterTempoMap rather than cached.

WasmJsTimelineFacade

class WasmJsTimelineFacade : TimelineFacade

WasmJsTimelineTrack

class WasmJsTimelineTrack : TimelineTrack

WasmJsTrackFragment

class WasmJsTrackFragment : TrackFragment

WasmJsTransportController

class WasmJsTransportController : TransportController

Functions

cleanupAppModel

actual fun cleanupAppModel()

expect fun cleanupAppModel()

actual fun cleanupAppModel()

createAddinManager

actual fun createAddinManager(): AddinManager

expect fun createAddinManager(): AddinManager

actual fun createAddinManager(): AddinManager

createAudioFileReader

actual fun createAudioFileReader(filepath: String): AudioFileReader

expect fun createAudioFileReader(filepath: String): AudioFileReader

actual fun createAudioFileReader(filepath: String): AudioFileReader

createFormatManager

actual fun createFormatManager(): FormatManager

expect fun createFormatManager(): FormatManager

actual fun createFormatManager(): FormatManager

createPluginGraph

actual fun createPluginGraph(eventBufferSizeInBytes: Long): PluginGraph

expect fun createPluginGraph(eventBufferSizeInBytes: Long): PluginGraph

actual fun createPluginGraph(eventBufferSizeInBytes: Long): PluginGraph

createPluginHost

actual fun createPluginHost(): PluginHost

expect fun createPluginHost(): PluginHost

actual fun createPluginHost(): PluginHost

createPluginInstancing

actual fun createPluginInstancing(scanTool: ScanTool, format: String, pluginId: String): PluginInstancing

expect fun createPluginInstancing(scanTool: ScanTool, format: String, pluginId: String): PluginInstancing

actual fun createPluginInstancing(scanTool: ScanTool, format: String, pluginId: String): PluginInstancing

createRealtimeSequencer

actual fun createRealtimeSequencer(bufferSize: UInt, umpBufferSize: UInt, sampleRate: Int, dispatcher: DeviceIODispatcher): RealtimeSequencer

expect fun createRealtimeSequencer(bufferSize: UInt, umpBufferSize: UInt, sampleRate: Int, dispatcher: DeviceIODispatcher): RealtimeSequencer

actual fun createRealtimeSequencer(bufferSize: UInt, umpBufferSize: UInt, sampleRate: Int, dispatcher: DeviceIODispatcher): RealtimeSequencer

createSaveScratchPath

fun createSaveScratchPath(defaultName: String): String

createScanTool

actual fun createScanTool(): ScanTool

expect fun createScanTool(): ScanTool

actual fun createScanTool(): ScanTool

createSequencerEngine

actual fun createSequencerEngine(sampleRate: Int, audioBufferSize: UInt, umpBufferSize: UInt): SequencerEngine

expect fun createSequencerEngine(sampleRate: Int, audioBufferSize: UInt, umpBufferSize: UInt): SequencerEngine

actual fun createSequencerEngine(sampleRate: Int, audioBufferSize: UInt, umpBufferSize: UInt): SequencerEngine

createSilentAudioFileReader

actual fun createSilentAudioFileReader(numFrames: Long, numChannels: Int, sampleRate: Int): AudioFileReader