@rnbo/js 1.3.5 → 1.4.1

package/dist/rnbo.webaudio.d.ts

@@ -19,7 +19,7 @@ declare const BangParameter_base: ObjectConstructor & (new (...args: any[]) => C
  * */
 export declare abstract class BaseDevice {
     protected _hasPatcher: boolean;
-    protected _sourceType: IPatcherSrc["type"];
+    protected _sourceType: IPatcherSrc_2["type"];
     /* Excluded from this release type: _timeConverter */
     /* Excluded from this release type: _parameterInterface */
     /* Excluded from this release type: _engine */
@@ -94,7 +94,7 @@ export declare abstract class BaseDevice {
     protected _onParameterChangeEvent: (param: Parameter) => void;
     protected _prepareToProcess(sampleRate: number, samplesPerBlock: number, force: boolean): void;
     protected _ensureIsValid(): void;
-    protected _extractPatcherCode(src: IPatcherSrc): string;
+    protected _extractPatcherCode(src: IPatcherSrc_2): string;
     /**
      * 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}
      */
@@ -151,7 +151,7 @@ export declare abstract class BaseDevice {
      */
     get parameterNotificationSetting(): ParameterNotificationSetting;
     set parameterNotificationSetting(level: ParameterNotificationSetting);
-    get sourceType(): IPatcherSrc["type"];
+    get sourceType(): IPatcherSrc_2["type"];
     /**
      * The {@link DeviceType} of the Device. An invalid Device will return {@link DeviceType.Invalid}.
      */
@@ -836,13 +836,14 @@ export declare interface IParameterDescription {
     enumValues: string[];
     displayName: string;
     unit: string;
-    initialized: boolean;
+    initialized?: boolean;
     debug: boolean;
-    saveable: boolean;
-    transmittable: boolean;
+    saveable?: boolean;
+    transmittable?: boolean;
     visible: boolean;
-    signalIndex: number;
+    signalIndex: number | null;
     ioType: string;
+    meta?: any;
 }
 
 declare interface IParameterInfo {
@@ -915,12 +916,20 @@ export declare interface IPatcherDescription {
     /** a list of outports */
     outports: MessagePort_2[];
     /** Patcher Options */
-    options: IPatcherOptions;
+    options?: IPatcherOptions;
     meta: {
         /** Version of Max the Patcher was exported with */
         maxversion?: string;
         /** Version of RNBO the Patcher was exported with */
         rnboversion: string;
+        /** Name of the RNBO object */
+        name?: string;
+        /** File name of the Max patcher containing the RNBO object */
+        filename?: string;
+        /** platform architecture of the Max application */
+        architecure?: string;
+        /** C++ classname of the rnbo export */
+        rnboobjname?: string;
     };
     /**
      * @deprecated since version 0.18.0, see meta.rnboversion
@@ -939,13 +948,19 @@ export declare interface IPatcherOptions {
 
 /* Excluded from this release type: IPatcherParamConversion */
 
+/**
+ * Public definition of IPatcherSrc using simple strings
+ * @public
+ */
 export declare interface IPatcherSrc {
     code: string;
-    compression?: "zlib";
-    encoding?: "base64" | "utf8" | "utf-8";
-    type: "wasm" | "js";
+    compression?: string;
+    encoding?: string;
+    type: string;
 }
 
+/* Excluded from this release type: IPatcherSrc_2 */
+
 /**
  * Collection of parameter values as a RNBO Patcher Preset, mapping:
  *
@@ -1160,10 +1175,10 @@ export declare class NumberParameter extends NumberParameter_base {
 declare const NumberParameter_base: ObjectConstructor & (new (...args: any[]) => CommonParameterMixin);
 
 /**
- * Union Type of all available Parameter Classes.
+ * Union Type of all publically available Parameter Classes.
  * @public
  */
-export declare type Parameter = BangParameter | EnumParameter | NumberParameter;
+export declare type Parameter = EnumParameter | NumberParameter;
 
 /**
  * Type of the ID of a parameter
@@ -1179,6 +1194,8 @@ declare type ParameterInterfaceOptions = {
     notificationSetting: ParameterNotificationSetting;
 };
 
+/* Excluded from this release type: ParameterInternal */
+
 /**
  * Enum defining the available options for the parameter change event setting of a {@link BaseDevice.parameterChangeEvent | Device}.
  * @public