aes70 1.3.8 → 1.4.0

package/src/controller/ControlClasses/OcaDynamicsDetector.js

@@ -1,8 +1,8 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaActuator } from './OcaActuator.js';
-import { OcaBitSet16 } from '../../OCP1/OcaBitSet16.js';
 import { OcaFloat32 } from '../../OCP1/OcaFloat32.js';
 import { OcaLevelDetectionLaw } from '../../OCP1/OcaLevelDetectionLaw.js';
+import { OcaParameterMask } from '../../OCP1/OcaParameterMask.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaActuator } from './OcaActuator.js';
 
 /**
  * Dynamics element : side-chain detector.
@@ -28,7 +28,13 @@ export const OcaDynamicsDetector = make_control_class(
       'SetMultiple',
       4,
       9,
-      [OcaBitSet16, OcaLevelDetectionLaw, OcaFloat32, OcaFloat32, OcaFloat32],
+      [
+        OcaParameterMask,
+        OcaLevelDetectionLaw,
+        OcaFloat32,
+        OcaFloat32,
+        OcaFloat32,
+      ],
       [],
     ],
   ],
@@ -42,22 +48,25 @@ export const OcaDynamicsDetector = make_control_class(
 );
 
 /**
- * Gets the value of the Law property. Return status indicates whether the value was successfully retrieved.
+ * Gets the value of the Law property. Return status indicates whether the value
+ * was successfully retrieved.
  *
  * @method OcaDynamicsDetector#GetLaw
  * @returns {Promise<OcaLevelDetectionLaw>}
  *   A promise which resolves to a single value of type :class:`OcaLevelDetectionLaw`.
  */
 /**
- * Sets the value of the Law property. Return status indicates whether the value was successfully set.
+ * Sets the value of the Law property. Return status indicates whether the value
+ * was successfully set.
  *
  * @method OcaDynamicsDetector#SetLaw
- * @param {OcaLevelDetectionLaw} Law
+ * @param {IOcaLevelDetectionLaw} Law
  *
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of the AttackTime property. The return value indicates if the value was successfully retrieved.
+ * Gets the value of the AttackTime property. The return value indicates if the
+ * value was successfully retrieved.
  * The return values of this method are
  *
  * - Time of type ``number``
@@ -68,7 +77,8 @@ export const OcaDynamicsDetector = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the value of the AttackTime property. The return value indicates whether the property was successfully set.
+ * Sets the value of the AttackTime property. The return value indicates whether
+ * the property was successfully set.
  *
  * @method OcaDynamicsDetector#SetAttackTime
  * @param {number} Time
@@ -76,7 +86,8 @@ export const OcaDynamicsDetector = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of the ReleaseTime property. The return value indicates if the value was successfully retrieved.
+ * Gets the value of the ReleaseTime property. The return value indicates if the
+ * value was successfully retrieved.
  * The return values of this method are
  *
  * - Time of type ``number``
@@ -87,7 +98,8 @@ export const OcaDynamicsDetector = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the value of the ReleaseTime property. The return value indicates whether the property was successfully set.
+ * Sets the value of the ReleaseTime property. The return value indicates
+ * whether the property was successfully set.
  *
  * @method OcaDynamicsDetector#SetReleaseTime
  * @param {number} Time
@@ -95,7 +107,8 @@ export const OcaDynamicsDetector = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of the HoldTime property. The return value indicates if the value was successfully retrieved.
+ * Gets the value of the HoldTime property. The return value indicates if the
+ * value was successfully retrieved.
  * The return values of this method are
  *
  * - Time of type ``number``
@@ -106,7 +119,8 @@ export const OcaDynamicsDetector = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the value of the HoldTime property. The return value indicates whether the property was successfully set.
+ * Sets the value of the HoldTime property. The return value indicates whether
+ * the property was successfully set.
  *
  * @method OcaDynamicsDetector#SetHoldTime
  * @param {number} Time
@@ -114,44 +128,42 @@ export const OcaDynamicsDetector = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Sets some or all detector 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 detector 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 OcaDynamicsDetector#SetMultiple
- * @param {number} Mask
- *
- * @param {OcaLevelDetectionLaw} Law
- *
+ * @param {IOcaParameterMask} Mask
+ * @param {IOcaLevelDetectionLaw} Law
  * @param {number} AttackTime
- *
  * @param {number} ReleaseTime
- *
  * @param {number} HoldTime
  *
  * @returns {Promise<void>}
  */
 /**
- * This event is emitted when the property Law changes in the remote object.
+ * This event is emitted when the property ``Law`` changes in the remote object.
  * The property ``Law`` is described in the AES70 standard as follows.
  * Level detection law: RMS, Peak, possibly others
  *
  * @member {PropertyEvent<OcaLevelDetectionLaw>} OcaDynamicsDetector#OnLawChanged
  */
 /**
- * This event is emitted when the property AttackTime changes in the remote object.
+ * This event is emitted when the property ``AttackTime`` changes in the remote object.
  * The property ``AttackTime`` is described in the AES70 standard as follows.
  * Detector attack time in seconds.
  *
  * @member {PropertyEvent<number>} OcaDynamicsDetector#OnAttackTimeChanged
  */
 /**
- * This event is emitted when the property ReleaseTime changes in the remote object.
+ * This event is emitted when the property ``ReleaseTime`` changes in the remote object.
  * The property ``ReleaseTime`` is described in the AES70 standard as follows.
  * Detector release time in seconds.
  *
  * @member {PropertyEvent<number>} OcaDynamicsDetector#OnReleaseTimeChanged
  */
 /**
- * This event is emitted when the property HoldTime changes in the remote object.
+ * This event is emitted when the property ``HoldTime`` changes in the remote object.
  * The property ``HoldTime`` is described in the AES70 standard as follows.
  * Detector hold time in seconds.
  *

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

@@ -1,10 +1,12 @@
+import { IOcaEvent } from '../../types/OcaEvent';
 import { RemoteDevice } from '../remote_device';
 import { OcaAgent } from './OcaAgent';
 
-import { IOcaEvent } from '../../types/OcaEvent';
-
 /**
- * Base class for event handler objects. This class applies to controllers that subscribe to events and receive notifications for them. Controller developers can derive from this class and add specific callback methods that perform processing and/or have specific event data structures.
+ * Base class for event handler objects. This class applies to controllers that
+ * subscribe to events and receive notifications for them. Controller developers
+ * can derive from this class and add specific callback methods that perform
+ * processing and/or have specific event data structures.
  * @extends OcaAgent
  * @class OcaEventHandler
  */
@@ -12,12 +14,12 @@ export declare class OcaEventHandler extends OcaAgent {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Generic empty callback method for events. Application developers can override this method in a derived class to add behavior.
+   * Generic empty callback method for events. Application developers can
+   * override this method in a derived class to add behavior.
    *
    * @method OcaEventHandler#OnEvent
    * @param {Uint8Array} Context
-   *
-   * @param {OcaEvent} eventData
+   * @param {IOcaEvent} eventData
    *
    * @returns {Promise<void>}
    */

package/src/controller/ControlClasses/OcaEventHandler.js

@@ -1,10 +1,13 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaAgent } from './OcaAgent.js';
 import { OcaBlob } from '../../OCP1/OcaBlob.js';
 import { OcaEvent } from '../../OCP1/OcaEvent.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaAgent } from './OcaAgent.js';
 
 /**
- * Base class for event handler objects. This class applies to controllers that subscribe to events and receive notifications for them. Controller developers can derive from this class and add specific callback methods that perform processing and/or have specific event data structures.
+ * Base class for event handler objects. This class applies to controllers that
+ * subscribe to events and receive notifications for them. Controller developers
+ * can derive from this class and add specific callback methods that perform
+ * processing and/or have specific event data structures.
  * @extends OcaAgent
  * @class OcaEventHandler
  */
@@ -20,12 +23,12 @@ export const OcaEventHandler = make_control_class(
 );
 
 /**
- * Generic empty callback method for events. Application developers can override this method in a derived class to add behavior.
+ * Generic empty callback method for events. Application developers can override
+ * this method in a derived class to add behavior.
  *
  * @method OcaEventHandler#OnEvent
  * @param {Uint8Array} Context
- *
- * @param {OcaEvent} eventData
+ * @param {IOcaEvent} eventData
  *
  * @returns {Promise<void>}
  */

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

@@ -1,13 +1,15 @@
-import { RemoteDevice } from '../remote_device';
-import { OcaActuator } from './OcaActuator';
+import {
+  IOcaTransferFunction,
+  OcaTransferFunction,
+} from '../../types/OcaTransferFunction';
 import { Arguments } from '../arguments';
-
 import { PropertyEvent } from '../property_event';
-import { IOcaTransferFunction } from '../../types/OcaTransferFunction';
-import { OcaTransferFunction } from '../../types/OcaTransferFunction';
+import { RemoteDevice } from '../remote_device';
+import { OcaActuator } from './OcaActuator';
 
 /**
- * An arbitrary-curve filter, with transfer function specified as amplitude and phase versus frequency.
+ * An arbitrary-curve filter, with transfer function specified as amplitude and
+ * phase versus frequency.
  * @extends OcaActuator
  * @class OcaFilterArbitraryCurve
  */
@@ -47,7 +49,7 @@ export declare class OcaFilterArbitraryCurve extends OcaActuator {
    * Sets the complex transfer function.
    *
    * @method OcaFilterArbitraryCurve#SetTransferFunction
-   * @param {OcaTransferFunction} TransferFunction
+   * @param {IOcaTransferFunction} TransferFunction
    *
    * @returns {Promise<void>}
    */
@@ -77,7 +79,8 @@ export declare class OcaFilterArbitraryCurve extends OcaActuator {
   SetSampleRate(Rate: number): Promise<void>;
 
   /**
-   * Returns the minimum number of required points in the specified transfer function.
+   * Returns the minimum number of required points in the specified transfer
+   * function.
    *
    * @method OcaFilterArbitraryCurve#GetTFMinLength
    * @returns {Promise<number>}
@@ -86,7 +89,8 @@ export declare class OcaFilterArbitraryCurve extends OcaActuator {
   GetTFMinLength(): Promise<number>;
 
   /**
-   * Returns the maximum number of allowed points in the specified transfer function.
+   * Returns the maximum number of allowed points in the specified transfer
+   * function.
    *
    * @method OcaFilterArbitraryCurve#GetTFMaxLength
    * @returns {Promise<number>}

package/src/controller/ControlClasses/OcaFilterArbitraryCurve.js

@@ -1,11 +1,12 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaActuator } from './OcaActuator.js';
 import { OcaFloat32 } from '../../OCP1/OcaFloat32.js';
 import { OcaTransferFunction } from '../../OCP1/OcaTransferFunction.js';
 import { OcaUint16 } from '../../OCP1/OcaUint16.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaActuator } from './OcaActuator.js';
 
 /**
- * An arbitrary-curve filter, with transfer function specified as amplitude and phase versus frequency.
+ * An arbitrary-curve filter, with transfer function specified as amplitude and
+ * phase versus frequency.
  * @extends OcaActuator
  * @class OcaFilterArbitraryCurve
  */
@@ -43,7 +44,7 @@ export const OcaFilterArbitraryCurve = make_control_class(
  * Sets the complex transfer function.
  *
  * @method OcaFilterArbitraryCurve#SetTransferFunction
- * @param {OcaTransferFunction} TransferFunction
+ * @param {IOcaTransferFunction} TransferFunction
  *
  * @returns {Promise<void>}
  */
@@ -67,43 +68,45 @@ export const OcaFilterArbitraryCurve = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Returns the minimum number of required points in the specified transfer function.
+ * Returns the minimum number of required points in the specified transfer
+ * function.
  *
  * @method OcaFilterArbitraryCurve#GetTFMinLength
  * @returns {Promise<number>}
  *   A promise which resolves to a single value of type ``number``.
  */
 /**
- * Returns the maximum number of allowed points in the specified transfer function.
+ * Returns the maximum number of allowed points in the specified transfer
+ * function.
  *
  * @method OcaFilterArbitraryCurve#GetTFMaxLength
  * @returns {Promise<number>}
  *   A promise which resolves to a single value of type ``number``.
  */
 /**
- * This event is emitted when the property TransferFunction changes in the remote object.
+ * This event is emitted when the property ``TransferFunction`` changes in the remote object.
  * The property ``TransferFunction`` is described in the AES70 standard as follows.
  * Transfer function of the filter.
  *
  * @member {PropertyEvent<OcaTransferFunction>} OcaFilterArbitraryCurve#OnTransferFunctionChanged
  */
 /**
- * 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>} OcaFilterArbitraryCurve#OnSampleRateChanged
  */
 /**
- * This event is emitted when the property TFMinLength changes in the remote object.
+ * This event is emitted when the property ``TFMinLength`` changes in the remote object.
  * The property ``TFMinLength`` is described in the AES70 standard as follows.
  * Minimum number of points that transfer function must specify
  *
  * @member {PropertyEvent<number>} OcaFilterArbitraryCurve#OnTFMinLengthChanged
  */
 /**
- * This event is emitted when the property TFMaxLength changes in the remote object.
+ * This event is emitted when the property ``TFMaxLength`` changes in the remote object.
  * The property ``TFMaxLength`` is described in the AES70 standard as follows.
  * Maximum number of points that transfer function may specify
  *

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

@@ -1,15 +1,21 @@
-import { RemoteDevice } from '../remote_device';
-import { OcaActuator } from './OcaActuator';
+import {
+  IOcaClassicalFilterShape,
+  OcaClassicalFilterShape,
+} from '../../types/OcaClassicalFilterShape';
+import {
+  IOcaFilterPassband,
+  OcaFilterPassband,
+} from '../../types/OcaFilterPassband';
+import { IOcaParameterMask } from '../../types/OcaParameterMask';
 import { Arguments } from '../arguments';
-
 import { PropertyEvent } from '../property_event';
-import { IOcaClassicalFilterShape } from '../../types/OcaClassicalFilterShape';
-import { IOcaFilterPassband } from '../../types/OcaFilterPassband';
-import { OcaClassicalFilterShape } from '../../types/OcaClassicalFilterShape';
-import { OcaFilterPassband } from '../../types/OcaFilterPassband';
+import { RemoteDevice } from '../remote_device';
+import { OcaActuator } from './OcaActuator';
 
 /**
- * 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
  */
@@ -42,7 +48,8 @@ export declare class OcaFilterClassical extends OcaActuator {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * 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``
@@ -55,7 +62,8 @@ export declare class OcaFilterClassical extends OcaActuator {
   GetFrequency(): 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
@@ -65,7 +73,8 @@ export declare class OcaFilterClassical extends OcaActuator {
   SetFrequency(frequency: number): 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>}
@@ -74,17 +83,19 @@ export declare class OcaFilterClassical extends OcaActuator {
   GetPassband(): Promise<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>}
    */
   SetPassband(Passband: IOcaFilterPassband): 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>}
@@ -93,17 +104,19 @@ export declare class OcaFilterClassical extends OcaActuator {
   GetShape(): Promise<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>}
    */
   SetShape(Shape: IOcaClassicalFilterShape): 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``
@@ -116,7 +129,8 @@ export declare class OcaFilterClassical extends OcaActuator {
   GetOrder(): 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
@@ -126,7 +140,8 @@ export declare class OcaFilterClassical extends OcaActuator {
   SetOrder(Order: number): 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``
@@ -139,7 +154,8 @@ export declare class OcaFilterClassical extends OcaActuator {
   GetParameter(): 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
@@ -149,25 +165,22 @@ export declare class OcaFilterClassical extends OcaActuator {
   SetParameter(Parameter: number): 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>}
    */
   SetMultiple(
-    Mask: number,
+    Mask: IOcaParameterMask,
     Frequency: number,
     Passband: IOcaFilterPassband,
     Shape: IOcaClassicalFilterShape,