aes70 1.6.2 → 2.0.1

package/src/types/OcaTimeDeliveryMechanism.js

@@ -0,0 +1,191 @@
+/*
+ * This file has been generated.
+ */
+import { Enum } from './Enum.js';
+
+/**
+ * Types of time delivery mechanisms. See [RFC 7273] for a detailed discussion
+ * of time sources , particularly sections 4.4-4.8. See the various time
+ * delivery method specifications (e.g. [IEEE-1588] (PTP) [RFC 5905] (NTP)
+ * [AES11] for more details.
+ * @class OcaTimeDeliveryMechanism
+ */
+export class OcaTimeDeliveryMechanism extends Enum({
+  Undefined: 0,
+  Local: 1,
+  Private: 2,
+  NTP: 3,
+  SNTP: 4,
+  IEEE1588_2002: 5,
+  IEEE1588_2008: 6,
+  IEEE1588_2019: 7,
+  IEEE8021AS: 8,
+  StreamEndpoint: 9,
+  AES11: 11,
+  TerrestrialRadio: 12,
+  GPS: 13,
+  Galileo: 14,
+  GLONASS: 15,
+  Beidou: 16,
+  INRSS: 17,
+  ExpansionBase: 128,
+  None: 1,
+  IEEE1588v1: 5,
+  IEEE1588v2: 6,
+  IEEE1588v2_1: 7,
+}) {}
+
+/**
+ * Singleton object corresponding to the entry with value ``0``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member Undefined
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member Local
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``2``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member Private
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``3``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member NTP
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``4``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member SNTP
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``5``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member IEEE1588_2002
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``6``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member IEEE1588_2008
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``7``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member IEEE1588_2019
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``8``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member IEEE8021AS
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``9``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member StreamEndpoint
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``11``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member AES11
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``12``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member TerrestrialRadio
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``13``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member GPS
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``14``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member Galileo
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``15``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member GLONASS
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``16``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member Beidou
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``17``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member INRSS
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``128``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member ExpansionBase
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member None
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``5``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member IEEE1588v1
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``6``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member IEEE1588v2
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``7``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member IEEE1588v2_1
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */

package/src/types/OcaTimeDeliveryParameters_StreamEndpoint.d.ts

@@ -0,0 +1,40 @@
+/*
+ * This file has been generated.
+ */
+
+export declare interface IOcaTimeDeliveryParameters_StreamEndpoint {
+  /**
+   * ONo of media transport network application object that owns the endpoint.
+   * @type number
+   */
+  EndpointOwner: number;
+
+  /**
+   * Endpoint index within its owner.
+   * @type number
+   */
+  EndpointID: number;
+}
+
+export declare class OcaTimeDeliveryParameters_StreamEndpoint
+  implements IOcaTimeDeliveryParameters_StreamEndpoint {
+  /**
+   * Value of **OcaTimeSource.TimeDeliveryParameters** when
+   * **OcaTimeSource.DeliveryMechanism** = **StreamEndpoint**. This datatype
+   * shall be rendered as a JSON object in the parameter record.
+   * @class OcaTimeDeliveryParameters_StreamEndpoint
+   */
+  constructor(EndpointOwner: number, EndpointID: number);
+
+  /**
+   * ONo of media transport network application object that owns the endpoint.
+   * @type number
+   */
+  EndpointOwner: number;
+
+  /**
+   * Endpoint index within its owner.
+   * @type number
+   */
+  EndpointID: number;
+}

package/src/types/OcaTimeDeliveryParameters_StreamEndpoint.js

@@ -0,0 +1,24 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaTimeDeliveryParameters_StreamEndpoint {
+  /**
+   * Value of **OcaTimeSource.TimeDeliveryParameters** when
+   * **OcaTimeSource.DeliveryMechanism** = **StreamEndpoint**. This datatype
+   * shall be rendered as a JSON object in the parameter record.
+   * @class OcaTimeDeliveryParameters_StreamEndpoint
+   */
+  constructor(EndpointOwner, EndpointID) {
+    /**
+     * ONo of media transport network application object that owns the endpoint.
+     * @type number
+     */
+    this.EndpointOwner = EndpointOwner;
+    /**
+     * Endpoint index within its owner.
+     * @type number
+     */
+    this.EndpointID = EndpointID;
+  }
+}

package/src/types/OcaTimePTP.d.ts

@@ -1,54 +1,7 @@
 /*
  * This file has been generated.
  */
-
-export declare interface IOcaTimePTP {
-  /**
-   * TRUE if and only if time value is negative. Absolute times are always
-   * positive.
-   * @type boolean
-   */
-  Negative: boolean;
-
-  /**
-   * 48 bits of seconds
-   * @type number|BigInt
-   */
-  Seconds: number | BigInt;
-
-  /**
-   * 32 bits of nano seconds
-   * @type number
-   */
-  Nanoseconds: number;
-}
-
-export declare class OcaTimePTP implements IOcaTimePTP {
-  /**
-   * An absolute or relative PTP time. Format is standard PTP format: - 48 bit
-   * integer seconds - 32 bit integer nanoseconds PLUS a boolean sign
-   * (positive=TRUE) field. Absolute times are always positive. Relative times
-   * may be positive or negative.
-   * @class OcaTimePTP
-   */
-  constructor(Negative: boolean, Seconds: number | BigInt, Nanoseconds: number);
-
-  /**
-   * TRUE if and only if time value is negative. Absolute times are always
-   * positive.
-   * @type boolean
-   */
-  Negative: boolean;
-
-  /**
-   * 48 bits of seconds
-   * @type number|BigInt
-   */
-  Seconds: number | BigInt;
-
-  /**
-   * 32 bits of nano seconds
-   * @type number
-   */
-  Nanoseconds: number;
-}
+import { IOcaTime } from './OcaTime';
+import { OcaTime } from './OcaTime';
+export type IOcaTimePTP = IOcaTime;
+export { OcaTime as OcaTimePTP };

package/src/types/OcaTimePTP.js

@@ -1,31 +1,5 @@
 /*
  * This file has been generated.
  */
-
-export class OcaTimePTP {
-  /**
-   * An absolute or relative PTP time. Format is standard PTP format: - 48 bit
-   * integer seconds - 32 bit integer nanoseconds PLUS a boolean sign
-   * (positive=TRUE) field. Absolute times are always positive. Relative times
-   * may be positive or negative.
-   * @class OcaTimePTP
-   */
-  constructor(Negative, Seconds, Nanoseconds) {
-    /**
-     * TRUE if and only if time value is negative. Absolute times are always
-     * positive.
-     * @type boolean
-     */
-    this.Negative = Negative;
-    /**
-     * 48 bits of seconds
-     * @type number|BigInt
-     */
-    this.Seconds = Seconds;
-    /**
-     * 32 bits of nano seconds
-     * @type number
-     */
-    this.Nanoseconds = Nanoseconds;
-  }
-}
+import { OcaTime } from './OcaTime.js';
+export { OcaTime as OcaTimePTP };

package/src/types/OcaTimeReferenceType.d.ts

@@ -2,7 +2,7 @@
  * This file has been generated.
  */
 /**
- * Types of time references.
+ * Types of time references. **This datatype is deprecated as of AES70-2023.**
  * @class OcaTimeReferenceType
  */
 export class OcaTimeReferenceType {
@@ -21,15 +21,11 @@ export class OcaTimeReferenceType {
   /**
    * Singleton object corresponding to the entry with value ``3``.
    */
-  static GPS: OcaTimeReferenceType;
+  static TAI: OcaTimeReferenceType;
   /**
-   * Singleton object corresponding to the entry with value ``4``.
+   * Singleton object corresponding to the entry with value ``128``.
    */
-  static Galileo: OcaTimeReferenceType;
-  /**
-   * Singleton object corresponding to the entry with value ``5``.
-   */
-  static GLONASS: OcaTimeReferenceType;
+  static ExpansionBase: OcaTimeReferenceType;
 
   /**
    * Returns the numeric value of this enum entry.
@@ -57,12 +53,10 @@ export type IOcaTimeReferenceType =
   | 'Undefined'
   | 'Local'
   | 'Private'
-  | 'GPS'
-  | 'Galileo'
-  | 'GLONASS'
+  | 'TAI'
+  | 'ExpansionBase'
   | 0
   | 1
   | 2
   | 3
-  | 4
-  | 5;
+  | 128;

package/src/types/OcaTimeReferenceType.js

@@ -4,16 +4,15 @@
 import { Enum } from './Enum.js';
 
 /**
- * Types of time references.
+ * Types of time references. **This datatype is deprecated as of AES70-2023.**
  * @class OcaTimeReferenceType
  */
 export class OcaTimeReferenceType extends Enum({
   Undefined: 0,
   Local: 1,
   Private: 2,
-  GPS: 3,
-  Galileo: 4,
-  GLONASS: 5,
+  TAI: 3,
+  ExpansionBase: 128,
 }) {}
 
 /**
@@ -40,21 +39,14 @@ export class OcaTimeReferenceType extends Enum({
 /**
  * Singleton object corresponding to the entry with value ``3``.
  * @type {OcaTimeReferenceType}
- * @member GPS
+ * @member TAI
  * @memberof OcaTimeReferenceType
  * @static
  */
 /**
- * Singleton object corresponding to the entry with value ``4``.
+ * Singleton object corresponding to the entry with value ``128``.
  * @type {OcaTimeReferenceType}
- * @member Galileo
- * @memberof OcaTimeReferenceType
- * @static
- */
-/**
- * Singleton object corresponding to the entry with value ``5``.
- * @type {OcaTimeReferenceType}
- * @member GLONASS
+ * @member ExpansionBase
  * @memberof OcaTimeReferenceType
  * @static
  */

package/src/types/OcaTimeSourceAvailability.d.ts

@@ -2,7 +2,7 @@
  * This file has been generated.
  */
 /**
- * States of time sources
+ * Availability states of a time source
  * @class OcaTimeSourceAvailability
  */
 export class OcaTimeSourceAvailability {

package/src/types/OcaTimeSourceAvailability.js

@@ -4,7 +4,7 @@
 import { Enum } from './Enum.js';
 
 /**
- * States of time sources
+ * Availability states of a time source
  * @class OcaTimeSourceAvailability
  */
 export class OcaTimeSourceAvailability extends Enum({

package/src/types/OcaTimeSourceSyncStatus.d.ts

@@ -2,7 +2,7 @@
  * This file has been generated.
  */
 /**
- * Synchronization statuses.
+ * Synchronization status of a time source.
  * @class OcaTimeSourceSyncStatus
  */
 export class OcaTimeSourceSyncStatus {

package/src/types/OcaTimeSourceSyncStatus.js

@@ -4,7 +4,7 @@
 import { Enum } from './Enum.js';
 
 /**
- * Synchronization statuses.
+ * Synchronization status of a time source.
  * @class OcaTimeSourceSyncStatus
  */
 export class OcaTimeSourceSyncStatus extends Enum({

package/src/types/OcaTransferFunction.d.ts

@@ -24,7 +24,7 @@ export declare interface IOcaTransferFunction {
 
 export declare class OcaTransferFunction implements IOcaTransferFunction {
   /**
-   * A complex (i.e. magnitude + phase) transfer function.
+   * Complex (i.e. magnitude + phase) transfer function.
    * @class OcaTransferFunction
    */
   constructor(Frequency: number[], Amplitude: number[], Phase: number[]);

package/src/types/OcaTransferFunction.js

@@ -4,7 +4,7 @@
 
 export class OcaTransferFunction {
   /**
-   * A complex (i.e. magnitude + phase) transfer function.
+   * Complex (i.e. magnitude + phase) transfer function.
    * @class OcaTransferFunction
    */
   constructor(Frequency, Amplitude, Phase) {

package/src/types/OcaTypedBlob.d.ts

@@ -0,0 +1,40 @@
+/*
+ * This file has been generated.
+ */
+
+export declare interface IOcaTypedBlob {
+  /**
+   * MIME type of the content of the **Content** field.
+   * @type string
+   */
+  ContentType: string;
+
+  /**
+   * **OcaBlob** whose payload has the format specified by the **ContentType**
+   * field.
+   * @type Uint8Array
+   */
+  Content: Uint8Array;
+}
+
+export declare class OcaTypedBlob implements IOcaTypedBlob {
+  /**
+   * **OcaBlob** with ancillary field that shall specify the MIME type of the
+   * **OcaBlob's** content.
+   * @class OcaTypedBlob
+   */
+  constructor(ContentType: string, Content: Uint8Array);
+
+  /**
+   * MIME type of the content of the **Content** field.
+   * @type string
+   */
+  ContentType: string;
+
+  /**
+   * **OcaBlob** whose payload has the format specified by the **ContentType**
+   * field.
+   * @type Uint8Array
+   */
+  Content: Uint8Array;
+}

package/src/types/OcaTypedBlob.js

@@ -0,0 +1,24 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaTypedBlob {
+  /**
+   * **OcaBlob** with ancillary field that shall specify the MIME type of the
+   * **OcaBlob's** content.
+   * @class OcaTypedBlob
+   */
+  constructor(ContentType, Content) {
+    /**
+     * MIME type of the content of the **Content** field.
+     * @type string
+     */
+    this.ContentType = ContentType;
+    /**
+     * **OcaBlob** whose payload has the format specified by the **ContentType**
+     * field.
+     * @type Uint8Array
+     */
+    this.Content = Content;
+  }
+}

package/src/types/OcaVariant.d.ts

@@ -0,0 +1,19 @@
+export declare class OcaVariant {
+  /**
+   * A class holding the value of an OcaVariant.
+   * @class OcaVariant
+   */
+  constructor(index: number, value: unknown);
+
+  /**
+   * The index of the variant alternative.
+   * @type number
+   */
+  Index: number;
+
+  /**
+   * The value.
+   * @type any
+   */
+  Value: unknown;
+}

package/src/types/OcaVariant.js

@@ -0,0 +1,18 @@
+export class OcaVariant {
+  /**
+   * A class holding the value of an OcaVariant.
+   * @class OcaVariant
+   */
+  constructor(index, value) {
+    /**
+     * The index of the variant alternative.
+     * @type number
+     */
+    this.Index = index;
+    /**
+     * The value.
+     * @type any
+     */
+    this.Value = value;
+  }
+}

package/src/types/OcaWhenPhysicalAbsolute.d.ts

@@ -0,0 +1,39 @@
+/*
+ * This file has been generated.
+ */
+import { IOcaTime, OcaTime } from './OcaTime';
+
+export declare interface IOcaWhenPhysicalAbsolute {
+  /**
+   * ONo of an **OcaTimeSource** object or zero to use device time - 4 bytes
+   * @type number
+   */
+  TimeRefONo: number;
+
+  /**
+   * Absolute physical time.
+   * @type OcaTime
+   */
+  Value: IOcaTime;
+}
+
+export declare class OcaWhenPhysicalAbsolute
+  implements IOcaWhenPhysicalAbsolute {
+  /**
+   * Absolute physical time.
+   * @class OcaWhenPhysicalAbsolute
+   */
+  constructor(TimeRefONo: number, Value: OcaTime);
+
+  /**
+   * ONo of an **OcaTimeSource** object or zero to use device time - 4 bytes
+   * @type number
+   */
+  TimeRefONo: number;
+
+  /**
+   * Absolute physical time.
+   * @type OcaTime
+   */
+  Value: OcaTime;
+}

package/src/types/OcaWhenPhysicalAbsolute.js

@@ -0,0 +1,22 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaWhenPhysicalAbsolute {
+  /**
+   * Absolute physical time.
+   * @class OcaWhenPhysicalAbsolute
+   */
+  constructor(TimeRefONo, Value) {
+    /**
+     * ONo of an **OcaTimeSource** object or zero to use device time - 4 bytes
+     * @type number
+     */
+    this.TimeRefONo = TimeRefONo;
+    /**
+     * Absolute physical time.
+     * @type OcaTime
+     */
+    this.Value = Value;
+  }
+}