aes70 1.3.8 → 1.4.0

package/src/controller/ControlClasses/OcaFilterClassical.js

@@ -1,13 +1,15 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaActuator } from './OcaActuator.js';
-import { OcaBitSet16 } from '../../OCP1/OcaBitSet16.js';
 import { OcaClassicalFilterShape } from '../../OCP1/OcaClassicalFilterShape.js';
 import { OcaFilterPassband } from '../../OCP1/OcaFilterPassband.js';
 import { OcaFloat32 } from '../../OCP1/OcaFloat32.js';
+import { OcaParameterMask } from '../../OCP1/OcaParameterMask.js';
 import { OcaUint16 } from '../../OCP1/OcaUint16.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaActuator } from './OcaActuator.js';
 
 /**
- * A classical analog-style filter - highpass, lowpass, bandpass, etc., with shape characteristics such as Butterworth, Chebyshev, Bessel, and Linkwitz-Riley. Frequently used in loudspeaker crossover networks.
+ * A classical analog-style filter - highpass, lowpass, bandpass, etc., with
+ * shape characteristics such as Butterworth, Chebyshev, Bessel, and
+ * Linkwitz-Riley. Frequently used in loudspeaker crossover networks.
  * @extends OcaActuator
  * @class OcaFilterClassical
  */
@@ -33,7 +35,7 @@ export const OcaFilterClassical = make_control_class(
       4,
       11,
       [
-        OcaBitSet16,
+        OcaParameterMask,
         OcaFloat32,
         OcaFilterPassband,
         OcaClassicalFilterShape,
@@ -54,7 +56,8 @@ export const OcaFilterClassical = make_control_class(
 );
 
 /**
- * Gets the value of the Frequency property. The return value indicates if the property was successfully retrieved.
+ * Gets the value of the Frequency property. The return value indicates if the
+ * property was successfully retrieved.
  * The return values of this method are
  *
  * - Frequency of type ``number``
@@ -65,7 +68,8 @@ export const OcaFilterClassical = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the value of the Frequency property. The return value indicates if the property was successfully set.
+ * Sets the value of the Frequency property. The return value indicates if the
+ * property was successfully set.
  *
  * @method OcaFilterClassical#SetFrequency
  * @param {number} frequency
@@ -73,37 +77,42 @@ export const OcaFilterClassical = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Returns the passband specification of the filter object. The return value indicates if the specification was successfully retrieved.
+ * Returns the passband specification of the filter object. The return value
+ * indicates if the specification was successfully retrieved.
  *
  * @method OcaFilterClassical#GetPassband
  * @returns {Promise<OcaFilterPassband>}
  *   A promise which resolves to a single value of type :class:`OcaFilterPassband`.
  */
 /**
- * Sets the passband specification of the filter object. The return value indicates if the specification was successfully set.
+ * Sets the passband specification of the filter object. The return value
+ * indicates if the specification was successfully set.
  *
  * @method OcaFilterClassical#SetPassband
- * @param {OcaFilterPassband} Passband
+ * @param {IOcaFilterPassband} Passband
  *
  * @returns {Promise<void>}
  */
 /**
- * Returns the Shape property of the filter. The return value indicates if the property was successfully retrieved.
+ * Returns the Shape property of the filter. The return value indicates if the
+ * property was successfully retrieved.
  *
  * @method OcaFilterClassical#GetShape
  * @returns {Promise<OcaClassicalFilterShape>}
  *   A promise which resolves to a single value of type :class:`OcaClassicalFilterShape`.
  */
 /**
- * Sets the Shape property of the filter. The return value indicates if the property was successfully set.
+ * Sets the Shape property of the filter. The return value indicates if the
+ * property was successfully set.
  *
  * @method OcaFilterClassical#SetShape
- * @param {OcaClassicalFilterShape} Shape
+ * @param {IOcaClassicalFilterShape} Shape
  *
  * @returns {Promise<void>}
  */
 /**
- * Returns the order of the filter. The return value indicates if the property was successfully retrieved.
+ * Returns the order of the filter. The return value indicates if the property
+ * was successfully retrieved.
  * The return values of this method are
  *
  * - Order of type ``number``
@@ -114,7 +123,8 @@ export const OcaFilterClassical = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the order of the filter. The return value indicates if the property was successfully set.
+ * Sets the order of the filter. The return value indicates if the property was
+ * successfully set.
  *
  * @method OcaFilterClassical#SetOrder
  * @param {number} Order
@@ -122,7 +132,8 @@ export const OcaFilterClassical = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Returns the filter parameter. The return value indicates if the property was successfully retrieved.
+ * Returns the filter parameter. The return value indicates if the property was
+ * successfully retrieved.
  * The return values of this method are
  *
  * - Parameter of type ``number``
@@ -133,7 +144,8 @@ export const OcaFilterClassical = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the filter parameter. The return value indicates if the parameter was successfully set.
+ * Sets the filter parameter. The return value indicates if the parameter was
+ * successfully set.
  *
  * @method OcaFilterClassical#SetParameter
  * @param {number} Parameter
@@ -141,53 +153,50 @@ export const OcaFilterClassical = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Sets some or all filter parameter. The return value indicates if the parameters were successfully set. The action of this method is atomic - if any of the value changes fails, none of the changes are made.
+ * Sets some or all filter parameter. The return value indicates if the
+ * parameters were successfully set. The action of this method is atomic - if
+ * any of the value changes fails, none of the changes are made.
  *
  * @method OcaFilterClassical#SetMultiple
- * @param {number} Mask
- *
+ * @param {IOcaParameterMask} Mask
  * @param {number} Frequency
- *
- * @param {OcaFilterPassband} Passband
- *
- * @param {OcaClassicalFilterShape} Shape
- *
+ * @param {IOcaFilterPassband} Passband
+ * @param {IOcaClassicalFilterShape} Shape
  * @param {number} Order
- *
  * @param {number} Parameter
  *
  * @returns {Promise<void>}
  */
 /**
- * This event is emitted when the property Frequency changes in the remote object.
+ * This event is emitted when the property ``Frequency`` changes in the remote object.
  * The property ``Frequency`` is described in the AES70 standard as follows.
  * The frequency of the filter.
  *
  * @member {PropertyEvent<number>} OcaFilterClassical#OnFrequencyChanged
  */
 /**
- * This event is emitted when the property Passband changes in the remote object.
+ * This event is emitted when the property ``Passband`` changes in the remote object.
  * The property ``Passband`` is described in the AES70 standard as follows.
  * Lowpass, highpass, bandpass, bandreject
  *
  * @member {PropertyEvent<OcaFilterPassband>} OcaFilterClassical#OnPassbandChanged
  */
 /**
- * This event is emitted when the property Shape changes in the remote object.
+ * This event is emitted when the property ``Shape`` changes in the remote object.
  * The property ``Shape`` is described in the AES70 standard as follows.
  * Shape family - Butterworth, Bessell, etc.
  *
  * @member {PropertyEvent<OcaClassicalFilterShape>} OcaFilterClassical#OnShapeChanged
  */
 /**
- * This event is emitted when the property Order changes in the remote object.
+ * This event is emitted when the property ``Order`` changes in the remote object.
  * The property ``Order`` is described in the AES70 standard as follows.
  * Filter order
  *
  * @member {PropertyEvent<number>} OcaFilterClassical#OnOrderChanged
  */
 /**
- * This event is emitted when the property Parameter changes in the remote object.
+ * This event is emitted when the property ``Parameter`` changes in the remote object.
  * The property ``Parameter`` is described in the AES70 standard as follows.
  * Ripple or other filter parameter, depending on shape. Not used by some
  * shapes.

package/src/controller/ControlClasses/OcaFilterFIR.d.ts

@@ -1,8 +1,7 @@
-import { RemoteDevice } from '../remote_device';
-import { OcaActuator } from './OcaActuator';
 import { Arguments } from '../arguments';
-
 import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaActuator } from './OcaActuator';
 
 /**
  * A finite impulse response (FIR) filter.
@@ -28,7 +27,8 @@ export declare class OcaFilterFIR extends OcaActuator {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the length of the FIR filter. The return value indicates whether the value was successfully retrieved.
+   * Gets the length of the FIR filter. The return value indicates whether the
+   * value was successfully retrieved.
    * The return values of this method are
    *
    * - Length of type ``number``
@@ -41,7 +41,8 @@ export declare class OcaFilterFIR extends OcaActuator {
   GetLength(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Gets the coefficients of the FIR filter. The return value indicates whether the coefficients were successfully retrieved.
+   * Gets the coefficients of the FIR filter. The return value indicates whether
+   * the coefficients were successfully retrieved.
    *
    * @method OcaFilterFIR#GetCoefficients
    * @returns {Promise<number[]>}
@@ -50,7 +51,8 @@ export declare class OcaFilterFIR extends OcaActuator {
   GetCoefficients(): Promise<number[]>;
 
   /**
-   * Sets the value of the properties of the FIR filter. The return value indicates whether the properties were successfully set.
+   * Sets the value of the properties of the FIR filter. The return value
+   * indicates whether the properties were successfully set.
    *
    * @method OcaFilterFIR#SetCoefficients
    * @param {number[]} Coefficients
@@ -60,7 +62,8 @@ export declare class OcaFilterFIR extends OcaActuator {
   SetCoefficients(Coefficients: number[]): Promise<void>;
 
   /**
-   * Gets the sample rate of the FIR filter. The return value indicates whether the data was successfully retrieved.
+   * Gets the sample rate of the FIR filter. The return value indicates whether
+   * the data was successfully retrieved.
    * The return values of this method are
    *
    * - Rate of type ``number``
@@ -73,7 +76,8 @@ export declare class OcaFilterFIR extends OcaActuator {
   GetSampleRate(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the sample rate of the FIR filter. The return value indicates whether the rate was successfully set.
+   * Sets the sample rate of the FIR filter. The return value indicates whether
+   * the rate was successfully set.
    *
    * @method OcaFilterFIR#SetSampleRate
    * @param {number} Rate

package/src/controller/ControlClasses/OcaFilterFIR.js

@@ -1,8 +1,8 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaActuator } from './OcaActuator.js';
 import { OcaFloat32 } from '../../OCP1/OcaFloat32.js';
 import { OcaList } from '../../OCP1/OcaList.js';
 import { OcaUint32 } from '../../OCP1/OcaUint32.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaActuator } from './OcaActuator.js';
 
 /**
  * A finite impulse response (FIR) filter.
@@ -31,7 +31,8 @@ export const OcaFilterFIR = make_control_class(
 );
 
 /**
- * Gets the length of the FIR filter. The return value indicates whether the value was successfully retrieved.
+ * Gets the length of the FIR filter. The return value indicates whether the
+ * value was successfully retrieved.
  * The return values of this method are
  *
  * - Length of type ``number``
@@ -42,14 +43,16 @@ export const OcaFilterFIR = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Gets the coefficients of the FIR filter. The return value indicates whether the coefficients were successfully retrieved.
+ * Gets the coefficients of the FIR filter. The return value indicates whether
+ * the coefficients were successfully retrieved.
  *
  * @method OcaFilterFIR#GetCoefficients
  * @returns {Promise<number[]>}
  *   A promise which resolves to a single value of type ``number[]``.
  */
 /**
- * Sets the value of the properties of the FIR filter. The return value indicates whether the properties were successfully set.
+ * Sets the value of the properties of the FIR filter. The return value
+ * indicates whether the properties were successfully set.
  *
  * @method OcaFilterFIR#SetCoefficients
  * @param {number[]} Coefficients
@@ -57,7 +60,8 @@ export const OcaFilterFIR = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the sample rate of the FIR filter. The return value indicates whether the data was successfully retrieved.
+ * Gets the sample rate of the FIR filter. The return value indicates whether
+ * the data was successfully retrieved.
  * The return values of this method are
  *
  * - Rate of type ``number``
@@ -68,7 +72,8 @@ export const OcaFilterFIR = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the sample rate of the FIR filter. The return value indicates whether the rate was successfully set.
+ * Sets the sample rate of the FIR filter. The return value indicates whether
+ * the rate was successfully set.
  *
  * @method OcaFilterFIR#SetSampleRate
  * @param {number} Rate
@@ -76,7 +81,7 @@ export const OcaFilterFIR = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * This event is emitted when the property Length changes in the remote object.
+ * This event is emitted when the property ``Length`` changes in the remote object.
  * The property ``Length`` is described in the AES70 standard as follows.
  * Length of the filter, in samples. Readonly. Value is set when
  * SetCoefficients(...) method executes.
@@ -84,18 +89,18 @@ export const OcaFilterFIR = make_control_class(
  * @member {PropertyEvent<number>} OcaFilterFIR#OnLengthChanged
  */
 /**
- * This event is emitted when the property Coefficients changes in the remote object.
+ * This event is emitted when the property ``Coefficients`` changes in the remote object.
  * The property ``Coefficients`` is described in the AES70 standard as follows.
- * Array of FIR Coefficients. The size of the array (number of entries)
- * is equal to the Order property plus 1.
+ * Array of FIR Coefficients. The size of the array (number of entries) is equal
+ * to the Order property plus 1.
  *
  * @member {PropertyEvent<number[]>} OcaFilterFIR#OnCoefficientsChanged
  */
 /**
- * This event is emitted when the property SampleRate changes in the remote object.
+ * This event is emitted when the property ``SampleRate`` changes in the remote object.
  * The property ``SampleRate`` is described in the AES70 standard as follows.
- * Sample rate inside the filter. We can't assume it's the same as the
- * device input or output rate.
+ * Sample rate inside the filter. We can't assume it's the same as the device
+ * input or output rate.
  *
  * @member {PropertyEvent<number>} OcaFilterFIR#OnSampleRateChanged
  */

package/src/controller/ControlClasses/OcaFilterParametric.d.ts

@@ -1,10 +1,12 @@
-import { RemoteDevice } from '../remote_device';
-import { OcaActuator } from './OcaActuator';
+import { IOcaParameterMask } from '../../types/OcaParameterMask';
+import {
+  IOcaParametricEQShape,
+  OcaParametricEQShape,
+} from '../../types/OcaParametricEQShape';
 import { Arguments } from '../arguments';
-
 import { PropertyEvent } from '../property_event';
-import { IOcaParametricEQShape } from '../../types/OcaParametricEQShape';
-import { OcaParametricEQShape } from '../../types/OcaParametricEQShape';
+import { RemoteDevice } from '../remote_device';
+import { OcaActuator } from './OcaActuator';
 
 /**
  * A parametric equalizer section with various shape options.
@@ -40,7 +42,8 @@ export declare class OcaFilterParametric extends OcaActuator {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the equalizer frequency setpoint. The return value indicates whether the data was successfully retrieved.
+   * Gets the equalizer frequency setpoint. The return value indicates whether
+   * the data was successfully retrieved.
    * The return values of this method are
    *
    * - Frequency of type ``number``
@@ -53,7 +56,8 @@ export declare class OcaFilterParametric extends OcaActuator {
   GetFrequency(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the equalizer frequency. The return value indicates whether the value was successfully set.
+   * Sets the equalizer frequency. The return value indicates whether the value
+   * was successfully set.
    *
    * @method OcaFilterParametric#SetFrequency
    * @param {number} Frequency
@@ -63,7 +67,8 @@ export declare class OcaFilterParametric extends OcaActuator {
   SetFrequency(Frequency: number): Promise<void>;
 
   /**
-   * Gets the curve shape of the equalizer. The return value indicates whether the data was successfully retrieved.
+   * Gets the curve shape of the equalizer. The return value indicates whether
+   * the data was successfully retrieved.
    *
    * @method OcaFilterParametric#GetShape
    * @returns {Promise<OcaParametricEQShape>}
@@ -72,17 +77,19 @@ export declare class OcaFilterParametric extends OcaActuator {
   GetShape(): Promise<OcaParametricEQShape>;
 
   /**
-   * Sets the curve shape shape of the equalizer. The return value indicates whether the shape was successfully set.
+   * Sets the curve shape shape of the equalizer. The return value indicates
+   * whether the shape was successfully set.
    *
    * @method OcaFilterParametric#SetShape
-   * @param {OcaParametricEQShape} type
+   * @param {IOcaParametricEQShape} type
    *
    * @returns {Promise<void>}
    */
   SetShape(type: IOcaParametricEQShape): Promise<void>;
 
   /**
-   * Gets the width parameter property of the equalizer. The return value indicates whether the data was successfully retrieved.
+   * Gets the width parameter property of the equalizer. The return value
+   * indicates whether the data was successfully retrieved.
    * The return values of this method are
    *
    * - Width of type ``number``
@@ -95,7 +102,8 @@ export declare class OcaFilterParametric extends OcaActuator {
   GetWidthParameter(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the width parameter property of the equalizer. The return value indicates whether the Q was successfully set.
+   * Sets the width parameter property of the equalizer. The return value
+   * indicates whether the Q was successfully set.
    *
    * @method OcaFilterParametric#SetWidthParameter
    * @param {number} Width
@@ -105,7 +113,8 @@ export declare class OcaFilterParametric extends OcaActuator {
   SetWidthParameter(Width: number): Promise<void>;
 
   /**
-   * Returns the in-band gain of the equalizer. The return value indicates whether the data was successfully retrieved.
+   * Returns the in-band gain of the equalizer. The return value indicates
+   * whether the data was successfully retrieved.
    * The return values of this method are
    *
    * - gain of type ``number``
@@ -118,7 +127,8 @@ export declare class OcaFilterParametric extends OcaActuator {
   GetInbandGain(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the in-band gain of the equalizer. The return value indicates whether the gain was successfully set.
+   * Sets the in-band gain of the equalizer. The return value indicates whether
+   * the gain was successfully set.
    *
    * @method OcaFilterParametric#SetInbandGain
    * @param {number} gain
@@ -128,7 +138,8 @@ export declare class OcaFilterParametric extends OcaActuator {
   SetInbandGain(gain: number): Promise<void>;
 
   /**
-   * Returns the shape parameter of the equalizer. The return value indicates whether the data was successfully retrieved.
+   * Returns the shape parameter of the equalizer. The return value indicates
+   * whether the data was successfully retrieved.
    * The return values of this method are
    *
    * - shape of type ``number``
@@ -141,7 +152,8 @@ export declare class OcaFilterParametric extends OcaActuator {
   GetShapeParameter(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the shape parameter of the equalizer. The return value indicates whether the parameter was successfully set.
+   * Sets the shape parameter of the equalizer. The return value indicates
+   * whether the parameter was successfully set.
    *
    * @method OcaFilterParametric#SetShapeParameter
    * @param {number} shape
@@ -151,25 +163,22 @@ export declare class OcaFilterParametric extends OcaActuator {
   SetShapeParameter(shape: number): Promise<void>;
 
   /**
-   * Sets some or all filter parameters. The return value indicates if the parameters were successfully set. The action of this method is atomic - if any of the value changes fails, none of the changes are made.
+   * Sets some or all filter parameters. The return value indicates if the
+   * parameters were successfully set. The action of this method is atomic - if
+   * any of the value changes fails, none of the changes are made.
    *
    * @method OcaFilterParametric#SetMultiple
-   * @param {number} Mask
-   *
+   * @param {IOcaParameterMask} Mask
    * @param {number} Frequency
-   *
-   * @param {OcaParametricEQShape} Shape
-   *
+   * @param {IOcaParametricEQShape} Shape
    * @param {number} WidthParameter
-   *
    * @param {number} InBandGain
-   *
    * @param {number} ShapeParameter
    *
    * @returns {Promise<void>}
    */
   SetMultiple(
-    Mask: number,
+    Mask: IOcaParameterMask,
     Frequency: number,
     Shape: IOcaParametricEQShape,
     WidthParameter: number,