aes70 1.6.1 → 2.0.0

package/src/types/OcaProtoPort.d.ts

@@ -1,25 +1,25 @@
 /*
  * This file has been generated.
  */
-import { IOcaProtoPortID, OcaProtoPortID } from './OcaProtoPortID';
+import { IOcaPortID, OcaPortID } from './OcaPortID';
 
 export declare interface IOcaProtoPort {
   /**
-   * Proto-object number of the proto-member that owns the proto-port. **The
-   * value of 0 (zero) is special, and refers to the block itself, rather than
-   * to any of its members.**
+   * Prototype object number of the prototype member that owns the prototype
+   * port. The value of 0 (zero) is special, and refers to the block itself,
+   * rather than to any of its members.
    * @type number
    */
   Owner: number;
 
   /**
-   * ID of the proto-port.
-   * @type OcaProtoPortID
+   * ID of the prototype port.
+   * @type OcaPortID
    */
-  ProtoID: IOcaProtoPortID;
+  ProtoID: IOcaPortID;
 
   /**
-   * Name of the proto-port.
+   * Name of the prototype port.
    * @type string
    */
   Name: string;
@@ -27,28 +27,26 @@ export declare interface IOcaProtoPort {
 
 export declare class OcaProtoPort implements IOcaProtoPort {
   /**
-   * Representation of an OCA (input or output) proto-port that is used in the
-   * proto-signal path representation of an OCA device.
    * @class OcaProtoPort
    */
-  constructor(Owner: number, ProtoID: OcaProtoPortID, Name: string);
+  constructor(Owner: number, ProtoID: OcaPortID, Name: string);
 
   /**
-   * Proto-object number of the proto-member that owns the proto-port. **The
-   * value of 0 (zero) is special, and refers to the block itself, rather than
-   * to any of its members.**
+   * Prototype object number of the prototype member that owns the prototype
+   * port. The value of 0 (zero) is special, and refers to the block itself,
+   * rather than to any of its members.
    * @type number
    */
   Owner: number;
 
   /**
-   * ID of the proto-port.
-   * @type OcaProtoPortID
+   * ID of the prototype port.
+   * @type OcaPortID
    */
-  ProtoID: OcaProtoPortID;
+  ProtoID: OcaPortID;
 
   /**
-   * Name of the proto-port.
+   * Name of the prototype port.
    * @type string
    */
   Name: string;

package/src/types/OcaProtoPort.js

@@ -4,25 +4,23 @@
 
 export class OcaProtoPort {
   /**
-   * Representation of an OCA (input or output) proto-port that is used in the
-   * proto-signal path representation of an OCA device.
    * @class OcaProtoPort
    */
   constructor(Owner, ProtoID, Name) {
     /**
-     * Proto-object number of the proto-member that owns the proto-port. **The
-     * value of 0 (zero) is special, and refers to the block itself, rather than
-     * to any of its members.**
+     * Prototype object number of the prototype member that owns the prototype
+     * port. The value of 0 (zero) is special, and refers to the block itself,
+     * rather than to any of its members.
      * @type number
      */
     this.Owner = Owner;
     /**
-     * ID of the proto-port.
-     * @type OcaProtoPortID
+     * ID of the prototype port.
+     * @type OcaPortID
      */
     this.ProtoID = ProtoID;
     /**
-     * Name of the proto-port.
+     * Name of the prototype port.
      * @type string
      */
     this.Name = Name;

package/src/types/OcaProtoPortClockMapEntry.d.ts

@@ -0,0 +1,46 @@
+/*
+ * This file has been generated.
+ */
+import {
+  IOcaSamplingRateConverterType,
+  OcaSamplingRateConverterType,
+} from './OcaSamplingRateConverterType';
+
+export declare interface IOcaProtoPortClockMapEntry {
+  /**
+   * Object number of the **OcaMediaClock3** object that clocks this Port. Value
+   * is either a prototype ONo or a regular ONo.
+   * @type (number | number)
+   */
+  ClockONo: number | number;
+
+  /**
+   * Sampling rate converter type - none, asynchronous, synchronous.
+   * @type OcaSamplingRateConverterType
+   */
+  SRCType: IOcaSamplingRateConverterType;
+}
+
+export declare class OcaProtoPortClockMapEntry
+  implements IOcaProtoPortClockMapEntry {
+  /**
+   * Entry describing the clocking and sampling rate conversion (if any) of an
+   * **OcaPort**. Stored in the **ProtoPortClockMap** property of
+   * **OcaBlockFactoryAgent**.
+   * @class OcaProtoPortClockMapEntry
+   */
+  constructor(ClockONo: number | number, SRCType: OcaSamplingRateConverterType);
+
+  /**
+   * Object number of the **OcaMediaClock3** object that clocks this Port. Value
+   * is either a prototype ONo or a regular ONo.
+   * @type (number | number)
+   */
+  ClockONo: number | number;
+
+  /**
+   * Sampling rate converter type - none, asynchronous, synchronous.
+   * @type OcaSamplingRateConverterType
+   */
+  SRCType: OcaSamplingRateConverterType;
+}

package/src/types/OcaProtoPortClockMapEntry.js

@@ -0,0 +1,25 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaProtoPortClockMapEntry {
+  /**
+   * Entry describing the clocking and sampling rate conversion (if any) of an
+   * **OcaPort**. Stored in the **ProtoPortClockMap** property of
+   * **OcaBlockFactoryAgent**.
+   * @class OcaProtoPortClockMapEntry
+   */
+  constructor(ClockONo, SRCType) {
+    /**
+     * Object number of the **OcaMediaClock3** object that clocks this Port.
+     * Value is either a prototype ONo or a regular ONo.
+     * @type (number | number)
+     */
+    this.ClockONo = ClockONo;
+    /**
+     * Sampling rate converter type - none, asynchronous, synchronous.
+     * @type OcaSamplingRateConverterType
+     */
+    this.SRCType = SRCType;
+  }
+}

package/src/types/OcaProtoSignalPath.d.ts

@@ -5,34 +5,36 @@ import { IOcaProtoPort, OcaProtoPort } from './OcaProtoPort';
 
 export declare interface IOcaProtoSignalPath {
   /**
-   * Source proto-port (i.e. output port) of the proto-signal path.
+   * Output port (i.e. signal source) of the prototype signal path.
    * @type OcaProtoPort
    */
-  SourceProtoPort: IOcaProtoPort;
+  OutputProtoPort: IOcaProtoPort;
 
   /**
-   * Sink proto-port (i.e. input port) of the proto-signal path.
+   * Input prototype port (i.e. signal destination port) of the prototype signal
+   * path.
    * @type OcaProtoPort
    */
-  SinkProtoPort: IOcaProtoPort;
+  InputProtoPort: IOcaProtoPort;
 }
 
 export declare class OcaProtoSignalPath implements IOcaProtoSignalPath {
   /**
-   * Proto-signal path between two proto-member ports in a factory.
+   * Prototype signal path between two prototype member ports in a factory.
    * @class OcaProtoSignalPath
    */
-  constructor(SourceProtoPort: OcaProtoPort, SinkProtoPort: OcaProtoPort);
+  constructor(OutputProtoPort: OcaProtoPort, InputProtoPort: OcaProtoPort);
 
   /**
-   * Source proto-port (i.e. output port) of the proto-signal path.
+   * Output port (i.e. signal source) of the prototype signal path.
    * @type OcaProtoPort
    */
-  SourceProtoPort: OcaProtoPort;
+  OutputProtoPort: OcaProtoPort;
 
   /**
-   * Sink proto-port (i.e. input port) of the proto-signal path.
+   * Input prototype port (i.e. signal destination port) of the prototype signal
+   * path.
    * @type OcaProtoPort
    */
-  SinkProtoPort: OcaProtoPort;
+  InputProtoPort: OcaProtoPort;
 }

package/src/types/OcaProtoSignalPath.js

@@ -4,19 +4,20 @@
 
 export class OcaProtoSignalPath {
   /**
-   * Proto-signal path between two proto-member ports in a factory.
+   * Prototype signal path between two prototype member ports in a factory.
    * @class OcaProtoSignalPath
    */
-  constructor(SourceProtoPort, SinkProtoPort) {
+  constructor(OutputProtoPort, InputProtoPort) {
     /**
-     * Source proto-port (i.e. output port) of the proto-signal path.
+     * Output port (i.e. signal source) of the prototype signal path.
      * @type OcaProtoPort
      */
-    this.SourceProtoPort = SourceProtoPort;
+    this.OutputProtoPort = OutputProtoPort;
     /**
-     * Sink proto-port (i.e. input port) of the proto-signal path.
+     * Input prototype port (i.e. signal destination port) of the prototype
+     * signal path.
      * @type OcaProtoPort
      */
-    this.SinkProtoPort = SinkProtoPort;
+    this.InputProtoPort = InputProtoPort;
   }
 }

package/src/types/OcaRamperState.d.ts

@@ -2,28 +2,29 @@
  * This file has been generated.
  */
 /**
- * States of the ramper. Here are the rules for ramper state change:
+ * States of the Ramper . Here are the rules for Ramper state changes:
  *
- *  - A freshly-constructed ramper's state is **NotInitialized**.
+ *  - A freshly-constructed Ramper's state shall be **NotInitialized**.
  *
- *  - A ramper becomes **Initialized** when : The ramper is **NotInitialized**;
- *    AND ** TargetProperty** has been set to a valid value; AND ** Goal** has
- *    been set; AND ** Duration** has been set.
+ *  - A Ramper's state shall become **Initialized** when: Its state is
+ *    **NotInitialized,** AND ** TargetProperty** has been set to a valid value,
+ *    AND ** Goal** has been set, AND ** Duration** has been set.
  *
- *  - A ramper becomes **Scheduled** when It is **Initialized**; AND **Tstart**
- *    and **TimeMode** have been set; AND (T :sub:`start` + **Duration**) is in
- *    the future.
+ *  - A Ramper's state shall become **Scheduled** when: It is **Initialized,**
+ *    AND **StartWhen** has been set, AND The given start time + **Duration** is
+ *    in the future.
  *
- *  - A ramper becomes **Enabled** when it is **Scheduled** AND receives an
- *    *Enable* command.
+ *  - A Ramper's state shall become **Enabled** when: Its state is
+ *    **Scheduled,** AND It receives an **Enable **command.
  *
- *  - A ramper becomes **Ramping** when: It is **Enabled** and the ramp start
- *    time is reached; OR It is **Initialized**, **Scheduled**, or **Enabled**
- *    and a *Start* command is received.
+ *  - A Ramper's state shall become **Ramping** when: It is **Enabled** and the
+ *    ramp start time is reached, OR It is **Initialized**, **Scheduled**, or
+ *    **Enabled** and a **Start** command is received.
  *
- *  - Completion of a ramp or Receipt of a *Halt* command causes the state to
- *    become: **Scheduled**, if T :sub:`start`, Time Mode have been set; AND (T
- *    :sub:`start` + Duration) is in the future. Otherwise, **Initialized.**
+ *  - When a ramp operation completes, or when **Halt** command is received: -
+ *    The Ramper's state shall become **Scheduled**, when: **StartWhen** has
+ *    been set, AND The given start time + **Duration** is in the future. -
+ *    Otherwise, the Ramper's state shall become **Initialized.**
  *
  *
  * @class OcaRamperState
@@ -36,7 +37,7 @@ export class OcaRamperState {
   /**
    * Singleton object corresponding to the entry with value ``2``.
    */
-  static Iniitialized: OcaRamperState;
+  static Initialized: OcaRamperState;
   /**
    * Singleton object corresponding to the entry with value ``3``.
    */
@@ -74,7 +75,7 @@ export class OcaRamperState {
 export type IOcaRamperState =
   | OcaRamperState
   | 'NotInitialized'
-  | 'Iniitialized'
+  | 'Initialized'
   | 'Scheduled'
   | 'Enabled'
   | 'Ramping'

package/src/types/OcaRamperState.js

@@ -4,35 +4,36 @@
 import { Enum } from './Enum.js';
 
 /**
- * States of the ramper. Here are the rules for ramper state change:
+ * States of the Ramper . Here are the rules for Ramper state changes:
  *
- *  - A freshly-constructed ramper's state is **NotInitialized**.
+ *  - A freshly-constructed Ramper's state shall be **NotInitialized**.
  *
- *  - A ramper becomes **Initialized** when : The ramper is **NotInitialized**;
- *    AND ** TargetProperty** has been set to a valid value; AND ** Goal** has
- *    been set; AND ** Duration** has been set.
+ *  - A Ramper's state shall become **Initialized** when: Its state is
+ *    **NotInitialized,** AND ** TargetProperty** has been set to a valid value,
+ *    AND ** Goal** has been set, AND ** Duration** has been set.
  *
- *  - A ramper becomes **Scheduled** when It is **Initialized**; AND **Tstart**
- *    and **TimeMode** have been set; AND (T :sub:`start` + **Duration**) is in
- *    the future.
+ *  - A Ramper's state shall become **Scheduled** when: It is **Initialized,**
+ *    AND **StartWhen** has been set, AND The given start time + **Duration** is
+ *    in the future.
  *
- *  - A ramper becomes **Enabled** when it is **Scheduled** AND receives an
- *    *Enable* command.
+ *  - A Ramper's state shall become **Enabled** when: Its state is
+ *    **Scheduled,** AND It receives an **Enable **command.
  *
- *  - A ramper becomes **Ramping** when: It is **Enabled** and the ramp start
- *    time is reached; OR It is **Initialized**, **Scheduled**, or **Enabled**
- *    and a *Start* command is received.
+ *  - A Ramper's state shall become **Ramping** when: It is **Enabled** and the
+ *    ramp start time is reached, OR It is **Initialized**, **Scheduled**, or
+ *    **Enabled** and a **Start** command is received.
  *
- *  - Completion of a ramp or Receipt of a *Halt* command causes the state to
- *    become: **Scheduled**, if T :sub:`start`, Time Mode have been set; AND (T
- *    :sub:`start` + Duration) is in the future. Otherwise, **Initialized.**
+ *  - When a ramp operation completes, or when **Halt** command is received: -
+ *    The Ramper's state shall become **Scheduled**, when: **StartWhen** has
+ *    been set, AND The given start time + **Duration** is in the future. -
+ *    Otherwise, the Ramper's state shall become **Initialized.**
  *
  *
  * @class OcaRamperState
  */
 export class OcaRamperState extends Enum({
   NotInitialized: 1,
-  Iniitialized: 2,
+  Initialized: 2,
   Scheduled: 3,
   Enabled: 4,
   Ramping: 5,
@@ -48,7 +49,7 @@ export class OcaRamperState extends Enum({
 /**
  * Singleton object corresponding to the entry with value ``2``.
  * @type {OcaRamperState}
- * @member Iniitialized
+ * @member Initialized
  * @memberof OcaRamperState
  * @static
  */

package/src/types/OcaResetCause.d.ts

@@ -22,6 +22,10 @@ export class OcaResetCause {
    * Singleton object corresponding to the entry with value ``3``.
    */
   static ExternalRequest: OcaResetCause;
+  /**
+   * Singleton object corresponding to the entry with value ``255``.
+   */
+  static Unknown: OcaResetCause;
 
   /**
    * Returns the numeric value of this enum entry.
@@ -50,7 +54,9 @@ export type IOcaResetCause =
   | 'InternalError'
   | 'Upgrade'
   | 'ExternalRequest'
+  | 'Unknown'
   | 0
   | 1
   | 2
-  | 3;
+  | 3
+  | 255;

package/src/types/OcaResetCause.js

@@ -12,6 +12,7 @@ export class OcaResetCause extends Enum({
   InternalError: 1,
   Upgrade: 2,
   ExternalRequest: 3,
+  Unknown: 255,
 }) {}
 
 /**
@@ -42,3 +43,10 @@ export class OcaResetCause extends Enum({
  * @memberof OcaResetCause
  * @static
  */
+/**
+ * Singleton object corresponding to the entry with value ``255``.
+ * @type {OcaResetCause}
+ * @member Unknown
+ * @memberof OcaResetCause
+ * @static
+ */

package/src/types/OcaSamplingRateConverterType.d.ts

@@ -0,0 +1,50 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Types of sampling rate converters
+ * @class OcaSamplingRateConverterType
+ */
+export class OcaSamplingRateConverterType {
+  /**
+   * Singleton object corresponding to the entry with value ``0``.
+   */
+  static None: OcaSamplingRateConverterType;
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static Synchronous: OcaSamplingRateConverterType;
+  /**
+   * Singleton object corresponding to the entry with value ``2``.
+   */
+  static Asynchronous: OcaSamplingRateConverterType;
+
+  /**
+   * Returns the numeric value of this enum entry.
+   */
+  valueOf(): number;
+
+  /**
+   * Returns the string representation of this enum entry.
+   */
+  toString(): string;
+
+  /**
+   * Returns the name of an enum entry.
+   */
+  static getName(value: number): string;
+
+  /**
+   * Returns the value of an enum entry name.
+   */
+  static getValue(name: string): number;
+}
+
+export type IOcaSamplingRateConverterType =
+  | OcaSamplingRateConverterType
+  | 'None'
+  | 'Synchronous'
+  | 'Asynchronous'
+  | 0
+  | 1
+  | 2;

package/src/types/OcaSamplingRateConverterType.js

@@ -0,0 +1,36 @@
+/*
+ * This file has been generated.
+ */
+import { Enum } from './Enum.js';
+
+/**
+ * Types of sampling rate converters
+ * @class OcaSamplingRateConverterType
+ */
+export class OcaSamplingRateConverterType extends Enum({
+  None: 0,
+  Synchronous: 1,
+  Asynchronous: 2,
+}) {}
+
+/**
+ * Singleton object corresponding to the entry with value ``0``.
+ * @type {OcaSamplingRateConverterType}
+ * @member None
+ * @memberof OcaSamplingRateConverterType
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaSamplingRateConverterType}
+ * @member Synchronous
+ * @memberof OcaSamplingRateConverterType
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``2``.
+ * @type {OcaSamplingRateConverterType}
+ * @member Asynchronous
+ * @memberof OcaSamplingRateConverterType
+ * @static
+ */

package/src/types/OcaSecurityType.d.ts

@@ -0,0 +1,39 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Security types for stream endpoints
+ * @class OcaSecurityType
+ */
+export class OcaSecurityType {
+  /**
+   * Singleton object corresponding to the entry with value ``0``.
+   */
+  static None: OcaSecurityType;
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static Default: OcaSecurityType;
+
+  /**
+   * Returns the numeric value of this enum entry.
+   */
+  valueOf(): number;
+
+  /**
+   * Returns the string representation of this enum entry.
+   */
+  toString(): string;
+
+  /**
+   * Returns the name of an enum entry.
+   */
+  static getName(value: number): string;
+
+  /**
+   * Returns the value of an enum entry name.
+   */
+  static getValue(name: string): number;
+}
+
+export type IOcaSecurityType = OcaSecurityType | 'None' | 'Default' | 0 | 1;

package/src/types/OcaSecurityType.js

@@ -0,0 +1,28 @@
+/*
+ * This file has been generated.
+ */
+import { Enum } from './Enum.js';
+
+/**
+ * Security types for stream endpoints
+ * @class OcaSecurityType
+ */
+export class OcaSecurityType extends Enum({
+  None: 0,
+  Default: 1,
+}) {}
+
+/**
+ * Singleton object corresponding to the entry with value ``0``.
+ * @type {OcaSecurityType}
+ * @member None
+ * @memberof OcaSecurityType
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaSecurityType}
+ * @member Default
+ * @memberof OcaSecurityType
+ * @static
+ */

package/src/types/OcaSignalPath.d.ts

@@ -5,34 +5,34 @@ import { IOcaPort, OcaPort } from './OcaPort';
 
 export declare interface IOcaSignalPath {
   /**
-   * Source port (i.e. output port) of the signal path.
+   * Output port. Signal originates here.
    * @type OcaPort
    */
-  SourcePort: IOcaPort;
+  OutputPort: IOcaPort;
 
   /**
-   * Sink port (i.e. input port) of the signal path.
+   * Input port. Signal is received here.
    * @type OcaPort
    */
-  SinkPort: IOcaPort;
+  InputPort: IOcaPort;
 }
 
 export declare class OcaSignalPath implements IOcaSignalPath {
   /**
-   * Signal path between two object ports in the same device.
+   * Signal path between two OcaPorts in the same device.
    * @class OcaSignalPath
    */
-  constructor(SourcePort: OcaPort, SinkPort: OcaPort);
+  constructor(OutputPort: OcaPort, InputPort: OcaPort);
 
   /**
-   * Source port (i.e. output port) of the signal path.
+   * Output port. Signal originates here.
    * @type OcaPort
    */
-  SourcePort: OcaPort;
+  OutputPort: OcaPort;
 
   /**
-   * Sink port (i.e. input port) of the signal path.
+   * Input port. Signal is received here.
    * @type OcaPort
    */
-  SinkPort: OcaPort;
+  InputPort: OcaPort;
 }

package/src/types/OcaSignalPath.js

@@ -4,19 +4,19 @@
 
 export class OcaSignalPath {
   /**
-   * Signal path between two object ports in the same device.
+   * Signal path between two OcaPorts in the same device.
    * @class OcaSignalPath
    */
-  constructor(SourcePort, SinkPort) {
+  constructor(OutputPort, InputPort) {
     /**
-     * Source port (i.e. output port) of the signal path.
+     * Output port. Signal originates here.
      * @type OcaPort
      */
-    this.SourcePort = SourcePort;
+    this.OutputPort = OutputPort;
     /**
-     * Sink port (i.e. input port) of the signal path.
+     * Input port. Signal is received here.
      * @type OcaPort
      */
-    this.SinkPort = SinkPort;
+    this.InputPort = InputPort;
   }
 }