aes70 1.3.8 → 1.4.1

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

@@ -1,12 +1,15 @@
+import {
+  IOcaLevelMeterLaw,
+  OcaLevelMeterLaw,
+} from '../../types/OcaLevelMeterLaw';
+import { PropertyEvent } from '../property_event';
 import { RemoteDevice } from '../remote_device';
 import { OcaLevelSensor } from './OcaLevelSensor';
 
-import { PropertyEvent } from '../property_event';
-import { IOcaLevelMeterLaw } from '../../types/OcaLevelMeterLaw';
-import { OcaLevelMeterLaw } from '../../types/OcaLevelMeterLaw';
-
 /**
- * Child of  **OcaLevelSensor** that returns an audio meter reading in dB relative to a known reference level, and whose value has been calculated by the selected averaging algorithm.
+ * Child of **OcaLevelSensor** that returns an audio meter reading in dB
+ * relative to a known reference level, and whose value has been calculated by
+ * the selected averaging algorithm.
  * @extends OcaLevelSensor
  * @class OcaAudioLevelSensor
  */
@@ -19,7 +22,8 @@ export declare class OcaAudioLevelSensor extends OcaLevelSensor {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the value of the Law property. The return value indicates whether the property was successfully retrieved.
+   * Gets the value of the Law property. The return value indicates whether the
+   * property was successfully retrieved.
    *
    * @method OcaAudioLevelSensor#GetLaw
    * @returns {Promise<OcaLevelMeterLaw>}
@@ -28,10 +32,12 @@ export declare class OcaAudioLevelSensor extends OcaLevelSensor {
   GetLaw(): Promise<OcaLevelMeterLaw>;
 
   /**
-   * Sets the value of the Law property. The return value indicates whether the property was successfully set. Only implemented for objects whose Law property is read/write.
+   * Sets the value of the Law property. The return value indicates whether the
+   * property was successfully set. Only implemented for objects whose Law
+   * property is read/write.
    *
    * @method OcaAudioLevelSensor#SetLaw
-   * @param {OcaLevelMeterLaw} law
+   * @param {IOcaLevelMeterLaw} law
    *
    * @returns {Promise<void>}
    */

package/src/controller/ControlClasses/OcaAudioLevelSensor.js

@@ -1,9 +1,11 @@
+import { OcaLevelMeterLaw } from '../../OCP1/OcaLevelMeterLaw.js';
 import { make_control_class } from '../make_control_class.js';
 import { OcaLevelSensor } from './OcaLevelSensor.js';
-import { OcaLevelMeterLaw } from '../../OCP1/OcaLevelMeterLaw.js';
 
 /**
- * Child of  **OcaLevelSensor** that returns an audio meter reading in dB relative to a known reference level, and whose value has been calculated by the selected averaging algorithm.
+ * Child of **OcaLevelSensor** that returns an audio meter reading in dB
+ * relative to a known reference level, and whose value has been calculated by
+ * the selected averaging algorithm.
  * @extends OcaLevelSensor
  * @class OcaAudioLevelSensor
  */
@@ -22,26 +24,28 @@ export const OcaAudioLevelSensor = make_control_class(
 );
 
 /**
- * Gets the value of the Law property. The return value indicates whether the property was successfully retrieved.
+ * Gets the value of the Law property. The return value indicates whether the
+ * property was successfully retrieved.
  *
  * @method OcaAudioLevelSensor#GetLaw
  * @returns {Promise<OcaLevelMeterLaw>}
  *   A promise which resolves to a single value of type :class:`OcaLevelMeterLaw`.
  */
 /**
- * Sets the value of the Law property. The return value indicates whether the property was successfully set. Only implemented for objects whose Law property is read/write.
+ * Sets the value of the Law property. The return value indicates whether the
+ * property was successfully set. Only implemented for objects whose Law
+ * property is read/write.
  *
  * @method OcaAudioLevelSensor#SetLaw
- * @param {OcaLevelMeterLaw} law
+ * @param {IOcaLevelMeterLaw} law
  *
  * @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.
- * Enum that defines metering algorithm, including averaging
- * characteristics and, in some cases, reference level. Readonly in some
- * objects.
+ * Enum that defines metering algorithm, including averaging characteristics
+ * and, in some cases, reference level. Readonly in some objects.
  *
  * @member {PropertyEvent<OcaLevelMeterLaw>} OcaAudioLevelSensor#OnLawChanged
  */

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

@@ -2,13 +2,14 @@ import { RemoteDevice } from '../remote_device';
 import { OcaManager } from './OcaManager';
 
 /**
- * Placeholder for optional manager that in future versions of the standard will hold various global audio processing parameters.
+ * Placeholder for optional manager that in future versions of the standard will
+ * hold various global audio processing parameters.
  *
  *  - May be instantiated once in any device.
  *
- *
  *  - If instantiated, object number must be 9.
  *
+ *
  * @extends OcaManager
  * @class OcaAudioProcessingManager
  */

package/src/controller/ControlClasses/OcaAudioProcessingManager.js

@@ -2,13 +2,14 @@ import { make_control_class } from '../make_control_class.js';
 import { OcaManager } from './OcaManager.js';
 
 /**
- * Placeholder for optional manager that in future versions of the standard will hold various global audio processing parameters.
+ * Placeholder for optional manager that in future versions of the standard will
+ * hold various global audio processing parameters.
  *
  *  - May be instantiated once in any device.
  *
- *
  *  - If instantiated, object number must be 9.
  *
+ *
  * @extends OcaManager
  * @class OcaAudioProcessingManager
  */

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

@@ -1,8 +1,7 @@
+import { PropertyEvent } from '../property_event';
 import { RemoteDevice } from '../remote_device';
 import { OcaBasicActuator } from './OcaBasicActuator';
 
-import { PropertyEvent } from '../property_event';
-
 /**
  * Bitstring actuator. Maximum bitstring length is 65,536 bits.
  * @extends OcaBasicActuator
@@ -17,7 +16,8 @@ export declare class OcaBitstringActuator extends OcaBasicActuator {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the number of bits in the string. The return value indicates whether the property was successfully gathered.
+   * Gets the number of bits in the string. The return value indicates whether
+   * the property was successfully gathered.
    *
    * @method OcaBitstringActuator#GetNrBits
    * @returns {Promise<number>}
@@ -26,7 +26,8 @@ export declare class OcaBitstringActuator extends OcaBasicActuator {
   GetNrBits(): Promise<number>;
 
   /**
-   * Gets the bit value of the given bit. The return value indicates whether the property was successfully gathered.
+   * Gets the bit value of the given bit. The return value indicates whether the
+   * property was successfully gathered.
    *
    * @method OcaBitstringActuator#GetBit
    * @param {number} bitNr
@@ -37,11 +38,11 @@ export declare class OcaBitstringActuator extends OcaBasicActuator {
   GetBit(bitNr: number): Promise<boolean>;
 
   /**
-   * Sets the bit value of the given bit. The return value indicates whether the property was successfully set.
+   * Sets the bit value of the given bit. The return value indicates whether the
+   * property was successfully set.
    *
    * @method OcaBitstringActuator#SetBit
    * @param {number} bitNr
-   *
    * @param {boolean} Value
    *
    * @returns {Promise<void>}
@@ -49,7 +50,8 @@ export declare class OcaBitstringActuator extends OcaBasicActuator {
   SetBit(bitNr: number, Value: boolean): Promise<void>;
 
   /**
-   * Gets the entire bitstring.The return value indicates whether the property was successfully gathered.
+   * Gets the entire bitstring.The return value indicates whether the property
+   * was successfully gathered.
    *
    * @method OcaBitstringActuator#GetBitstring
    * @returns {Promise<boolean[]>}
@@ -58,7 +60,8 @@ export declare class OcaBitstringActuator extends OcaBasicActuator {
   GetBitstring(): Promise<boolean[]>;
 
   /**
-   * Sets the entire bitstring. The return value indicates whether the property was successfully set.
+   * Sets the entire bitstring. The return value indicates whether the property
+   * was successfully set.
    *
    * @method OcaBitstringActuator#SetBitstring
    * @param {boolean[]} BitString

package/src/controller/ControlClasses/OcaBitstringActuator.js

@@ -1,8 +1,8 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaBasicActuator } from './OcaBasicActuator.js';
 import { OcaBitstring } from '../../OCP1/OcaBitstring.js';
 import { OcaBoolean } from '../../OCP1/OcaBoolean.js';
 import { OcaUint16 } from '../../OCP1/OcaUint16.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaBasicActuator } from './OcaBasicActuator.js';
 
 /**
  * Bitstring actuator. Maximum bitstring length is 65,536 bits.
@@ -27,14 +27,16 @@ export const OcaBitstringActuator = make_control_class(
 );
 
 /**
- * Gets the number of bits in the string. The return value indicates whether the property was successfully gathered.
+ * Gets the number of bits in the string. The return value indicates whether the
+ * property was successfully gathered.
  *
  * @method OcaBitstringActuator#GetNrBits
  * @returns {Promise<number>}
  *   A promise which resolves to a single value of type ``number``.
  */
 /**
- * Gets the bit value of the given bit. The return value indicates whether the property was successfully gathered.
+ * Gets the bit value of the given bit. The return value indicates whether the
+ * property was successfully gathered.
  *
  * @method OcaBitstringActuator#GetBit
  * @param {number} bitNr
@@ -43,24 +45,26 @@ export const OcaBitstringActuator = make_control_class(
  *   A promise which resolves to a single value of type ``boolean``.
  */
 /**
- * Sets the bit value of the given bit. The return value indicates whether the property was successfully set.
+ * Sets the bit value of the given bit. The return value indicates whether the
+ * property was successfully set.
  *
  * @method OcaBitstringActuator#SetBit
  * @param {number} bitNr
- *
  * @param {boolean} Value
  *
  * @returns {Promise<void>}
  */
 /**
- * Gets the entire bitstring.The return value indicates whether the property was successfully gathered.
+ * Gets the entire bitstring.The return value indicates whether the property was
+ * successfully gathered.
  *
  * @method OcaBitstringActuator#GetBitstring
  * @returns {Promise<boolean[]>}
  *   A promise which resolves to a single value of type ``boolean[]``.
  */
 /**
- * Sets the entire bitstring. The return value indicates whether the property was successfully set.
+ * Sets the entire bitstring. The return value indicates whether the property
+ * was successfully set.
  *
  * @method OcaBitstringActuator#SetBitstring
  * @param {boolean[]} BitString
@@ -68,7 +72,7 @@ export const OcaBitstringActuator = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * This event is emitted when the property Bitstring changes in the remote object.
+ * This event is emitted when the property ``Bitstring`` changes in the remote object.
  * The property ``Bitstring`` is described in the AES70 standard as follows.
  * The bitstring data.
  *

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

@@ -1,8 +1,7 @@
+import { PropertyEvent } from '../property_event';
 import { RemoteDevice } from '../remote_device';
 import { OcaBasicSensor } from './OcaBasicSensor';
 
-import { PropertyEvent } from '../property_event';
-
 /**
  * Bit string sensor.
  * @extends OcaBasicSensor
@@ -17,7 +16,8 @@ export declare class OcaBitstringSensor extends OcaBasicSensor {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the number of bits of the bitmask data. Returned status indicates success or failure of the retrieval.
+   * Gets the number of bits of the bitmask data. Returned status indicates
+   * success or failure of the retrieval.
    *
    * @method OcaBitstringSensor#GetNrBits
    * @returns {Promise<number>}
@@ -26,7 +26,8 @@ export declare class OcaBitstringSensor extends OcaBasicSensor {
   GetNrBits(): Promise<number>;
 
   /**
-   * Gets the value of the given bit. Return status indicates success or failure of the retrieval.
+   * Gets the value of the given bit. Return status indicates success or failure
+   * of the retrieval.
    *
    * @method OcaBitstringSensor#GetBit
    * @param {number} bitNr
@@ -37,7 +38,8 @@ export declare class OcaBitstringSensor extends OcaBasicSensor {
   GetBit(bitNr: number): Promise<number>;
 
   /**
-   * Gets the entire bitstring. Return status indicates success or failure of the retrieval.
+   * Gets the entire bitstring. Return status indicates success or failure of
+   * the retrieval.
    *
    * @method OcaBitstringSensor#GetBitString
    * @returns {Promise<boolean[]>}

package/src/controller/ControlClasses/OcaBitstringSensor.js

@@ -1,8 +1,8 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaBasicSensor } from './OcaBasicSensor.js';
 import { OcaBitstring } from '../../OCP1/OcaBitstring.js';
 import { OcaUint16 } from '../../OCP1/OcaUint16.js';
 import { OcaUint8 } from '../../OCP1/OcaUint8.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaBasicSensor } from './OcaBasicSensor.js';
 
 /**
  * Bit string sensor.
@@ -25,14 +25,16 @@ export const OcaBitstringSensor = make_control_class(
 );
 
 /**
- * Gets the number of bits of the bitmask data. Returned status indicates success or failure of the retrieval.
+ * Gets the number of bits of the bitmask data. Returned status indicates
+ * success or failure of the retrieval.
  *
  * @method OcaBitstringSensor#GetNrBits
  * @returns {Promise<number>}
  *   A promise which resolves to a single value of type ``number``.
  */
 /**
- * Gets the value of the given bit. Return status indicates success or failure of the retrieval.
+ * Gets the value of the given bit. Return status indicates success or failure
+ * of the retrieval.
  *
  * @method OcaBitstringSensor#GetBit
  * @param {number} bitNr
@@ -41,14 +43,15 @@ export const OcaBitstringSensor = make_control_class(
  *   A promise which resolves to a single value of type ``number``.
  */
 /**
- * Gets the entire bitstring. Return status indicates success or failure of the retrieval.
+ * Gets the entire bitstring. Return status indicates success or failure of the
+ * retrieval.
  *
  * @method OcaBitstringSensor#GetBitString
  * @returns {Promise<boolean[]>}
  *   A promise which resolves to a single value of type ``boolean[]``.
  */
 /**
- * This event is emitted when the property BitString changes in the remote object.
+ * This event is emitted when the property ``BitString`` changes in the remote object.
  * The property ``BitString`` is described in the AES70 standard as follows.
  * The bitstring.
  *