aes70 1.6.1 → 2.0.0

package/src/types/OcaObjectSearchResult.d.ts

@@ -1,86 +1,7 @@
 /*
  * This file has been generated.
  */
-import {
-  IOcaClassIdentification,
-  OcaClassIdentification,
-} from './OcaClassIdentification';
-
-export declare interface IOcaObjectSearchResult {
-  /**
-   * ONo of object found
-   * @type number
-   */
-  ONo: number;
-
-  /**
-   * Class identification (class ID + class version) of object found
-   * @type OcaClassIdentification
-   */
-  ClassIdentification: IOcaClassIdentification;
-
-  /**
-   * Chain of ONos leading from root to this object's container
-   * @type number[]
-   */
-  ContainerPath: number[];
-
-  /**
-   * Object role in device
-   * @type string
-   */
-  Role: string;
-
-  /**
-   * Object user-specified label
-   * @type string
-   */
-  Label: string;
-}
-
-export declare class OcaObjectSearchResult implements IOcaObjectSearchResult {
-  /**
-   * Result of object search via the Find...() methods of **OcaBlock**. Dynamic
-   * format, form used depends on type of search and options. The FieldMap
-   * parameter of the Find...() methods specifies which optional fields should
-   * be returned as nonnull.
-   * @class OcaObjectSearchResult
-   */
-  constructor(
-    ONo: number,
-    ClassIdentification: OcaClassIdentification,
-    ContainerPath: number[],
-    Role: string,
-    Label: string
-  );
-
-  /**
-   * ONo of object found
-   * @type number
-   */
-  ONo: number;
-
-  /**
-   * Class identification (class ID + class version) of object found
-   * @type OcaClassIdentification
-   */
-  ClassIdentification: OcaClassIdentification;
-
-  /**
-   * Chain of ONos leading from root to this object's container
-   * @type number[]
-   */
-  ContainerPath: number[];
-
-  /**
-   * Object role in device
-   * @type string
-   */
-  Role: string;
-
-  /**
-   * Object user-specified label
-   * @type string
-   */
-  Label: string;
-}
+import { IOcaActionObjectSearchResult } from './OcaActionObjectSearchResult';
+import { OcaActionObjectSearchResult } from './OcaActionObjectSearchResult';
+export type IOcaObjectSearchResult = IOcaActionObjectSearchResult;
+export { OcaActionObjectSearchResult as OcaObjectSearchResult };

package/src/types/OcaObjectSearchResult.js

@@ -1,40 +1,5 @@
 /*
  * This file has been generated.
  */
-
-export class OcaObjectSearchResult {
-  /**
-   * Result of object search via the Find...() methods of **OcaBlock**. Dynamic
-   * format, form used depends on type of search and options. The FieldMap
-   * parameter of the Find...() methods specifies which optional fields should
-   * be returned as nonnull.
-   * @class OcaObjectSearchResult
-   */
-  constructor(ONo, ClassIdentification, ContainerPath, Role, Label) {
-    /**
-     * ONo of object found
-     * @type number
-     */
-    this.ONo = ONo;
-    /**
-     * Class identification (class ID + class version) of object found
-     * @type OcaClassIdentification
-     */
-    this.ClassIdentification = ClassIdentification;
-    /**
-     * Chain of ONos leading from root to this object's container
-     * @type number[]
-     */
-    this.ContainerPath = ContainerPath;
-    /**
-     * Object role in device
-     * @type string
-     */
-    this.Role = Role;
-    /**
-     * Object user-specified label
-     * @type string
-     */
-    this.Label = Label;
-  }
-}
+import { OcaActionObjectSearchResult } from './OcaActionObjectSearchResult.js';
+export { OcaActionObjectSearchResult as OcaObjectSearchResult };

package/src/types/OcaObjectSearchResultFlags.d.ts

@@ -1,36 +1,7 @@
 /*
  * This file has been generated.
  */
-/**
- * Bitset that describes the contents of an **OcaSearchResult**
- * @enum {number}
- * @readonly
- */
-export declare const OcaObjectSearchResultFlags: {
-  /**
-   * Entry with value ``1``.
-   */
-  ONo: number;
-
-  /**
-   * Entry with value ``2``.
-   */
-  ClassIdentification: number;
-
-  /**
-   * Entry with value ``4``.
-   */
-  ContainerPath: number;
-
-  /**
-   * Entry with value ``8``.
-   */
-  Role: number;
-
-  /**
-   * Entry with value ``16``.
-   */
-  Label: number;
-};
-
-export declare type IOcaObjectSearchResultFlags = number;
+import { IOcaActionObjectSearchResultFlags } from './OcaActionObjectSearchResultFlags';
+import { OcaActionObjectSearchResultFlags } from './OcaActionObjectSearchResultFlags';
+export type IOcaObjectSearchResultFlags = IOcaActionObjectSearchResultFlags;
+export { OcaActionObjectSearchResultFlags as OcaObjectSearchResultFlags };

package/src/types/OcaObjectSearchResultFlags.js

@@ -1,51 +1,5 @@
 /*
  * This file has been generated.
  */
-/**
- * Bitset that describes the contents of an **OcaSearchResult**
- * @enum {number}
- * @readonly
- */
-export const OcaObjectSearchResultFlags = {
-  ONo: 1,
-  ClassIdentification: 2,
-  ContainerPath: 4,
-  Role: 8,
-  Label: 16,
-};
-
-/**
- * Entry with value ``1``.
- * @type {number}
- * @member ONo
- * @memberof OcaObjectSearchResultFlags
- * @static
- */
-/**
- * Entry with value ``2``.
- * @type {number}
- * @member ClassIdentification
- * @memberof OcaObjectSearchResultFlags
- * @static
- */
-/**
- * Entry with value ``4``.
- * @type {number}
- * @member ContainerPath
- * @memberof OcaObjectSearchResultFlags
- * @static
- */
-/**
- * Entry with value ``8``.
- * @type {number}
- * @member Role
- * @memberof OcaObjectSearchResultFlags
- * @static
- */
-/**
- * Entry with value ``16``.
- * @type {number}
- * @member Label
- * @memberof OcaObjectSearchResultFlags
- * @static
- */
+import { OcaActionObjectSearchResultFlags } from './OcaActionObjectSearchResultFlags.js';
+export { OcaActionObjectSearchResultFlags as OcaObjectSearchResultFlags };

package/src/types/OcaObservationEventData.d.ts

@@ -13,8 +13,8 @@ export declare interface IOcaObservationEventData {
 export declare class OcaObservationEventData
   implements IOcaObservationEventData {
   /**
-   * Event data for event **OcaNumericObserver.Observation**. Note: due to an
-   * error in AES70-2015, this class was not made a subclass of
+   * Notification data supplied by event **OcaNumericObserver.Observation**.
+   * Note: due to an error in AES70-2015, this class was not made a subclass of
    * **OcaEventData**. Therefore, this class explicitly defines the **Event**
    * property explicitly, rather than inheriting it from **OcaEventData,** as
    * other event data classes do. However, the effect is the same as for all

package/src/types/OcaObservationEventData.js

@@ -4,8 +4,8 @@
 
 export class OcaObservationEventData {
   /**
-   * Event data for event **OcaNumericObserver.Observation**. Note: due to an
-   * error in AES70-2015, this class was not made a subclass of
+   * Notification data supplied by event **OcaNumericObserver.Observation**.
+   * Note: due to an error in AES70-2015, this class was not made a subclass of
    * **OcaEventData**. Therefore, this class explicitly defines the **Event**
    * property explicitly, rather than inheriting it from **OcaEventData,** as
    * other event data classes do. However, the effect is the same as for all

package/src/types/OcaObservationListEventData.d.ts

@@ -13,8 +13,8 @@ export declare interface IOcaObservationListEventData {
 export declare class OcaObservationListEventData
   implements IOcaObservationListEventData {
   /**
-   * Event data for event **OcaNumericObserverList.Observation**. Note: due to
-   * an error in AES70-2015, this class was not made a subclass of
+   * Notification data supplied by event **OcaNumericObserverList.Observation**.
+   * Note: due to an error in AES70-2015, this class was not made a subclass of
    * **OcaEventData**. Therefore, this class explicitly defines the **Event**
    * property explicitly, rather than inheriting it from **OcaEventData,** as
    * other event data classes do. However, the effect is the same as for all

package/src/types/OcaObservationListEventData.js

@@ -4,8 +4,8 @@
 
 export class OcaObservationListEventData {
   /**
-   * Event data for event **OcaNumericObserverList.Observation**. Note: due to
-   * an error in AES70-2015, this class was not made a subclass of
+   * Notification data supplied by event **OcaNumericObserverList.Observation**.
+   * Note: due to an error in AES70-2015, this class was not made a subclass of
    * **OcaEventData**. Therefore, this class explicitly defines the **Event**
    * property explicitly, rather than inheriting it from **OcaEventData,** as
    * other event data classes do. However, the effect is the same as for all

package/src/types/OcaObserverState.d.ts

@@ -2,7 +2,7 @@
  * This file has been generated.
  */
 /**
- * Interpolation law for ramper to use.
+ * State of observer
  * @class OcaObserverState
  */
 export class OcaObserverState {

package/src/types/OcaObserverState.js

@@ -4,7 +4,7 @@
 import { Enum } from './Enum.js';
 
 /**
- * Interpolation law for ramper to use.
+ * State of observer
  * @class OcaObserverState
  */
 export class OcaObserverState extends Enum({

package/src/types/OcaParameterMask.d.ts

@@ -8,6 +8,86 @@
  * @enum {number}
  * @readonly
  */
-export declare const OcaParameterMask: Record<string, never>;
+export declare const OcaParameterMask: {
+  /**
+   * Entry with value ``1``.
+   */
+  Par1: number;
+
+  /**
+   * Entry with value ``2``.
+   */
+  Par2: number;
+
+  /**
+   * Entry with value ``4``.
+   */
+  Par3: number;
+
+  /**
+   * Entry with value ``8``.
+   */
+  Par4: number;
+
+  /**
+   * Entry with value ``16``.
+   */
+  Par5: number;
+
+  /**
+   * Entry with value ``32``.
+   */
+  Par6: number;
+
+  /**
+   * Entry with value ``64``.
+   */
+  Par7: number;
+
+  /**
+   * Entry with value ``128``.
+   */
+  Par8: number;
+
+  /**
+   * Entry with value ``256``.
+   */
+  Par9: number;
+
+  /**
+   * Entry with value ``512``.
+   */
+  Par10: number;
+
+  /**
+   * Entry with value ``1024``.
+   */
+  Par11: number;
+
+  /**
+   * Entry with value ``2048``.
+   */
+  Par12: number;
+
+  /**
+   * Entry with value ``4096``.
+   */
+  Par13: number;
+
+  /**
+   * Entry with value ``8192``.
+   */
+  Par14: number;
+
+  /**
+   * Entry with value ``16384``.
+   */
+  Par15: number;
+
+  /**
+   * Entry with value ``32768``.
+   */
+  Par16: number;
+};
 
 export declare type IOcaParameterMask = number;

package/src/types/OcaParameterMask.js

@@ -8,4 +8,134 @@
  * @enum {number}
  * @readonly
  */
-export const OcaParameterMask = {};
+export const OcaParameterMask = {
+  Par1: 1,
+  Par2: 2,
+  Par3: 4,
+  Par4: 8,
+  Par5: 16,
+  Par6: 32,
+  Par7: 64,
+  Par8: 128,
+  Par9: 256,
+  Par10: 512,
+  Par11: 1024,
+  Par12: 2048,
+  Par13: 4096,
+  Par14: 8192,
+  Par15: 16384,
+  Par16: 32768,
+};
+
+/**
+ * Entry with value ``1``.
+ * @type {number}
+ * @member Par1
+ * @memberof OcaParameterMask
+ * @static
+ */
+/**
+ * Entry with value ``2``.
+ * @type {number}
+ * @member Par2
+ * @memberof OcaParameterMask
+ * @static
+ */
+/**
+ * Entry with value ``4``.
+ * @type {number}
+ * @member Par3
+ * @memberof OcaParameterMask
+ * @static
+ */
+/**
+ * Entry with value ``8``.
+ * @type {number}
+ * @member Par4
+ * @memberof OcaParameterMask
+ * @static
+ */
+/**
+ * Entry with value ``16``.
+ * @type {number}
+ * @member Par5
+ * @memberof OcaParameterMask
+ * @static
+ */
+/**
+ * Entry with value ``32``.
+ * @type {number}
+ * @member Par6
+ * @memberof OcaParameterMask
+ * @static
+ */
+/**
+ * Entry with value ``64``.
+ * @type {number}
+ * @member Par7
+ * @memberof OcaParameterMask
+ * @static
+ */
+/**
+ * Entry with value ``128``.
+ * @type {number}
+ * @member Par8
+ * @memberof OcaParameterMask
+ * @static
+ */
+/**
+ * Entry with value ``256``.
+ * @type {number}
+ * @member Par9
+ * @memberof OcaParameterMask
+ * @static
+ */
+/**
+ * Entry with value ``512``.
+ * @type {number}
+ * @member Par10
+ * @memberof OcaParameterMask
+ * @static
+ */
+/**
+ * Entry with value ``1024``.
+ * @type {number}
+ * @member Par11
+ * @memberof OcaParameterMask
+ * @static
+ */
+/**
+ * Entry with value ``2048``.
+ * @type {number}
+ * @member Par12
+ * @memberof OcaParameterMask
+ * @static
+ */
+/**
+ * Entry with value ``4096``.
+ * @type {number}
+ * @member Par13
+ * @memberof OcaParameterMask
+ * @static
+ */
+/**
+ * Entry with value ``8192``.
+ * @type {number}
+ * @member Par14
+ * @memberof OcaParameterMask
+ * @static
+ */
+/**
+ * Entry with value ``16384``.
+ * @type {number}
+ * @member Par15
+ * @memberof OcaParameterMask
+ * @static
+ */
+/**
+ * Entry with value ``32768``.
+ * @type {number}
+ * @member Par16
+ * @memberof OcaParameterMask
+ * @static
+ */

package/src/types/OcaPort.d.ts

@@ -17,10 +17,11 @@ export declare interface IOcaPort {
   ID: IOcaPortID;
 
   /**
-   * Port ID of the port.
+   * Role of the port in the containing object. Values beginning with "oca" in
+   * any character case are reserved for AES use.
    * @type string
    */
-  Name: string;
+  Role: string;
 }
 
 export declare class OcaPort implements IOcaPort {
@@ -29,7 +30,7 @@ export declare class OcaPort implements IOcaPort {
    * path representation of an OCA device.
    * @class OcaPort
    */
-  constructor(Owner: number, ID: OcaPortID, Name: string);
+  constructor(Owner: number, ID: OcaPortID, Role: string);
 
   /**
    * Object number of the object that owns the port.
@@ -44,8 +45,9 @@ export declare class OcaPort implements IOcaPort {
   ID: OcaPortID;
 
   /**
-   * Port ID of the port.
+   * Role of the port in the containing object. Values beginning with "oca" in
+   * any character case are reserved for AES use.
    * @type string
    */
-  Name: string;
+  Role: string;
 }

package/src/types/OcaPort.js

@@ -8,7 +8,7 @@ export class OcaPort {
    * path representation of an OCA device.
    * @class OcaPort
    */
-  constructor(Owner, ID, Name) {
+  constructor(Owner, ID, Role) {
     /**
      * Object number of the object that owns the port.
      * @type number
@@ -20,9 +20,10 @@ export class OcaPort {
      */
     this.ID = ID;
     /**
-     * Port ID of the port.
+     * Role of the port in the containing object. Values beginning with "oca" in
+     * any character case are reserved for AES use.
      * @type string
      */
-    this.Name = Name;
+    this.Role = Role;
   }
 }

package/src/types/OcaPortClockMapEntry.d.ts

@@ -0,0 +1,42 @@
+/*
+ * This file has been generated.
+ */
+import {
+  IOcaSamplingRateConverterType,
+  OcaSamplingRateConverterType,
+} from './OcaSamplingRateConverterType';
+
+export declare interface IOcaPortClockMapEntry {
+  /**
+   * Object number of the **OcaMediaClock3** object that clocks this port.
+   * @type number
+   */
+  ClockONo: number;
+
+  /**
+   * Sampling Rate Converter (SRC) type - none, asynchronous, synchronous.
+   * @type OcaSamplingRateConverterType
+   */
+  SRCType: IOcaSamplingRateConverterType;
+}
+
+export declare class OcaPortClockMapEntry implements IOcaPortClockMapEntry {
+  /**
+   * Port clock map entry that describes the clocking and sample-rate conversion
+   * (if any) of an **OcaPort**.
+   * @class OcaPortClockMapEntry
+   */
+  constructor(ClockONo: number, SRCType: OcaSamplingRateConverterType);
+
+  /**
+   * Object number of the **OcaMediaClock3** object that clocks this port.
+   * @type number
+   */
+  ClockONo: number;
+
+  /**
+   * Sampling Rate Converter (SRC) type - none, asynchronous, synchronous.
+   * @type OcaSamplingRateConverterType
+   */
+  SRCType: OcaSamplingRateConverterType;
+}

package/src/types/OcaPortClockMapEntry.js

@@ -0,0 +1,23 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaPortClockMapEntry {
+  /**
+   * Port clock map entry that describes the clocking and sample-rate conversion
+   * (if any) of an **OcaPort**.
+   * @class OcaPortClockMapEntry
+   */
+  constructor(ClockONo, SRCType) {
+    /**
+     * Object number of the **OcaMediaClock3** object that clocks this port.
+     * @type number
+     */
+    this.ClockONo = ClockONo;
+    /**
+     * Sampling Rate Converter (SRC) type - none, asynchronous, synchronous.
+     * @type OcaSamplingRateConverterType
+     */
+    this.SRCType = SRCType;
+  }
+}

package/src/types/OcaPortID.d.ts

@@ -1,14 +1,15 @@
 /*
  * This file has been generated.
  */
-import { IOcaPortMode, OcaPortMode } from './OcaPortMode';
+import { IOcaIODirection, OcaIODirection } from './OcaIODirection';
 
 export declare interface IOcaPortID {
   /**
-   * Enum that indicates whether the port is for input or output.
-   * @type OcaPortMode
+   * Indicates whether the port is for input or output. Before OCA 1.5, was
+   * named **Mode**, with (now-renamed) datatype **OcaPortMode.**
+   * @type OcaIODirection
    */
-  Mode: IOcaPortMode;
+  Direction: IOcaIODirection;
 
   /**
    * Index of port within given input or output set of specified object.
@@ -19,18 +20,19 @@ export declare interface IOcaPortID {
 
 export declare class OcaPortID implements IOcaPortID {
   /**
-   * Unique identifier of input or output port within a given worker or block
+   * Unique identifier of input or output Port within a given Worker or Block
    * class. Port numbers are ordinals starting at 1, and there are separate
-   * numbering spaces for input and output ports.
+   * numbering spaces for input and output Ports.
    * @class OcaPortID
    */
-  constructor(Mode: OcaPortMode, Index: number);
+  constructor(Direction: OcaIODirection, Index: number);
 
   /**
-   * Enum that indicates whether the port is for input or output.
-   * @type OcaPortMode
+   * Indicates whether the port is for input or output. Before OCA 1.5, was
+   * named **Mode**, with (now-renamed) datatype **OcaPortMode.**
+   * @type OcaIODirection
    */
-  Mode: OcaPortMode;
+  Direction: OcaIODirection;
 
   /**
    * Index of port within given input or output set of specified object.