aes70 1.3.8 → 1.4.0

package/src/controller/ControlClasses/OcaMediaClock3.js

@@ -1,14 +1,15 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaAgent } from './OcaAgent.js';
 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 { OcaUint32 } from '../../OCP1/OcaUint32.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaAgent } from './OcaAgent.js';
 
 /**
- * A media clock, internal or external. OCA Connection Management 3 (OCA-CM3) version.
+ * A media clock, internal or external. OCA Connection Management 3 (OCA-CM3)
+ * version.
  * @extends OcaAgent
  * @class OcaMediaClock3
  */
@@ -52,99 +53,110 @@ 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. The return value indicates
+ * whether the value was successfully retrieved.
  *
  * @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. The return value indicates
+ * whether the value was successfully set. Optional method, may not be supported
+ * in all implementations.
  *
  * @method OcaMediaClock3#SetAvailability
- * @param {OcaMediaClockAvailability} Availability
+ * @param {IOcaMediaClockAvailability} Availability
  *
  * @returns {Promise<void>}
  */
 /**
- * Gets the current clock rate and the ONo of the associated  **OcaTimeSource** object. The return value indicates whether the value was successfully retrieved.
+ * Gets the current clock rate and the ONo of the associated **OcaTimeSource**
+ * object. The return value indicates whether the value was successfully
+ * retrieved.
  * The return values of this method are
  *
- * - Rate of type :class:`OcaMediaClockRate`
+ * - Rate of type ``IOcaMediaClockRate``
  * - TimeSourceONo of type ``number``
  *
  * @method OcaMediaClock3#GetCurrentRate
  * @returns {Promise<Arguments<OcaMediaClockRate,number>>}
  */
 /**
- * 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.
+ * 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.
  *
  * @method OcaMediaClock3#SetCurrentRate
- * @param {OcaMediaClockRate} Rate
- *
+ * @param {IOcaMediaClockRate} Rate
  * @param {number} TimeSourceONo
  *
  * @returns {Promise<void>}
  */
 /**
- * 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.
+ * 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.
  *
  * @method OcaMediaClock3#GetOffset
  * @returns {Promise<OcaTimePTP>}
  *   A promise which resolves to a single value of type :class:`OcaTimePTP`.
  */
 /**
- * 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 implementations.
+ * 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
+ * implementations.
  *
  * @method OcaMediaClock3#SetOffset
- * @param {OcaTimePTP} Offset
+ * @param {IOcaTimePTP} 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 the given time source. The
+ * return value indicates whether the list was successfully retrieved.
  *
  * @method OcaMediaClock3#GetSupportedRates
  * @returns {Promise<Map<number, OcaMediaClockRate[]>>}
  *   A promise which resolves to a single value of type ``Map<number, OcaMediaClockRate[]>``.
  */
 /**
- * This event is emitted when the property Availability changes in the remote object.
+ * 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.
  *
  * @member {PropertyEvent<OcaMediaClockAvailability>} OcaMediaClock3#OnAvailabilityChanged
  */
 /**
- * This event is emitted when the property TimeSourceONo changes in the remote object.
+ * 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.
  *
  * @member {PropertyEvent<number>} OcaMediaClock3#OnTimeSourceONoChanged
  */
 /**
- * This event is emitted when the property Offset changes in the remote object.
+ * This event is emitted when the property ``Offset`` changes in the remote object.
  * The property ``Offset`` is described in the AES70 standard as follows.
- * Offset of media clock time from reference time. Note: For RTP-based
- * media transport networks, this value is NOT the RTP time offset. RTP
- * time offset is an implementation detail that is out of AES70's scope.
+ * Offset of media clock time from reference time. Note: For RTP-based media
+ * 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
  */
 /**
- * This event is emitted when the property CurrentRate changes in the remote object.
+ * This event is emitted when the property ``CurrentRate`` changes in the remote object.
  * The property ``CurrentRate`` is described in the AES70 standard as follows.
  * Current clock rate
  *
  * @member {PropertyEvent<OcaMediaClockRate>} OcaMediaClock3#OnCurrentRateChanged
  */
 /**
- * This event is emitted when the property SupportedRates changes in the remote object.
+ * 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
+ * supported time source; value is list of supported clock rates for the given
+ * time source. Private parameter, does not generate property-change events.
  *
  * @member {PropertyEvent<Map<number, OcaMediaClockRate[]>>} OcaMediaClock3#OnSupportedRatesChanged
  */

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

@@ -1,17 +1,18 @@
+import { OcaMediaClockType } from '../../types/OcaMediaClockType';
+import { PropertyEvent } from '../property_event';
 import { RemoteDevice } from '../remote_device';
 import { OcaManager } from './OcaManager';
 
-import { PropertyEvent } from '../property_event';
-import { OcaMediaClockType } from '../../types/OcaMediaClockType';
-
 /**
  * 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  **OcaMediaClock** ,  **OcaMediaClock3** , or any subclass of these classes.
- *
+ *  - Must be instantiated once for 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.
  *
  *  - If instantiated, object number must be 7.
  *
+ *
  * @extends OcaManager
  * @class OcaMediaClockManager
  */
@@ -34,7 +35,9 @@ export declare class OcaMediaClockManager extends OcaManager {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * 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.
+   * 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.
    *
    * @method OcaMediaClockManager#GetClocks
    * @returns {Promise<number[]>}
@@ -43,16 +46,19 @@ export declare class OcaMediaClockManager extends OcaManager {
   GetClocks(): Promise<number[]>;
 
   /**
-   * 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.
+   * 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.
    *
    * @method OcaMediaClockManager#GetMediaClockTypesSupported
    * @returns {Promise<OcaMediaClockType[]>}
-   *   A promise which resolves to a single value of type ``OcaMediaClockType[]``.
+   *   A promise which resolves to a single value of type :class:`OcaMediaClockType[]`.
    */
   GetMediaClockTypesSupported(): Promise<OcaMediaClockType[]>;
 
   /**
-   * Gets the list of object numbers of  **OcaMediaClock3** instances in this device. Return value indicates whether list was successfully retrieved.
+   * Gets the list of object numbers of **OcaMediaClock3** instances in this
+   * device. Return value indicates whether list was successfully retrieved.
    *
    * @method OcaMediaClockManager#GetClock3s
    * @returns {Promise<number[]>}

package/src/controller/ControlClasses/OcaMediaClockManager.js

@@ -1,17 +1,19 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaManager } from './OcaManager.js';
 import { OcaList } from '../../OCP1/OcaList.js';
 import { OcaMediaClockType } from '../../OCP1/OcaMediaClockType.js';
 import { OcaUint32 } from '../../OCP1/OcaUint32.js';
+import { make_control_class } from '../make_control_class.js';
+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  **OcaMediaClock** ,  **OcaMediaClock3** , or any subclass of these classes.
- *
+ *  - Must be instantiated once for 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.
  *
  *  - If instantiated, object number must be 7.
  *
+ *
  * @extends OcaManager
  * @class OcaMediaClockManager
  */
@@ -43,53 +45,56 @@ 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.
+ * 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.
  *
  * @method OcaMediaClockManager#GetClocks
  * @returns {Promise<number[]>}
  *   A promise which resolves to a single value of type ``number[]``.
  */
 /**
- * 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.
+ * 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.
  *
  * @method OcaMediaClockManager#GetMediaClockTypesSupported
  * @returns {Promise<OcaMediaClockType[]>}
- *   A promise which resolves to a single value of type ``OcaMediaClockType[]``.
+ *   A promise which resolves to a single value of type :class:`OcaMediaClockType[]`.
  */
 /**
- * Gets the list of object numbers of  **OcaMediaClock3** instances in this device. Return value indicates whether list was successfully retrieved.
+ * Gets the list of object numbers of **OcaMediaClock3** instances in this
+ * device. Return value indicates whether list was successfully retrieved.
  *
  * @method OcaMediaClockManager#GetClock3s
  * @returns {Promise<number[]>}
  *   A promise which resolves to a single value of type ``number[]``.
  */
 /**
- * This event is emitted when the property ClockSourceTypesSupported changes in the remote object.
+ * This event is emitted when the property ``ClockSourceTypesSupported`` changes in the remote object.
  * The property ``ClockSourceTypesSupported`` is described in the AES70 standard as follows.
- * List of clock source types supported by <b>OcaMediaClock </b>objects
- * in this device. Note: In AES70-2017, this method is deprecated. It
- * only reflects the clock types of <b>OcaMediaClock </b>objects, which
- * are now deprecated. It does not apply to <b>OcaMediaClock3
- * </b>objects, since these do not have type attributes. If the number of
- * <b>OcaMediaClock </b>objects in the device is zero, this property is
- * empty.
+ * List of clock source types supported by **OcaMediaClock** objects in this
+ * device. Note: In AES70-2017, this method is deprecated. It only reflects the
+ * clock types of **OcaMediaClock** objects, which are now deprecated. It does
+ * not apply to **OcaMediaClock3** objects, since these do not have type
+ * attributes. If the number of **OcaMediaClock** objects in the device is zero,
+ * this property is empty.
  *
  * @member {PropertyEvent<OcaMediaClockType[]>} OcaMediaClockManager#OnClockSourceTypesSupportedChanged
  */
 /**
- * This event is emitted when the property Clocks changes in the remote object.
+ * This event is emitted when the property ``Clocks`` changes in the remote object.
  * The property ``Clocks`` is described in the AES70 standard as follows.
- * Object numbers of <b>OcaMediaClock </b>objects, one for each clock
- * which this device uses and/or sources. Note: In AES70-2017, this
- * property is deprecated.
+ * Object numbers of **OcaMediaClock** objects, one for each clock which this
+ * device uses and/or sources. Note: In AES70-2017, this property is deprecated.
  *
  * @member {PropertyEvent<number[]>} OcaMediaClockManager#OnClocksChanged
  */
 /**
- * This event is emitted when the property Clock3s changes in the remote object.
+ * This event is emitted when the property ``Clock3s`` changes in the remote object.
  * The property ``Clock3s`` is described in the AES70 standard as follows.
- * Object numbers of <b>OcaMediaClock3 </b>objects, one for each clock
- * which this device uses and/or sources.
+ * Object numbers of **OcaMediaClock3** objects, one for each clock which this
+ * device uses and/or sources.
  *
  * @member {PropertyEvent<number[]>} OcaMediaClockManager#OnClock3sChanged
  */