aes70 1.6.1 → 2.0.0

package/src/controller/ControlClasses/OcaFilterArbitraryCurve.js

@@ -5,7 +5,7 @@ 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
+ * Arbitrary-curve filter, with transfer function specified as amplitude and
  * phase versus frequency.
  * @extends OcaActuator
  * @class OcaFilterArbitraryCurve
@@ -14,7 +14,7 @@ export const OcaFilterArbitraryCurve = make_control_class(
   'OcaFilterArbitraryCurve',
   4,
   '\u0001\u0001\u0001\r',
-  2,
+  3,
   OcaActuator,
   [
     ['GetTransferFunction', 4, 1, [], [OcaTransferFunction]],
@@ -34,7 +34,7 @@ export const OcaFilterArbitraryCurve = make_control_class(
 );
 
 /**
- * Returns the complex transfer function.
+ * Gets the complex transfer function.
  *
  * @method OcaFilterArbitraryCurve#GetTransferFunction
  * @returns {Promise<OcaTransferFunction>}
@@ -49,7 +49,7 @@ export const OcaFilterArbitraryCurve = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the filter sampling rate.
+ * Gets the value and limits of the filter sampling rate.
  * The return values of this method are
  *
  * - Rate of type ``number``
@@ -68,16 +68,14 @@ export const OcaFilterArbitraryCurve = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Returns the minimum number of required points in the specified transfer
- * function.
+ * Gets the value and limits of the TFMinLength property.
  *
  * @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.
+ * Gets the value and limits of the TFMaxLength property.
  *
  * @method OcaFilterArbitraryCurve#GetTFMaxLength
  * @returns {Promise<number>}
@@ -93,22 +91,22 @@ export const OcaFilterArbitraryCurve = make_control_class(
 /**
  * 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.
+ * Sampling rate inside the filter. Note: This rate is not necessarily the same
+ * as the Device input or output sampling rate.
  *
  * @member {PropertyEvent<number>} OcaFilterArbitraryCurve#OnSampleRateChanged
  */
 /**
  * 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
+ * Minimum number of points that the transfer function must specify
  *
  * @member {PropertyEvent<number>} OcaFilterArbitraryCurve#OnTFMinLengthChanged
  */
 /**
  * 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
+ * Maximum number of points that the transfer function may specify
  *
  * @member {PropertyEvent<number>} OcaFilterArbitraryCurve#OnTFMaxLengthChanged
  */

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

@@ -13,9 +13,8 @@ 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.
+ * Classical analog-style filter - highpass, lowpass, bandpass, etc., with shape
+ * characteristics such as Butterworth, Chebyshev, Bessel, and Linkwitz-Riley.
  * @extends OcaActuator
  * @class OcaFilterClassical
  */
@@ -48,8 +47,7 @@ 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 and limits of the **Frequency** property.
    * The return values of this method are
    *
    * - Frequency of type ``number``
@@ -62,8 +60,7 @@ 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.
    *
    * @method OcaFilterClassical#SetFrequency
    * @param {number} frequency
@@ -73,8 +70,7 @@ 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.
+   * Gets the value of the **Passband** property.
    *
    * @method OcaFilterClassical#GetPassband
    * @returns {Promise<OcaFilterPassband>}
@@ -83,8 +79,7 @@ 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 value of the **Passband** property.
    *
    * @method OcaFilterClassical#SetPassband
    * @param {IOcaFilterPassband} Passband
@@ -94,8 +89,7 @@ export declare class OcaFilterClassical extends OcaActuator {
   SetPassband(Passband: IOcaFilterPassband): Promise<void>;
 
   /**
-   * Returns the Shape property of the filter. The return value indicates if the
-   * property was successfully retrieved.
+   * Gets the value of the **Shape** property.
    *
    * @method OcaFilterClassical#GetShape
    * @returns {Promise<OcaClassicalFilterShape>}
@@ -104,8 +98,7 @@ 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 value of the **Shape** property.
    *
    * @method OcaFilterClassical#SetShape
    * @param {IOcaClassicalFilterShape} Shape
@@ -115,8 +108,7 @@ export declare class OcaFilterClassical extends OcaActuator {
   SetShape(Shape: IOcaClassicalFilterShape): Promise<void>;
 
   /**
-   * Returns the order of the filter. The return value indicates if the property
-   * was successfully retrieved.
+   * Gets the value and limits of the **Order** property.
    * The return values of this method are
    *
    * - Order of type ``number``
@@ -129,8 +121,7 @@ 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 value of the **Order** property.
    *
    * @method OcaFilterClassical#SetOrder
    * @param {number} Order
@@ -140,8 +131,7 @@ 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.
+   * Gets the value and limits of the **Parameter** property.
    * The return values of this method are
    *
    * - Parameter of type ``number``
@@ -154,8 +144,7 @@ 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 value of the **Parameter** property.
    *
    * @method OcaFilterClassical#SetParameter
    * @param {number} Parameter
@@ -165,9 +154,9 @@ 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 parameters. The action of this method shall be
+   * atomic - if any of the changes fails, **none** of the changes shall be
+   * made.
    *
    * @method OcaFilterClassical#SetMultiple
    * @param {IOcaParameterMask} Mask

package/src/controller/ControlClasses/OcaFilterClassical.js

@@ -7,9 +7,8 @@ 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.
+ * Classical analog-style filter - highpass, lowpass, bandpass, etc., with shape
+ * characteristics such as Butterworth, Chebyshev, Bessel, and Linkwitz-Riley.
  * @extends OcaActuator
  * @class OcaFilterClassical
  */
@@ -17,7 +16,7 @@ export const OcaFilterClassical = make_control_class(
   'OcaFilterClassical',
   4,
   '\u0001\u0001\u0001\t',
-  2,
+  3,
   OcaActuator,
   [
     ['GetFrequency', 4, 1, [], [OcaFloat32, OcaFloat32, OcaFloat32]],
@@ -56,8 +55,7 @@ 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 and limits of the **Frequency** property.
  * The return values of this method are
  *
  * - Frequency of type ``number``
@@ -68,8 +66,7 @@ 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.
  *
  * @method OcaFilterClassical#SetFrequency
  * @param {number} frequency
@@ -77,16 +74,14 @@ 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.
+ * Gets the value of the **Passband** property.
  *
  * @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 value of the **Passband** property.
  *
  * @method OcaFilterClassical#SetPassband
  * @param {IOcaFilterPassband} Passband
@@ -94,16 +89,14 @@ export const OcaFilterClassical = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Returns the Shape property of the filter. The return value indicates if the
- * property was successfully retrieved.
+ * Gets the value of the **Shape** property.
  *
  * @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 value of the **Shape** property.
  *
  * @method OcaFilterClassical#SetShape
  * @param {IOcaClassicalFilterShape} Shape
@@ -111,8 +104,7 @@ export const OcaFilterClassical = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Returns the order of the filter. The return value indicates if the property
- * was successfully retrieved.
+ * Gets the value and limits of the **Order** property.
  * The return values of this method are
  *
  * - Order of type ``number``
@@ -123,8 +115,7 @@ 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 value of the **Order** property.
  *
  * @method OcaFilterClassical#SetOrder
  * @param {number} Order
@@ -132,8 +123,7 @@ export const OcaFilterClassical = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Returns the filter parameter. The return value indicates if the property was
- * successfully retrieved.
+ * Gets the value and limits of the **Parameter** property.
  * The return values of this method are
  *
  * - Parameter of type ``number``
@@ -144,8 +134,7 @@ 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 value of the **Parameter** property.
  *
  * @method OcaFilterClassical#SetParameter
  * @param {number} Parameter
@@ -153,9 +142,8 @@ 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 parameters. The action of this method shall be atomic
+ * - if any of the changes fails, **none** of the changes shall be made.
  *
  * @method OcaFilterClassical#SetMultiple
  * @param {IOcaParameterMask} Mask

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

@@ -4,7 +4,7 @@ import { RemoteDevice } from '../remote_device';
 import { OcaActuator } from './OcaActuator';
 
 /**
- * A finite impulse response (FIR) filter.
+ * Finite impulse response (FIR) filter.
  * @extends OcaActuator
  * @class OcaFilterFIR
  */
@@ -27,8 +27,7 @@ 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 and length limits of the FIR filter.
    * The return values of this method are
    *
    * - Length of type ``number``
@@ -41,8 +40,7 @@ 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.
    *
    * @method OcaFilterFIR#GetCoefficients
    * @returns {Promise<number[]>}
@@ -51,8 +49,7 @@ 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 coefficients of the FIR filter.
    *
    * @method OcaFilterFIR#SetCoefficients
    * @param {number[]} Coefficients
@@ -62,8 +59,7 @@ 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 value and limits of the **SampleRate** property.
    * The return values of this method are
    *
    * - Rate of type ``number``
@@ -76,8 +72,7 @@ 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 sampling rate of the FIR filter.
    *
    * @method OcaFilterFIR#SetSampleRate
    * @param {number} Rate

package/src/controller/ControlClasses/OcaFilterFIR.js

@@ -5,7 +5,7 @@ import { make_control_class } from '../make_control_class.js';
 import { OcaActuator } from './OcaActuator.js';
 
 /**
- * A finite impulse response (FIR) filter.
+ * Finite impulse response (FIR) filter.
  * @extends OcaActuator
  * @class OcaFilterFIR
  */
@@ -13,7 +13,7 @@ export const OcaFilterFIR = make_control_class(
   'OcaFilterFIR',
   4,
   '\u0001\u0001\u0001\f',
-  2,
+  3,
   OcaActuator,
   [
     ['GetLength', 4, 1, [], [OcaUint32, OcaUint32, OcaUint32]],
@@ -31,8 +31,7 @@ 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 and length limits of the FIR filter.
  * The return values of this method are
  *
  * - Length of type ``number``
@@ -43,16 +42,14 @@ 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.
  *
  * @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 coefficients of the FIR filter.
  *
  * @method OcaFilterFIR#SetCoefficients
  * @param {number[]} Coefficients
@@ -60,8 +57,7 @@ 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 value and limits of the **SampleRate** property.
  * The return values of this method are
  *
  * - Rate of type ``number``
@@ -72,8 +68,7 @@ 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 sampling rate of the FIR filter.
  *
  * @method OcaFilterFIR#SetSampleRate
  * @param {number} Rate
@@ -83,24 +78,23 @@ export const OcaFilterFIR = make_control_class(
 /**
  * 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.
+ * Length of the filter, in samples. Readonly.
  *
  * @member {PropertyEvent<number>} OcaFilterFIR#OnLengthChanged
  */
 /**
  * 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. Number of entries shall be equal to the value of
+ * the **Order** property plus 1.
  *
  * @member {PropertyEvent<number[]>} OcaFilterFIR#OnCoefficientsChanged
  */
 /**
  * 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.
+ * Sampling rate inside the filter. Note: This rate is not necessarily the same
+ * as the Device input or output sampling rate.
  *
  * @member {PropertyEvent<number>} OcaFilterFIR#OnSampleRateChanged
  */

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

@@ -9,7 +9,7 @@ import { RemoteDevice } from '../remote_device';
 import { OcaActuator } from './OcaActuator';
 
 /**
- * A parametric equalizer section with various shape options.
+ * Parametric equalizer section with various shape options.
  * @extends OcaActuator
  * @class OcaFilterParametric
  */
@@ -34,10 +34,14 @@ export declare class OcaFilterParametric extends OcaActuator {
    */
   OnQChanged: PropertyEvent<number>;
   /**
-   * This event is emitted whenever InbandGain changes.
+   * This event is emitted whenever InBandGain changes.
    */
-  OnInbandGainChanged: PropertyEvent<number>;
+  OnInBandGainChanged: PropertyEvent<number>;
 
+  /**
+   * An alias for OnInBandGainChanged
+   */
+  OnInbandGainChanged: PropertyEvent<number>;
   /**
    * This event is emitted whenever ShapeParameter changes.
    */
@@ -46,8 +50,7 @@ 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 value and limits of the **Frequency** property.
    * The return values of this method are
    *
    * - Frequency of type ``number``
@@ -60,8 +63,7 @@ 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 value of the **Frequency** property.
    *
    * @method OcaFilterParametric#SetFrequency
    * @param {number} Frequency
@@ -71,8 +73,7 @@ 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 value of the **Shape** property.
    *
    * @method OcaFilterParametric#GetShape
    * @returns {Promise<OcaParametricEQShape>}
@@ -81,8 +82,7 @@ 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 value of the **Shape** property.
    *
    * @method OcaFilterParametric#SetShape
    * @param {IOcaParametricEQShape} type
@@ -92,8 +92,7 @@ export declare class OcaFilterParametric extends OcaActuator {
   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 value and limits of the **WidthParameter** property.
    * The return values of this method are
    *
    * - Width of type ``number``
@@ -106,8 +105,21 @@ 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.
+   * Gets the value and limits of the **WidthParameter** property.
+   * An alias for GetWidthParameter.
+   * The return values of this method are
+   *
+   * - Width of type ``number``
+   * - minWidth of type ``number``
+   * - maxWidth of type ``number``
+   *
+   * @method OcaFilterParametric#GetQ
+   * @returns {Promise<Arguments<number,number,number>>}
+   */
+  GetQ(): Promise<Arguments<[number, number, number]>>;
+
+  /**
+   * Sets the value of the **WidthParameter** property.
    *
    * @method OcaFilterParametric#SetWidthParameter
    * @param {number} Width
@@ -117,8 +129,18 @@ 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.
+   * Sets the value of the **WidthParameter** property.
+   * An alias for SetWidthParameter.
+   *
+   * @method OcaFilterParametric#SetQ
+   * @param {number} Width
+   *
+   * @returns {Promise<void>}
+   */
+  SetQ(Width: number): Promise<void>;
+
+  /**
+   * Gets the value, min, and max of the **InBandGain** property.
    * The return values of this method are
    *
    * - gain of type ``number``
@@ -131,8 +153,7 @@ 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 value of the **InBandGain** property.
    *
    * @method OcaFilterParametric#SetInbandGain
    * @param {number} gain
@@ -142,8 +163,18 @@ 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.
+   * Sets the value of the **InBandGain** property.
+   * An alias for SetInbandGain.
+   *
+   * @method OcaFilterParametric#SetInbandgain
+   * @param {number} gain
+   *
+   * @returns {Promise<void>}
+   */
+  SetInbandgain(gain: number): Promise<void>;
+
+  /**
+   * Gets the value and limits of the **ShapeParameter** property.
    * The return values of this method are
    *
    * - shape of type ``number``
@@ -156,8 +187,7 @@ 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 value of the S**hapeParameter** property.
    *
    * @method OcaFilterParametric#SetShapeParameter
    * @param {number} shape
@@ -167,9 +197,8 @@ 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 action of this method is atomic -
+   * if any of the value changes fails, none of the changes are made.
    *
    * @method OcaFilterParametric#SetMultiple
    * @param {IOcaParameterMask} Mask