uapmd-binding/dev.atsushieno.uapmd/PianoRollSession

PianoRollSession

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

Inheritors

AndroidPianoRollSession

JsPianoRollSession

JvmPianoRollSession

NativePianoRollSession

WasmJsPianoRollSession

Properties

clipboardCount

abstract val clipboardCount: Int

clipReferenceId

abstract val clipReferenceId: String?

The document reference id of the clip being edited, or null.

durationSeconds

abstract val durationSeconds: Double

error

abstract val error: String

Empty when the last edit succeeded.

focusedNote

abstract var focusedNote: Int

The note the detail editor is on, or -1.

isDirty

abstract val isDirty: Boolean

maxNote

abstract val maxNote: Int

minNote

abstract val minNote: Int

notes

abstract val notes: List<PianoRollNote>

selectedNoteCount

abstract val selectedNoteCount: Int

selectionContext

abstract val selectionContext: SelectionContextId?

The selection context this session publishes its note selection in; hand it to ProjectSelectionService.snapshot and friends. null when the session has none.

Functions

beginDrag

abstract fun beginDrag()

A move drag works from the notes as they were when it began, so each update re-applies one delta rather than accumulating rounding. The session holds that snapshot: say when the drag starts, how far it has moved, and whether it ended or was cancelled.

cancelDrag

abstract fun cancelDrag()

commit

abstract fun commit(app: AppModel): Boolean

Writes the session back to the clip, through the undo history.

createNote

abstract fun createNote(startSeconds: Double, durationSeconds: Double, note: Int, velocity: Float)

deleteNote

abstract fun deleteNote(index: Int)

finishDrag

abstract fun finishDrag(index: Int, originalStart: Double, originalEnd: Double, originalNote: Int)

isNoteSelected

abstract fun isNoteSelected(index: Int): Boolean

isObjectSelected

abstract fun isObjectSelected(referenceId: String): Boolean

loadNotes

abstract fun loadNotes(snapshot: PianoRollSnapshot?)

matchesSource

abstract fun matchesSource(snapshot: PianoRollSnapshot): Boolean

Whether this session was built from that snapshot's UMP stream. False means the clip changed underneath and the session must be reloaded — which is what stops an edit being applied to a clip it was not made against.

moveSelection

abstract fun moveSelection(timeDeltaSeconds: Double, pitchDelta: Int)

noteReferenceId

abstract fun noteReferenceId(index: Int): String?

The document reference id of the note at index, or null for an unknown index.

performAction

abstract fun performAction(action: PianoRollAction, pasteSeconds: Double = 0.0)

resizeNote

abstract fun resizeNote(index: Int, startSeconds: Double, durationSeconds: Double, note: Int)

selectNote

abstract fun selectNote(index: Int, additive: Boolean = false, toggle: Boolean = false)

index -1 clears the selection.

selectObject

abstract fun selectObject(referenceId: String, additive: Boolean = false, toggle: Boolean = false)

Selects (or, with toggle, flips) a note or automation point by reference id, then makes this session's context the active one. additive keeps the rest of the selection.

syncSelection

abstract fun syncSelection()

Re-reads the session's selection from the selection service, for when it changed elsewhere.