aes70 1.3.8 → 1.4.0

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.
  *

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

@@ -1,21 +1,27 @@
-import { RemoteDevice } from '../remote_device';
-import { OcaWorker } from './OcaWorker';
-
-import { PropertyEvent } from '../property_event';
-import { IOcaLibVolIdentifier } from '../../types/OcaLibVolIdentifier';
-import { IOcaObjectSearchResultFlags } from '../../types/OcaObjectSearchResultFlags';
-import { IOcaSignalPath } from '../../types/OcaSignalPath';
-import { IOcaStringComparisonType } from '../../types/OcaStringComparisonType';
 import { OcaBlockMember } from '../../types/OcaBlockMember';
 import { OcaGlobalTypeIdentifier } from '../../types/OcaGlobalTypeIdentifier';
 import { OcaLibVolData_ParamSet } from '../../types/OcaLibVolData_ParamSet';
-import { OcaLibVolIdentifier } from '../../types/OcaLibVolIdentifier';
+import {
+  IOcaLibVolIdentifier,
+  OcaLibVolIdentifier,
+} from '../../types/OcaLibVolIdentifier';
 import { OcaObjectIdentification } from '../../types/OcaObjectIdentification';
 import { OcaObjectSearchResult } from '../../types/OcaObjectSearchResult';
-import { OcaSignalPath } from '../../types/OcaSignalPath';
+import { IOcaObjectSearchResultFlags } from '../../types/OcaObjectSearchResultFlags';
+import { IOcaSignalPath, OcaSignalPath } from '../../types/OcaSignalPath';
+import { IOcaStringComparisonType } from '../../types/OcaStringComparisonType';
+import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaWorker } from './OcaWorker';
 
 /**
- * A block is an object with three aspects: - It can contain other blocks. - It can contain workers. - It can contain agents. - It can contain data networks. - It can contain application networks. - It has a signal flow topology. We refer to an object inside a block as a  **member**  of that block. We refer to the block which contains an object as the object's  **container.**  **1**  Normally, a block contains a set of members that together function as a processing unit -- for example, a crossover channel or mixer strip.
+ * A block is an object with three aspects: - It can contain other blocks. - It
+ * can contain workers. - It can contain agents. - It can contain data networks.
+ * - It can contain application networks. - It has a signal flow topology. We
+ * refer to an object inside a block as a **member** of that block. We refer to
+ * the block which contains an object as the object's **container.****1**
+ * Normally, a block contains a set of members that together function as a
+ * processing unit -- for example, a crossover channel or mixer strip.
  * @extends OcaWorker
  * @class OcaBlock
  */
@@ -38,7 +44,11 @@ export declare class OcaBlock extends OcaWorker {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the block type. For statically-defined blocks, the block type is a Uint32 with a value corresponding to the unique configuration of this block. For dynamically-defined blocks, the block type is the object number of the block's factory. For the root block, the value of this property is 1.
+   * Gets the block type. For statically-defined blocks, the block type is a
+   * Uint32 with a value corresponding to the unique configuration of this
+   * block. For dynamically-defined blocks, the block type is the object number
+   * of the block's factory. For the root block, the value of this property is
+   * 1.
    *
    * @method OcaBlock#GetType
    * @returns {Promise<number>}
@@ -47,23 +57,9 @@ export declare class OcaBlock extends OcaWorker {
   GetType(): Promise<number>;
 
   /**
-   * Constructs an object according to the given construction specification and adds it to the block. The return value indicates whether the member was successfully created and added.
-   *
-   * @method OcaBlock#ConstructMember
-   * @param {string} ClassID
-   *
-   * @param {any} ConstructionParameters
-   *
-   * @returns {Promise<number>}
-   *   A promise which resolves to a single value of type ``number``.
-   */
-  ConstructMember(
-    ClassID: string,
-    ConstructionParameters: any
-  ): Promise<number>;
-
-  /**
-   * Invokes a factory to construct an instance of the given class, then adds it to the block. The return value indicates whether the member was successfully created and added.
+   * Invokes a factory to construct an instance of the given class, then adds it
+   * to the block. The return value indicates whether the member was
+   * successfully created and added.
    *
    * @method OcaBlock#ConstructMemberUsingFactory
    * @param {number} FactoryONo
@@ -74,7 +70,9 @@ export declare class OcaBlock extends OcaWorker {
   ConstructMemberUsingFactory(FactoryONo: number): Promise<number>;
 
   /**
-   * Removes a member from the block and destroys the object. . Deletes all signal paths attached to its ports. The return value indicates whether the member was successfully removed and destroyed.
+   * Removes a member from the block and destroys the object. . Deletes all
+   * signal paths attached to its ports. The return value indicates whether the
+   * member was successfully removed and destroyed.
    *
    * @method OcaBlock#DeleteMember
    * @param {number} ObjectNumber
@@ -84,28 +82,35 @@ export declare class OcaBlock extends OcaWorker {
   DeleteMember(ObjectNumber: number): Promise<void>;
 
   /**
-   * Gets the list of block members. Does not recurse inner blocks. Each inner block is included in the returned list as a single object -- its contents are not enumerated. The return value indicates whether the list was successfully retrieved.
+   * Gets the list of block members. Does not recurse inner blocks. Each inner
+   * block is included in the returned list as a single object -- its contents
+   * are not enumerated. The return value indicates whether the list was
+   * successfully retrieved.
    *
    * @method OcaBlock#GetMembers
    * @returns {Promise<OcaObjectIdentification[]>}
-   *   A promise which resolves to a single value of type ``OcaObjectIdentification[]``.
+   *   A promise which resolves to a single value of type :class:`OcaObjectIdentification[]`.
    */
   GetMembers(): Promise<OcaObjectIdentification[]>;
 
   /**
-   * Gets the list of block members. Recurses inner blocks. Each inner block is included in the returned list as a single object, amd its contents are enumerated. The return value indicates whether the list was successfully retrieved.
+   * Gets the list of block members. Recurses inner blocks. Each inner block is
+   * included in the returned list as a single object, amd its contents are
+   * enumerated. The return value indicates whether the list was successfully
+   * retrieved.
    *
    * @method OcaBlock#GetMembersRecursive
    * @returns {Promise<OcaBlockMember[]>}
-   *   A promise which resolves to a single value of type ``OcaBlockMember[]``.
+   *   A promise which resolves to a single value of type :class:`OcaBlockMember[]`.
    */
   GetMembersRecursive(): Promise<OcaBlockMember[]>;
 
   /**
-   * Adds a signal path to the block. The return value indicates whether the signal path was successfully added.
+   * Adds a signal path to the block. The return value indicates whether the
+   * signal path was successfully added.
    *
    * @method OcaBlock#AddSignalPath
-   * @param {OcaSignalPath} Path
+   * @param {IOcaSignalPath} Path
    *
    * @returns {Promise<number>}
    *   A promise which resolves to a single value of type ``number``.
@@ -113,7 +118,8 @@ export declare class OcaBlock extends OcaWorker {
   AddSignalPath(Path: IOcaSignalPath): Promise<number>;
 
   /**
-   * Deletes a signal path from the block. The return value indicates whether the signal path was successfully added.
+   * Deletes a signal path from the block. The return value indicates whether
+   * the signal path was successfully added.
    *
    * @method OcaBlock#DeleteSignalPath
    * @param {number} Index
@@ -123,7 +129,8 @@ export declare class OcaBlock extends OcaWorker {
   DeleteSignalPath(Index: number): Promise<void>;
 
   /**
-   * Gets the map of signal paths in the block. Does not recurse inner blocks. The return value indicates whether the list was successfully retrieved.
+   * Gets the map of signal paths in the block. Does not recurse inner blocks.
+   * The return value indicates whether the list was successfully retrieved.
    *
    * @method OcaBlock#GetSignalPaths
    * @returns {Promise<Map<number, OcaSignalPath>>}
@@ -132,7 +139,8 @@ export declare class OcaBlock extends OcaWorker {
   GetSignalPaths(): Promise<Map<number, OcaSignalPath>>;
 
   /**
-   * Gets the mapof signal paths in the block. Recurses inner blocks. The return value indicates whether the list was successfully retrieved.
+   * Gets the mapof signal paths in the block. Recurses inner blocks. The return
+   * value indicates whether the list was successfully retrieved.
    *
    * @method OcaBlock#GetSignalPathsRecursive
    * @returns {Promise<Map<number, OcaSignalPath>>}
@@ -150,7 +158,9 @@ export declare class OcaBlock extends OcaWorker {
   GetMostRecentParamSetIdentifier(): Promise<OcaLibVolIdentifier>;
 
   /**
-   * Applies the referenced paramset to this block, and sets the MostRecentParamSet property. The return value indicates whether the paramset was successfully applied.
+   * Applies the referenced paramset to this block, and sets the
+   * MostRecentParamSet property. The return value indicates whether the
+   * paramset was successfully applied.
    *
    * @method OcaBlock#ApplyParamSet
    * @returns {Promise<OcaLibVolIdentifier>}
@@ -159,7 +169,8 @@ export declare class OcaBlock extends OcaWorker {
   ApplyParamSet(): Promise<OcaLibVolIdentifier>;
 
   /**
-   * Returns a paramset library volume data block which represents the current state of the block -- i.e. a "snapshot".
+   * Returns a paramset library volume data block which represents the current
+   * state of the block -- i.e. a "snapshot".
    *
    * @method OcaBlock#GetCurrentParamSetData
    * @returns {Promise<OcaLibVolData_ParamSet>}
@@ -168,10 +179,12 @@ export declare class OcaBlock extends OcaWorker {
   GetCurrentParamSetData(): Promise<OcaLibVolData_ParamSet>;
 
   /**
-   * Stores a paramset library volume data block which represents the current state of the block ("snapshot") in the given library.  **Replaces** the library volume at the specified LibVolIdentifier.
+   * Stores a paramset library volume data block which represents the current
+   * state of the block ("snapshot") in the given library. **Replaces** the
+   * library volume at the specified LibVolIdentifier.
    *
    * @method OcaBlock#StoreCurrentParamSetData
-   * @param {OcaLibVolIdentifier} LibVolIdentifier
+   * @param {IOcaLibVolIdentifier} LibVolIdentifier
    *
    * @returns {Promise<void>}
    */
@@ -180,7 +193,10 @@ export declare class OcaBlock extends OcaWorker {
   ): Promise<void>;
 
   /**
-   * Gets the global blocktype. The return value indicates whether the type was successfully retrieved. If this block has no global blocktype, the  **Authority**  field of the returned  **GlobalType**  parameter will be zero.  **Added in version 2 of this class.**
+   * Gets the global blocktype. The return value indicates whether the type was
+   * successfully retrieved. If this block has no global blocktype, the
+   * **Authority** field of the returned **GlobalType** parameter will be zero.
+   * **Added in version 2 of this class.**
    *
    * @method OcaBlock#GetGlobalType
    * @returns {Promise<OcaGlobalTypeIdentifier>}
@@ -189,7 +205,8 @@ export declare class OcaBlock extends OcaWorker {
   GetGlobalType(): Promise<OcaGlobalTypeIdentifier>;
 
   /**
-   * Gets the block's ONo map. The return value indicates whether the map was successfully retrieved.  **Added in version 2 of this class.**
+   * Gets the block's ONo map. The return value indicates whether the map was
+   * successfully retrieved. **Added in version 2 of this class.**
    *
    * @method OcaBlock#GetONoMap
    * @returns {Promise<Map<number, number>>}
@@ -198,84 +215,81 @@ export declare class OcaBlock extends OcaWorker {
   GetONoMap(): Promise<Map<number, number>>;
 
   /**
-   * Returns object identifications of all objects in the block that match the given Role search string and Class ID. Return value indicates whether the method succeeded.  **Added in version 2 of this class.**
+   * Returns object identifications of all objects in the block that match the
+   * given Role search string and Class ID. Return value indicates whether the
+   * method succeeded. **Added in version 2 of this class.**
    *
    * @method OcaBlock#FindObjectsByRole
    * @param {string} SearchName
-   *
-   * @param {OcaStringComparisonType} NameComparisonType
-   *
+   * @param {IOcaStringComparisonType} NameComparisonType
    * @param {string} SearchClassID
-   *
-   * @param {number} ResultFlags
+   * @param {IOcaObjectSearchResultFlags} ResultFlags
    *
    * @returns {Promise<OcaObjectSearchResult[]>}
-   *   A promise which resolves to a single value of type ``OcaObjectSearchResult[]``.
+   *   A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
    */
   FindObjectsByRole(
     SearchName: string,
     NameComparisonType: IOcaStringComparisonType,
     SearchClassID: string,
-    ResultFlags: number
+    ResultFlags: IOcaObjectSearchResultFlags
   ): Promise<OcaObjectSearchResult[]>;
 
   /**
-   * Returns block member descriptors of all objects in the block and all contained blocks that match the given Role search string and Class ID.  **Added in version 2 of this class.**
+   * Returns block member descriptors of all objects in the block and all
+   * contained blocks that match the given Role search string and Class ID.
+   * **Added in version 2 of this class.**
    *
    * @method OcaBlock#FindObjectsByRoleRecursive
    * @param {string} SearchName
-   *
-   * @param {OcaStringComparisonType} NameComparisonType
-   *
+   * @param {IOcaStringComparisonType} NameComparisonType
    * @param {string} SearchClassID
-   *
-   * @param {number} ResultFlags
+   * @param {IOcaObjectSearchResultFlags} ResultFlags
    *
    * @returns {Promise<OcaObjectSearchResult[]>}
-   *   A promise which resolves to a single value of type ``OcaObjectSearchResult[]``.
+   *   A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
    */
   FindObjectsByRoleRecursive(
     SearchName: string,
     NameComparisonType: IOcaStringComparisonType,
     SearchClassID: string,
-    ResultFlags: number
+    ResultFlags: IOcaObjectSearchResultFlags
   ): Promise<OcaObjectSearchResult[]>;
 
   /**
-   * Returns object identifications of all objects with the given name path.  **Added in version 2 of this class.**
+   * Returns object identifications of all objects with the given name path.
+   * **Added in version 2 of this class.**
    *
    * @method OcaBlock#FindObjectsByPath
    * @param {string[]} SearchPath
-   *
-   * @param {number} ResultFlags
+   * @param {IOcaObjectSearchResultFlags} ResultFlags
    *
    * @returns {Promise<OcaObjectSearchResult[]>}
-   *   A promise which resolves to a single value of type ``OcaObjectSearchResult[]``.
+   *   A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
    */
   FindObjectsByPath(
     SearchPath: string[],
-    ResultFlags: number
+    ResultFlags: IOcaObjectSearchResultFlags
   ): Promise<OcaObjectSearchResult[]>;
 
   /**
-   * Returns block member descriptors of all objects in the block and all contained blocks that match the given Label search string and Class ID.  **Added in version 2 of this class.**
+   * Returns block member descriptors of all objects in the block and all
+   * contained blocks that match the given Label search string and Class ID.
+   * **Added in version 2 of this class.**
    *
    * @method OcaBlock#FindObjectsByLabelRecursive
    * @param {string} SearchName
-   *
-   * @param {OcaStringComparisonType} NameComparisonType
-   *
+   * @param {IOcaStringComparisonType} NameComparisonType
    * @param {string} SearchClassID
-   *
-   * @param {number} ResultFlags
+   * @param {IOcaObjectSearchResultFlags} ResultFlags
    *
    * @returns {Promise<OcaObjectSearchResult[]>}
-   *   A promise which resolves to a single value of type ``OcaObjectSearchResult[]``.
+   *   A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
    */
   FindObjectsByLabelRecursive(
     SearchName: string,
     NameComparisonType: IOcaStringComparisonType,
     SearchClassID: string,
-    ResultFlags: number
+    ResultFlags: IOcaObjectSearchResultFlags
   ): Promise<OcaObjectSearchResult[]>;
 }