aes70 1.6.2 → 2.0.0

package/src/types/OcaGenericEndState.d.ts

@@ -0,0 +1,56 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Reasons why a Commandset terminated
+ * @class OcaGenericEndState
+ */
+export class OcaGenericEndState {
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static CompletedNormally: OcaGenericEndState;
+  /**
+   * Singleton object corresponding to the entry with value ``2``.
+   */
+  static CompletedAbnormally: OcaGenericEndState;
+  /**
+   * Singleton object corresponding to the entry with value ``3``.
+   */
+  static Interrupted: OcaGenericEndState;
+  /**
+   * Singleton object corresponding to the entry with value ``4``.
+   */
+  static Failed: OcaGenericEndState;
+
+  /**
+   * 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 IOcaGenericEndState =
+  | OcaGenericEndState
+  | 'CompletedNormally'
+  | 'CompletedAbnormally'
+  | 'Interrupted'
+  | 'Failed'
+  | 1
+  | 2
+  | 3
+  | 4;

package/src/types/OcaGenericEndState.js

@@ -0,0 +1,44 @@
+/*
+ * This file has been generated.
+ */
+import { Enum } from './Enum.js';
+
+/**
+ * Reasons why a Commandset terminated
+ * @class OcaGenericEndState
+ */
+export class OcaGenericEndState extends Enum({
+  CompletedNormally: 1,
+  CompletedAbnormally: 2,
+  Interrupted: 3,
+  Failed: 4,
+}) {}
+
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaGenericEndState}
+ * @member CompletedNormally
+ * @memberof OcaGenericEndState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``2``.
+ * @type {OcaGenericEndState}
+ * @member CompletedAbnormally
+ * @memberof OcaGenericEndState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``3``.
+ * @type {OcaGenericEndState}
+ * @member Interrupted
+ * @memberof OcaGenericEndState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``4``.
+ * @type {OcaGenericEndState}
+ * @member Failed
+ * @memberof OcaGenericEndState
+ * @static
+ */

package/src/types/OcaGlobalTypeIdentifier.d.ts

@@ -5,15 +5,14 @@
 export declare interface IOcaGlobalTypeIdentifier {
   /**
    * Unique identifier of organization that has authority over this reusable
-   * block type. A zero value indicates a global type defined by the AES70
-   * standard itself.
+   * block type.
    * @type Uint8Array
    */
-  Authority: Uint8Array;
+  Organization: Uint8Array;
 
   /**
-   * ID of library volume type defined by given Authority. Value is unique
-   * within the given Authority.
+   * ID of item defined by given Authority. Value is unique within the given
+   * Authority.
    * @type number
    */
   ID: number;
@@ -22,22 +21,23 @@ export declare interface IOcaGlobalTypeIdentifier {
 export declare class OcaGlobalTypeIdentifier
   implements IOcaGlobalTypeIdentifier {
   /**
-   * Globally unique identifier of something that belongs to an organization.
+   * Globally unique identifier of something that belongs to an organization. An
+   * identifier with both Authority and ID fields of zero shall be interpreted
+   * as a null value.
    * @class OcaGlobalTypeIdentifier
    */
-  constructor(Authority: Uint8Array, ID: number);
+  constructor(Organization: Uint8Array, ID: number);
 
   /**
    * Unique identifier of organization that has authority over this reusable
-   * block type. A zero value indicates a global type defined by the AES70
-   * standard itself.
+   * block type.
    * @type Uint8Array
    */
-  Authority: Uint8Array;
+  Organization: Uint8Array;
 
   /**
-   * ID of library volume type defined by given Authority. Value is unique
-   * within the given Authority.
+   * ID of item defined by given Authority. Value is unique within the given
+   * Authority.
    * @type number
    */
   ID: number;

package/src/types/OcaGlobalTypeIdentifier.js

@@ -4,20 +4,21 @@
 
 export class OcaGlobalTypeIdentifier {
   /**
-   * Globally unique identifier of something that belongs to an organization.
+   * Globally unique identifier of something that belongs to an organization. An
+   * identifier with both Authority and ID fields of zero shall be interpreted
+   * as a null value.
    * @class OcaGlobalTypeIdentifier
    */
-  constructor(Authority, ID) {
+  constructor(Organization, ID) {
     /**
      * Unique identifier of organization that has authority over this reusable
-     * block type. A zero value indicates a global type defined by the AES70
-     * standard itself.
+     * block type.
      * @type Uint8Array
      */
-    this.Authority = Authority;
+    this.Organization = Organization;
     /**
-     * ID of library volume type defined by given Authority. Value is unique
-     * within the given Authority.
+     * ID of item defined by given Authority. Value is unique within the given
+     * Authority.
      * @type number
      */
     this.ID = ID;

package/src/types/OcaGroupException.d.ts

@@ -0,0 +1,53 @@
+/*
+ * This file has been generated.
+ */
+import { IOcaMethodID, OcaMethodID } from './OcaMethodID';
+import { IOcaStatus, OcaStatus } from './OcaStatus';
+
+export declare interface IOcaGroupException {
+  /**
+   * ONo of Group Member raising the exception
+   * @type number
+   */
+  ONo: number;
+
+  /**
+   * Method ID of the called method that returned a not-OK status, thereby
+   * causing the exception.
+   * @type OcaMethodID
+   */
+  MethodID: IOcaMethodID;
+
+  /**
+   * Status code returned by the called method.
+   * @type OcaStatus
+   */
+  Status: IOcaStatus;
+}
+
+export declare class OcaGroupException implements IOcaGroupException {
+  /**
+   * Member of the OcaGroupExceptionEventData list.
+   * @class OcaGroupException
+   */
+  constructor(ONo: number, MethodID: OcaMethodID, Status: OcaStatus);
+
+  /**
+   * ONo of Group Member raising the exception
+   * @type number
+   */
+  ONo: number;
+
+  /**
+   * Method ID of the called method that returned a not-OK status, thereby
+   * causing the exception.
+   * @type OcaMethodID
+   */
+  MethodID: OcaMethodID;
+
+  /**
+   * Status code returned by the called method.
+   * @type OcaStatus
+   */
+  Status: OcaStatus;
+}

package/src/types/OcaGroupException.js

@@ -0,0 +1,28 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaGroupException {
+  /**
+   * Member of the OcaGroupExceptionEventData list.
+   * @class OcaGroupException
+   */
+  constructor(ONo, MethodID, Status) {
+    /**
+     * ONo of Group Member raising the exception
+     * @type number
+     */
+    this.ONo = ONo;
+    /**
+     * Method ID of the called method that returned a not-OK status, thereby
+     * causing the exception.
+     * @type OcaMethodID
+     */
+    this.MethodID = MethodID;
+    /**
+     * Status code returned by the called method.
+     * @type OcaStatus
+     */
+    this.Status = Status;
+  }
+}

package/src/types/OcaGrouperCitizen.d.ts

@@ -5,20 +5,20 @@ import { IOcaOPath, OcaOPath } from './OcaOPath';
 
 export declare interface IOcaGrouperCitizen {
   /**
-   * Index of citizen in Grouper
+   * Index of Citizen in Grouper
    * @type number
    */
   Index: number;
 
   /**
-   * Object path (= hostname + object number) of the worker object that is the
-   * citizen of the grouper.
+   * Object Path (= hostname + Object Number) of the Worker object that is the
+   * Citizen of the Grouper.
    * @type OcaOPath
    */
   ObjectPath: IOcaOPath;
 
   /**
-   * True iff connection from grouper to citizen is healthy.
+   * True if and only if connection from Grouper to Citizen is healthy.
    * @type boolean
    */
   Online: boolean;
@@ -26,27 +26,27 @@ export declare interface IOcaGrouperCitizen {
 
 export declare class OcaGrouperCitizen implements IOcaGrouperCitizen {
   /**
-   * Describes a citizen of a grouper. Refers to a specific worker object
-   * somewhere in the media network.
+   * Describes a Citizen of a Grouper. Refers to a specific Worker object
+   * somewhere in the media network. **Deprecated** in AES70-2024.
    * @class OcaGrouperCitizen
    */
   constructor(Index: number, ObjectPath: OcaOPath, Online: boolean);
 
   /**
-   * Index of citizen in Grouper
+   * Index of Citizen in Grouper
    * @type number
    */
   Index: number;
 
   /**
-   * Object path (= hostname + object number) of the worker object that is the
-   * citizen of the grouper.
+   * Object Path (= hostname + Object Number) of the Worker object that is the
+   * Citizen of the Grouper.
    * @type OcaOPath
    */
   ObjectPath: OcaOPath;
 
   /**
-   * True iff connection from grouper to citizen is healthy.
+   * True if and only if connection from Grouper to Citizen is healthy.
    * @type boolean
    */
   Online: boolean;

package/src/types/OcaGrouperCitizen.js

@@ -4,24 +4,24 @@
 
 export class OcaGrouperCitizen {
   /**
-   * Describes a citizen of a grouper. Refers to a specific worker object
-   * somewhere in the media network.
+   * Describes a Citizen of a Grouper. Refers to a specific Worker object
+   * somewhere in the media network. **Deprecated** in AES70-2024.
    * @class OcaGrouperCitizen
    */
   constructor(Index, ObjectPath, Online) {
     /**
-     * Index of citizen in Grouper
+     * Index of Citizen in Grouper
      * @type number
      */
     this.Index = Index;
     /**
-     * Object path (= hostname + object number) of the worker object that is the
-     * citizen of the grouper.
+     * Object Path (= hostname + Object Number) of the Worker object that is the
+     * Citizen of the Grouper.
      * @type OcaOPath
      */
     this.ObjectPath = ObjectPath;
     /**
-     * True iff connection from grouper to citizen is healthy.
+     * True if and only if connection from Grouper to Citizen is healthy.
      * @type boolean
      */
     this.Online = Online;

package/src/types/OcaGrouperEnrollment.d.ts

@@ -4,15 +4,12 @@
 
 export declare interface IOcaGrouperEnrollment {
   /**
-   * Grouper's index of group in which the citizen identified by CitizenIndex is
-   * enrolled.
+   * Index of Group in which the given Citizen identified is enrolled.
    * @type number
    */
   GroupIndex: number;
 
   /**
-   * Grouper's index of a citizen enrolled in the group identified by
-   * GroupIndex.
    * @type number
    */
   CitizenIndex: number;
@@ -20,21 +17,19 @@ export declare interface IOcaGrouperEnrollment {
 
 export declare class OcaGrouperEnrollment implements IOcaGrouperEnrollment {
   /**
-   * Describes the enrollment of a citizen into a group.
+   * Describes the Enrollment of a Citizen in a Group. **Deprecated** in
+   * AES70-2024.
    * @class OcaGrouperEnrollment
    */
   constructor(GroupIndex: number, CitizenIndex: number);
 
   /**
-   * Grouper's index of group in which the citizen identified by CitizenIndex is
-   * enrolled.
+   * Index of Group in which the given Citizen identified is enrolled.
    * @type number
    */
   GroupIndex: number;
 
   /**
-   * Grouper's index of a citizen enrolled in the group identified by
-   * GroupIndex.
    * @type number
    */
   CitizenIndex: number;

package/src/types/OcaGrouperEnrollment.js

@@ -4,19 +4,17 @@
 
 export class OcaGrouperEnrollment {
   /**
-   * Describes the enrollment of a citizen into a group.
+   * Describes the Enrollment of a Citizen in a Group. **Deprecated** in
+   * AES70-2024.
    * @class OcaGrouperEnrollment
    */
   constructor(GroupIndex, CitizenIndex) {
     /**
-     * Grouper's index of group in which the citizen identified by CitizenIndex
-     * is enrolled.
+     * Index of Group in which the given Citizen identified is enrolled.
      * @type number
      */
     this.GroupIndex = GroupIndex;
     /**
-     * Grouper's index of a citizen enrolled in the group identified by
-     * GroupIndex.
      * @type number
      */
     this.CitizenIndex = CitizenIndex;

package/src/types/OcaGrouperGroup.d.ts

@@ -4,20 +4,20 @@
 
 export declare interface IOcaGrouperGroup {
   /**
-   * Index of group in Grouper
+   * Index of Group in Grouper
    * @type number
    */
   Index: number;
 
   /**
-   * Name of the group.
+   * Name of Group
    * @type string
    */
   Name: string;
 
   /**
-   * Object number of the group's proxy. The proxy's class is the same as the
-   * Grouper's citizen class.
+   * Object Number of the Group's Proxy. The Proxy's class shall be the same as
+   * the Grouper's Citizen Class.
    * @type number
    */
   ProxyONo: number;
@@ -25,26 +25,26 @@ export declare interface IOcaGrouperGroup {
 
 export declare class OcaGrouperGroup implements IOcaGrouperGroup {
   /**
-   * Describes a group in a grouper.
+   * Describes a Group in a Grouper. **Deprecated** in AES70-2024.
    * @class OcaGrouperGroup
    */
   constructor(Index: number, Name: string, ProxyONo: number);
 
   /**
-   * Index of group in Grouper
+   * Index of Group in Grouper
    * @type number
    */
   Index: number;
 
   /**
-   * Name of the group.
+   * Name of Group
    * @type string
    */
   Name: string;
 
   /**
-   * Object number of the group's proxy. The proxy's class is the same as the
-   * Grouper's citizen class.
+   * Object Number of the Group's Proxy. The Proxy's class shall be the same as
+   * the Grouper's Citizen Class.
    * @type number
    */
   ProxyONo: number;

package/src/types/OcaGrouperGroup.js

@@ -4,23 +4,23 @@
 
 export class OcaGrouperGroup {
   /**
-   * Describes a group in a grouper.
+   * Describes a Group in a Grouper. **Deprecated** in AES70-2024.
    * @class OcaGrouperGroup
    */
   constructor(Index, Name, ProxyONo) {
     /**
-     * Index of group in Grouper
+     * Index of Group in Grouper
      * @type number
      */
     this.Index = Index;
     /**
-     * Name of the group.
+     * Name of Group
      * @type string
      */
     this.Name = Name;
     /**
-     * Object number of the group's proxy. The proxy's class is the same as the
-     * Grouper's citizen class.
+     * Object Number of the Group's Proxy. The Proxy's class shall be the same
+     * as the Grouper's Citizen Class.
      * @type number
      */
     this.ProxyONo = ProxyONo;

package/src/types/OcaGrouperMode.d.ts

@@ -2,14 +2,15 @@
  * This file has been generated.
  */
 /**
- * Select mode of **OcaGrouper**: master-slave or peer-to-peer
+ * Select mode of **OcaGrouper**: hierarchical or peer-to-peer. **Deprecated**
+ * in AES70-2024.
  * @class OcaGrouperMode
  */
 export class OcaGrouperMode {
   /**
    * Singleton object corresponding to the entry with value ``1``.
    */
-  static MasterSlave: OcaGrouperMode;
+  static Hierarchical: OcaGrouperMode;
   /**
    * Singleton object corresponding to the entry with value ``2``.
    */
@@ -38,7 +39,7 @@ export class OcaGrouperMode {
 
 export type IOcaGrouperMode =
   | OcaGrouperMode
-  | 'MasterSlave'
+  | 'Hierarchical'
   | 'PeerToPeer'
   | 1
   | 2;

package/src/types/OcaGrouperMode.js

@@ -4,18 +4,19 @@
 import { Enum } from './Enum.js';
 
 /**
- * Select mode of **OcaGrouper**: master-slave or peer-to-peer
+ * Select mode of **OcaGrouper**: hierarchical or peer-to-peer. **Deprecated**
+ * in AES70-2024.
  * @class OcaGrouperMode
  */
 export class OcaGrouperMode extends Enum({
-  MasterSlave: 1,
+  Hierarchical: 1,
   PeerToPeer: 2,
 }) {}
 
 /**
  * Singleton object corresponding to the entry with value ``1``.
  * @type {OcaGrouperMode}
- * @member MasterSlave
+ * @member Hierarchical
  * @memberof OcaGrouperMode
  * @static
  */

package/src/types/OcaGrouperStatusChangeEventData.d.ts

@@ -30,8 +30,8 @@ export declare interface IOcaGrouperStatusChangeEventData {
 export declare class OcaGrouperStatusChangeEventData
   implements IOcaGrouperStatusChangeEventData {
   /**
-   * Class that defines the event data parameter for the **StatusChange** event
-   * defined in **OcaGrouper**.
+   * Notification data supplied by the **OcaGrouper.StatusChange()** event.
+   * **Deprecated** in AES70-2024.
    * @class OcaGrouperStatusChangeEventData
    */
   constructor(

package/src/types/OcaGrouperStatusChangeEventData.js

@@ -4,8 +4,8 @@
 
 export class OcaGrouperStatusChangeEventData {
   /**
-   * Class that defines the event data parameter for the **StatusChange** event
-   * defined in **OcaGrouper**.
+   * Notification data supplied by the **OcaGrouper.StatusChange()** event.
+   * **Deprecated** in AES70-2024.
    * @class OcaGrouperStatusChangeEventData
    */
   constructor(groupIndex, citizenIndex, changeType) {

package/src/types/OcaGrouperStatusChangeType.d.ts

@@ -3,7 +3,7 @@
  */
 /**
  * Enum describing status change types, as used in **OcaGrouper's StatusChange**
- * event.
+ * event. **Deprecated** in AES70-2024.
  * @class OcaGrouperStatusChangeType
  */
 export class OcaGrouperStatusChangeType {

package/src/types/OcaGrouperStatusChangeType.js

@@ -5,7 +5,7 @@ import { Enum } from './Enum.js';
 
 /**
  * Enum describing status change types, as used in **OcaGrouper's StatusChange**
- * event.
+ * event. **Deprecated** in AES70-2024.
  * @class OcaGrouperStatusChangeType
  */
 export class OcaGrouperStatusChangeType extends Enum({

package/src/types/OcaIODirection.d.ts

@@ -0,0 +1,39 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Enum that describes whether a port is for input or output.
+ * @class OcaIODirection
+ */
+export class OcaIODirection {
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static Input: OcaIODirection;
+  /**
+   * Singleton object corresponding to the entry with value ``2``.
+   */
+  static Output: OcaIODirection;
+
+  /**
+   * 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 IOcaIODirection = OcaIODirection | 'Input' | 'Output' | 1 | 2;

package/src/types/OcaIODirection.js

@@ -0,0 +1,28 @@
+/*
+ * This file has been generated.
+ */
+import { Enum } from './Enum.js';
+
+/**
+ * Enum that describes whether a port is for input or output.
+ * @class OcaIODirection
+ */
+export class OcaIODirection extends Enum({
+  Input: 1,
+  Output: 2,
+}) {}
+
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaIODirection}
+ * @member Input
+ * @memberof OcaIODirection
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``2``.
+ * @type {OcaIODirection}
+ * @member Output
+ * @memberof OcaIODirection
+ * @static
+ */