aes70 1.3.8 → 1.4.0

package/src/controller/ControlClasses/OcaSignalGenerator.js

@@ -1,10 +1,10 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaActuator } from './OcaActuator.js';
-import { OcaBitSet16 } from '../../OCP1/OcaBitSet16.js';
 import { OcaBoolean } from '../../OCP1/OcaBoolean.js';
 import { OcaFloat32 } from '../../OCP1/OcaFloat32.js';
+import { OcaParameterMask } from '../../OCP1/OcaParameterMask.js';
 import { OcaSweepType } from '../../OCP1/OcaSweepType.js';
 import { OcaWaveformType } from '../../OCP1/OcaWaveformType.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaActuator } from './OcaActuator.js';
 
 /**
  * Multiwaveform signal generator with optional sweep capability.
@@ -40,7 +40,7 @@ export const OcaSignalGenerator = make_control_class(
       4,
       18,
       [
-        OcaBitSet16,
+        OcaParameterMask,
         OcaFloat32,
         OcaFloat32,
         OcaFloat32,
@@ -66,7 +66,8 @@ export const OcaSignalGenerator = make_control_class(
 );
 
 /**
- * Gets the value of the Frequency1 property. The return value indicates whether the property was successfully retrieved.
+ * Gets the value of the Frequency1 property. The return value indicates whether
+ * the property was successfully retrieved.
  * The return values of this method are
  *
  * - frequency of type ``number``
@@ -77,7 +78,8 @@ export const OcaSignalGenerator = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the value of the Frequency1 property. The return value indicates whether the property was successfully set.
+ * Sets the value of the Frequency1 property. The return value indicates whether
+ * the property was successfully set.
  *
  * @method OcaSignalGenerator#SetFrequency1
  * @param {number} frequency
@@ -85,7 +87,8 @@ export const OcaSignalGenerator = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of the Frequency2 property. The return value indicates whether the property was successfully retrieved.
+ * Gets the value of the Frequency2 property. The return value indicates whether
+ * the property was successfully retrieved.
  * The return values of this method are
  *
  * - frequency of type ``number``
@@ -96,7 +99,8 @@ export const OcaSignalGenerator = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the value of the Frequency2 property. The return value indicates whether the property was successfully set.
+ * Sets the value of the Frequency2 property. The return value indicates whether
+ * the property was successfully set.
  *
  * @method OcaSignalGenerator#SetFrequency2
  * @param {number} frequency
@@ -104,7 +108,8 @@ export const OcaSignalGenerator = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of the Level property. The return value indicates whether the property was successfully retrieved.
+ * Gets the value of the Level property. The return value indicates whether the
+ * property was successfully retrieved.
  * The return values of this method are
  *
  * - Level of type ``number``
@@ -115,7 +120,8 @@ export const OcaSignalGenerator = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the value of the Level property. The return value indicates whether the property was successfully set.
+ * Sets the value of the Level property. The return value indicates whether the
+ * property was successfully set.
  *
  * @method OcaSignalGenerator#SetLevel
  * @param {number} Level
@@ -123,37 +129,42 @@ export const OcaSignalGenerator = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of the Waveform property. The return value indicates whether the property was successfully retrieved.
+ * Gets the value of the Waveform property. The return value indicates whether
+ * the property was successfully retrieved.
  *
  * @method OcaSignalGenerator#GetWaveform
  * @returns {Promise<OcaWaveformType>}
  *   A promise which resolves to a single value of type :class:`OcaWaveformType`.
  */
 /**
- * Sets the value of the Waveform property. The return value indicates whether the property was successfully set.
+ * Sets the value of the Waveform property. The return value indicates whether
+ * the property was successfully set.
  *
  * @method OcaSignalGenerator#SetWaveform
- * @param {OcaWaveformType} waveform
+ * @param {IOcaWaveformType} waveform
  *
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of the SweepType property. The return value indicates whether the property was successfully retrieved.
+ * Gets the value of the SweepType property. The return value indicates whether
+ * the property was successfully retrieved.
  *
  * @method OcaSignalGenerator#GetSweepType
  * @returns {Promise<OcaSweepType>}
  *   A promise which resolves to a single value of type :class:`OcaSweepType`.
  */
 /**
- * Sets the value of the SweepType property. The return value indicates whether the property was successfully set.
+ * Sets the value of the SweepType property. The return value indicates whether
+ * the property was successfully set.
  *
  * @method OcaSignalGenerator#SetSweepType
- * @param {OcaSweepType} sweepType
+ * @param {IOcaSweepType} sweepType
  *
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of the SweepTime property. The return value indicates whether the property was successfully retrieved.
+ * Gets the value of the SweepTime property. The return value indicates whether
+ * the property was successfully retrieved.
  * The return values of this method are
  *
  * - sweepTime of type ``number``
@@ -164,7 +175,8 @@ export const OcaSignalGenerator = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the value of the SweepTime property. The return value indicates whether the property was successfully set.
+ * Sets the value of the SweepTime property. The return value indicates whether
+ * the property was successfully set.
  *
  * @method OcaSignalGenerator#SetSweepTime
  * @param {number} sweepTime
@@ -172,14 +184,16 @@ export const OcaSignalGenerator = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of the SweepRepeat property. The return value indicates whether the property was successfully retrieved.
+ * Gets the value of the SweepRepeat property. The return value indicates
+ * whether the property was successfully retrieved.
  *
  * @method OcaSignalGenerator#GetSweepRepeat
  * @returns {Promise<boolean>}
  *   A promise which resolves to a single value of type ``boolean``.
  */
 /**
- * Sets the value of the SweepRepeat property. The return value indicates whether the property was successfully set.
+ * Sets the value of the SweepRepeat property. The return value indicates
+ * whether the property was successfully set.
  *
  * @method OcaSignalGenerator#SetSweepRepeat
  * @param {boolean} sweepRepeat
@@ -187,77 +201,74 @@ export const OcaSignalGenerator = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of the Generating property. The return value indicates whether the property was successfully retrieved.
+ * Gets the value of the Generating property. The return value indicates whether
+ * the property was successfully retrieved.
  *
  * @method OcaSignalGenerator#GetGenerating
  * @returns {Promise<boolean>}
  *   A promise which resolves to a single value of type ``boolean``.
  */
 /**
- * Starts the signal generator. The return value indicates whether the signal generator was successfully started.
+ * Starts the signal generator. The return value indicates whether the signal
+ * generator was successfully started.
  *
  * @method OcaSignalGenerator#Start
  * @returns {Promise<void>}
  */
 /**
- * Stops the signal generator. The return value indicates whether the signal generator was successfully stopped.
+ * Stops the signal generator. The return value indicates whether the signal
+ * generator was successfully stopped.
  *
  * @method OcaSignalGenerator#Stop
  * @returns {Promise<void>}
  */
 /**
- * Sets some or all signal generation parameters. The return value indicates if the parameters were successfully set. The action of this method is atomic - if any of the value changes fails, none of the changes are made.
+ * Sets some or all signal generation parameters. The return value indicates if
+ * the parameters were successfully set. The action of this method is atomic -
+ * if any of the value changes fails, none of the changes are made.
  *
  * @method OcaSignalGenerator#SetMultiple
- * @param {number} Mask
- *
+ * @param {IOcaParameterMask} Mask
  * @param {number} Frequency1
- *
  * @param {number} Frequency2
- *
  * @param {number} Level
- *
- * @param {OcaWaveformType} Waveform
- *
- * @param {OcaSweepType} SweepType
- *
+ * @param {IOcaWaveformType} Waveform
+ * @param {IOcaSweepType} SweepType
  * @param {number} SweepTime
- *
  * @param {boolean} SweepRepeat
  *
  * @returns {Promise<void>}
  */
 /**
- * This event is emitted when the property Frequency1 changes in the remote object.
+ * This event is emitted when the property ``Frequency1`` changes in the remote object.
  * The property ``Frequency1`` is described in the AES70 standard as follows.
  * Center frequency or sweep start frequency.
  *
  * @member {PropertyEvent<number>} OcaSignalGenerator#OnFrequency1Changed
  */
 /**
- * This event is emitted when the property Frequency2 changes in the remote object.
+ * This event is emitted when the property ``Frequency2`` changes in the remote object.
  * The property ``Frequency2`` is described in the AES70 standard as follows.
  * Sweep end frequency.
  *
  * @member {PropertyEvent<number>} OcaSignalGenerator#OnFrequency2Changed
  */
 /**
- * This event is emitted when the property Level changes in the remote object.
+ * This event is emitted when the property ``Level`` changes in the remote object.
  * The property ``Level`` is described in the AES70 standard as follows.
  * Output level in dB relative to device-defined zero level.
  *
  * @member {PropertyEvent<number>} OcaSignalGenerator#OnLevelChanged
  */
 /**
- * This event is emitted when the property Waveform changes in the remote object.
+ * This event is emitted when the property ``Waveform`` changes in the remote object.
  * The property ``Waveform`` is described in the AES70 standard as follows.
- * The waveform type this generator generates (e.g. sine, square, noise,
- * etc.).
+ * The waveform type this generator generates (e.g. sine, square, noise, etc.).
  *
  * @member {PropertyEvent<OcaWaveformType>} OcaSignalGenerator#OnWaveformChanged
  */
 /**
- * This event is emitted when the property SweepType changes in the remote object.
+ * This event is emitted when the property ``SweepType`` changes in the remote object.
  * The property ``SweepType`` is described in the AES70 standard as follows.
  * The sweep type of the signal generator: None for no sweep, linear or
  * logarithmic if sweep is generated.
@@ -265,24 +276,24 @@ export const OcaSignalGenerator = make_control_class(
  * @member {PropertyEvent<OcaSweepType>} OcaSignalGenerator#OnSweepTypeChanged
  */
 /**
- * This event is emitted when the property SweepTime changes in the remote object.
+ * This event is emitted when the property ``SweepTime`` changes in the remote object.
  * The property ``SweepTime`` is described in the AES70 standard as follows.
  * Duration of sweep in seconds.
  *
  * @member {PropertyEvent<number>} OcaSignalGenerator#OnSweepTimeChanged
  */
 /**
- * This event is emitted when the property SweepRepeat changes in the remote object.
+ * This event is emitted when the property ``SweepRepeat`` changes in the remote object.
  * The property ``SweepRepeat`` is described in the AES70 standard as follows.
  * Indicates whether the sweep is repeated (true) or is one-shot (false).
  *
  * @member {PropertyEvent<boolean>} OcaSignalGenerator#OnSweepRepeatChanged
  */
 /**
- * This event is emitted when the property Generating changes in the remote object.
+ * This event is emitted when the property ``Generating`` changes in the remote object.
  * The property ``Generating`` is described in the AES70 standard as follows.
- * Read-only property that indicates whether the generator is producing
- * output (true) or not (false).
+ * Read-only property that indicates whether the generator is producing output
+ * (true) or not (false).
  *
  * @member {PropertyEvent<boolean>} OcaSignalGenerator#OnGeneratingChanged
  */

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

@@ -2,7 +2,10 @@ import { RemoteDevice } from '../remote_device';
 import { OcaActuator } from './OcaActuator';
 
 /**
- * A set of one or more non-network signal inputs. Number of channels is set at construction time. This class has no native properties or methods - they are all inherited from  **OcaWorker**  and above. It is defined as a separate class as an aid to enumeration and signal flow definition.
+ * A set of one or more non-network signal inputs. Number of channels is set at
+ * construction time. This class has no native properties or methods - they are
+ * all inherited from **OcaWorker** and above. It is defined as a separate class
+ * as an aid to enumeration and signal flow definition.
  * @extends OcaActuator
  * @class OcaSignalInput
  */

package/src/controller/ControlClasses/OcaSignalInput.js

@@ -2,7 +2,10 @@ import { make_control_class } from '../make_control_class.js';
 import { OcaActuator } from './OcaActuator.js';
 
 /**
- * A set of one or more non-network signal inputs. Number of channels is set at construction time. This class has no native properties or methods - they are all inherited from  **OcaWorker**  and above. It is defined as a separate class as an aid to enumeration and signal flow definition.
+ * A set of one or more non-network signal inputs. Number of channels is set at
+ * construction time. This class has no native properties or methods - they are
+ * all inherited from **OcaWorker** and above. It is defined as a separate class
+ * as an aid to enumeration and signal flow definition.
  * @extends OcaActuator
  * @class OcaSignalInput
  */

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

@@ -2,7 +2,10 @@ import { RemoteDevice } from '../remote_device';
 import { OcaActuator } from './OcaActuator';
 
 /**
- * A set of one or more non-network signal outputs. Number of channels is set at construction time. This class has no native properties or methods - they are all inherited from  **OcaWorker**  and above. It is defined as a separate class as an aid to enumeration and signal flow definition.
+ * A set of one or more non-network signal outputs. Number of channels is set at
+ * construction time. This class has no native properties or methods - they are
+ * all inherited from **OcaWorker** and above. It is defined as a separate class
+ * as an aid to enumeration and signal flow definition.
  * @extends OcaActuator
  * @class OcaSignalOutput
  */

package/src/controller/ControlClasses/OcaSignalOutput.js

@@ -2,7 +2,10 @@ import { make_control_class } from '../make_control_class.js';
 import { OcaActuator } from './OcaActuator.js';
 
 /**
- * A set of one or more non-network signal outputs. Number of channels is set at construction time. This class has no native properties or methods - they are all inherited from  **OcaWorker**  and above. It is defined as a separate class as an aid to enumeration and signal flow definition.
+ * A set of one or more non-network signal outputs. Number of channels is set at
+ * construction time. This class has no native properties or methods - they are
+ * all inherited from **OcaWorker** and above. It is defined as a separate class
+ * as an aid to enumeration and signal flow definition.
  * @extends OcaActuator
  * @class OcaSignalOutput
  */

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

@@ -1,21 +1,42 @@
+import {
+  IOcaNetworkMediaSourceOrSink,
+  OcaNetworkMediaSourceOrSink,
+} from '../../types/OcaNetworkMediaSourceOrSink';
+import { IOcaStream, OcaStream } from '../../types/OcaStream';
+import { OcaStreamConnectorStatus } from '../../types/OcaStreamConnectorStatus';
+import { PropertyEvent } from '../property_event';
 import { RemoteDevice } from '../remote_device';
 import { OcaAgent } from './OcaAgent';
 
-import { PropertyEvent } from '../property_event';
-import { IOcaNetworkMediaSourceOrSink } from '../../types/OcaNetworkMediaSourceOrSink';
-import { IOcaStream } from '../../types/OcaStream';
-import { OcaNetworkMediaSourceOrSink } from '../../types/OcaNetworkMediaSourceOrSink';
-import { OcaStream } from '../../types/OcaStream';
-import { OcaStreamConnectorStatus } from '../../types/OcaStreamConnectorStatus';
-
 /**
- *  **DEPRECATED CLASS**   *Replaced by the*  **OcaMediaSinkConnector **  *and*  **OcaMediaSourceConnector **  *datatypes in version 3 of Connection Management (CM3)*  Agent class for objects ("connectors") that allow connection of streams to the device. Streams may be single channels or multichannel groups. A connector is either a  *source*  or a  *sink.*  Sources are sometimes called "talkers". Sinks are sometimes called "listeners". Each connector links to zero or more  **OcaStream**  data objects. Each  **OcaStream**  object represents a signal flow to or from a local connector to a remote connector. The remote connector is usually, but not necessarily, in a different node. Each connector collects zero or more  *signal channels* . A signal channel is an instance of  **OcaNetworkSignalChannel.**  Each signal channel exposes one media channel of the stream to the interior of the device. A signal channel therefore is a Worker that contains exactly one  **OcaPort**  data object. Each  **OcaStreamConnector** object belongs to a particular instance of  **OcaStreamNetwork**  or a subclass of  **OcaStreamNetwork**   **.**  Each  **OcaStreamConnector** is linked to its network through the  **Owner**  property.
+ * **DEPRECATED CLASS** *Replaced by the* **OcaMediaSinkConnector ***and*
+ * **OcaMediaSourceConnector ***datatypes in version 3 of Connection Management
+ * (CM3)* Agent class for objects ("connectors") that allow connection of
+ * streams to the device. Streams may be single channels or multichannel groups.
+ * A connector is either a *source* or a *sink.* Sources are sometimes called
+ * "talkers". Sinks are sometimes called "listeners". Each connector links to
+ * zero or more **OcaStream** data objects. Each **OcaStream** object represents
+ * a signal flow to or from a local connector to a remote connector. The remote
+ * connector is usually, but not necessarily, in a different node. Each
+ * connector collects zero or more *signal channels*. A signal channel is an
+ * instance of **OcaNetworkSignalChannel.** Each signal channel exposes one
+ * media channel of the stream to the interior of the device. A signal channel
+ * therefore is a Worker that contains exactly one **OcaPort** data object. Each
+ * **OcaStreamConnector** object belongs to a particular instance of
+ * **OcaStreamNetwork** or a subclass of **OcaStreamNetwork** **.** Each
+ * **OcaStreamConnector** is linked to its network through the **Owner**
+ * property.
+ *
+ *  - When a controller creates an **OcaStreamConnector** object dynamically,
+ *    the controller must store the Object Number of the corresponding
+ *    **OcaStreamNetwork** object in the **Owner** property.
  *
- *  - When a controller creates an  **OcaStreamConnector** object dynamically, the controller must store the Object Number of the corresponding  **OcaStreamNetwork** object in the  **Owner**  property.
+ *  - Upon receiving the **Owner** property change, the **OcaStreamConnector**
+ *    object must register itself with the given stream network object via some
+ *    internal means.
  *
  *
- *  - Upon receiving the  **Owner**  property change, the  **OcaStreamConnector** object must register itself with the given stream network object via some internal means.
- *   This class may be subclassed to support various network types.
+ * This class may be subclassed to support various network types. ** **
  * @extends OcaAgent
  * @class OcaStreamConnector
  */
@@ -53,10 +74,11 @@ export declare class OcaStreamConnector extends OcaAgent {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Connects a stream to this connector. Return status indicates success of operation.
+   * Connects a stream to this connector. Return status indicates success of
+   * operation.
    *
    * @method OcaStreamConnector#ConnectStream
-   * @param {OcaStream} Stream
+   * @param {IOcaStream} Stream
    *
    * @returns {Promise<number>}
    *   A promise which resolves to a single value of type ``number``.
@@ -64,7 +86,8 @@ export declare class OcaStreamConnector extends OcaAgent {
   ConnectStream(Stream: IOcaStream): Promise<number>;
 
   /**
-   * Disconnects a stream from this connector. Return status indicates success of operation.
+   * Disconnects a stream from this connector. Return status indicates success
+   * of operation.
    *
    * @method OcaStreamConnector#DisconnectStream
    * @param {number} StreamID
@@ -74,7 +97,8 @@ export declare class OcaStreamConnector extends OcaAgent {
   DisconnectStream(StreamID: number): Promise<void>;
 
   /**
-   * Gets the value of the IDAdvertised property. Return status indicates success of operation.
+   * Gets the value of the IDAdvertised property. Return status indicates
+   * success of operation.
    *
    * @method OcaStreamConnector#GetIDAdvertised
    * @returns {Promise<Uint8Array>}
@@ -83,7 +107,8 @@ export declare class OcaStreamConnector extends OcaAgent {
   GetIDAdvertised(): Promise<Uint8Array>;
 
   /**
-   * Gets the object number of the  **OcaStreamNetwork** object to which this connector belongs. Return status indicates success of operation.
+   * Gets the object number of the **OcaStreamNetwork** object to which this
+   * connector belongs. Return status indicates success of operation.
    *
    * @method OcaStreamConnector#GetOwnerNetwork
    * @returns {Promise<number>}
@@ -92,7 +117,8 @@ export declare class OcaStreamConnector extends OcaAgent {
   GetOwnerNetwork(): Promise<number>;
 
   /**
-   * Gets the list of object numbers of  **OcaNetworkSignalChannel** objects connected to this connector. Return status indicates success of operation.
+   * Gets the list of object numbers of **OcaNetworkSignalChannel** objects
+   * connected to this connector. Return status indicates success of operation.
    *
    * @method OcaStreamConnector#GetPins
    * @returns {Promise<Map<number, number>>}
@@ -101,7 +127,8 @@ export declare class OcaStreamConnector extends OcaAgent {
   GetPins(): Promise<Map<number, number>>;
 
   /**
-   * Gets the value of the SourceOrSink property. Return status indicates success of operation.
+   * Gets the value of the SourceOrSink property. Return status indicates
+   * success of operation.
    *
    * @method OcaStreamConnector#GetSourceOrSink
    * @returns {Promise<OcaNetworkMediaSourceOrSink>}
@@ -110,7 +137,8 @@ export declare class OcaStreamConnector extends OcaAgent {
   GetSourceOrSink(): Promise<OcaNetworkMediaSourceOrSink>;
 
   /**
-   * Gets the value of the Status property. Return status indicates success of operation.
+   * Gets the value of the Status property. Return status indicates success of
+   * operation.
    *
    * @method OcaStreamConnector#GetStatus
    * @returns {Promise<OcaStreamConnectorStatus>}
@@ -119,7 +147,8 @@ export declare class OcaStreamConnector extends OcaAgent {
   GetStatus(): Promise<OcaStreamConnectorStatus>;
 
   /**
-   * Gets the map of OcaStream items connected to this connector. Return status indicates success of operation.
+   * Gets the map of OcaStream items connected to this connector. Return status
+   * indicates success of operation.
    *
    * @method OcaStreamConnector#GetStreams
    * @returns {Promise<Map<number, OcaStream>>}
@@ -128,7 +157,8 @@ export declare class OcaStreamConnector extends OcaAgent {
   GetStreams(): Promise<Map<number, OcaStream>>;
 
   /**
-   * Sets the value of the IDAdvertised property. Return status indicates success of operation.
+   * Sets the value of the IDAdvertised property. Return status indicates
+   * success of operation.
    *
    * @method OcaStreamConnector#SetIDAdvertised
    * @param {Uint8Array} IDAdvertised
@@ -138,7 +168,9 @@ export declare class OcaStreamConnector extends OcaAgent {
   SetIDAdvertised(IDAdvertised: Uint8Array): Promise<void>;
 
   /**
-   * Sets the object number of the  **OcaStreamNetwork** object to which this connector belongs. Return status indicates success of operation. Only implemented for reconfigurable devices.
+   * Sets the object number of the **OcaStreamNetwork** object to which this
+   * connector belongs. Return status indicates success of operation. Only
+   * implemented for reconfigurable devices.
    *
    * @method OcaStreamConnector#SetOwnerNetwork
    * @param {number} Network
@@ -148,10 +180,13 @@ export declare class OcaStreamConnector extends OcaAgent {
   SetOwnerNetwork(Network: number): Promise<void>;
 
   /**
-   * Sets the value of the SourceOrSink property. Return status indicates success of operation. Only implemented for reconfigurable devices. Note that this method can only be called when the SignalChannels property is empty, i.e. does not contain any actual channels.
+   * Sets the value of the SourceOrSink property. Return status indicates
+   * success of operation. Only implemented for reconfigurable devices. Note
+   * that this method can only be called when the SignalChannels property is
+   * empty, i.e. does not contain any actual channels.
    *
    * @method OcaStreamConnector#SetSourceOrSink
-   * @param {OcaNetworkMediaSourceOrSink} SourceOrSink
+   * @param {IOcaNetworkMediaSourceOrSink} SourceOrSink
    *
    * @returns {Promise<void>}
    */