uapmd-binding/dev.atsushieno.uapmd/TimelineFacade

TimelineFacade

interface TimelineFacade

Inheritors

AndroidTimelineFacade

JsTimelineFacade

JvmTimelineFacade

NativeTimelineFacade

WasmJsTimelineFacade

Properties

addresses

abstract val addresses: ProjectAddressBook

Translation between persistent document identities and runtime indexes.

commands

abstract val commands: ProjectCommands

The undoable edits this project supports, and (through ProjectCommands.history) the history they record into. Everything that changes the document goes through here.

hasPendingPluginMutations

abstract val hasPendingPluginMutations: Boolean

masterTempoMap

abstract val masterTempoMap: TempoMap

The project's seconds-to-beats curve, owned by the master track. This is the one the engine schedules playback against, so a display converting through it can never disagree with what is heard.

masterTimelineTrack

abstract val masterTimelineTrack: TimelineTrack

trackCount

abstract val trackCount: UInt

Functions

addAudioClip

abstract fun addAudioClip(trackIndex: Int, position: TimelinePosition, reader: AudioFileReader, filepath: String): ClipAddResult

addEmptyTrack

abstract fun addEmptyTrack(origin: MutationOrigin = MutationOrigin.User, callback: (trackIndex: Int, error: String?) -> Unit)

addMidiClipFromFile

abstract fun addMidiClipFromFile(trackIndex: Int, position: TimelinePosition, filepath: String, nrpnToParameterMapping: Boolean = false): ClipAddResult

attachClipFragment

abstract fun attachClipFragment(trackIndex: Int, fragment: ClipFragment, idPolicy: ObjectIdPolicy): ClipAddResult

attachTrackFragment

abstract fun attachTrackFragment(fragment: TrackFragment, options: TrackAttachOptions, callback: (trackIndex: Int, error: String?) -> Unit)

calculateContentBounds

abstract fun calculateContentBounds(): ContentBounds

captureClipFragment

abstract fun captureClipFragment(trackIndex: Int, clipId: Int): ClipFragment?

Capture is non-destructive; deleting is a separate removeClip. Must NOT be called inside a documentTransaction. The returned fragment is owned by the caller.

captureTrackFragment

abstract fun captureTrackFragment(trackIndex: Int, callback: (TrackFragment?, String?) -> Unit)

Both halves are asynchronous because a track owns live plug-in instances. The callback runs exactly once, on the thread completing the last plug-in operation. Capture must NOT be called inside a documentTransaction.

clearClipsFromTrack

abstract fun clearClipsFromTrack(trackIndex: Int, origin: MutationOrigin = MutationOrigin.User): Boolean

Removes every clip on the track. True when at least one was removed.

documentTransaction

abstract fun <T> documentTransaction(block: () -> T): T

Groups the document events produced by everything inside block into a single batch. Use whenever one user-visible action performs several mutations, or observers can see it half-applied. Calls nest.

getMidiClipNotes

abstract fun getMidiClipNotes(trackIndex: Int, clipId: Int): List<MidiNoteData>?

Returns MIDI notes for the given clip, or null if the track/clip is not found or is not a MIDI clip. Empty list means a valid MIDI clip with no notes.

getState

abstract fun getState(): TimelineState?

getTrack

abstract fun getTrack(index: UInt): TimelineTrack

isClipEnabled

abstract fun isClipEnabled(trackIndex: Int, clipId: Int): Boolean

loadPluginPreset

abstract fun loadPluginPreset(instanceId: Int, presetIndex: Int, origin: MutationOrigin = MutationOrigin.User, completion: (UndoResult) -> Unit? = null)

loadProject

abstract fun loadProject(filePath: String): ProjectResult

newProject

abstract fun newProject(): ProjectResult

Discards the current document and starts an empty one: no tracks, a fresh master track, no undo history, nothing dirty. Observers see the same closing/loaded pair a load emits, so state owned outside the timeline is dropped the same way. Whether unsaved changes may be discarded is the caller's decision, not this one.

pasteClipFragment

abstract fun pasteClipFragment(trackIndex: Int, fragment: ClipFragment): ClipAddResult

Paste: attaches with fresh identifiers AND records the result as one undoable edit, which attachClipFragment does not do. Must NOT be called inside a documentTransaction.

recordPluginInstanceAddition

abstract fun recordPluginInstanceAddition(instanceId: Int, origin: MutationOrigin = MutationOrigin.User, completion: (UndoResult) -> Unit? = null)

Records a plug-in that has already been instantiated.

recordTrackAddition

abstract fun recordTrackAddition(trackIndex: Int, origin: MutationOrigin = MutationOrigin.User, callback: (trackIndex: Int, error: String?) -> Unit)

Records an already-published, fully constructed track as one addition.

removeClip

abstract fun removeClip(trackIndex: Int, clipId: Int): Boolean

abstract fun removeClip(trackIndex: Int, clipId: Int, origin: MutationOrigin): Boolean

removePluginInstance

abstract fun removePluginInstance(instanceId: Int, origin: MutationOrigin = MutationOrigin.User, completion: (UndoResult) -> Unit? = null)

Captures state, removes the instance, and records the removal as one step.

removeTrack

abstract fun removeTrack(trackIndex: Int, origin: MutationOrigin = MutationOrigin.User, callback: (trackIndex: Int, error: String?) -> Unit)

replaceAudioClipContent

abstract fun replaceAudioClipContent(trackIndex: Int, clipId: Int, filepath: String, markers: List<ClipMarkerData>, warps: List<AudioWarpPointData>, masterMarkers: List<ClipMarkerData>, origin: MutationOrigin = MutationOrigin.User): Boolean

Rebuilds an audio clip's source from its file with the given markers and warp points. A non-empty filepath switches the clip to that file and adopts its length; otherwise the clip keeps its length.

replaceMidiClipContent

abstract fun replaceMidiClipContent(trackIndex: Int, clipId: Int, umpEvents: UIntArray, tickTimestamps: LongArray, origin: MutationOrigin = MutationOrigin.User): Boolean

Replaces a MIDI clip's authored content, resizing the clip to match.

setLoop

abstract fun setLoop(enabled: Boolean, start: TimelinePosition, end: TimelinePosition)

setPluginState

abstract fun setPluginState(instanceId: Int, state: ByteArray, origin: MutationOrigin = MutationOrigin.User, completion: (UndoResult) -> Unit? = null)

setTempo

abstract fun setTempo(tempo: Double)

setTimelineChangedCallback

abstract fun setTimelineChangedCallback(callback: () -> Unit?)

Registers a callback invoked after every clip add/remove and after loadProject(). Pass null to unregister.

setTimeSignature

abstract fun setTimeSignature(numerator: Int, denominator: Int)