aes70 1.6.1 → 2.0.0

package/src/controller/ControlClasses/OcaMediaClock3.js

@@ -2,7 +2,7 @@ import { OcaList } from '../../OCP1/OcaList.js';
 import { OcaMap } from '../../OCP1/OcaMap.js';
 import { OcaMediaClockAvailability } from '../../OCP1/OcaMediaClockAvailability.js';
 import { OcaMediaClockRate } from '../../OCP1/OcaMediaClockRate.js';
-import { OcaTimePTP } from '../../OCP1/OcaTimePTP.js';
+import { OcaTime } from '../../OCP1/OcaTime.js';
 import { OcaUint32 } from '../../OCP1/OcaUint32.js';
 import { make_control_class } from '../make_control_class.js';
 import { OcaAgent } from './OcaAgent.js';
@@ -17,15 +17,15 @@ export const OcaMediaClock3 = make_control_class(
   'OcaMediaClock3',
   3,
   '\u0001\u0002\u000f',
-  1,
+  3,
   OcaAgent,
   [
     ['GetAvailability', 3, 1, [], [OcaMediaClockAvailability]],
     ['SetAvailability', 3, 2, [OcaMediaClockAvailability], []],
     ['GetCurrentRate', 3, 3, [], [OcaMediaClockRate, OcaUint32]],
     ['SetCurrentRate', 3, 4, [OcaMediaClockRate, OcaUint32], []],
-    ['GetOffset', 3, 5, [], [OcaTimePTP]],
-    ['SetOffset', 3, 6, [OcaTimePTP], []],
+    ['GetOffset', 3, 5, [], [OcaTime]],
+    ['SetOffset', 3, 6, [OcaTime], []],
     [
       'GetSupportedRates',
       3,
@@ -37,7 +37,7 @@ export const OcaMediaClock3 = make_control_class(
   [
     ['Availability', [OcaMediaClockAvailability], 3, 1, false, false, null],
     ['TimeSourceONo', [OcaUint32], 3, 2, false, false, null],
-    ['Offset', [OcaTimePTP], 3, 3, false, false, null],
+    ['Offset', [OcaTime], 3, 3, false, false, null],
     ['CurrentRate', [OcaMediaClockRate], 3, 4, false, false, null],
     [
       'SupportedRates',
@@ -53,17 +53,15 @@ export const OcaMediaClock3 = make_control_class(
 );
 
 /**
- * Gets the value of the **Availability** property. The return value indicates
- * whether the value was successfully retrieved.
+ * Gets the value of the **Availability** property.
  *
  * @method OcaMediaClock3#GetAvailability
  * @returns {Promise<OcaMediaClockAvailability>}
  *   A promise which resolves to a single value of type :class:`OcaMediaClockAvailability`.
  */
 /**
- * Sets the value of the **Availability** property. The return value indicates
- * whether the value was successfully set. Optional method, may not be supported
- * in all implementations.
+ * Sets the value of the **Availability** property. Optional method, need not be
+ * supported in all implementations.
  *
  * @method OcaMediaClock3#SetAvailability
  * @param {IOcaMediaClockAvailability} Availability
@@ -72,8 +70,7 @@ export const OcaMediaClock3 = make_control_class(
  */
 /**
  * Gets the current clock rate and the ONo of the associated **OcaTimeSource**
- * object. The return value indicates whether the value was successfully
- * retrieved.
+ * object.
  * The return values of this method are
  *
  * - Rate of type ``IOcaMediaClockRate``
@@ -84,8 +81,7 @@ export const OcaMediaClock3 = make_control_class(
  */
 /**
  * Sets the clock rate and the ONo of the associated **OcaTimeSource** object.
- * The return value indicates whether the value was successfully set. Optional
- * method, may not be supported in all implementations.
+ * Optional method, may not be supported in all implementations.
  *
  * @method OcaMediaClock3#SetCurrentRate
  * @param {IOcaMediaClockRate} Rate
@@ -95,27 +91,24 @@ export const OcaMediaClock3 = make_control_class(
  */
 /**
  * Gets the offset of this media clock's time from that of the associated
- * **OcaTimeSource** object. The return value indicates whether the value was
- * successfully retrieved.
+ * **OcaTimeSource** object.
  *
  * @method OcaMediaClock3#GetOffset
- * @returns {Promise<OcaTimePTP>}
- *   A promise which resolves to a single value of type :class:`OcaTimePTP`.
+ * @returns {Promise<OcaTime>}
+ *   A promise which resolves to a single value of type :class:`OcaTime`.
  */
 /**
  * Sets the offset of this media clock's time from that of the associated
- * **OcaTimeSource** object. The return value indicates whether the value was
- * successfully set. Optional method, may not be supported in all
+ * **OcaTimeSource** object. Optional method, may not be supported in all
  * implementations.
  *
  * @method OcaMediaClock3#SetOffset
- * @param {IOcaTimePTP} Offset
+ * @param {IOcaTime} Offset
  *
  * @returns {Promise<void>}
  */
 /**
- * Gets the list of supported media clock rates for the given time source. The
- * return value indicates whether the list was successfully retrieved.
+ * Gets the list of supported media clock rates for each supported time source.
  *
  * @method OcaMediaClock3#GetSupportedRates
  * @returns {Promise<Map<number, OcaMediaClockRate[]>>}
@@ -124,14 +117,14 @@ export const OcaMediaClock3 = make_control_class(
 /**
  * This event is emitted when the property ``Availability`` changes in the remote object.
  * The property ``Availability`` is described in the AES70 standard as follows.
- * Availability of media clock.
+ * Availability of the media clock.
  *
  * @member {PropertyEvent<OcaMediaClockAvailability>} OcaMediaClock3#OnAvailabilityChanged
  */
 /**
  * This event is emitted when the property ``TimeSourceONo`` changes in the remote object.
  * The property ``TimeSourceONo`` is described in the AES70 standard as follows.
- * ONo of time source that drives this media clock.
+ * **ONo** of time source object that drives this media clock.
  *
  * @member {PropertyEvent<number>} OcaMediaClock3#OnTimeSourceONoChanged
  */
@@ -142,7 +135,7 @@ export const OcaMediaClock3 = make_control_class(
  * transport networks, this value is NOT the RTP time offset. RTP time offset is
  * an implementation detail that is out of AES70's scope.
  *
- * @member {PropertyEvent<OcaTimePTP>} OcaMediaClock3#OnOffsetChanged
+ * @member {PropertyEvent<OcaTime>} OcaMediaClock3#OnOffsetChanged
  */
 /**
  * This event is emitted when the property ``CurrentRate`` changes in the remote object.
@@ -154,9 +147,9 @@ export const OcaMediaClock3 = make_control_class(
 /**
  * This event is emitted when the property ``SupportedRates`` changes in the remote object.
  * The property ``SupportedRates`` is described in the AES70 standard as follows.
- * Map of supported rates for each supported time source. Key of map is ONo of
- * supported time source; value is list of supported clock rates for the given
- * time source. Private parameter, does not generate property-change events.
+ * Map of supported rates for each supported time source. Key of map is **ONo**
+ * of an **OcaTimeSource** object; value is list of supported clock rates for
+ * the given time source.
  *
  * @member {PropertyEvent<Map<number, OcaMediaClockRate[]>>} OcaMediaClock3#OnSupportedRatesChanged
  */

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

@@ -6,10 +6,12 @@ import { OcaManager } from './OcaManager';
 /**
  * Optional manager that collects all media clocks the device uses.
  *
- *  - Must be instantiated once for every device that has more than one media
- *    clock object. In this context, "media clock" means an instance of
+ *  - Must be instantiated in every device that has more than one media clock
+ *    object. In this context, "media clock" means an instance of
  *    **OcaMediaClock**, **OcaMediaClock3**, or any subclass of these classes.
  *
+ *  - May be instantiated at most once in any device.
+ *
  *  - If instantiated, object number must be 7.
  *
  *
@@ -22,10 +24,6 @@ export declare class OcaMediaClockManager extends OcaManager {
    */
   OnClockSourceTypesSupportedChanged: PropertyEvent<OcaMediaClockType[]>;
 
-  /**
-   * An alias for OnClockSourceTypesSupportedChanged
-   */
-  OnMediaClockTypesSupportedChanged: PropertyEvent<OcaMediaClockType[]>;
   /**
    * This event is emitted whenever Clocks changes.
    */
@@ -40,8 +38,7 @@ export declare class OcaMediaClockManager extends OcaManager {
 
   /**
    * Gets the list of object numbers of **OcaMediaClock** instances in this
-   * device. Return value indicates whether list was successfully retrieved.
-   * Note: In AES70-2017, this method is deprecated.
+   * device. **Deprecated** in version 2 of this class.
    *
    * @method OcaMediaClockManager#GetClocks
    * @returns {Promise<number[]>}
@@ -52,7 +49,7 @@ export declare class OcaMediaClockManager extends OcaManager {
   /**
    * Gets the list of media clock types supported by **OcaMediaClock** objects
    * in the device. Return value indicates whether the list was successfully
-   * retrieved. Note : In AES70-2017, this method is deprecated.
+   * retrieved. **Deprecated** in version 2 of this class.
    *
    * @method OcaMediaClockManager#GetMediaClockTypesSupported
    * @returns {Promise<OcaMediaClockType[]>}
@@ -62,7 +59,7 @@ export declare class OcaMediaClockManager extends OcaManager {
 
   /**
    * Gets the list of object numbers of **OcaMediaClock3** instances in this
-   * device. Return value indicates whether list was successfully retrieved.
+   * device.
    *
    * @method OcaMediaClockManager#GetClock3s
    * @returns {Promise<number[]>}

package/src/controller/ControlClasses/OcaMediaClockManager.js

@@ -7,10 +7,12 @@ import { OcaManager } from './OcaManager.js';
 /**
  * Optional manager that collects all media clocks the device uses.
  *
- *  - Must be instantiated once for every device that has more than one media
- *    clock object. In this context, "media clock" means an instance of
+ *  - Must be instantiated in every device that has more than one media clock
+ *    object. In this context, "media clock" means an instance of
  *    **OcaMediaClock**, **OcaMediaClock3**, or any subclass of these classes.
  *
+ *  - May be instantiated at most once in any device.
+ *
  *  - If instantiated, object number must be 7.
  *
  *
@@ -21,7 +23,7 @@ export const OcaMediaClockManager = make_control_class(
   'OcaMediaClockManager',
   3,
   '\u0001\u0003\u0007',
-  2,
+  3,
   OcaManager,
   [
     ['GetClocks', 3, 1, [], [OcaList(OcaUint32)]],
@@ -36,7 +38,7 @@ export const OcaMediaClockManager = make_control_class(
       1,
       false,
       false,
-      ['MediaClockTypesSupported'],
+      null,
     ],
     ['Clocks', [OcaList(OcaUint32)], 3, 2, false, false, null],
     ['Clock3s', [OcaList(OcaUint32)], 3, 3, false, false, null],
@@ -46,8 +48,7 @@ export const OcaMediaClockManager = make_control_class(
 
 /**
  * Gets the list of object numbers of **OcaMediaClock** instances in this
- * device. Return value indicates whether list was successfully retrieved. Note:
- * In AES70-2017, this method is deprecated.
+ * device. **Deprecated** in version 2 of this class.
  *
  * @method OcaMediaClockManager#GetClocks
  * @returns {Promise<number[]>}
@@ -56,7 +57,7 @@ export const OcaMediaClockManager = make_control_class(
 /**
  * Gets the list of media clock types supported by **OcaMediaClock** objects in
  * the device. Return value indicates whether the list was successfully
- * retrieved. Note : In AES70-2017, this method is deprecated.
+ * retrieved. **Deprecated** in version 2 of this class.
  *
  * @method OcaMediaClockManager#GetMediaClockTypesSupported
  * @returns {Promise<OcaMediaClockType[]>}
@@ -64,7 +65,7 @@ export const OcaMediaClockManager = make_control_class(
  */
 /**
  * Gets the list of object numbers of **OcaMediaClock3** instances in this
- * device. Return value indicates whether list was successfully retrieved.
+ * device.
  *
  * @method OcaMediaClockManager#GetClock3s
  * @returns {Promise<number[]>}
@@ -82,11 +83,6 @@ 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/OcaMediaRecorderPlayer.d.ts

@@ -0,0 +1,235 @@
+import { IOcaLockState } from '../../types/OcaLockState';
+import { IOcaMediaAccessMode } from '../../types/OcaMediaAccessMode';
+import {
+  IOcaMediaPlayOption,
+  OcaMediaPlayOption,
+} from '../../types/OcaMediaPlayOption';
+import { OcaMediaRecorderPlayerState } from '../../types/OcaMediaRecorderPlayerState';
+import { IOcaMediaTrackFunction } from '../../types/OcaMediaTrackFunction';
+import {
+  IOcaMediaVolumePosition,
+  OcaMediaVolumePosition,
+} from '../../types/OcaMediaVolumePosition';
+import { Arguments } from '../arguments';
+import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaDatasetWorker } from './OcaDatasetWorker';
+
+/**
+ * Media volume recorder/player that shall provide streaming data access into
+ * and out of **OcaDataset** objects whose Datasets are media files.
+ * @extends OcaDatasetWorker
+ * @class OcaMediaRecorderPlayer
+ */
+export declare class OcaMediaRecorderPlayer extends OcaDatasetWorker {
+  /**
+   * This event is emitted whenever State changes.
+   */
+  OnStateChanged: PropertyEvent<OcaMediaRecorderPlayerState>;
+
+  /**
+   * This event is emitted whenever TrackCount changes.
+   */
+  OnTrackCountChanged: PropertyEvent<number>;
+
+  /**
+   * This event is emitted whenever TrackFunctions changes.
+   */
+  OnTrackFunctionsChanged: PropertyEvent<IOcaMediaTrackFunction[]>;
+
+  /**
+   * This event is emitted whenever PlayOption changes.
+   */
+  OnPlayOptionChanged: PropertyEvent<OcaMediaPlayOption>;
+
+  /**
+   * This event is emitted whenever WindowStart changes.
+   */
+  OnWindowStartChanged: PropertyEvent<OcaMediaVolumePosition>;
+
+  /**
+   * This event is emitted whenever WindowEnd changes.
+   */
+  OnWindowEndChanged: PropertyEvent<OcaMediaVolumePosition>;
+
+  constructor(objectNumber: number, device: RemoteDevice);
+
+  /**
+   * Opens a session with a media volume for playing or recording. Request a
+   * readonly or exclusive lock, if desired.
+   *
+   * @method OcaMediaRecorderPlayer#Open
+   * @param {number} DatasetONo
+   * @param {IOcaMediaAccessMode} AccessMode
+   * @param {IOcaLockState} LockState
+   *
+   * @returns {Promise<void>}
+   */
+  Open(
+    DatasetONo: number,
+    AccessMode: IOcaMediaAccessMode,
+    LockState: IOcaLockState
+  ): Promise<void>;
+
+  /**
+   * Closes this object's session on the open media volume.
+   *
+   * @method OcaMediaRecorderPlayer#Close
+   * @returns {Promise<void>}
+   */
+  Close(): Promise<void>;
+
+  /**
+   * Starts recording immediately. Overwrites the current record/play window,
+   * from current position to end.
+   *
+   * @method OcaMediaRecorderPlayer#Record
+   * @returns {Promise<void>}
+   */
+  Record(): Promise<void>;
+
+  /**
+   * Starts playing immediately. Plays the current record/play window, from
+   * current position to end.
+   *
+   * @method OcaMediaRecorderPlayer#Play
+   * @returns {Promise<void>}
+   */
+  Play(): Promise<void>;
+
+  /**
+   * Stops playing / recording immediately, does not close session. Leaves
+   * **Position** at (last accessed +1 ).
+   *
+   * @method OcaMediaRecorderPlayer#Stop
+   * @returns {Promise<void>}
+   */
+  Stop(): Promise<void>;
+
+  /**
+   * Stops playing/recording immediately. Resets record/play window range to
+   * entire volume. Sets P**osition** to start of volume. Sets **PlayOption** to
+   * **Normal**. Does **not **reset track functions.
+   *
+   * @method OcaMediaRecorderPlayer#Reset
+   * @returns {Promise<void>}
+   */
+  Reset(): Promise<void>;
+
+  /**
+   * Returns current state of this **OcaMediaRecorderPlayer** object.
+   *
+   * @method OcaMediaRecorderPlayer#GetState
+   * @returns {Promise<OcaMediaRecorderPlayerState>}
+   *   A promise which resolves to a single value of type :class:`OcaMediaRecorderPlayerState`.
+   */
+  GetState(): Promise<OcaMediaRecorderPlayerState>;
+
+  /**
+   * Returns track count of currently open media volume, or zero if no volume is
+   * open.
+   *
+   * @method OcaMediaRecorderPlayer#GetTrackCount
+   * @returns {Promise<number>}
+   *   A promise which resolves to a single value of type ``number``.
+   */
+  GetTrackCount(): Promise<number>;
+
+  /**
+   * Sets track count of currently open media volume. Fails if media volume is
+   * not open in RECORD mode, or if no media volume is open.
+   *
+   * @method OcaMediaRecorderPlayer#SetTrackCount
+   * @param {number} TrackCount
+   *
+   * @returns {Promise<void>}
+   */
+  SetTrackCount(TrackCount: number): Promise<void>;
+
+  /**
+   * Returns the list of track functions.
+   *
+   * @method OcaMediaRecorderPlayer#GetTrackFunctions
+   * @returns {Promise<IOcaMediaTrackFunction[]>}
+   *   A promise which resolves to a single value of type ``IOcaMediaTrackFunction[]``.
+   */
+  GetTrackFunctions(): Promise<IOcaMediaTrackFunction[]>;
+
+  /**
+   * Sets the list of track functions. Fails if no media volume is open.
+   *
+   * @method OcaMediaRecorderPlayer#SetTrackFunctions
+   * @param {IOcaMediaTrackFunction[]} Functions
+   *
+   * @returns {Promise<void>}
+   */
+  SetTrackFunctions(Functions: IOcaMediaTrackFunction[]): Promise<void>;
+
+  /**
+   * Returns value of **PlayOption** property.
+   *
+   * @method OcaMediaRecorderPlayer#GetPlayOption
+   * @returns {Promise<OcaMediaPlayOption>}
+   *   A promise which resolves to a single value of type :class:`OcaMediaPlayOption`.
+   */
+  GetPlayOption(): Promise<OcaMediaPlayOption>;
+
+  /**
+   * Sets value of **PlayOption** property.
+   *
+   * @method OcaMediaRecorderPlayer#SetPlayOption
+   * @param {IOcaMediaPlayOption} Option
+   *
+   * @returns {Promise<void>}
+   */
+  SetPlayOption(Option: IOcaMediaPlayOption): Promise<void>;
+
+  /**
+   * Returns current media position or null value if no media volume is open.
+   * Value is relative to the start of the current interval.
+   *
+   * @method OcaMediaRecorderPlayer#GetPosition
+   * @returns {Promise<OcaMediaVolumePosition>}
+   *   A promise which resolves to a single value of type :class:`OcaMediaVolumePosition`.
+   */
+  GetPosition(): Promise<OcaMediaVolumePosition>;
+
+  /**
+   * Sets media position. Value is relative to the start of the current
+   * interval.
+   *
+   * @method OcaMediaRecorderPlayer#SetPosition
+   * @param {IOcaMediaVolumePosition} Position
+   *
+   * @returns {Promise<void>}
+   */
+  SetPosition(Position: IOcaMediaVolumePosition): Promise<void>;
+
+  /**
+   * Returns start and end point positions of current record/play window.
+   * The return values of this method are
+   *
+   * - FirstPosition of type ``IOcaMediaVolumePosition``
+   * - LastPosition of type ``IOcaMediaVolumePosition``
+   *
+   * @method OcaMediaRecorderPlayer#GetWindowRange
+   * @returns {Promise<Arguments<OcaMediaVolumePosition,OcaMediaVolumePosition>>}
+   */
+  GetWindowRange(): Promise<
+    Arguments<[OcaMediaVolumePosition, OcaMediaVolumePosition]>
+  >;
+
+  /**
+   * Sets start and end point positions of current record/play window.
+   *
+   * @method OcaMediaRecorderPlayer#SetWindowRange
+   * @param {IOcaMediaVolumePosition} FirstPosition
+   * @param {IOcaMediaVolumePosition} LastPosition
+   *
+   * @returns {Promise<void>}
+   */
+  SetWindowRange(
+    FirstPosition: IOcaMediaVolumePosition,
+    LastPosition: IOcaMediaVolumePosition
+  ): Promise<void>;
+}