@jeffy-g/live-midi-types 0.8.1 → 0.8.2

package/dist/index.d.ts

@@ -2,4 +2,4 @@ export * from "./midi-event.js";
 export * from "./midi-clip.js";
 export * from "./project.js";
 export * from "./ableton-colors.js";
-export declare const version = "v0.8.1";
+export declare const version = "v0.8.2";

package/dist/index.js

@@ -2,4 +2,4 @@ export * from "./midi-event.js";
 export * from "./midi-clip.js";
 export * from "./project.js";
 export * from "./ableton-colors.js";
-export const version = "v0.8.1";
+export const version = "v0.8.2";

package/dist/midi-clip.d.ts

@@ -28,6 +28,18 @@ export type TMidiClipData = {
   clipStartInBeats: number;
   /**
    * Length of the clip (in beats). Usually `CurrentEnd.Value - CurrentStart.Value`.
+   *
+   * ```
+   * // e.g. obtain `midiClip` object
+   * // xpath: "/Ableton/LiveSet/Tracks/MidiTrack[0]/DeviceChain/MainSequencer/ClipTimeable/ArrangerAutomation/Events/MidiClip[0]"
+   * const midiClip = Ableton.LiveSet.Tracks.MidiTrack[0].DeviceChain.MainSequencer.ClipTimeable.ArrangerAutomation.Events.MidiClip[0];
+   * // clip start position in Live arrangement view
+   * const clipStart = midiClip.CurrentStart.Value;
+   * // clip end position in Live arrangement view
+   * const clipEnd = midiClip.CurrentEnd.Value;
+   * // calculate clip range
+   * const clipLength = +clipEnd - +clipStart;
+   * ```
    */
   clipLength: number;
   /**
@@ -35,7 +47,7 @@ export type TMidiClipData = {
    */
   adjustTimeOftempee: number;
   /**
-   * List of known CC events in this clip.
+   * CC numbers known to this clip, sorted in ascending order.
    *
    * {@link TMidiClipData.ccMap __`ccMap`__}
    */

package/dist/midi-event.d.ts

@@ -24,10 +24,12 @@ export type NoteEvent = {
   time: number;
   /**
    * NOTE: floating number
+   * + quarter-note beats
    */
   duration: number;
   /**
-   * NOTE: Must be an integer. Floating-point values are not valid.
+   * NOTE: Must be an integer. Floating-point values are invalid.
+   * + `0..127` integer
    */
   pitch: number;
   /**
@@ -45,6 +47,9 @@ export type ControlChangeEvent = {
   time: number;
   /**
    * MIDI controller number.
+   *
+   * NOTE: Must be an integer. Floating-point values are invalid.
+   * + `0..127` integer
    */
   controller: number;
   /**
@@ -55,6 +60,7 @@ export type ControlChangeEvent = {
   value: number;
   /**
    * Source type: "curve" for interpolated, "single" for discrete.
+   * + In **LME**, the "curve" is assigned to Bezier events, while it is omitted in regular discrete events.
    */
   source?: "curve" | "single";
 };

package/dist/project.d.ts

@@ -40,7 +40,7 @@ export type TClipSummary<T extends Record<string, any>> = {
    * "/Ableton/LiveSet/Tracks/MidiTrack/DeviceChain/MainSequencer/ClipTimeable/ArrangerAutomation/Events/MidiClip/Color/@Value"
    *
    * // how to actual color
-   * // "0" or "12" to "#ff94a6" / "#e553a0"
+   * // e.g - "0" to "#ff94a6", "12" to "#e553a0"
    * const hexColor = getColorFromIndex(+clip.color);
    * ```
    *
@@ -95,7 +95,7 @@ export type TTrackInfo<T extends Record<string, any>> = {
    *
    * ```
    * // e.g.
-   * "clip-" + crypto.randomUUID()
+   * "track-" + crypto.randomUUID()
    * ```
    */
   id: string;
@@ -117,8 +117,8 @@ export type TTrackInfo<T extends Record<string, any>> = {
    * "/Ableton/LiveSet/Tracks/MidiTrack/Color/@Value"
    *
    * // Convert the index to a CSS color:
-   * // "0" or "12" to "#ff94a6" / "#e553a0"
-   * const hexColor = getColorFromIndex(+clip.color);
+   * // e.g - "0" to "#ff94a6", "12" to "#e553a0"
+   * const hexColor = getColorFromIndex(+track.color);
    * ```
    * @see {@link getColorFromIndex}
    */
@@ -134,7 +134,7 @@ export type TTrackInfo<T extends Record<string, any>> = {
    */
   annotation: string;
   /**
-   * MIDI clips indexed by clip name.
+   * MIDI clips indexed by {@linkcode TClipSummary.id TClipSummary.id}
    */
   clips: Record<string, TClipSummary<T>>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jeffy-g/live-midi-types",
-  "version": "0.8.1",
+  "version": "0.8.2",
   "description": "Common TypeScript types for Ableton Live MIDI clip and event data.",
   "type": "module",
   "main": "dist/index.js",