aes70 1.6.0 → 1.6.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aes70",
-  "version": "1.6.0",
+  "version": "1.6.2",
   "description": "A controller library for the AES70 protocol.",
   "type": "module",
   "main": "src/index.js",

package/src/OCP1/encoded_arguments.js

@@ -1,37 +1,49 @@
-export class EncodedArguments {
-  get byteLength() {
-    let byteLength = this._byteLength;
+function calculateByteLength(encoders, data) {
+  let byteLength = 0;
 
-    if (byteLength === -1) {
-      const encoders = this.encoders;
-      const data = this.data;
+  for (let i = 0; i < encoders.length; i++) {
+    byteLength += encoders[i].encodedLength(data[i]);
+  }
 
-      byteLength = 0;
+  return byteLength;
+}
 
-      for (let i = 0; i < encoders.length; i++) {
-        byteLength += encoders[i].encodedLength(data[i]);
-      }
-      this._byteLength = byteLength;
-    }
+function encode(encoders, data, byteLength) {
+  if (!byteLength) return null;
+  const result = new ArrayBuffer(byteLength);
+  const dataView = new DataView(result);
 
-    return byteLength;
+  for (let i = 0, pos = 0; i < encoders.length; i++) {
+    pos = encoders[i].encodeTo(dataView, pos, data[i]);
   }
 
+  return result;
+}
+
+export class EncodedArguments {
   constructor(encoders, data) {
     this.encoders = encoders;
     this.data = data;
-    this._byteLength = -1;
+    this.byteLength = calculateByteLength(encoders, data);
+    this.buffer = encode(encoders, data, this.byteLength);
   }
 
   encodeTo(dataView, pos) {
     pos = pos | 0;
 
-    const { encoders, data } = this;
+    const { byteLength, buffer } = this;
+
+    if (!byteLength) return pos;
+
+    const src = new Uint8Array(buffer);
+    const dst = new Uint8Array(
+      dataView.buffer,
+      dataView.byteOffset,
+      dataView.byteLength
+    );
 
-    for (let i = 0; i < encoders.length; i++) {
-      pos = encoders[i].encodeTo(dataView, pos, data[i]);
-    }
+    dst.set(src, pos);
 
-    return pos;
+    return pos + byteLength;
   }
 }

package/src/connection.d.ts

@@ -61,6 +61,11 @@ export declare class Connection extends Events {
    */
   close(): void;
 
+  /**
+   * Returns true if this connection has been closed.
+   */
+  is_closed(): boolean;
+
   /**
    * Receive and handle some incoming data. This is usually called
    * internally when data is received on e.g. a tcp socket.

package/src/controller/ControlClasses/OcaBlock.d.ts

@@ -257,39 +257,39 @@ export declare class OcaBlock extends OcaWorker {
   ): Promise<OcaObjectSearchResult[]>;
 
   /**
-   * Returns object identifications of all objects with the given name path.
+   * Returns block member descriptors of all objects in the block and all
+   * contained blocks that match the given Label search string and Class ID.
    * **Added in version 2 of this class.**
    *
-   * @method OcaBlock#FindObjectsByPath
-   * @param {string[]} SearchPath
+   * @method OcaBlock#FindObjectsByLabelRecursive
+   * @param {string} SearchName
+   * @param {IOcaStringComparisonType} NameComparisonType
+   * @param {string} SearchClassID
    * @param {IOcaObjectSearchResultFlags} ResultFlags
    *
    * @returns {Promise<OcaObjectSearchResult[]>}
    *   A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
    */
-  FindObjectsByPath(
-    SearchPath: string[],
+  FindObjectsByLabelRecursive(
+    SearchName: string,
+    NameComparisonType: IOcaStringComparisonType,
+    SearchClassID: string,
     ResultFlags: IOcaObjectSearchResultFlags
   ): Promise<OcaObjectSearchResult[]>;
 
   /**
-   * Returns block member descriptors of all objects in the block and all
-   * contained blocks that match the given Label search string and Class ID.
+   * Returns object identifications of all objects with the given name path.
    * **Added in version 2 of this class.**
    *
-   * @method OcaBlock#FindObjectsByLabelRecursive
-   * @param {string} SearchName
-   * @param {IOcaStringComparisonType} NameComparisonType
-   * @param {string} SearchClassID
+   * @method OcaBlock#FindObjectsByPath
+   * @param {string[]} SearchPath
    * @param {IOcaObjectSearchResultFlags} ResultFlags
    *
    * @returns {Promise<OcaObjectSearchResult[]>}
    *   A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
    */
-  FindObjectsByLabelRecursive(
-    SearchName: string,
-    NameComparisonType: IOcaStringComparisonType,
-    SearchClassID: string,
+  FindObjectsByPath(
+    SearchPath: string[],
     ResultFlags: IOcaObjectSearchResultFlags
   ): Promise<OcaObjectSearchResult[]>;
 }

package/src/controller/ControlClasses/OcaBlock.js

@@ -73,13 +73,6 @@ export const OcaBlock = make_control_class(
       ],
       [OcaList(OcaObjectSearchResult)],
     ],
-    [
-      'FindObjectsByPath',
-      3,
-      20,
-      [OcaList(OcaString), OcaObjectSearchResultFlags],
-      [OcaList(OcaObjectSearchResult)],
-    ],
     [
       'FindObjectsByLabelRecursive',
       3,
@@ -92,6 +85,13 @@ export const OcaBlock = make_control_class(
       ],
       [OcaList(OcaObjectSearchResult)],
     ],
+    [
+      'FindObjectsByPath',
+      3,
+      20,
+      [OcaList(OcaString), OcaObjectSearchResultFlags],
+      [OcaList(OcaObjectSearchResult)],
+    ],
   ],
   [
     ['Type', [OcaUint32], 3, 1, true, false, null],
@@ -287,25 +287,25 @@ export const OcaBlock = make_control_class(
  *   A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
  */
 /**
- * Returns object identifications of all objects with the given name path.
+ * Returns block member descriptors of all objects in the block and all
+ * contained blocks that match the given Label search string and Class ID.
  * **Added in version 2 of this class.**
  *
- * @method OcaBlock#FindObjectsByPath
- * @param {string[]} SearchPath
+ * @method OcaBlock#FindObjectsByLabelRecursive
+ * @param {string} SearchName
+ * @param {IOcaStringComparisonType} NameComparisonType
+ * @param {string} SearchClassID
  * @param {IOcaObjectSearchResultFlags} ResultFlags
  *
  * @returns {Promise<OcaObjectSearchResult[]>}
  *   A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
  */
 /**
- * Returns block member descriptors of all objects in the block and all
- * contained blocks that match the given Label search string and Class ID.
+ * Returns object identifications of all objects with the given name path.
  * **Added in version 2 of this class.**
  *
- * @method OcaBlock#FindObjectsByLabelRecursive
- * @param {string} SearchName
- * @param {IOcaStringComparisonType} NameComparisonType
- * @param {string} SearchClassID
+ * @method OcaBlock#FindObjectsByPath
+ * @param {string[]} SearchPath
  * @param {IOcaObjectSearchResultFlags} ResultFlags
  *
  * @returns {Promise<OcaObjectSearchResult[]>}

package/src/controller/ControlClasses/OcaControlNetwork.d.ts

@@ -13,6 +13,11 @@ export declare class OcaControlNetwork extends OcaApplicationNetwork {
    */
   OnProtocolChanged: PropertyEvent<OcaNetworkControlProtocol>;
 
+  /**
+   * An alias for OnProtocolChanged
+   */
+  OnControlProtocolChanged: PropertyEvent<OcaNetworkControlProtocol>;
+
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**

package/src/controller/ControlClasses/OcaControlNetwork.js

@@ -42,3 +42,8 @@ export const OcaControlNetwork = make_control_class(
  *
  * @member {PropertyEvent<OcaNetworkControlProtocol>} OcaControlNetwork#OnProtocolChanged
  */
+/**
+ * An alias for OnProtocolChanged
+ *
+ * @member {PropertyEvent<OcaNetworkControlProtocol>} OcaControlNetwork#OnControlProtocolChanged
+ */

package/src/controller/ControlClasses/OcaFilterParametric.d.ts

@@ -29,6 +29,10 @@ export declare class OcaFilterParametric extends OcaActuator {
    */
   OnWidthParameterChanged: PropertyEvent<number>;
 
+  /**
+   * An alias for OnWidthParameterChanged
+   */
+  OnQChanged: PropertyEvent<number>;
   /**
    * This event is emitted whenever InbandGain changes.
    */

package/src/controller/ControlClasses/OcaFilterParametric.js

@@ -189,6 +189,11 @@ export const OcaFilterParametric = make_control_class(
  *
  * @member {PropertyEvent<number>} OcaFilterParametric#OnWidthParameterChanged
  */
+/**
+ * An alias for OnWidthParameterChanged
+ *
+ * @member {PropertyEvent<number>} OcaFilterParametric#OnQChanged
+ */
 /**
  * This event is emitted when the property ``InbandGain`` changes in the remote object.
  * The property ``InbandGain`` is described in the AES70 standard as follows.

package/src/controller/ControlClasses/OcaGrouper.d.ts

@@ -147,16 +147,28 @@ export declare class OcaGrouper extends OcaAgent {
    */
   OnGroupsChanged: PropertyEvent<OcaGrouperGroup[]>;
 
+  /**
+   * An alias for OnGroupsChanged
+   */
+  OnGroupListChanged: PropertyEvent<OcaGrouperGroup[]>;
   /**
    * This event is emitted whenever Citizens changes.
    */
   OnCitizensChanged: PropertyEvent<OcaGrouperCitizen[]>;
 
+  /**
+   * An alias for OnCitizensChanged
+   */
+  OnCitizenListChanged: PropertyEvent<OcaGrouperCitizen[]>;
   /**
    * This event is emitted whenever Enrollments changes.
    */
   OnEnrollmentsChanged: PropertyEvent<OcaGrouperEnrollment[]>;
 
+  /**
+   * An alias for OnEnrollmentsChanged
+   */
+  OnEnrollmentListChanged: PropertyEvent<OcaGrouperEnrollment[]>;
   /**
    * This event is emitted whenever Mode changes.
    */

package/src/controller/ControlClasses/OcaGrouper.js

@@ -339,6 +339,11 @@ export const OcaGrouper = make_control_class(
  *
  * @member {PropertyEvent<OcaGrouperGroup[]>} OcaGrouper#OnGroupsChanged
  */
+/**
+ * An alias for OnGroupsChanged
+ *
+ * @member {PropertyEvent<OcaGrouperGroup[]>} OcaGrouper#OnGroupListChanged
+ */
 /**
  * This event is emitted when the property ``Citizens`` changes in the remote object.
  * The property ``Citizens`` is described in the AES70 standard as follows.
@@ -346,6 +351,11 @@ export const OcaGrouper = make_control_class(
  *
  * @member {PropertyEvent<OcaGrouperCitizen[]>} OcaGrouper#OnCitizensChanged
  */
+/**
+ * An alias for OnCitizensChanged
+ *
+ * @member {PropertyEvent<OcaGrouperCitizen[]>} OcaGrouper#OnCitizenListChanged
+ */
 /**
  * This event is emitted when the property ``Enrollments`` changes in the remote object.
  * The property ``Enrollments`` is described in the AES70 standard as follows.
@@ -354,6 +364,11 @@ export const OcaGrouper = make_control_class(
  *
  * @member {PropertyEvent<OcaGrouperEnrollment[]>} OcaGrouper#OnEnrollmentsChanged
  */
+/**
+ * An alias for OnEnrollmentsChanged
+ *
+ * @member {PropertyEvent<OcaGrouperEnrollment[]>} OcaGrouper#OnEnrollmentListChanged
+ */
 /**
  * This event is emitted when the property ``Mode`` changes in the remote object.
  * The property ``Mode`` is described in the AES70 standard as follows.

package/src/controller/ControlClasses/OcaMediaClockManager.d.ts

@@ -22,6 +22,10 @@ export declare class OcaMediaClockManager extends OcaManager {
    */
   OnClockSourceTypesSupportedChanged: PropertyEvent<OcaMediaClockType[]>;
 
+  /**
+   * An alias for OnClockSourceTypesSupportedChanged
+   */
+  OnMediaClockTypesSupportedChanged: PropertyEvent<OcaMediaClockType[]>;
   /**
    * This event is emitted whenever Clocks changes.
    */

package/src/controller/ControlClasses/OcaMediaClockManager.js

@@ -82,6 +82,11 @@ export const OcaMediaClockManager = make_control_class(
  *
  * @member {PropertyEvent<OcaMediaClockType[]>} OcaMediaClockManager#OnClockSourceTypesSupportedChanged
  */
+/**
+ * An alias for OnClockSourceTypesSupportedChanged
+ *
+ * @member {PropertyEvent<OcaMediaClockType[]>} OcaMediaClockManager#OnMediaClockTypesSupportedChanged
+ */
 /**
  * This event is emitted when the property ``Clocks`` changes in the remote object.
  * The property ``Clocks`` is described in the AES70 standard as follows.

package/src/controller/ControlClasses/OcaMediaTransportNetwork.d.ts

@@ -52,6 +52,10 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
    */
   OnProtocolChanged: PropertyEvent<OcaNetworkMediaProtocol>;
 
+  /**
+   * An alias for OnProtocolChanged
+   */
+  OnMediaProtocolChanged: PropertyEvent<OcaNetworkMediaProtocol>;
   /**
    * This event is emitted whenever Ports changes.
    */

package/src/controller/ControlClasses/OcaMediaTransportNetwork.js

@@ -390,6 +390,11 @@ export const OcaMediaTransportNetwork = make_control_class(
  *
  * @member {PropertyEvent<OcaNetworkMediaProtocol>} OcaMediaTransportNetwork#OnProtocolChanged
  */
+/**
+ * An alias for OnProtocolChanged
+ *
+ * @member {PropertyEvent<OcaNetworkMediaProtocol>} OcaMediaTransportNetwork#OnMediaProtocolChanged
+ */
 /**
  * This event is emitted when the property ``Ports`` changes in the remote object.
  * The property ``Ports`` is described in the AES70 standard as follows.

package/src/controller/ControlClasses/OcaNetworkSignalChannel.d.ts

@@ -23,11 +23,6 @@ import { OcaWorker } from './OcaWorker';
  * @class OcaNetworkSignalChannel
  */
 export declare class OcaNetworkSignalChannel extends OcaWorker {
-  /**
-   * This event is emitted whenever ConnectorPins changes.
-   */
-  OnConnectorPinsChanged: PropertyEvent<Map<number, number>>;
-
   /**
    * This event is emitted whenever IDAdvertised changes.
    */
@@ -38,6 +33,11 @@ export declare class OcaNetworkSignalChannel extends OcaWorker {
    */
   OnNetworkChanged: PropertyEvent<number>;
 
+  /**
+   * This event is emitted whenever ConnectorPins changes.
+   */
+  OnConnectorPinsChanged: PropertyEvent<Map<number, number>>;
+
   /**
    * This event is emitted whenever RemoteChannelID changes.
    */
@@ -55,30 +55,6 @@ export declare class OcaNetworkSignalChannel extends OcaWorker {
 
   constructor(objectNumber: number, device: RemoteDevice);
 
-  /**
-   * Adds the object number of the stream connector object to which this media
-   * port belongs, and specifies on what index of the stream connector this
-   * channel can be found. Return status indicates success of operation.
-   *
-   * @method OcaNetworkSignalChannel#AddToConnector
-   * @param {number} Connector
-   * @param {number} Index
-   *
-   * @returns {Promise<void>}
-   */
-  AddToConnector(Connector: number, Index: number): Promise<void>;
-
-  /**
-   * Gets the object number of the stream connector object to which this media
-   * port belongs, if any. If port does not belong to a stream connector,
-   * returns zero. Return status indicates success of operation.
-   *
-   * @method OcaNetworkSignalChannel#GetConnectorPins
-   * @returns {Promise<Map<number, number>>}
-   *   A promise which resolves to a single value of type ``Map<number, number>``.
-   */
-  GetConnectorPins(): Promise<Map<number, number>>;
-
   /**
    * Gets the value of the IDAdvertised property. Return status indicates
    * success of operation.
@@ -89,6 +65,17 @@ export declare class OcaNetworkSignalChannel extends OcaWorker {
    */
   GetIDAdvertised(): Promise<Uint8Array>;
 
+  /**
+   * Sets the value of the IDAdvertised property. Return status indicates
+   * success of operation.
+   *
+   * @method OcaNetworkSignalChannel#SetIDAdvertised
+   * @param {Uint8Array} IDAdvertised
+   *
+   * @returns {Promise<void>}
+   */
+  SetIDAdvertised(IDAdvertised: Uint8Array): Promise<void>;
+
   /**
    * Gets the object number of the stream network object to which this media
    * port belongs. Return status indicates success of operation.
@@ -100,36 +87,40 @@ export declare class OcaNetworkSignalChannel extends OcaWorker {
   GetNetwork(): Promise<number>;
 
   /**
-   * Gets the remote channel ID to which this channel is connected. Empty if the
-   * channel is not connected (at least not directly to another channel). For
-   * stream-oriented connection management this functionality is not used (i.e.
-   * the remote channel ID will always be empty).
+   * Sets the object number of the stream network object to which this media
+   * port belongs. Return status indicates success of operation. Only
+   * implemented for reconfigurable devices.
    *
-   * @method OcaNetworkSignalChannel#GetRemoteChannelID
-   * @returns {Promise<Uint8Array>}
-   *   A promise which resolves to a single value of type ``Uint8Array``.
+   * @method OcaNetworkSignalChannel#SetNetwork
+   * @param {number} Network
+   *
+   * @returns {Promise<void>}
    */
-  GetRemoteChannelID(): Promise<Uint8Array>;
+  SetNetwork(Network: number): Promise<void>;
 
   /**
-   * Gets the value of the SourceOrSink property. Return status indicates
-   * success of operation.
+   * Gets the object number of the stream connector object to which this media
+   * port belongs, if any. If port does not belong to a stream connector,
+   * returns zero. Return status indicates success of operation.
    *
-   * @method OcaNetworkSignalChannel#GetSourceOrSink
-   * @returns {Promise<OcaNetworkMediaSourceOrSink>}
-   *   A promise which resolves to a single value of type :class:`OcaNetworkMediaSourceOrSink`.
+   * @method OcaNetworkSignalChannel#GetConnectorPins
+   * @returns {Promise<Map<number, number>>}
+   *   A promise which resolves to a single value of type ``Map<number, number>``.
    */
-  GetSourceOrSink(): Promise<OcaNetworkMediaSourceOrSink>;
+  GetConnectorPins(): Promise<Map<number, number>>;
 
   /**
-   * Gets the value of the Status property. Return status indicates success of
-   * operation.
+   * Adds the object number of the stream connector object to which this media
+   * port belongs, and specifies on what index of the stream connector this
+   * channel can be found. Return status indicates success of operation.
    *
-   * @method OcaNetworkSignalChannel#GetStatus
-   * @returns {Promise<OcaNetworkSignalChannelStatus>}
-   *   A promise which resolves to a single value of type :class:`OcaNetworkSignalChannelStatus`.
+   * @method OcaNetworkSignalChannel#AddToConnector
+   * @param {number} Connector
+   * @param {number} Index
+   *
+   * @returns {Promise<void>}
    */
-  GetStatus(): Promise<OcaNetworkSignalChannelStatus>;
+  AddToConnector(Connector: number, Index: number): Promise<void>;
 
   /**
    * Removes this channel from the passed stream connector. Return status
@@ -143,27 +134,16 @@ export declare class OcaNetworkSignalChannel extends OcaWorker {
   RemoveFromConnector(Connector: number): Promise<void>;
 
   /**
-   * Sets the value of the IDAdvertised property. Return status indicates
-   * success of operation.
-   *
-   * @method OcaNetworkSignalChannel#SetIDAdvertised
-   * @param {Uint8Array} IDAdvertised
-   *
-   * @returns {Promise<void>}
-   */
-  SetIDAdvertised(IDAdvertised: Uint8Array): Promise<void>;
-
-  /**
-   * Sets the object number of the stream network object to which this media
-   * port belongs. Return status indicates success of operation. Only
-   * implemented for reconfigurable devices.
-   *
-   * @method OcaNetworkSignalChannel#SetNetwork
-   * @param {number} Network
+   * Gets the remote channel ID to which this channel is connected. Empty if the
+   * channel is not connected (at least not directly to another channel). For
+   * stream-oriented connection management this functionality is not used (i.e.
+   * the remote channel ID will always be empty).
    *
-   * @returns {Promise<void>}
+   * @method OcaNetworkSignalChannel#GetRemoteChannelID
+   * @returns {Promise<Uint8Array>}
+   *   A promise which resolves to a single value of type ``Uint8Array``.
    */
-  SetNetwork(Network: number): Promise<void>;
+  GetRemoteChannelID(): Promise<Uint8Array>;
 
   /**
    * Sets the remote channel ID to which this channel must be connected. Only
@@ -178,4 +158,24 @@ export declare class OcaNetworkSignalChannel extends OcaWorker {
    * @returns {Promise<void>}
    */
   SetRemoteChannelID(RemoteChannelID: Uint8Array): Promise<void>;
+
+  /**
+   * Gets the value of the SourceOrSink property. Return status indicates
+   * success of operation.
+   *
+   * @method OcaNetworkSignalChannel#GetSourceOrSink
+   * @returns {Promise<OcaNetworkMediaSourceOrSink>}
+   *   A promise which resolves to a single value of type :class:`OcaNetworkMediaSourceOrSink`.
+   */
+  GetSourceOrSink(): Promise<OcaNetworkMediaSourceOrSink>;
+
+  /**
+   * Gets the value of the Status property. Return status indicates success of
+   * operation.
+   *
+   * @method OcaNetworkSignalChannel#GetStatus
+   * @returns {Promise<OcaNetworkSignalChannelStatus>}
+   *   A promise which resolves to a single value of type :class:`OcaNetworkSignalChannelStatus`.
+   */
+  GetStatus(): Promise<OcaNetworkSignalChannelStatus>;
 }