aes70 1.6.1 → 2.0.0

package/src/types/OcaNetworkAdvertisingService.d.ts

@@ -0,0 +1,56 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Network advertising services.
+ * @class OcaNetworkAdvertisingService
+ */
+export class OcaNetworkAdvertisingService {
+  /**
+   * Singleton object corresponding to the entry with value ``0``.
+   */
+  static DNSSD: OcaNetworkAdvertisingService;
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static MDNS_DNSSD: OcaNetworkAdvertisingService;
+  /**
+   * Singleton object corresponding to the entry with value ``2``.
+   */
+  static NMOS: OcaNetworkAdvertisingService;
+  /**
+   * Singleton object corresponding to the entry with value ``128``.
+   */
+  static ExpansionBase: OcaNetworkAdvertisingService;
+
+  /**
+   * 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 IOcaNetworkAdvertisingService =
+  | OcaNetworkAdvertisingService
+  | 'DNSSD'
+  | 'MDNS_DNSSD'
+  | 'NMOS'
+  | 'ExpansionBase'
+  | 0
+  | 1
+  | 2
+  | 128;

package/src/types/OcaNetworkAdvertisingService.js

@@ -0,0 +1,44 @@
+/*
+ * This file has been generated.
+ */
+import { Enum } from './Enum.js';
+
+/**
+ * Network advertising services.
+ * @class OcaNetworkAdvertisingService
+ */
+export class OcaNetworkAdvertisingService extends Enum({
+  DNSSD: 0,
+  MDNS_DNSSD: 1,
+  NMOS: 2,
+  ExpansionBase: 128,
+}) {}
+
+/**
+ * Singleton object corresponding to the entry with value ``0``.
+ * @type {OcaNetworkAdvertisingService}
+ * @member DNSSD
+ * @memberof OcaNetworkAdvertisingService
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaNetworkAdvertisingService}
+ * @member MDNS_DNSSD
+ * @memberof OcaNetworkAdvertisingService
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``2``.
+ * @type {OcaNetworkAdvertisingService}
+ * @member NMOS
+ * @memberof OcaNetworkAdvertisingService
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``128``.
+ * @type {OcaNetworkAdvertisingService}
+ * @member ExpansionBase
+ * @memberof OcaNetworkAdvertisingService
+ * @static
+ */

package/src/types/OcaNetworkInterfaceAssignment.d.ts

@@ -0,0 +1,99 @@
+/*
+ * This file has been generated.
+ */
+import {
+  IOcaNetworkAdvertisingMechanism,
+  OcaNetworkAdvertisingMechanism,
+} from './OcaNetworkAdvertisingMechanism';
+
+export declare interface IOcaNetworkInterfaceAssignment {
+  /**
+   * Internal ID of Network Assignment. Unique within the instance of
+   * **OcaMediaTransportApplication** (or subclass)**** that owns the
+   * Assignment.
+   * @type number
+   */
+  ID: number;
+
+  /**
+   * ONo of the Network Interface
+   * @type number
+   */
+  NetworkInterfaceONo: number;
+
+  /**
+   * Assignment-specific parameters. Format depends on application. For example,
+   * IP-based applications can use this field to designate the IP port being
+   * used.
+   * @type Uint8Array
+   */
+  NetworkBindingParameters: Uint8Array;
+
+  /**
+   * List of identities of security keys that apply to this assignment. Assumes
+   * the identities refer to private shared keys registered in
+   * **OcaSecurityManager**.
+   * @type string[]
+   */
+  SecurityKeyIdentities: string[];
+
+  /**
+   * List of advertising mechanisms associated with this Assignment. May be
+   * empty.
+   * @type OcaNetworkAdvertisingMechanism[]
+   */
+  AdvertisingMechanisms: IOcaNetworkAdvertisingMechanism[];
+}
+
+export declare class OcaNetworkInterfaceAssignment
+  implements IOcaNetworkInterfaceAssignment {
+  /**
+   * Assignment of a Network Interface object to a Network Application object.
+   * Also specifies associated Network Advertising mechanism(s).
+   * @class OcaNetworkInterfaceAssignment
+   */
+  constructor(
+    ID: number,
+    NetworkInterfaceONo: number,
+    NetworkBindingParameters: Uint8Array,
+    SecurityKeyIdentities: string[],
+    AdvertisingMechanisms: OcaNetworkAdvertisingMechanism[]
+  );
+
+  /**
+   * Internal ID of Network Assignment. Unique within the instance of
+   * **OcaMediaTransportApplication** (or subclass)**** that owns the
+   * Assignment.
+   * @type number
+   */
+  ID: number;
+
+  /**
+   * ONo of the Network Interface
+   * @type number
+   */
+  NetworkInterfaceONo: number;
+
+  /**
+   * Assignment-specific parameters. Format depends on application. For example,
+   * IP-based applications can use this field to designate the IP port being
+   * used.
+   * @type Uint8Array
+   */
+  NetworkBindingParameters: Uint8Array;
+
+  /**
+   * List of identities of security keys that apply to this assignment. Assumes
+   * the identities refer to private shared keys registered in
+   * **OcaSecurityManager**.
+   * @type string[]
+   */
+  SecurityKeyIdentities: string[];
+
+  /**
+   * List of advertising mechanisms associated with this Assignment. May be
+   * empty.
+   * @type OcaNetworkAdvertisingMechanism[]
+   */
+  AdvertisingMechanisms: OcaNetworkAdvertisingMechanism[];
+}

package/src/types/OcaNetworkInterfaceAssignment.js

@@ -0,0 +1,51 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaNetworkInterfaceAssignment {
+  /**
+   * Assignment of a Network Interface object to a Network Application object.
+   * Also specifies associated Network Advertising mechanism(s).
+   * @class OcaNetworkInterfaceAssignment
+   */
+  constructor(
+    ID,
+    NetworkInterfaceONo,
+    NetworkBindingParameters,
+    SecurityKeyIdentities,
+    AdvertisingMechanisms
+  ) {
+    /**
+     * Internal ID of Network Assignment. Unique within the instance of
+     * **OcaMediaTransportApplication** (or subclass)**** that owns the
+     * Assignment.
+     * @type number
+     */
+    this.ID = ID;
+    /**
+     * ONo of the Network Interface
+     * @type number
+     */
+    this.NetworkInterfaceONo = NetworkInterfaceONo;
+    /**
+     * Assignment-specific parameters. Format depends on application. For
+     * example, IP-based applications can use this field to designate the IP
+     * port being used.
+     * @type Uint8Array
+     */
+    this.NetworkBindingParameters = NetworkBindingParameters;
+    /**
+     * List of identities of security keys that apply to this assignment.
+     * Assumes the identities refer to private shared keys registered in
+     * **OcaSecurityManager**.
+     * @type string[]
+     */
+    this.SecurityKeyIdentities = SecurityKeyIdentities;
+    /**
+     * List of advertising mechanisms associated with this Assignment. May be
+     * empty.
+     * @type OcaNetworkAdvertisingMechanism[]
+     */
+    this.AdvertisingMechanisms = AdvertisingMechanisms;
+  }
+}

package/src/types/OcaNetworkInterfaceCommand.d.ts

@@ -0,0 +1,50 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Command values for **OcaNetworkInterface.ApplyCommand().**
+ * @class OcaNetworkInterfaceCommand
+ */
+export class OcaNetworkInterfaceCommand {
+  /**
+   * Singleton object corresponding to the entry with value ``0``.
+   */
+  static Start: OcaNetworkInterfaceCommand;
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static Stop: OcaNetworkInterfaceCommand;
+  /**
+   * Singleton object corresponding to the entry with value ``2``.
+   */
+  static Restart: OcaNetworkInterfaceCommand;
+
+  /**
+   * 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 IOcaNetworkInterfaceCommand =
+  | OcaNetworkInterfaceCommand
+  | 'Start'
+  | 'Stop'
+  | 'Restart'
+  | 0
+  | 1
+  | 2;

package/src/types/OcaNetworkInterfaceCommand.js

@@ -0,0 +1,36 @@
+/*
+ * This file has been generated.
+ */
+import { Enum } from './Enum.js';
+
+/**
+ * Command values for **OcaNetworkInterface.ApplyCommand().**
+ * @class OcaNetworkInterfaceCommand
+ */
+export class OcaNetworkInterfaceCommand extends Enum({
+  Start: 0,
+  Stop: 1,
+  Restart: 2,
+}) {}
+
+/**
+ * Singleton object corresponding to the entry with value ``0``.
+ * @type {OcaNetworkInterfaceCommand}
+ * @member Start
+ * @memberof OcaNetworkInterfaceCommand
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaNetworkInterfaceCommand}
+ * @member Stop
+ * @memberof OcaNetworkInterfaceCommand
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``2``.
+ * @type {OcaNetworkInterfaceCommand}
+ * @member Restart
+ * @memberof OcaNetworkInterfaceCommand
+ * @static
+ */

package/src/types/OcaNetworkInterfaceState.d.ts

@@ -0,0 +1,50 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Network Interface state.
+ * @class OcaNetworkInterfaceState
+ */
+export class OcaNetworkInterfaceState {
+  /**
+   * Singleton object corresponding to the entry with value ``0``.
+   */
+  static NotReady: OcaNetworkInterfaceState;
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static Ready: OcaNetworkInterfaceState;
+  /**
+   * Singleton object corresponding to the entry with value ``2``.
+   */
+  static Fault: OcaNetworkInterfaceState;
+
+  /**
+   * 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 IOcaNetworkInterfaceState =
+  | OcaNetworkInterfaceState
+  | 'NotReady'
+  | 'Ready'
+  | 'Fault'
+  | 0
+  | 1
+  | 2;

package/src/types/OcaNetworkInterfaceState.js

@@ -0,0 +1,36 @@
+/*
+ * This file has been generated.
+ */
+import { Enum } from './Enum.js';
+
+/**
+ * Network Interface state.
+ * @class OcaNetworkInterfaceState
+ */
+export class OcaNetworkInterfaceState extends Enum({
+  NotReady: 0,
+  Ready: 1,
+  Fault: 2,
+}) {}
+
+/**
+ * Singleton object corresponding to the entry with value ``0``.
+ * @type {OcaNetworkInterfaceState}
+ * @member NotReady
+ * @memberof OcaNetworkInterfaceState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaNetworkInterfaceState}
+ * @member Ready
+ * @memberof OcaNetworkInterfaceState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``2``.
+ * @type {OcaNetworkInterfaceState}
+ * @member Fault
+ * @memberof OcaNetworkInterfaceState
+ * @static
+ */

package/src/types/OcaNetworkInterfaceStatus.d.ts

@@ -0,0 +1,42 @@
+/*
+ * This file has been generated.
+ */
+import {
+  IOcaNetworkInterfaceState,
+  OcaNetworkInterfaceState,
+} from './OcaNetworkInterfaceState';
+
+export declare interface IOcaNetworkInterfaceStatus {
+  /**
+   * Generic state of the network interface
+   * @type OcaNetworkInterfaceState
+   */
+  State: IOcaNetworkInterfaceState;
+
+  /**
+   * Adaptation-dependent state data
+   * @type Uint8Array
+   */
+  AdaptationData: Uint8Array;
+}
+
+export declare class OcaNetworkInterfaceStatus
+  implements IOcaNetworkInterfaceStatus {
+  /**
+   * Network-type-specific network interface status.
+   * @class OcaNetworkInterfaceStatus
+   */
+  constructor(State: OcaNetworkInterfaceState, AdaptationData: Uint8Array);
+
+  /**
+   * Generic state of the network interface
+   * @type OcaNetworkInterfaceState
+   */
+  State: OcaNetworkInterfaceState;
+
+  /**
+   * Adaptation-dependent state data
+   * @type Uint8Array
+   */
+  AdaptationData: Uint8Array;
+}

package/src/types/OcaNetworkInterfaceStatus.js

@@ -0,0 +1,22 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaNetworkInterfaceStatus {
+  /**
+   * Network-type-specific network interface status.
+   * @class OcaNetworkInterfaceStatus
+   */
+  constructor(State, AdaptationData) {
+    /**
+     * Generic state of the network interface
+     * @type OcaNetworkInterfaceState
+     */
+    this.State = State;
+    /**
+     * Adaptation-dependent state data
+     * @type Uint8Array
+     */
+    this.AdaptationData = AdaptationData;
+  }
+}

package/src/types/OcaNotificationDeliveryMode.d.ts

@@ -3,10 +3,18 @@
  */
 /**
  * Enum for subscriptions that specifies whether its notification messages are
- * to be delivered by reliable means (e.g. TCP) or fast means (e.g. UDP).
+ * to be delivered by normal means (e.g. TCP) or lightweight means (e.g. UDP).
  * @class OcaNotificationDeliveryMode
  */
 export class OcaNotificationDeliveryMode {
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static Normal: OcaNotificationDeliveryMode;
+  /**
+   * Singleton object corresponding to the entry with value ``2``.
+   */
+  static Lightweight: OcaNotificationDeliveryMode;
   /**
    * Singleton object corresponding to the entry with value ``1``.
    */
@@ -39,7 +47,11 @@ export class OcaNotificationDeliveryMode {
 
 export type IOcaNotificationDeliveryMode =
   | OcaNotificationDeliveryMode
+  | 'Normal'
+  | 'Lightweight'
   | 'Reliable'
   | 'Fast'
   | 1
+  | 2
+  | 1
   | 2;

package/src/types/OcaNotificationDeliveryMode.js

@@ -5,14 +5,30 @@ import { Enum } from './Enum.js';
 
 /**
  * Enum for subscriptions that specifies whether its notification messages are
- * to be delivered by reliable means (e.g. TCP) or fast means (e.g. UDP).
+ * to be delivered by normal means (e.g. TCP) or lightweight means (e.g. UDP).
  * @class OcaNotificationDeliveryMode
  */
 export class OcaNotificationDeliveryMode extends Enum({
+  Normal: 1,
+  Lightweight: 2,
   Reliable: 1,
   Fast: 2,
 }) {}
 
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaNotificationDeliveryMode}
+ * @member Normal
+ * @memberof OcaNotificationDeliveryMode
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``2``.
+ * @type {OcaNotificationDeliveryMode}
+ * @member Lightweight
+ * @memberof OcaNotificationDeliveryMode
+ * @static
+ */
 /**
  * Singleton object corresponding to the entry with value ``1``.
  * @type {OcaNotificationDeliveryMode}

package/src/types/OcaOPath.d.ts

@@ -4,7 +4,14 @@
 
 export declare interface IOcaOPath {
   /**
-   * Host ID of device that contains the referenced object.
+   * Service ID of host that contains the referenced object, as registered in
+   * the network discovery system being used. Format depends on discovery system
+   * type. NOTE For AES70-2023 and later, the value for this property will
+   * normally be the Service Name of the target host's service, as registered in
+   * DNS-SD - see [AES70-3]. For AES70-2018, the value for this property will
+   * normally be the value of the **ServiceID** property of the
+   * **OcaControlNetwork** object that describes the target host's network
+   * connection. This property is inherited from **OcaApplicationNetwork**.
    * @type Uint8Array
    */
   HostID: Uint8Array;
@@ -25,7 +32,14 @@ export declare class OcaOPath implements IOcaOPath {
   constructor(HostID: Uint8Array, ONo: number);
 
   /**
-   * Host ID of device that contains the referenced object.
+   * Service ID of host that contains the referenced object, as registered in
+   * the network discovery system being used. Format depends on discovery system
+   * type. NOTE For AES70-2023 and later, the value for this property will
+   * normally be the Service Name of the target host's service, as registered in
+   * DNS-SD - see [AES70-3]. For AES70-2018, the value for this property will
+   * normally be the value of the **ServiceID** property of the
+   * **OcaControlNetwork** object that describes the target host's network
+   * connection. This property is inherited from **OcaApplicationNetwork**.
    * @type Uint8Array
    */
   HostID: Uint8Array;

package/src/types/OcaOPath.js

@@ -10,7 +10,14 @@ export class OcaOPath {
    */
   constructor(HostID, ONo) {
     /**
-     * Host ID of device that contains the referenced object.
+     * Service ID of host that contains the referenced object, as registered in
+     * the network discovery system being used. Format depends on discovery
+     * system type. NOTE For AES70-2023 and later, the value for this property
+     * will normally be the Service Name of the target host's service, as
+     * registered in DNS-SD - see [AES70-3]. For AES70-2018, the value for this
+     * property will normally be the value of the **ServiceID** property of the
+     * **OcaControlNetwork** object that describes the target host's network
+     * connection. This property is inherited from **OcaApplicationNetwork**.
      * @type Uint8Array
      */
     this.HostID = HostID;

package/src/types/OcaObjectListEventData.d.ts

@@ -12,8 +12,8 @@ export declare interface IOcaObjectListEventData {
 
 export declare class OcaObjectListEventData implements IOcaObjectListEventData {
   /**
-   * Event data for events returning object lists, for example the
-   * **SynchronizeState** event defined in **OcaSubscriptionManager.**
+   * Notification data supplied by events returning object lists, for example
+   * the **SynchronizeState** event defined in **OcaSubscriptionManager.**
    * @class OcaObjectListEventData
    */
   constructor(objectList: number[]);

package/src/types/OcaObjectListEventData.js

@@ -4,8 +4,8 @@
 
 export class OcaObjectListEventData {
   /**
-   * Event data for events returning object lists, for example the
-   * **SynchronizeState** event defined in **OcaSubscriptionManager.**
+   * Notification data supplied by events returning object lists, for example
+   * the **SynchronizeState** event defined in **OcaSubscriptionManager.**
    * @class OcaObjectListEventData
    */
   constructor(objectList) {