@rnbo/js 1.3.3 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE.md CHANGED
@@ -1,4 +1,4 @@
1
- Copyright (c) 2022 Cycling '74
1
+ Copyright (c) 2025 Cycling '74
2
2
 
3
3
 
4
4
  Permission is hereby granted, free of charge, to any person obtaining
@@ -19,7 +19,7 @@ declare const BangParameter_base: ObjectConstructor & (new (...args: any[]) => C
19
19
  * */
20
20
  export declare abstract class BaseDevice {
21
21
  protected _hasPatcher: boolean;
22
- protected _sourceType: IPatcherSrc["type"];
22
+ protected _sourceType: IPatcherSrc_2["type"];
23
23
  /* Excluded from this release type: _timeConverter */
24
24
  /* Excluded from this release type: _parameterInterface */
25
25
  /* Excluded from this release type: _engine */
@@ -94,7 +94,7 @@ export declare abstract class BaseDevice {
94
94
  protected _onParameterChangeEvent: (param: Parameter) => void;
95
95
  protected _prepareToProcess(sampleRate: number, samplesPerBlock: number, force: boolean): void;
96
96
  protected _ensureIsValid(): void;
97
- protected _extractPatcherCode(src: IPatcherSrc): string;
97
+ protected _extractPatcherCode(src: IPatcherSrc_2): string;
98
98
  /**
99
99
  * The {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioContext | AudioContext} used for creating the Device. For more information, visit the guide on {@link https://rnbo.cycling74.com/learn/working-with-web-audio-contexts | Working with Web Audio Contexts}
100
100
  */
@@ -151,7 +151,7 @@ export declare abstract class BaseDevice {
151
151
  */
152
152
  get parameterNotificationSetting(): ParameterNotificationSetting;
153
153
  set parameterNotificationSetting(level: ParameterNotificationSetting);
154
- get sourceType(): IPatcherSrc["type"];
154
+ get sourceType(): IPatcherSrc_2["type"];
155
155
  /**
156
156
  * The {@link DeviceType} of the Device. An invalid Device will return {@link DeviceType.Invalid}.
157
157
  */
@@ -625,32 +625,29 @@ export declare enum EventType {
625
625
  */
626
626
  MIDIEvent = 4,
627
627
  /* Excluded from this release type: ParameterEvent */
628
- /**
629
- * PresetEvents received from a RNBO Device.
630
- * See {@link PresetEvent}
631
- */
632
- PresetEvent = 6,
628
+ /* Excluded from this release type: ParameterBangEvent */
629
+ PresetEvent = 7,
633
630
  /* Excluded from this release type: StartupEvent */
634
631
  /**
635
632
  * TransportEvents sent into a RNBO Device.
636
633
  * See {@link TransportEvent}
637
634
  */
638
- TransportEvent = 8,
635
+ TransportEvent = 9,
639
636
  /**
640
637
  * TempoEvents sent into a RNBO Device.
641
638
  * See {@link TempoEvent}
642
639
  */
643
- TempoEvent = 9,
640
+ TempoEvent = 10,
644
641
  /**
645
642
  * BeatTimeEvents sent into a RNBO Device.
646
643
  * See {@link BeatTimeEvent}
647
644
  */
648
- BeatTimeEvent = 10,
645
+ BeatTimeEvent = 11,
649
646
  /**
650
647
  * TimeSignatureEvents sent into a RNBO Device.
651
648
  * See {@link TimeSignatureEvent}
652
649
  */
653
- TimeSignatureEvent = 11
650
+ TimeSignatureEvent = 12
654
651
  }
655
652
 
656
653
  /**
@@ -839,13 +836,14 @@ export declare interface IParameterDescription {
839
836
  enumValues: string[];
840
837
  displayName: string;
841
838
  unit: string;
842
- initialized: boolean;
839
+ initialized?: boolean;
843
840
  debug: boolean;
844
- saveable: boolean;
845
- transmittable: boolean;
841
+ saveable?: boolean;
842
+ transmittable?: boolean;
846
843
  visible: boolean;
847
- signalIndex: number;
844
+ signalIndex: number | null;
848
845
  ioType: string;
846
+ meta?: any;
849
847
  }
850
848
 
851
849
  declare interface IParameterInfo {
@@ -918,12 +916,20 @@ export declare interface IPatcherDescription {
918
916
  /** a list of outports */
919
917
  outports: MessagePort_2[];
920
918
  /** Patcher Options */
921
- options: IPatcherOptions;
919
+ options?: IPatcherOptions;
922
920
  meta: {
923
921
  /** Version of Max the Patcher was exported with */
924
922
  maxversion?: string;
925
923
  /** Version of RNBO the Patcher was exported with */
926
924
  rnboversion: string;
925
+ /** Name of the RNBO object */
926
+ name?: string;
927
+ /** File name of the Max patcher containing the RNBO object */
928
+ filename?: string;
929
+ /** platform architecture of the Max application */
930
+ architecure?: string;
931
+ /** C++ classname of the rnbo export */
932
+ rnboobjname?: string;
927
933
  };
928
934
  /**
929
935
  * @deprecated since version 0.18.0, see meta.rnboversion
@@ -942,13 +948,19 @@ export declare interface IPatcherOptions {
942
948
 
943
949
  /* Excluded from this release type: IPatcherParamConversion */
944
950
 
951
+ /**
952
+ * Public definition of IPatcherSrc using simple strings
953
+ * @public
954
+ */
945
955
  export declare interface IPatcherSrc {
946
956
  code: string;
947
- compression?: "zlib";
948
- encoding?: "base64" | "utf8" | "utf-8";
949
- type: "wasm" | "js";
957
+ compression?: string;
958
+ encoding?: string;
959
+ type: string;
950
960
  }
951
961
 
962
+ /* Excluded from this release type: IPatcherSrc_2 */
963
+
952
964
  /**
953
965
  * Collection of parameter values as a RNBO Patcher Preset, mapping:
954
966
  *
@@ -981,6 +993,8 @@ export declare interface IPresetEvent extends IBaseEvent {
981
993
 
982
994
  /* Excluded from this release type: IRNBOFloat32AudioBuffer */
983
995
 
996
+ /* Excluded from this release type: IRNBOParameterBangEvent */
997
+
984
998
  /* Excluded from this release type: IRNBOParameterEvent */
985
999
 
986
1000
  /* Excluded from this release type: IRNBOStartupEvent */
@@ -1161,10 +1175,10 @@ export declare class NumberParameter extends NumberParameter_base {
1161
1175
  declare const NumberParameter_base: ObjectConstructor & (new (...args: any[]) => CommonParameterMixin);
1162
1176
 
1163
1177
  /**
1164
- * Union Type of all available Parameter Classes.
1178
+ * Union Type of all publically available Parameter Classes.
1165
1179
  * @public
1166
1180
  */
1167
- export declare type Parameter = BangParameter | EnumParameter | NumberParameter;
1181
+ export declare type Parameter = EnumParameter | NumberParameter;
1168
1182
 
1169
1183
  /**
1170
1184
  * Type of the ID of a parameter
@@ -1180,6 +1194,8 @@ declare type ParameterInterfaceOptions = {
1180
1194
  notificationSetting: ParameterNotificationSetting;
1181
1195
  };
1182
1196
 
1197
+ /* Excluded from this release type: ParameterInternal */
1198
+
1183
1199
  /**
1184
1200
  * Enum defining the available options for the parameter change event setting of a {@link BaseDevice.parameterChangeEvent | Device}.
1185
1201
  * @public
@@ -1237,6 +1253,8 @@ export declare enum ParameterType {
1237
1253
 
1238
1254
  /* Excluded from this release type: RNBOFloat32AudioBuffer */
1239
1255
 
1256
+ /* Excluded from this release type: RNBOParameterBangEvent */
1257
+
1240
1258
  /* Excluded from this release type: RNBOParameterEvent */
1241
1259
 
1242
1260
  /**