aes70 2.0.1 → 2.0.3

package/dist/AES70.es5.js

@@ -993,6 +993,16 @@
     }
   }
 
+  /**
+   * Error class raised when a connection is closed due to a timeout.
+   */
+  class TimeoutError extends Error {
+    constructor(error) {
+      super(`Connection has timed out.`);
+      this.name = 'aes70.TimeoutError';
+    }
+  }
+
   /**
    * Connection base class. It extends :class:`Events` and defines two events:
    *
@@ -2709,9 +2719,9 @@
   const OcaResetCause = Enum8(OcaResetCause$1);
 
   class EventSubscriber {
-    constructor(callback, error_callback) {
+    constructor(callback, failure_callback) {
       this.callback = callback;
-      this.failure_callback = error_callback;
+      this.failure_callback = failure_callback;
     }
 
     emit(ctx, results) {
@@ -2723,9 +2733,9 @@
     }
 
     emit_error(ctx, error) {
-      if (this.error_callback) {
+      if (this.failure_callback) {
         try {
-          this.error_callback.call(ctx, error);
+          this.failure_callback.call(ctx, error);
         } catch (e) {
           console.error('Exception thrown by error event handler: ', e);
         }
@@ -2838,7 +2848,7 @@
     [pos, try_again] = OcaBoolean.decodeFrom(view, pos);
     [pos, data] = OcaBlob.decodeFrom(view, pos);
 
-    return [type, try_again, view];
+    return [type, try_again, data];
   }
 
   /**
@@ -3580,6 +3590,11 @@
       if (has_setter) descriptor.set = make_setter(prop.setter(blue_print, true));
 
       Object.defineProperty(o, prop.name, descriptor);
+      if (prop.aliases) {
+        prop.aliases.forEach((alias) => {
+          Object.defineProperty(o, alias, descriptor);
+        });
+      }
       index++;
     });
 
@@ -6996,7 +7011,7 @@
       ['GetState', 3, 5, [], [OcaTaskManagerState]],
       ['GetTaskStatuses', 3, 6, [], [OcaTaskStatus]],
       ['GetTaskStatus', 3, 7, [OcaUint32], [OcaTaskStatus]],
-      ['AddTask', 3, 8, [], []],
+      ['AddTask', 3, 8, [OcaTask], [OcaTask]],
       ['GetTasks', 3, 9, [], [OcaMap(OcaUint32, OcaTask)]],
       ['GetTask', 3, 10, [OcaUint32], [OcaTask]],
       ['SetTask', 3, 11, [OcaUint32, OcaTask], []],
@@ -7081,7 +7096,10 @@
    * successfully created.
    *
    * @method OcaTaskManager#AddTask
-   * @returns {Promise<void>}
+   * @param {IOcaTask} Task
+   *
+   * @returns {Promise<OcaTask>}
+   *   A promise which resolves to a single value of type :class:`OcaTask`.
    */
   /**
    * Gets map of Tasks in the device. Return value indicates whether map was
@@ -20311,7 +20329,13 @@
         [OcaMediaSourceConnector, OcaMediaConnectorState],
         [],
       ],
-      ['AddSinkConnector', 3, 16, [OcaMediaConnectorStatus], []],
+      [
+        'AddSinkConnector',
+        3,
+        16,
+        [OcaMediaConnectorStatus, OcaMediaSinkConnector],
+        [OcaMediaSinkConnector],
+      ],
       ['ControlConnector', 3, 17, [OcaUint16, OcaMediaConnectorCommand], []],
       [
         'SetSourceConnectorPinMap',
@@ -20499,8 +20523,10 @@
    *
    * @method OcaMediaTransportNetwork#AddSinkConnector
    * @param {IOcaMediaConnectorStatus} InitialStatus
+   * @param {IOcaMediaSinkConnector} Connector
    *
-   * @returns {Promise<void>}
+   * @returns {Promise<OcaMediaSinkConnector>}
+   *   A promise which resolves to a single value of type :class:`OcaMediaSinkConnector`.
    */
   /**
    * Change the state of a given connector. Return status indicates the success of
@@ -23707,16 +23733,6 @@
     return await fetchDeviceContentRec(objects);
   }
 
-  /**
-   * Error class raised when a connection is closed due to a timeout.
-   */
-  let TimeoutError$1 = class TimeoutError extends Error {
-    constructor(error) {
-      super(`Connection has timed out.`);
-      this.name = 'aes70.TimeoutError';
-    }
-  };
-
   /*
    * This file has been generated.
    */
@@ -24516,7 +24532,7 @@
     RemoteDevice: RemoteDevice,
     RemoteError: RemoteError,
     Response: Response$1,
-    TimeoutError: TimeoutError$1,
+    TimeoutError: TimeoutError,
     Types: types,
     WebSocketConnection: WebSocketConnection,
     currentProtocolVersion: currentProtocolVersion,

package/package.json

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

package/src/connection.js

@@ -2,6 +2,7 @@ import { Events } from './events.js';
 import { decodeMessage } from './OCP1/decode_message.js';
 import { KeepAlive } from './OCP1/keepalive.js';
 import { MessageGenerator } from './OCP1/message_generator.js';
+import { TimeoutError } from './timeout_error.js';
 
 /**
  * Connection base class. It extends :class:`Events` and defines two events:

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

@@ -1,7 +1,10 @@
 import { OcaCounter } from '../../types/OcaCounter';
 import { OcaCounterSet } from '../../types/OcaCounterSet';
 import { IOcaIODirection } from '../../types/OcaIODirection';
-import { OcaMediaStreamEndpoint } from '../../types/OcaMediaStreamEndpoint';
+import {
+  IOcaMediaStreamEndpoint,
+  OcaMediaStreamEndpoint,
+} from '../../types/OcaMediaStreamEndpoint';
 import { IOcaMediaStreamEndpointCommand } from '../../types/OcaMediaStreamEndpointCommand';
 import { IOcaMediaStreamEndpointState } from '../../types/OcaMediaStreamEndpointState';
 import { OcaMediaStreamEndpointStatus } from '../../types/OcaMediaStreamEndpointStatus';
@@ -375,11 +378,16 @@ export declare class OcaMediaTransportApplication extends OcaNetworkApplication
    * property **AlignmentLevelLimits**.
    *
    * @method OcaMediaTransportApplication#AddEndpoint
+   * @param {IOcaMediaStreamEndpoint} Endpoint
    * @param {IOcaMediaStreamEndpointState} InitialStatus
    *
-   * @returns {Promise<void>}
+   * @returns {Promise<OcaMediaStreamEndpoint>}
+   *   A promise which resolves to a single value of type :class:`OcaMediaStreamEndpoint`.
    */
-  AddEndpoint(InitialStatus: IOcaMediaStreamEndpointState): Promise<void>;
+  AddEndpoint(
+    Endpoint: IOcaMediaStreamEndpoint,
+    InitialStatus: IOcaMediaStreamEndpointState
+  ): Promise<OcaMediaStreamEndpoint>;
 
   /**
    * Deletes a stream endpoint from this media transport application object.

package/src/controller/ControlClasses/OcaMediaTransportApplication.js

@@ -99,7 +99,13 @@ export const OcaMediaTransportApplication = make_control_class(
       [OcaMap(OcaUint32, OcaMediaStreamEndpointStatus)],
     ],
     ['GetEndpointStatus', 3, 24, [OcaUint32], [OcaMediaStreamEndpointStatus]],
-    ['AddEndpoint', 3, 25, [OcaMediaStreamEndpointState], []],
+    [
+      'AddEndpoint',
+      3,
+      25,
+      [OcaMediaStreamEndpoint, OcaMediaStreamEndpointState],
+      [OcaMediaStreamEndpoint],
+    ],
     ['DeleteEndpoint', 3, 26, [OcaUint32], []],
     [
       'ApplyEndpointCommand',
@@ -427,9 +433,11 @@ export const OcaMediaTransportApplication = make_control_class(
  * property **AlignmentLevelLimits**.
  *
  * @method OcaMediaTransportApplication#AddEndpoint
+ * @param {IOcaMediaStreamEndpoint} Endpoint
  * @param {IOcaMediaStreamEndpointState} InitialStatus
  *
- * @returns {Promise<void>}
+ * @returns {Promise<OcaMediaStreamEndpoint>}
+ *   A promise which resolves to a single value of type :class:`OcaMediaStreamEndpoint`.
  */
 /**
  * Deletes a stream endpoint from this media transport application object.

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

@@ -6,7 +6,10 @@ import {
   IOcaMediaConnectorStatus,
   OcaMediaConnectorStatus,
 } from '../../types/OcaMediaConnectorStatus';
-import { OcaMediaSinkConnector } from '../../types/OcaMediaSinkConnector';
+import {
+  IOcaMediaSinkConnector,
+  OcaMediaSinkConnector,
+} from '../../types/OcaMediaSinkConnector';
 import {
   IOcaMediaSourceConnector,
   OcaMediaSourceConnector,
@@ -267,10 +270,15 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
    *
    * @method OcaMediaTransportNetwork#AddSinkConnector
    * @param {IOcaMediaConnectorStatus} InitialStatus
+   * @param {IOcaMediaSinkConnector} Connector
    *
-   * @returns {Promise<void>}
+   * @returns {Promise<OcaMediaSinkConnector>}
+   *   A promise which resolves to a single value of type :class:`OcaMediaSinkConnector`.
    */
-  AddSinkConnector(InitialStatus: IOcaMediaConnectorStatus): Promise<void>;
+  AddSinkConnector(
+    InitialStatus: IOcaMediaConnectorStatus,
+    Connector: IOcaMediaSinkConnector
+  ): Promise<OcaMediaSinkConnector>;
 
   /**
    * Change the state of a given connector. Return status indicates the success

package/src/controller/ControlClasses/OcaMediaTransportNetwork.js

@@ -51,7 +51,13 @@ export const OcaMediaTransportNetwork = make_control_class(
       [OcaMediaSourceConnector, OcaMediaConnectorState],
       [],
     ],
-    ['AddSinkConnector', 3, 16, [OcaMediaConnectorStatus], []],
+    [
+      'AddSinkConnector',
+      3,
+      16,
+      [OcaMediaConnectorStatus, OcaMediaSinkConnector],
+      [OcaMediaSinkConnector],
+    ],
     ['ControlConnector', 3, 17, [OcaUint16, OcaMediaConnectorCommand], []],
     [
       'SetSourceConnectorPinMap',
@@ -239,8 +245,10 @@ export const OcaMediaTransportNetwork = make_control_class(
  *
  * @method OcaMediaTransportNetwork#AddSinkConnector
  * @param {IOcaMediaConnectorStatus} InitialStatus
+ * @param {IOcaMediaSinkConnector} Connector
  *
- * @returns {Promise<void>}
+ * @returns {Promise<OcaMediaSinkConnector>}
+ *   A promise which resolves to a single value of type :class:`OcaMediaSinkConnector`.
  */
 /**
  * Change the state of a given connector. Return status indicates the success of

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

@@ -1,4 +1,11 @@
-import { OcaMediaTransportSession } from '../../types/OcaMediaTransportSession';
+import {
+  IOcaMediaTransportSession,
+  OcaMediaTransportSession,
+} from '../../types/OcaMediaTransportSession';
+import {
+  IOcaMediaTransportSessionConnection,
+  OcaMediaTransportSessionConnection,
+} from '../../types/OcaMediaTransportSessionConnection';
 import { OcaMediaTransportSessionStatus } from '../../types/OcaMediaTransportSessionStatus';
 import { PropertyEvent } from '../property_event';
 import { RemoteDevice } from '../remote_device';
@@ -66,9 +73,14 @@ export declare class OcaMediaTransportSessionAgent extends OcaAgent {
    * with session ID filled in.
    *
    * @method OcaMediaTransportSessionAgent#AddSession
-   * @returns {Promise<void>}
+   * @param {IOcaMediaTransportSession} Session
+   *
+   * @returns {Promise<OcaMediaTransportSession>}
+   *   A promise which resolves to a single value of type :class:`OcaMediaTransportSession`.
    */
-  AddSession(): Promise<void>;
+  AddSession(
+    Session: IOcaMediaTransportSession
+  ): Promise<OcaMediaTransportSession>;
 
   /**
    * Configures a session.
@@ -170,10 +182,15 @@ export declare class OcaMediaTransportSessionAgent extends OcaAgent {
    *
    * @method OcaMediaTransportSessionAgent#AddConnection
    * @param {number} SessionID
+   * @param {IOcaMediaTransportSessionConnection} Connection
    *
-   * @returns {Promise<void>}
+   * @returns {Promise<OcaMediaTransportSessionConnection>}
+   *   A promise which resolves to a single value of type :class:`OcaMediaTransportSessionConnection`.
    */
-  AddConnection(SessionID: number): Promise<void>;
+  AddConnection(
+    SessionID: number,
+    Connection: IOcaMediaTransportSessionConnection
+  ): Promise<OcaMediaTransportSessionConnection>;
 
   /**
    * Configures a connection.

package/src/controller/ControlClasses/OcaMediaTransportSessionAgent.js

@@ -3,6 +3,7 @@ import { OcaBoolean } from '../../OCP1/OcaBoolean.js';
 import { OcaList } from '../../OCP1/OcaList.js';
 import { OcaMap } from '../../OCP1/OcaMap.js';
 import { OcaMediaTransportSession } from '../../OCP1/OcaMediaTransportSession.js';
+import { OcaMediaTransportSessionConnection } from '../../OCP1/OcaMediaTransportSessionConnection.js';
 import { OcaMediaTransportSessionStatus } from '../../OCP1/OcaMediaTransportSessionStatus.js';
 import { OcaString } from '../../OCP1/OcaString.js';
 import { OcaUint32 } from '../../OCP1/OcaUint32.js';
@@ -27,7 +28,13 @@ export const OcaMediaTransportSessionAgent = make_control_class(
     ['GetSessionType', 3, 1, [], [OcaString]],
     ['GetSessions', 3, 2, [], [OcaList(OcaMediaTransportSession)]],
     ['GetSession', 3, 3, [OcaUint32], [OcaMediaTransportSession]],
-    ['AddSession', 3, 4, [], []],
+    [
+      'AddSession',
+      3,
+      4,
+      [OcaMediaTransportSession],
+      [OcaMediaTransportSession],
+    ],
     ['ConfigureSession', 3, 5, [OcaUint32, OcaBlob, OcaString, OcaBlob], []],
     ['DeleteSession', 3, 6, [OcaUint32], []],
     ['ResetSession', 3, 7, [OcaUint32], []],
@@ -42,7 +49,13 @@ export const OcaMediaTransportSessionAgent = make_control_class(
       [OcaMap(OcaUint32, OcaMediaTransportSessionStatus)],
     ],
     ['GetSessionStatus', 3, 12, [OcaUint32], [OcaMediaTransportSessionStatus]],
-    ['AddConnection', 3, 13, [OcaUint32], []],
+    [
+      'AddConnection',
+      3,
+      13,
+      [OcaUint32, OcaMediaTransportSessionConnection],
+      [OcaMediaTransportSessionConnection],
+    ],
     [
       'ConfigureConnection',
       3,
@@ -100,7 +113,10 @@ export const OcaMediaTransportSessionAgent = make_control_class(
  * session ID filled in.
  *
  * @method OcaMediaTransportSessionAgent#AddSession
- * @returns {Promise<void>}
+ * @param {IOcaMediaTransportSession} Session
+ *
+ * @returns {Promise<OcaMediaTransportSession>}
+ *   A promise which resolves to a single value of type :class:`OcaMediaTransportSession`.
  */
 /**
  * Configures a session.
@@ -180,8 +196,10 @@ export const OcaMediaTransportSessionAgent = make_control_class(
  *
  * @method OcaMediaTransportSessionAgent#AddConnection
  * @param {number} SessionID
+ * @param {IOcaMediaTransportSessionConnection} Connection
  *
- * @returns {Promise<void>}
+ * @returns {Promise<OcaMediaTransportSessionConnection>}
+ *   A promise which resolves to a single value of type :class:`OcaMediaTransportSessionConnection`.
  */
 /**
  * Configures a connection.

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

@@ -149,9 +149,12 @@ export declare class OcaTaskManager extends OcaManager {
    * successfully created.
    *
    * @method OcaTaskManager#AddTask
-   * @returns {Promise<void>}
+   * @param {IOcaTask} Task
+   *
+   * @returns {Promise<OcaTask>}
+   *   A promise which resolves to a single value of type :class:`OcaTask`.
    */
-  AddTask(): Promise<void>;
+  AddTask(Task: IOcaTask): Promise<OcaTask>;
 
   /**
    * Gets map of Tasks in the device. Return value indicates whether map was

package/src/controller/ControlClasses/OcaTaskManager.js

@@ -53,7 +53,7 @@ export const OcaTaskManager = make_control_class(
     ['GetState', 3, 5, [], [OcaTaskManagerState]],
     ['GetTaskStatuses', 3, 6, [], [OcaTaskStatus]],
     ['GetTaskStatus', 3, 7, [OcaUint32], [OcaTaskStatus]],
-    ['AddTask', 3, 8, [], []],
+    ['AddTask', 3, 8, [OcaTask], [OcaTask]],
     ['GetTasks', 3, 9, [], [OcaMap(OcaUint32, OcaTask)]],
     ['GetTask', 3, 10, [OcaUint32], [OcaTask]],
     ['SetTask', 3, 11, [OcaUint32, OcaTask], []],
@@ -138,7 +138,10 @@ export const OcaTaskManager = make_control_class(
  * successfully created.
  *
  * @method OcaTaskManager#AddTask
- * @returns {Promise<void>}
+ * @param {IOcaTask} Task
+ *
+ * @returns {Promise<OcaTask>}
+ *   A promise which resolves to a single value of type :class:`OcaTask`.
  */
 /**
  * Gets map of Tasks in the device. Return value indicates whether map was

package/src/controller/base_event.js

@@ -2,9 +2,9 @@ import { CloseError } from '../close_error.js';
 import { OcaEvent } from '../types/OcaEvent.js';
 
 class EventSubscriber {
-  constructor(callback, error_callback) {
+  constructor(callback, failure_callback) {
     this.callback = callback;
-    this.failure_callback = error_callback;
+    this.failure_callback = failure_callback;
   }
 
   emit(ctx, results) {
@@ -16,9 +16,9 @@ class EventSubscriber {
   }
 
   emit_error(ctx, error) {
-    if (this.error_callback) {
+    if (this.failure_callback) {
       try {
-        this.error_callback.call(ctx, error);
+        this.failure_callback.call(ctx, error);
       } catch (e) {
         console.error('Exception thrown by error event handler: ', e);
       }

package/src/controller/make_control_class.js

@@ -42,6 +42,11 @@ function createPropertySync(control_class) {
     if (has_setter) descriptor.set = make_setter(prop.setter(blue_print, true));
 
     Object.defineProperty(o, prop.name, descriptor);
+    if (prop.aliases) {
+      prop.aliases.forEach((alias) => {
+        Object.defineProperty(o, alias, descriptor);
+      });
+    }
     index++;
   });
 

package/src/controller/notification_error.js

@@ -25,7 +25,7 @@ function parseNotificationExceptionData(buffer) {
   [pos, try_again] = OcaBoolean.decodeFrom(view, pos);
   [pos, data] = OcaBlob.decodeFrom(view, pos);
 
-  return [type, try_again, view];
+  return [type, try_again, data];
 }
 
 /**