@jpdutoit/squelchy 0.0.1 → 0.0.2

package/index.d.ts

@@ -244,16 +244,21 @@ export declare const Hat: {
 };
 /**
  * Gate + pitch CV for driving patchable modules (Envelope trig, V/Oct inputs).
- * `gate` goes 1 at `time`, back to 0 after `duration`; `pitch` holds the midi
- * value (semitones = the project's V/Oct unit). Both are ConstantSourceNodes.
+ * `gate` goes to the hit's velocity at `time`, back to 0 after `duration`;
+ * `pitch` holds the note (absolute key position, 69 = A4), typed as the
+ * library's pitch signal like every other V/OCT output. Both are
+ * ConstantSourceNodes.
  */
+export interface NoteCvInstance {
+	/** Gate CV: the hit's velocity while a note is held, 0 otherwise. */
+	gate: ConstantSourceNode;
+	/** Pitch CV: the current note (69 = A4), held between notes. */
+	pitch: ConstantSourceNode & Signal<Note>;
+	trigger(time: Seconds, hit?: Partial<Hit<Note>>): void;
+	dispose(): void;
+}
 export declare const NoteCv: {
-	create(ctx: BaseAudioContext): {
-		gate: ConstantSourceNode;
-		pitch: ConstantSourceNode;
-		trigger(time: Seconds, h?: Partial<Hit<Note>>): void;
-		dispose(): void;
-	};
+	create(ctx: BaseAudioContext): NoteCvInstance;
 };
 export declare function pulse(target: AudioNode, when?: number): void;
 /** Canonical percussion voice keys shared by every sample set and by any
@@ -299,9 +304,11 @@ export declare function loadSampleSet(ctx: BaseAudioContext, set: SampleSetInfo,
 	baseUrl?: string;
 	fetch?: typeof fetch;
 }): Promise<LoadedSampleSet>;
-/** A one-sample voice. velocity 0..1 scales level; `value` (semitones) repitches. */
+/** A one-sample voice. velocity 0..1 scales level; a number `value`
+ *  repitches in semitones, anything else (e.g. `true` from steps()) plays it
+ *  unshifted. */
 export declare const SampleVoice: {
-	create(ctx: BaseAudioContext, kit: LoadedSampleSet, key: VoiceKey): VoiceInstance<number>;
+	create(ctx: BaseAudioContext, kit: LoadedSampleSet, key: VoiceKey): VoiceInstance<number | boolean>;
 };
 export declare const SampleSets: {
 	readonly "roland-808": {