aes70 1.3.8 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (430) hide show
  1. package/Changelog +14 -1
  2. package/dist/AES70.es5.js +1 -1
  3. package/package.json +1 -1
  4. package/src/OCP1/OcaBlockMember.js +1 -1
  5. package/src/OCP1/OcaClassAuthorityID.js +1 -1
  6. package/src/OCP1/OcaClassIdentification.js +1 -1
  7. package/src/OCP1/OcaDBr.js +1 -1
  8. package/src/OCP1/OcaDelayValue.js +1 -1
  9. package/src/OCP1/OcaEvent.js +1 -1
  10. package/src/OCP1/OcaEventID.js +1 -1
  11. package/src/OCP1/OcaGlobalTypeIdentifier.js +1 -1
  12. package/src/OCP1/OcaGrouperCitizen.js +1 -1
  13. package/src/OCP1/OcaGrouperEnrollment.js +1 -1
  14. package/src/OCP1/OcaGrouperGroup.js +1 -1
  15. package/src/OCP1/OcaGrouperStatusChangeEventData.js +1 -3
  16. package/src/OCP1/OcaImpedance.js +1 -1
  17. package/src/OCP1/OcaLibParamSetAssignment.js +1 -1
  18. package/src/OCP1/OcaLibVol.js +1 -1
  19. package/src/OCP1/OcaLibVolChangedEventData.js +1 -3
  20. package/src/OCP1/OcaLibVolData_ParamSet.js +1 -1
  21. package/src/OCP1/OcaLibVolIdentifier.js +1 -1
  22. package/src/OCP1/OcaLibVolMetadata.js +1 -1
  23. package/src/OCP1/OcaLibVolType.js +1 -1
  24. package/src/OCP1/OcaLibraryIdentifier.js +1 -1
  25. package/src/OCP1/OcaManagerDescriptor.js +1 -1
  26. package/src/OCP1/OcaMediaClockRate.js +1 -1
  27. package/src/OCP1/OcaMediaCoding.js +1 -1
  28. package/src/OCP1/OcaMediaConnection.js +1 -1
  29. package/src/OCP1/OcaMediaConnectorElement.js +2 -2
  30. package/src/OCP1/OcaMediaConnectorStatus.js +1 -1
  31. package/src/OCP1/OcaMediaConnectorStatusChangedEventData.js +1 -3
  32. package/src/OCP1/OcaMediaSinkConnector.js +1 -1
  33. package/src/OCP1/OcaMediaSinkConnectorChangedEventData.js +1 -3
  34. package/src/OCP1/OcaMediaSourceConnector.js +1 -1
  35. package/src/OCP1/OcaMediaSourceConnectorChangedEventData.js +1 -3
  36. package/src/OCP1/OcaMethod.js +1 -1
  37. package/src/OCP1/OcaMethodID.js +1 -1
  38. package/src/OCP1/OcaModelDescription.js +1 -1
  39. package/src/OCP1/OcaModelGUID.js +1 -1
  40. package/src/OCP1/OcaNetworkStatistics.js +1 -1
  41. package/src/OCP1/OcaNetworkSystemInterfaceDescriptor.js +1 -1
  42. package/src/OCP1/OcaNetworkSystemInterfaceID.js +1 -1
  43. package/src/OCP1/OcaOPath.js +1 -1
  44. package/src/OCP1/OcaObjectIdentification.js +1 -1
  45. package/src/OCP1/OcaObjectListEventData.js +1 -3
  46. package/src/OCP1/OcaObjectSearchResult.js +1 -1
  47. package/src/OCP1/OcaObservationEventData.js +1 -3
  48. package/src/OCP1/OcaObservationListEventData.js +1 -3
  49. package/src/OCP1/OcaParameterMask.js +3 -0
  50. package/src/OCP1/OcaPilotToneDetectorSpec.js +1 -1
  51. package/src/OCP1/OcaPort.js +1 -1
  52. package/src/OCP1/OcaPortID.js +1 -1
  53. package/src/OCP1/OcaPositionDescriptor.js +3 -3
  54. package/src/OCP1/OcaPositionDescriptorFieldFlags.js +3 -0
  55. package/src/OCP1/OcaProperty.js +1 -1
  56. package/src/OCP1/OcaPropertyDescriptor.js +1 -1
  57. package/src/OCP1/OcaPropertyID.js +1 -1
  58. package/src/OCP1/OcaProtoObjectIdentification.js +1 -1
  59. package/src/OCP1/OcaProtoPort.js +1 -1
  60. package/src/OCP1/OcaProtoPortID.js +1 -1
  61. package/src/OCP1/OcaProtoSignalPath.js +1 -1
  62. package/src/OCP1/OcaSignalPath.js +1 -1
  63. package/src/OCP1/OcaStream.js +1 -1
  64. package/src/OCP1/OcaStreamConnectorIdentification.js +1 -1
  65. package/src/OCP1/OcaTask.js +1 -1
  66. package/src/OCP1/OcaTaskStateChangedEventData.js +1 -1
  67. package/src/OCP1/OcaTaskStatus.js +1 -1
  68. package/src/OCP1/OcaTimePTP.js +1 -1
  69. package/src/OCP1/OcaTransferFunction.js +1 -1
  70. package/src/OCP1/OcaVersion.js +1 -1
  71. package/src/controller/ControlClasses/OcaActuator.d.ts +3 -1
  72. package/src/controller/ControlClasses/OcaActuator.js +3 -1
  73. package/src/controller/ControlClasses/OcaAgent.d.ts +10 -7
  74. package/src/controller/ControlClasses/OcaAgent.js +12 -8
  75. package/src/controller/ControlClasses/OcaApplicationNetwork.d.ts +35 -21
  76. package/src/controller/ControlClasses/OcaApplicationNetwork.js +43 -32
  77. package/src/controller/ControlClasses/OcaAudioLevelSensor.d.ts +14 -8
  78. package/src/controller/ControlClasses/OcaAudioLevelSensor.js +13 -9
  79. package/src/controller/ControlClasses/OcaAudioProcessingManager.d.ts +3 -2
  80. package/src/controller/ControlClasses/OcaAudioProcessingManager.js +3 -2
  81. package/src/controller/ControlClasses/OcaBitstringActuator.d.ts +11 -8
  82. package/src/controller/ControlClasses/OcaBitstringActuator.js +13 -9
  83. package/src/controller/ControlClasses/OcaBitstringSensor.d.ts +7 -5
  84. package/src/controller/ControlClasses/OcaBitstringSensor.js +9 -6
  85. package/src/controller/ControlClasses/OcaBlock.d.ts +88 -74
  86. package/src/controller/ControlClasses/OcaBlock.js +80 -63
  87. package/src/controller/ControlClasses/OcaBlockFactory.d.ts +73 -29
  88. package/src/controller/ControlClasses/OcaBlockFactory.js +69 -42
  89. package/src/controller/ControlClasses/OcaBooleanActuator.d.ts +5 -4
  90. package/src/controller/ControlClasses/OcaBooleanActuator.js +6 -4
  91. package/src/controller/ControlClasses/OcaBooleanSensor.d.ts +3 -3
  92. package/src/controller/ControlClasses/OcaBooleanSensor.js +4 -3
  93. package/src/controller/ControlClasses/OcaCodingManager.d.ts +10 -7
  94. package/src/controller/ControlClasses/OcaCodingManager.js +17 -13
  95. package/src/controller/ControlClasses/OcaControlNetwork.d.ts +4 -5
  96. package/src/controller/ControlClasses/OcaControlNetwork.js +5 -6
  97. package/src/controller/ControlClasses/OcaCurrentSensor.d.ts +4 -4
  98. package/src/controller/ControlClasses/OcaCurrentSensor.js +4 -3
  99. package/src/controller/ControlClasses/OcaDelay.d.ts +6 -5
  100. package/src/controller/ControlClasses/OcaDelay.js +6 -4
  101. package/src/controller/ControlClasses/OcaDelayExtended.d.ts +18 -15
  102. package/src/controller/ControlClasses/OcaDelayExtended.js +17 -12
  103. package/src/controller/ControlClasses/OcaDeviceManager.d.ts +56 -31
  104. package/src/controller/ControlClasses/OcaDeviceManager.js +75 -51
  105. package/src/controller/ControlClasses/OcaDeviceTimeManager.d.ts +33 -16
  106. package/src/controller/ControlClasses/OcaDeviceTimeManager.js +36 -18
  107. package/src/controller/ControlClasses/OcaDiagnosticManager.d.ts +6 -3
  108. package/src/controller/ControlClasses/OcaDiagnosticManager.js +8 -5
  109. package/src/controller/ControlClasses/OcaDynamics.d.ts +89 -61
  110. package/src/controller/ControlClasses/OcaDynamics.js +101 -79
  111. package/src/controller/ControlClasses/OcaDynamicsCurve.d.ts +77 -30
  112. package/src/controller/ControlClasses/OcaDynamicsCurve.js +85 -37
  113. package/src/controller/ControlClasses/OcaDynamicsDetector.d.ts +30 -22
  114. package/src/controller/ControlClasses/OcaDynamicsDetector.js +36 -24
  115. package/src/controller/ControlClasses/OcaEventHandler.d.ts +8 -6
  116. package/src/controller/ControlClasses/OcaEventHandler.js +9 -6
  117. package/src/controller/ControlClasses/OcaFilterArbitraryCurve.d.ts +13 -9
  118. package/src/controller/ControlClasses/OcaFilterArbitraryCurve.js +15 -12
  119. package/src/controller/ControlClasses/OcaFilterClassical.d.ts +43 -30
  120. package/src/controller/ControlClasses/OcaFilterClassical.js +40 -31
  121. package/src/controller/ControlClasses/OcaFilterFIR.d.ts +12 -8
  122. package/src/controller/ControlClasses/OcaFilterFIR.js +19 -14
  123. package/src/controller/ControlClasses/OcaFilterParametric.d.ts +34 -25
  124. package/src/controller/ControlClasses/OcaFilterParametric.js +39 -33
  125. package/src/controller/ControlClasses/OcaFilterPolynomial.d.ts +6 -6
  126. package/src/controller/ControlClasses/OcaFilterPolynomial.js +11 -10
  127. package/src/controller/ControlClasses/OcaFirmwareManager.d.ts +71 -21
  128. package/src/controller/ControlClasses/OcaFirmwareManager.js +71 -22
  129. package/src/controller/ControlClasses/OcaFloat32Actuator.d.ts +6 -5
  130. package/src/controller/ControlClasses/OcaFloat32Actuator.js +6 -4
  131. package/src/controller/ControlClasses/OcaFloat32Sensor.d.ts +4 -4
  132. package/src/controller/ControlClasses/OcaFloat32Sensor.js +4 -3
  133. package/src/controller/ControlClasses/OcaFloat64Actuator.d.ts +6 -5
  134. package/src/controller/ControlClasses/OcaFloat64Actuator.js +6 -4
  135. package/src/controller/ControlClasses/OcaFloat64Sensor.d.ts +4 -4
  136. package/src/controller/ControlClasses/OcaFloat64Sensor.js +4 -3
  137. package/src/controller/ControlClasses/OcaFrequencyActuator.d.ts +6 -5
  138. package/src/controller/ControlClasses/OcaFrequencyActuator.js +6 -4
  139. package/src/controller/ControlClasses/OcaFrequencySensor.d.ts +4 -4
  140. package/src/controller/ControlClasses/OcaFrequencySensor.js +4 -3
  141. package/src/controller/ControlClasses/OcaGain.d.ts +6 -5
  142. package/src/controller/ControlClasses/OcaGain.js +6 -4
  143. package/src/controller/ControlClasses/OcaGainSensor.d.ts +6 -5
  144. package/src/controller/ControlClasses/OcaGainSensor.js +6 -4
  145. package/src/controller/ControlClasses/OcaGrouper.d.ts +138 -58
  146. package/src/controller/ControlClasses/OcaGrouper.js +139 -61
  147. package/src/controller/ControlClasses/OcaIdentificationActuator.d.ts +9 -10
  148. package/src/controller/ControlClasses/OcaIdentificationActuator.js +10 -10
  149. package/src/controller/ControlClasses/OcaIdentificationSensor.d.ts +6 -4
  150. package/src/controller/ControlClasses/OcaIdentificationSensor.js +5 -3
  151. package/src/controller/ControlClasses/OcaImpedanceSensor.d.ts +8 -8
  152. package/src/controller/ControlClasses/OcaImpedanceSensor.js +7 -6
  153. package/src/controller/ControlClasses/OcaInt16Actuator.d.ts +6 -5
  154. package/src/controller/ControlClasses/OcaInt16Actuator.js +6 -4
  155. package/src/controller/ControlClasses/OcaInt16Sensor.d.ts +4 -4
  156. package/src/controller/ControlClasses/OcaInt16Sensor.js +4 -3
  157. package/src/controller/ControlClasses/OcaInt32Actuator.d.ts +6 -5
  158. package/src/controller/ControlClasses/OcaInt32Actuator.js +6 -4
  159. package/src/controller/ControlClasses/OcaInt32Sensor.d.ts +4 -4
  160. package/src/controller/ControlClasses/OcaInt32Sensor.js +4 -3
  161. package/src/controller/ControlClasses/OcaInt64Actuator.d.ts +6 -5
  162. package/src/controller/ControlClasses/OcaInt64Actuator.js +6 -4
  163. package/src/controller/ControlClasses/OcaInt64Sensor.d.ts +4 -4
  164. package/src/controller/ControlClasses/OcaInt64Sensor.js +4 -3
  165. package/src/controller/ControlClasses/OcaInt8Actuator.d.ts +6 -5
  166. package/src/controller/ControlClasses/OcaInt8Actuator.js +6 -4
  167. package/src/controller/ControlClasses/OcaInt8Sensor.d.ts +4 -4
  168. package/src/controller/ControlClasses/OcaInt8Sensor.js +4 -3
  169. package/src/controller/ControlClasses/OcaLevelSensor.d.ts +4 -4
  170. package/src/controller/ControlClasses/OcaLevelSensor.js +4 -3
  171. package/src/controller/ControlClasses/OcaLibrary.d.ts +50 -25
  172. package/src/controller/ControlClasses/OcaLibrary.js +54 -26
  173. package/src/controller/ControlClasses/OcaLibraryManager.d.ts +22 -16
  174. package/src/controller/ControlClasses/OcaLibraryManager.js +22 -17
  175. package/src/controller/ControlClasses/OcaManager.d.ts +4 -1
  176. package/src/controller/ControlClasses/OcaManager.js +4 -1
  177. package/src/controller/ControlClasses/OcaMatrix.d.ts +69 -20
  178. package/src/controller/ControlClasses/OcaMatrix.js +86 -38
  179. package/src/controller/ControlClasses/OcaMediaClock.d.ts +33 -19
  180. package/src/controller/ControlClasses/OcaMediaClock.js +30 -19
  181. package/src/controller/ControlClasses/OcaMediaClock3.d.ts +37 -22
  182. package/src/controller/ControlClasses/OcaMediaClock3.js +39 -27
  183. package/src/controller/ControlClasses/OcaMediaClockManager.d.ts +15 -9
  184. package/src/controller/ControlClasses/OcaMediaClockManager.js +28 -23
  185. package/src/controller/ControlClasses/OcaMediaTransportNetwork.d.ts +106 -74
  186. package/src/controller/ControlClasses/OcaMediaTransportNetwork.js +121 -111
  187. package/src/controller/ControlClasses/OcaMute.d.ts +7 -7
  188. package/src/controller/ControlClasses/OcaMute.js +7 -5
  189. package/src/controller/ControlClasses/OcaNetwork.d.ts +38 -20
  190. package/src/controller/ControlClasses/OcaNetwork.js +58 -42
  191. package/src/controller/ControlClasses/OcaNetworkManager.d.ts +20 -9
  192. package/src/controller/ControlClasses/OcaNetworkManager.js +33 -23
  193. package/src/controller/ControlClasses/OcaNetworkSignalChannel.d.ts +43 -19
  194. package/src/controller/ControlClasses/OcaNetworkSignalChannel.js +67 -44
  195. package/src/controller/ControlClasses/OcaNumericObserver.d.ts +77 -38
  196. package/src/controller/ControlClasses/OcaNumericObserver.js +95 -59
  197. package/src/controller/ControlClasses/OcaNumericObserverList.d.ts +96 -45
  198. package/src/controller/ControlClasses/OcaNumericObserverList.js +129 -80
  199. package/src/controller/ControlClasses/OcaPanBalance.d.ts +10 -7
  200. package/src/controller/ControlClasses/OcaPanBalance.js +14 -11
  201. package/src/controller/ControlClasses/OcaPhysicalPosition.d.ts +31 -18
  202. package/src/controller/ControlClasses/OcaPhysicalPosition.js +43 -18
  203. package/src/controller/ControlClasses/OcaPolarity.d.ts +10 -7
  204. package/src/controller/ControlClasses/OcaPolarity.js +7 -5
  205. package/src/controller/ControlClasses/OcaPowerManager.d.ts +20 -14
  206. package/src/controller/ControlClasses/OcaPowerManager.js +27 -21
  207. package/src/controller/ControlClasses/OcaPowerSupply.d.ts +24 -15
  208. package/src/controller/ControlClasses/OcaPowerSupply.js +31 -23
  209. package/src/controller/ControlClasses/OcaRamper.d.ts +55 -34
  210. package/src/controller/ControlClasses/OcaRamper.js +58 -37
  211. package/src/controller/ControlClasses/OcaRoot.d.ts +28 -14
  212. package/src/controller/ControlClasses/OcaRoot.js +32 -24
  213. package/src/controller/ControlClasses/OcaSecurityManager.d.ts +29 -13
  214. package/src/controller/ControlClasses/OcaSecurityManager.js +31 -14
  215. package/src/controller/ControlClasses/OcaSensor.d.ts +4 -4
  216. package/src/controller/ControlClasses/OcaSensor.js +6 -5
  217. package/src/controller/ControlClasses/OcaSignalGenerator.d.ts +48 -38
  218. package/src/controller/ControlClasses/OcaSignalGenerator.js +57 -46
  219. package/src/controller/ControlClasses/OcaSignalInput.d.ts +4 -1
  220. package/src/controller/ControlClasses/OcaSignalInput.js +4 -1
  221. package/src/controller/ControlClasses/OcaSignalOutput.d.ts +4 -1
  222. package/src/controller/ControlClasses/OcaSignalOutput.js +4 -1
  223. package/src/controller/ControlClasses/OcaStreamConnector.d.ts +59 -24
  224. package/src/controller/ControlClasses/OcaStreamConnector.js +80 -48
  225. package/src/controller/ControlClasses/OcaStreamNetwork.d.ts +100 -27
  226. package/src/controller/ControlClasses/OcaStreamNetwork.js +124 -54
  227. package/src/controller/ControlClasses/OcaStringActuator.d.ts +5 -4
  228. package/src/controller/ControlClasses/OcaStringActuator.js +7 -5
  229. package/src/controller/ControlClasses/OcaStringSensor.d.ts +7 -5
  230. package/src/controller/ControlClasses/OcaStringSensor.js +10 -7
  231. package/src/controller/ControlClasses/OcaSubscriptionManager.d.ts +73 -46
  232. package/src/controller/ControlClasses/OcaSubscriptionManager.js +78 -51
  233. package/src/controller/ControlClasses/OcaSummingPoint.d.ts +2 -1
  234. package/src/controller/ControlClasses/OcaSummingPoint.js +2 -1
  235. package/src/controller/ControlClasses/OcaSwitch.d.ts +23 -15
  236. package/src/controller/ControlClasses/OcaSwitch.js +31 -23
  237. package/src/controller/ControlClasses/OcaTaskManager.d.ts +47 -38
  238. package/src/controller/ControlClasses/OcaTaskManager.js +48 -37
  239. package/src/controller/ControlClasses/OcaTemperatureActuator.d.ts +6 -5
  240. package/src/controller/ControlClasses/OcaTemperatureActuator.js +6 -4
  241. package/src/controller/ControlClasses/OcaTemperatureSensor.d.ts +4 -4
  242. package/src/controller/ControlClasses/OcaTemperatureSensor.js +4 -3
  243. package/src/controller/ControlClasses/OcaTimeIntervalSensor.d.ts +4 -4
  244. package/src/controller/ControlClasses/OcaTimeIntervalSensor.js +4 -3
  245. package/src/controller/ControlClasses/OcaTimeSource.d.ts +38 -22
  246. package/src/controller/ControlClasses/OcaTimeSource.js +41 -27
  247. package/src/controller/ControlClasses/OcaUint16Actuator.d.ts +6 -5
  248. package/src/controller/ControlClasses/OcaUint16Actuator.js +6 -4
  249. package/src/controller/ControlClasses/OcaUint16Sensor.d.ts +4 -4
  250. package/src/controller/ControlClasses/OcaUint16Sensor.js +4 -3
  251. package/src/controller/ControlClasses/OcaUint32Actuator.d.ts +6 -5
  252. package/src/controller/ControlClasses/OcaUint32Actuator.js +6 -4
  253. package/src/controller/ControlClasses/OcaUint32Sensor.d.ts +4 -4
  254. package/src/controller/ControlClasses/OcaUint32Sensor.js +4 -3
  255. package/src/controller/ControlClasses/OcaUint64Actuator.d.ts +6 -5
  256. package/src/controller/ControlClasses/OcaUint64Actuator.js +6 -4
  257. package/src/controller/ControlClasses/OcaUint64Sensor.d.ts +4 -4
  258. package/src/controller/ControlClasses/OcaUint64Sensor.js +4 -3
  259. package/src/controller/ControlClasses/OcaUint8Actuator.d.ts +6 -5
  260. package/src/controller/ControlClasses/OcaUint8Actuator.js +6 -4
  261. package/src/controller/ControlClasses/OcaUint8Sensor.d.ts +4 -4
  262. package/src/controller/ControlClasses/OcaUint8Sensor.js +4 -3
  263. package/src/controller/ControlClasses/OcaVoltageSensor.d.ts +4 -4
  264. package/src/controller/ControlClasses/OcaVoltageSensor.js +4 -3
  265. package/src/controller/ControlClasses/OcaWorker.d.ts +38 -28
  266. package/src/controller/ControlClasses/OcaWorker.js +50 -40
  267. package/src/controller/abstract_udp_connection.js +11 -7
  268. package/src/controller/client_connection.d.ts +1 -1
  269. package/src/controller/node_udp.js +2 -3
  270. package/src/controller/property_event.js +1 -1
  271. package/src/types/OcaBlockMember.d.ts +1 -2
  272. package/src/types/OcaClassAuthorityID.d.ts +14 -3
  273. package/src/types/OcaClassAuthorityID.js +8 -2
  274. package/src/types/OcaClassIdentification.d.ts +4 -3
  275. package/src/types/OcaClassIdentification.js +2 -2
  276. package/src/types/OcaComponent.d.ts +3 -1
  277. package/src/types/OcaComponent.js +3 -1
  278. package/src/types/OcaDBr.d.ts +6 -4
  279. package/src/types/OcaDBr.js +3 -2
  280. package/src/types/OcaDelayValue.d.ts +1 -2
  281. package/src/types/OcaDeviceState.d.ts +4 -1
  282. package/src/types/OcaDeviceState.js +4 -1
  283. package/src/types/OcaDynamicsFunction.d.ts +2 -1
  284. package/src/types/OcaDynamicsFunction.js +2 -1
  285. package/src/types/OcaEvent.d.ts +3 -3
  286. package/src/types/OcaEvent.js +2 -1
  287. package/src/types/OcaEventID.d.ts +3 -1
  288. package/src/types/OcaEventID.js +3 -1
  289. package/src/types/OcaGlobalTypeIdentifier.d.ts +10 -4
  290. package/src/types/OcaGlobalTypeIdentifier.js +5 -2
  291. package/src/types/OcaGrouperCitizen.d.ts +7 -5
  292. package/src/types/OcaGrouperCitizen.js +4 -2
  293. package/src/types/OcaGrouperEnrollment.d.ts +8 -4
  294. package/src/types/OcaGrouperEnrollment.js +4 -2
  295. package/src/types/OcaGrouperGroup.d.ts +4 -2
  296. package/src/types/OcaGrouperGroup.js +2 -1
  297. package/src/types/OcaGrouperMode.d.ts +1 -1
  298. package/src/types/OcaGrouperMode.js +1 -1
  299. package/src/types/OcaGrouperStatusChangeEventData.d.ts +7 -19
  300. package/src/types/OcaGrouperStatusChangeEventData.js +5 -8
  301. package/src/types/OcaGrouperStatusChangeType.d.ts +2 -1
  302. package/src/types/OcaGrouperStatusChangeType.js +2 -1
  303. package/src/types/OcaLevelDetectionLaw.d.ts +2 -1
  304. package/src/types/OcaLevelDetectionLaw.js +2 -1
  305. package/src/types/OcaLibParamSetAssignment.d.ts +3 -3
  306. package/src/types/OcaLibParamSetAssignment.js +2 -1
  307. package/src/types/OcaLibVol.d.ts +3 -3
  308. package/src/types/OcaLibVol.js +3 -2
  309. package/src/types/OcaLibVolChangedEventData.d.ts +4 -21
  310. package/src/types/OcaLibVolChangedEventData.js +3 -7
  311. package/src/types/OcaLibVolData_ParamSet.d.ts +13 -3
  312. package/src/types/OcaLibVolData_ParamSet.js +11 -3
  313. package/src/types/OcaLibVolMetadata.d.ts +4 -5
  314. package/src/types/OcaLibVolMetadata.js +1 -1
  315. package/src/types/OcaLibVolType.d.ts +12 -4
  316. package/src/types/OcaLibVolType.js +6 -2
  317. package/src/types/OcaLibraryIdentifier.d.ts +3 -3
  318. package/src/types/OcaLibraryIdentifier.js +2 -1
  319. package/src/types/OcaManagerDefaultObjectNumbers.d.ts +58 -116
  320. package/src/types/OcaManagerDefaultObjectNumbers.js +2 -2
  321. package/src/types/OcaManagerDescriptor.d.ts +4 -0
  322. package/src/types/OcaManagerDescriptor.js +2 -0
  323. package/src/types/OcaMediaClockRate.d.ts +12 -6
  324. package/src/types/OcaMediaClockRate.js +6 -3
  325. package/src/types/OcaMediaCoding.d.ts +4 -2
  326. package/src/types/OcaMediaCoding.js +2 -1
  327. package/src/types/OcaMediaConnection.d.ts +21 -8
  328. package/src/types/OcaMediaConnection.js +18 -5
  329. package/src/types/OcaMediaConnectorStatus.d.ts +5 -4
  330. package/src/types/OcaMediaConnectorStatus.js +2 -1
  331. package/src/types/OcaMediaConnectorStatusChangedEventData.d.ts +2 -17
  332. package/src/types/OcaMediaConnectorStatusChangedEventData.js +1 -7
  333. package/src/types/OcaMediaSinkConnector.d.ts +43 -15
  334. package/src/types/OcaMediaSinkConnector.js +23 -7
  335. package/src/types/OcaMediaSinkConnectorChangedEventData.d.ts +20 -30
  336. package/src/types/OcaMediaSinkConnectorChangedEventData.js +8 -11
  337. package/src/types/OcaMediaSourceConnector.d.ts +33 -13
  338. package/src/types/OcaMediaSourceConnector.js +17 -7
  339. package/src/types/OcaMediaSourceConnectorChangedEventData.d.ts +20 -30
  340. package/src/types/OcaMediaSourceConnectorChangedEventData.js +8 -11
  341. package/src/types/OcaMethod.d.ts +8 -5
  342. package/src/types/OcaMethod.js +5 -2
  343. package/src/types/OcaMethodID.d.ts +3 -1
  344. package/src/types/OcaMethodID.js +3 -1
  345. package/src/types/OcaModelGUID.d.ts +4 -2
  346. package/src/types/OcaModelGUID.js +5 -4
  347. package/src/types/OcaNetworkMediaSourceOrSink.d.ts +2 -1
  348. package/src/types/OcaNetworkMediaSourceOrSink.js +2 -1
  349. package/src/types/OcaNetworkSystemInterfaceDescriptor.d.ts +2 -1
  350. package/src/types/OcaNetworkSystemInterfaceDescriptor.js +3 -2
  351. package/src/types/OcaNetworkSystemInterfaceID.d.ts +2 -1
  352. package/src/types/OcaNetworkSystemInterfaceID.js +3 -2
  353. package/src/types/OcaNotificationDeliveryMode.d.ts +2 -1
  354. package/src/types/OcaNotificationDeliveryMode.js +2 -1
  355. package/src/types/OcaOPath.d.ts +2 -1
  356. package/src/types/OcaOPath.js +2 -1
  357. package/src/types/OcaObjectIdentification.d.ts +3 -3
  358. package/src/types/OcaObjectIdentification.js +2 -1
  359. package/src/types/OcaObjectListEventData.d.ts +3 -16
  360. package/src/types/OcaObjectListEventData.js +4 -8
  361. package/src/types/OcaObjectSearchResult.d.ts +5 -3
  362. package/src/types/OcaObjectSearchResult.js +4 -1
  363. package/src/types/OcaObjectSearchResultFlags.d.ts +1 -1
  364. package/src/types/OcaObjectSearchResultFlags.js +1 -1
  365. package/src/types/OcaObservationEventData.d.ts +8 -16
  366. package/src/types/OcaObservationEventData.js +8 -7
  367. package/src/types/OcaObservationListEventData.d.ts +8 -16
  368. package/src/types/OcaObservationListEventData.js +9 -8
  369. package/src/types/OcaParameterMask.d.ts +13 -0
  370. package/src/types/OcaParameterMask.js +11 -0
  371. package/src/types/OcaPilotToneDetectorSpec.d.ts +1 -2
  372. package/src/types/OcaPort.d.ts +3 -3
  373. package/src/types/OcaPort.js +2 -1
  374. package/src/types/OcaPortID.d.ts +4 -3
  375. package/src/types/OcaPortID.js +3 -1
  376. package/src/types/OcaPositionCoordinateSystem.d.ts +2 -1
  377. package/src/types/OcaPositionCoordinateSystem.js +2 -1
  378. package/src/types/OcaPositionDescriptor.d.ts +21 -20
  379. package/src/types/OcaPositionDescriptor.js +12 -14
  380. package/src/types/OcaPositionDescriptorFieldFlags.d.ts +13 -0
  381. package/src/types/OcaPositionDescriptorFieldFlags.js +11 -0
  382. package/src/types/OcaPowerState.d.ts +2 -1
  383. package/src/types/OcaPowerState.js +2 -1
  384. package/src/types/OcaPresentationUnit.d.ts +8 -1
  385. package/src/types/OcaPresentationUnit.js +8 -1
  386. package/src/types/OcaProperty.d.ts +3 -3
  387. package/src/types/OcaProperty.js +2 -1
  388. package/src/types/OcaPropertyDescriptor.d.ts +9 -9
  389. package/src/types/OcaPropertyDescriptor.js +4 -3
  390. package/src/types/OcaPropertyID.d.ts +3 -1
  391. package/src/types/OcaPropertyID.js +3 -1
  392. package/src/types/OcaProtoObjectIdentification.d.ts +3 -3
  393. package/src/types/OcaProtoObjectIdentification.js +2 -1
  394. package/src/types/OcaProtoPort.d.ts +9 -5
  395. package/src/types/OcaProtoPort.js +5 -2
  396. package/src/types/OcaProtoPortID.d.ts +4 -3
  397. package/src/types/OcaProtoPortID.js +3 -1
  398. package/src/types/OcaProtoSignalPath.d.ts +1 -2
  399. package/src/types/OcaRamperCommand.d.ts +1 -1
  400. package/src/types/OcaRamperCommand.js +1 -1
  401. package/src/types/OcaRamperState.d.ts +15 -10
  402. package/src/types/OcaRamperState.js +15 -10
  403. package/src/types/OcaSensorReadingState.d.ts +2 -1
  404. package/src/types/OcaSensorReadingState.js +2 -1
  405. package/src/types/OcaSignalPath.d.ts +1 -2
  406. package/src/types/OcaStream.d.ts +23 -10
  407. package/src/types/OcaStream.js +17 -5
  408. package/src/types/OcaStreamConnectorIdentification.d.ts +17 -7
  409. package/src/types/OcaStreamConnectorIdentification.js +15 -6
  410. package/src/types/OcaSubscriptionManagerState.d.ts +1 -1
  411. package/src/types/OcaSubscriptionManagerState.js +1 -1
  412. package/src/types/OcaTask.d.ts +27 -13
  413. package/src/types/OcaTask.js +14 -6
  414. package/src/types/OcaTaskManagerState.d.ts +13 -9
  415. package/src/types/OcaTaskManagerState.js +13 -9
  416. package/src/types/OcaTaskState.d.ts +3 -1
  417. package/src/types/OcaTaskState.js +3 -1
  418. package/src/types/OcaTaskStateChangedEventData.d.ts +6 -6
  419. package/src/types/OcaTaskStateChangedEventData.js +2 -2
  420. package/src/types/OcaTaskStatus.d.ts +6 -5
  421. package/src/types/OcaTaskStatus.js +5 -3
  422. package/src/types/OcaTimeMode.d.ts +1 -1
  423. package/src/types/OcaTimeMode.js +1 -1
  424. package/src/types/OcaTimePTP.d.ts +8 -3
  425. package/src/types/OcaTimePTP.js +6 -2
  426. package/src/types/OcaTransferFunction.js +3 -3
  427. package/src/types/OcaUnitOfMeasure.d.ts +5 -1
  428. package/src/types/OcaUnitOfMeasure.js +5 -1
  429. package/src/types/OcaVersion.d.ts +7 -5
  430. package/src/types/OcaVersion.js +4 -2
@@ -1,13 +1,50 @@
1
- import { RemoteDevice } from '../remote_device';
2
- import { OcaActuator } from './OcaActuator';
1
+ import { IOcaDBr, OcaDBr } from '../../types/OcaDBr';
2
+ import { IOcaParameterMask } from '../../types/OcaParameterMask';
3
3
  import { Arguments } from '../arguments';
4
-
5
4
  import { PropertyEvent } from '../property_event';
6
- import { IOcaDBr } from '../../types/OcaDBr';
7
- import { OcaDBr } from '../../types/OcaDBr';
5
+ import { RemoteDevice } from '../remote_device';
6
+ import { OcaActuator } from './OcaActuator';
8
7
 
9
8
  /**
10
- * Dynamic compression / expansion curve. **Curve** means a function that expresses the relationship of output level to input level. The dependent variable (Y) of the curve is output level; the independent variable (X) is input level. Every curve is composed of **(n+1)** straight-line **segments** joined by **(n)** small fillets called **knees** . Each knee occurs at a particular input level value called the **threshold.** Each segment is characterized by its **slope.** | / | S3 / | S2 / | T1 **-------------** T2 | / | S1 / | / | / +------------------------------------ This "drawing" shows a three-segment curve. The horizontal axis is input level, vertical axis is output level. Algebraically, a curve is a function **Out = Curve( In, T[1..n-1], S[1..n], K[1..n-1] )** where **n** is the number of segments, and **In** is input level in dBr **Out** is output level in dBr **T[1...n-1]** is an array of **thresholds** in dBr **S[1...n]** is an array of **slopes** in dBr per dBr, i.e. unitless **K[1..n]** is the **knee parameter** , an implementation-dependant parameter that specifies the shape of the curve around the knee. Each segment has a slope that expresses its ratio of output level to input level. Note that this slope is the inverse of what dynamics processors call "ratio". For example, a ratio of 2:1 is represented by a curve segment with slope 1/2 = 0.5. This model can represent familiar audio dynamics elements (we ignore **K[]** in these examples): - Compressor with ratio of 2:1 and threshold of 10dBr: **n = 2** **T[1] = 10** **S[1] = 1** **S[2] = 0.5** - Hard limiter with threshold of 18dBr: **n = 2** T[1] = 18 S[1] = 1 S[2] = 0 - Upward expander with ratio of 1.5:1 and threshold of -12dBr: **n = 2** T[1] = -12 S[1] = 1 S[2] = 1.5 - Downward expander (gate) with ratio of 50:1 and threshold of -45dBr: **n = 2** T[1] = -45 S[1] = 50 S[2] = 1 This class, **OcaDynamicsCurve,** adds two additional parameters to the basic curve mechanism. **Out = Curve( In, T[1..n-1], S[1..n], K[1..n-1] , Floor, Ceiling)** where **In, T[], and S[],** and **K[]** are as defined above. **Floor** is the lowest gain (in dBr) that the dynamics element is allowed to produce. **Ceiling** is the highest gain (in dBr) that the dynamics element is allowed to produce. To show the use of **Floor** and **Ceiling** , we revisit some of the examples above (again, **K[]** is ignored): - Compressor with ratio of 2:1, threshold of 10dBr, and max gain reduction of 20dB: **n = 2** **T[1] = 10** **S[1] = 1** **S[2] = 0.5** **Floor = -20** **Ceiling = 0** - Upward expander with ratio of 1.5:1, threshold of -12dBr, and max gain boost of 4dB: **n = 2** T[1] = -12 S[1] = 1 S[2] = 1.5 Floor = 0 Ceiling = 4.0 More complex dynamics curves can be modeled by using more segments ( **n > 2)** .
9
+ * Dynamic compression / expansion curve. **Curve** means a function that
10
+ * expresses the relationship of output level to input level. The dependent
11
+ * variable (Y) of the curve is output level; the independent variable (X) is
12
+ * input level. Every curve is composed of **(n+1)** straight-line **segments**
13
+ * joined by **(n)** small fillets called **knees**. Each knee occurs at a
14
+ * particular input level value called the **threshold.** Each segment is
15
+ * characterized by its **slope.** ** ** | ** / ** | S3 ** / ** | S2 ** / ** |
16
+ * T1**-------------**T2 | ** / ** | S1 ** / ** | ** / ** | ** / **
17
+ * +------------------------------------ This "drawing" shows a three-segment
18
+ * curve. The horizontal axis is input level, vertical axis is output level.
19
+ * Algebraically, a curve is a function ** Out = Curve( In, T[1..n-1], S[1..n],
20
+ * K[1..n-1] )** where **n** is the number of segments, and **In** is input
21
+ * level in dBr **Out** is output level in dBr **T[1...n-1]** is an array of
22
+ * **thresholds** in dBr **S[1...n]** is an array of **slopes** in dBr per dBr,
23
+ * i.e. unitless **K[1..n]** is the **knee parameter**, an
24
+ * implementation-dependant parameter that specifies the shape of the curve
25
+ * around the knee. Each segment has a slope that expresses its ratio of output
26
+ * level to input level. Note that this slope is the inverse of what dynamics
27
+ * processors call "ratio". For example, a ratio of 2:1 is represented by a
28
+ * curve segment with slope 1/2 = 0.5. This model can represent familiar audio
29
+ * dynamics elements (we ignore **K[]** in these examples): - Compressor with
30
+ * ratio of 2:1 and threshold of 10dBr: ** n = 2** ** T[1] = 10** ** S[1] = 1**
31
+ * ** S[2] = 0.5** - Hard limiter with threshold of 18dBr: ** n = 2** T[1] = 18
32
+ * S[1] = 1 S[2] = 0 - Upward expander with ratio of 1.5:1 and threshold of
33
+ * -12dBr: ** n = 2** T[1] = -12 S[1] = 1 S[2] = 1.5 - Downward expander (gate)
34
+ * with ratio of 50:1 and threshold of -45dBr: ** n = 2** T[1] = -45 S[1] = 50
35
+ * S[2] = 1 This class, **OcaDynamicsCurve,** adds two additional parameters to
36
+ * the basic curve mechanism. **Out = Curve( In, T[1..n-1], S[1..n], K[1..n-1] ,
37
+ * Floor, Ceiling)** where **In, T[], and S[],** and **K[]** are as defined
38
+ * above. **Floor** is the lowest gain (in dBr) that the dynamics element is
39
+ * allowed to produce. **Ceiling** is the highest gain (in dBr) that the
40
+ * dynamics element is allowed to produce. To show the use of **Floor** and
41
+ * **Ceiling**, we revisit some of the examples above (again, **K[]** is
42
+ * ignored): - Compressor with ratio of 2:1, threshold of 10dBr, and max gain
43
+ * reduction of 20dB: ** n = 2** ** T[1] = 10** ** S[1] = 1** ** S[2] = 0.5** **
44
+ * Floor = -20** ** Ceiling = 0** - Upward expander with ratio of 1.5:1,
45
+ * threshold of -12dBr, and max gain boost of 4dB: ** n = 2** T[1] = -12 S[1] =
46
+ * 1 S[2] = 1.5 Floor = 0 Ceiling = 4.0 More complex dynamics curves can be
47
+ * modeled by using more segments (**n > 2)**.
11
48
  * @extends OcaActuator
12
49
  * @class OcaDynamicsCurve
13
50
  */
@@ -45,7 +82,8 @@ export declare class OcaDynamicsCurve extends OcaActuator {
45
82
  constructor(objectNumber: number, device: RemoteDevice);
46
83
 
47
84
  /**
48
- * Gets the number of curve segments. The return value indicates whether the value was successfully retrieved.
85
+ * Gets the number of curve segments. The return value indicates whether the
86
+ * value was successfully retrieved.
49
87
  * The return values of this method are
50
88
  *
51
89
  * - n of type ``number``
@@ -58,7 +96,10 @@ export declare class OcaDynamicsCurve extends OcaActuator {
58
96
  GetNSegments(): Promise<Arguments<[number, number, number]>>;
59
97
 
60
98
  /**
61
- * Sets the number of curve segments. The return value indicates whether the data was successfully set. If this method increases the value of n, the data in properties **Threshold** , **Slope** , and **KneeParameter** of the new segment are by default set to the values of the previous segment.
99
+ * Sets the number of curve segments. The return value indicates whether the
100
+ * data was successfully set. If this method increases the value of n, the
101
+ * data in properties **Threshold**, **Slope**, and **KneeParameter** of the
102
+ * new segment are by default set to the values of the previous segment.
62
103
  *
63
104
  * @method OcaDynamicsCurve#SetNSegments
64
105
  * @param {number} Slope
@@ -68,10 +109,11 @@ export declare class OcaDynamicsCurve extends OcaActuator {
68
109
  SetNSegments(Slope: number): Promise<void>;
69
110
 
70
111
  /**
71
- * Gets the list of Threshold values. The return value indicates whether the data was successfully retrieved.
112
+ * Gets the list of Threshold values. The return value indicates whether the
113
+ * data was successfully retrieved.
72
114
  * The return values of this method are
73
115
  *
74
- * - Threshold of type ``OcaDBr[]``
116
+ * - Threshold of type ``IOcaDBr[]``
75
117
  * - minThreshold of type ``number``
76
118
  * - maxThreshold of type ``number``
77
119
  *
@@ -81,17 +123,19 @@ export declare class OcaDynamicsCurve extends OcaActuator {
81
123
  GetThreshold(): Promise<Arguments<[OcaDBr[], number, number]>>;
82
124
 
83
125
  /**
84
- * Sets the list of Threshold values. The return value indicates whether the values were successfully set.
126
+ * Sets the list of Threshold values. The return value indicates whether the
127
+ * values were successfully set.
85
128
  *
86
129
  * @method OcaDynamicsCurve#SetThreshold
87
- * @param {OcaDBr[]} Threshold
130
+ * @param {IOcaDBr[]} Threshold
88
131
  *
89
132
  * @returns {Promise<void>}
90
133
  */
91
134
  SetThreshold(Threshold: IOcaDBr[]): Promise<void>;
92
135
 
93
136
  /**
94
- * Gets the list of Slope values. The return value indicates whether the list was successfully retrieved.
137
+ * Gets the list of Slope values. The return value indicates whether the list
138
+ * was successfully retrieved.
95
139
  * The return values of this method are
96
140
  *
97
141
  * - slope of type ``number[]``
@@ -104,7 +148,8 @@ export declare class OcaDynamicsCurve extends OcaActuator {
104
148
  GetSlope(): Promise<Arguments<[number[], number[], number[]]>>;
105
149
 
106
150
  /**
107
- * Sets the list of Slope values. The return value indicates whether the values were successfully set.
151
+ * Sets the list of Slope values. The return value indicates whether the
152
+ * values were successfully set.
108
153
  *
109
154
  * @method OcaDynamicsCurve#SetSlope
110
155
  * @param {number[]} slope
@@ -114,7 +159,8 @@ export declare class OcaDynamicsCurve extends OcaActuator {
114
159
  SetSlope(slope: number[]): Promise<void>;
115
160
 
116
161
  /**
117
- * Gets the list of KneeParameter valuess. The return value indicates whether the list was successfully retrieved.
162
+ * Gets the list of KneeParameter valuess. The return value indicates whether
163
+ * the list was successfully retrieved.
118
164
  * The return values of this method are
119
165
  *
120
166
  * - parameter of type ``number[]``
@@ -127,7 +173,8 @@ export declare class OcaDynamicsCurve extends OcaActuator {
127
173
  GetKneeParameter(): Promise<Arguments<[number[], number[], number[]]>>;
128
174
 
129
175
  /**
130
- * Sets the list of KneeParameter values. The return value indicates whether the values were successfully set.
176
+ * Sets the list of KneeParameter values. The return value indicates whether
177
+ * the values were successfully set.
131
178
  *
132
179
  * @method OcaDynamicsCurve#SetKneeParameter
133
180
  * @param {number[]} parameter
@@ -137,7 +184,8 @@ export declare class OcaDynamicsCurve extends OcaActuator {
137
184
  SetKneeParameter(parameter: number[]): Promise<void>;
138
185
 
139
186
  /**
140
- * Gets the value of the DynamicGainCeiling property. The return value indicates whether the data was successfully retrieved.
187
+ * Gets the value of the DynamicGainCeiling property. The return value
188
+ * indicates whether the data was successfully retrieved.
141
189
  * The return values of this method are
142
190
  *
143
191
  * - gain of type ``number``
@@ -150,7 +198,8 @@ export declare class OcaDynamicsCurve extends OcaActuator {
150
198
  GetDynamicGainCeiling(): Promise<Arguments<[number, number, number]>>;
151
199
 
152
200
  /**
153
- * Sets the value of the DynamicGainCeiling property. The return value indicates whether the data was successfully set.
201
+ * Sets the value of the DynamicGainCeiling property. The return value
202
+ * indicates whether the data was successfully set.
154
203
  *
155
204
  * @method OcaDynamicsCurve#SetDynamicGainCeiling
156
205
  * @param {number} gain
@@ -160,7 +209,8 @@ export declare class OcaDynamicsCurve extends OcaActuator {
160
209
  SetDynamicGainCeiling(gain: number): Promise<void>;
161
210
 
162
211
  /**
163
- * Gets the value of the DynamicGainFloor property. The return value indicates whether the data was successfully retrieved.
212
+ * Gets the value of the DynamicGainFloor property. The return value indicates
213
+ * whether the data was successfully retrieved.
164
214
  * The return values of this method are
165
215
  *
166
216
  * - Gain of type ``number``
@@ -173,7 +223,8 @@ export declare class OcaDynamicsCurve extends OcaActuator {
173
223
  GetDynamicGainFloor(): Promise<Arguments<[number, number, number]>>;
174
224
 
175
225
  /**
176
- * Sets the value of the DynamicGainFloor property. The return value indicates whether the data was successfully set.
226
+ * Sets the value of the DynamicGainFloor property. The return value indicates
227
+ * whether the data was successfully set.
177
228
  *
178
229
  * @method OcaDynamicsCurve#SetDynamicGainFloor
179
230
  * @param {number} Gain
@@ -183,27 +234,23 @@ export declare class OcaDynamicsCurve extends OcaActuator {
183
234
  SetDynamicGainFloor(Gain: number): Promise<void>;
184
235
 
185
236
  /**
186
- * Sets some or all dynamics curve 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.
237
+ * Sets some or all dynamics curve parameters. The return value indicates if
238
+ * the parameters were successfully set. The action of this method is atomic -
239
+ * if any of the value changes fails, none of the changes are made.
187
240
  *
188
241
  * @method OcaDynamicsCurve#SetMultiple
189
- * @param {number} Mask
190
- *
242
+ * @param {IOcaParameterMask} Mask
191
243
  * @param {number} nSegments
192
- *
193
- * @param {OcaDBr[]} Threshold
194
- *
244
+ * @param {IOcaDBr[]} Threshold
195
245
  * @param {number[]} Slope
196
- *
197
246
  * @param {number[]} KneeParameter
198
- *
199
247
  * @param {number} DynamicGainFloor
200
- *
201
248
  * @param {number} DynamicGainCeiling
202
249
  *
203
250
  * @returns {Promise<void>}
204
251
  */
205
252
  SetMultiple(
206
- Mask: number,
253
+ Mask: IOcaParameterMask,
207
254
  nSegments: number,
208
255
  Threshold: IOcaDBr[],
209
256
  Slope: number[],
@@ -1,13 +1,51 @@
1
- import { make_control_class } from '../make_control_class.js';
2
- import { OcaActuator } from './OcaActuator.js';
3
- import { OcaBitSet16 } from '../../OCP1/OcaBitSet16.js';
4
1
  import { OcaDBr } from '../../OCP1/OcaDBr.js';
5
2
  import { OcaFloat32 } from '../../OCP1/OcaFloat32.js';
6
3
  import { OcaList } from '../../OCP1/OcaList.js';
4
+ import { OcaParameterMask } from '../../OCP1/OcaParameterMask.js';
7
5
  import { OcaUint8 } from '../../OCP1/OcaUint8.js';
6
+ import { make_control_class } from '../make_control_class.js';
7
+ import { OcaActuator } from './OcaActuator.js';
8
8
 
9
9
  /**
10
- * Dynamic compression / expansion curve. **Curve** means a function that expresses the relationship of output level to input level. The dependent variable (Y) of the curve is output level; the independent variable (X) is input level. Every curve is composed of **(n+1)** straight-line **segments** joined by **(n)** small fillets called **knees** . Each knee occurs at a particular input level value called the **threshold.** Each segment is characterized by its **slope.** | / | S3 / | S2 / | T1 **-------------** T2 | / | S1 / | / | / +------------------------------------ This "drawing" shows a three-segment curve. The horizontal axis is input level, vertical axis is output level. Algebraically, a curve is a function **Out = Curve( In, T[1..n-1], S[1..n], K[1..n-1] )** where **n** is the number of segments, and **In** is input level in dBr **Out** is output level in dBr **T[1...n-1]** is an array of **thresholds** in dBr **S[1...n]** is an array of **slopes** in dBr per dBr, i.e. unitless **K[1..n]** is the **knee parameter** , an implementation-dependant parameter that specifies the shape of the curve around the knee. Each segment has a slope that expresses its ratio of output level to input level. Note that this slope is the inverse of what dynamics processors call "ratio". For example, a ratio of 2:1 is represented by a curve segment with slope 1/2 = 0.5. This model can represent familiar audio dynamics elements (we ignore **K[]** in these examples): - Compressor with ratio of 2:1 and threshold of 10dBr: **n = 2** **T[1] = 10** **S[1] = 1** **S[2] = 0.5** - Hard limiter with threshold of 18dBr: **n = 2** T[1] = 18 S[1] = 1 S[2] = 0 - Upward expander with ratio of 1.5:1 and threshold of -12dBr: **n = 2** T[1] = -12 S[1] = 1 S[2] = 1.5 - Downward expander (gate) with ratio of 50:1 and threshold of -45dBr: **n = 2** T[1] = -45 S[1] = 50 S[2] = 1 This class, **OcaDynamicsCurve,** adds two additional parameters to the basic curve mechanism. **Out = Curve( In, T[1..n-1], S[1..n], K[1..n-1] , Floor, Ceiling)** where **In, T[], and S[],** and **K[]** are as defined above. **Floor** is the lowest gain (in dBr) that the dynamics element is allowed to produce. **Ceiling** is the highest gain (in dBr) that the dynamics element is allowed to produce. To show the use of **Floor** and **Ceiling** , we revisit some of the examples above (again, **K[]** is ignored): - Compressor with ratio of 2:1, threshold of 10dBr, and max gain reduction of 20dB: **n = 2** **T[1] = 10** **S[1] = 1** **S[2] = 0.5** **Floor = -20** **Ceiling = 0** - Upward expander with ratio of 1.5:1, threshold of -12dBr, and max gain boost of 4dB: **n = 2** T[1] = -12 S[1] = 1 S[2] = 1.5 Floor = 0 Ceiling = 4.0 More complex dynamics curves can be modeled by using more segments ( **n &gt; 2)** .
10
+ * Dynamic compression / expansion curve. **Curve** means a function that
11
+ * expresses the relationship of output level to input level. The dependent
12
+ * variable (Y) of the curve is output level; the independent variable (X) is
13
+ * input level. Every curve is composed of **(n+1)** straight-line **segments**
14
+ * joined by **(n)** small fillets called **knees**. Each knee occurs at a
15
+ * particular input level value called the **threshold.** Each segment is
16
+ * characterized by its **slope.** ** ** | ** / ** | S3 ** / ** | S2 ** / ** |
17
+ * T1**-------------**T2 | ** / ** | S1 ** / ** | ** / ** | ** / **
18
+ * +------------------------------------ This "drawing" shows a three-segment
19
+ * curve. The horizontal axis is input level, vertical axis is output level.
20
+ * Algebraically, a curve is a function ** Out = Curve( In, T[1..n-1], S[1..n],
21
+ * K[1..n-1] )** where **n** is the number of segments, and **In** is input
22
+ * level in dBr **Out** is output level in dBr **T[1...n-1]** is an array of
23
+ * **thresholds** in dBr **S[1...n]** is an array of **slopes** in dBr per dBr,
24
+ * i.e. unitless **K[1..n]** is the **knee parameter**, an
25
+ * implementation-dependant parameter that specifies the shape of the curve
26
+ * around the knee. Each segment has a slope that expresses its ratio of output
27
+ * level to input level. Note that this slope is the inverse of what dynamics
28
+ * processors call "ratio". For example, a ratio of 2:1 is represented by a
29
+ * curve segment with slope 1/2 = 0.5. This model can represent familiar audio
30
+ * dynamics elements (we ignore **K[]** in these examples): - Compressor with
31
+ * ratio of 2:1 and threshold of 10dBr: ** n = 2** ** T[1] = 10** ** S[1] = 1**
32
+ * ** S[2] = 0.5** - Hard limiter with threshold of 18dBr: ** n = 2** T[1] = 18
33
+ * S[1] = 1 S[2] = 0 - Upward expander with ratio of 1.5:1 and threshold of
34
+ * -12dBr: ** n = 2** T[1] = -12 S[1] = 1 S[2] = 1.5 - Downward expander (gate)
35
+ * with ratio of 50:1 and threshold of -45dBr: ** n = 2** T[1] = -45 S[1] = 50
36
+ * S[2] = 1 This class, **OcaDynamicsCurve,** adds two additional parameters to
37
+ * the basic curve mechanism. **Out = Curve( In, T[1..n-1], S[1..n], K[1..n-1] ,
38
+ * Floor, Ceiling)** where **In, T[], and S[],** and **K[]** are as defined
39
+ * above. **Floor** is the lowest gain (in dBr) that the dynamics element is
40
+ * allowed to produce. **Ceiling** is the highest gain (in dBr) that the
41
+ * dynamics element is allowed to produce. To show the use of **Floor** and
42
+ * **Ceiling**, we revisit some of the examples above (again, **K[]** is
43
+ * ignored): - Compressor with ratio of 2:1, threshold of 10dBr, and max gain
44
+ * reduction of 20dB: ** n = 2** ** T[1] = 10** ** S[1] = 1** ** S[2] = 0.5** **
45
+ * Floor = -20** ** Ceiling = 0** - Upward expander with ratio of 1.5:1,
46
+ * threshold of -12dBr, and max gain boost of 4dB: ** n = 2** T[1] = -12 S[1] =
47
+ * 1 S[2] = 1.5 Floor = 0 Ceiling = 4.0 More complex dynamics curves can be
48
+ * modeled by using more segments (**n > 2)**.
11
49
  * @extends OcaActuator
12
50
  * @class OcaDynamicsCurve
13
51
  */
@@ -47,7 +85,7 @@ export const OcaDynamicsCurve = make_control_class(
47
85
  4,
48
86
  13,
49
87
  [
50
- OcaBitSet16,
88
+ OcaParameterMask,
51
89
  OcaUint8,
52
90
  OcaList(OcaDBr),
53
91
  OcaList(OcaFloat32),
@@ -70,7 +108,8 @@ export const OcaDynamicsCurve = make_control_class(
70
108
  );
71
109
 
72
110
  /**
73
- * Gets the number of curve segments. The return value indicates whether the value was successfully retrieved.
111
+ * Gets the number of curve segments. The return value indicates whether the
112
+ * value was successfully retrieved.
74
113
  * The return values of this method are
75
114
  *
76
115
  * - n of type ``number``
@@ -81,7 +120,10 @@ export const OcaDynamicsCurve = make_control_class(
81
120
  * @returns {Promise<Arguments<number,number,number>>}
82
121
  */
83
122
  /**
84
- * Sets the number of curve segments. The return value indicates whether the data was successfully set. If this method increases the value of n, the data in properties **Threshold** , **Slope** , and **KneeParameter** of the new segment are by default set to the values of the previous segment.
123
+ * Sets the number of curve segments. The return value indicates whether the
124
+ * data was successfully set. If this method increases the value of n, the data
125
+ * in properties **Threshold**, **Slope**, and **KneeParameter** of the new
126
+ * segment are by default set to the values of the previous segment.
85
127
  *
86
128
  * @method OcaDynamicsCurve#SetNSegments
87
129
  * @param {number} Slope
@@ -89,10 +131,11 @@ export const OcaDynamicsCurve = make_control_class(
89
131
  * @returns {Promise<void>}
90
132
  */
91
133
  /**
92
- * Gets the list of Threshold values. The return value indicates whether the data was successfully retrieved.
134
+ * Gets the list of Threshold values. The return value indicates whether the
135
+ * data was successfully retrieved.
93
136
  * The return values of this method are
94
137
  *
95
- * - Threshold of type ``OcaDBr[]``
138
+ * - Threshold of type ``IOcaDBr[]``
96
139
  * - minThreshold of type ``number``
97
140
  * - maxThreshold of type ``number``
98
141
  *
@@ -100,15 +143,17 @@ export const OcaDynamicsCurve = make_control_class(
100
143
  * @returns {Promise<Arguments<OcaDBr[],number,number>>}
101
144
  */
102
145
  /**
103
- * Sets the list of Threshold values. The return value indicates whether the values were successfully set.
146
+ * Sets the list of Threshold values. The return value indicates whether the
147
+ * values were successfully set.
104
148
  *
105
149
  * @method OcaDynamicsCurve#SetThreshold
106
- * @param {OcaDBr[]} Threshold
150
+ * @param {IOcaDBr[]} Threshold
107
151
  *
108
152
  * @returns {Promise<void>}
109
153
  */
110
154
  /**
111
- * Gets the list of Slope values. The return value indicates whether the list was successfully retrieved.
155
+ * Gets the list of Slope values. The return value indicates whether the list
156
+ * was successfully retrieved.
112
157
  * The return values of this method are
113
158
  *
114
159
  * - slope of type ``number[]``
@@ -119,7 +164,8 @@ export const OcaDynamicsCurve = make_control_class(
119
164
  * @returns {Promise<Arguments<number[],number[],number[]>>}
120
165
  */
121
166
  /**
122
- * Sets the list of Slope values. The return value indicates whether the values were successfully set.
167
+ * Sets the list of Slope values. The return value indicates whether the values
168
+ * were successfully set.
123
169
  *
124
170
  * @method OcaDynamicsCurve#SetSlope
125
171
  * @param {number[]} slope
@@ -127,7 +173,8 @@ export const OcaDynamicsCurve = make_control_class(
127
173
  * @returns {Promise<void>}
128
174
  */
129
175
  /**
130
- * Gets the list of KneeParameter valuess. The return value indicates whether the list was successfully retrieved.
176
+ * Gets the list of KneeParameter valuess. The return value indicates whether
177
+ * the list was successfully retrieved.
131
178
  * The return values of this method are
132
179
  *
133
180
  * - parameter of type ``number[]``
@@ -138,7 +185,8 @@ export const OcaDynamicsCurve = make_control_class(
138
185
  * @returns {Promise<Arguments<number[],number[],number[]>>}
139
186
  */
140
187
  /**
141
- * Sets the list of KneeParameter values. The return value indicates whether the values were successfully set.
188
+ * Sets the list of KneeParameter values. The return value indicates whether the
189
+ * values were successfully set.
142
190
  *
143
191
  * @method OcaDynamicsCurve#SetKneeParameter
144
192
  * @param {number[]} parameter
@@ -146,7 +194,8 @@ export const OcaDynamicsCurve = make_control_class(
146
194
  * @returns {Promise<void>}
147
195
  */
148
196
  /**
149
- * Gets the value of the DynamicGainCeiling property. The return value indicates whether the data was successfully retrieved.
197
+ * Gets the value of the DynamicGainCeiling property. The return value indicates
198
+ * whether the data was successfully retrieved.
150
199
  * The return values of this method are
151
200
  *
152
201
  * - gain of type ``number``
@@ -157,7 +206,8 @@ export const OcaDynamicsCurve = make_control_class(
157
206
  * @returns {Promise<Arguments<number,number,number>>}
158
207
  */
159
208
  /**
160
- * Sets the value of the DynamicGainCeiling property. The return value indicates whether the data was successfully set.
209
+ * Sets the value of the DynamicGainCeiling property. The return value indicates
210
+ * whether the data was successfully set.
161
211
  *
162
212
  * @method OcaDynamicsCurve#SetDynamicGainCeiling
163
213
  * @param {number} gain
@@ -165,7 +215,8 @@ export const OcaDynamicsCurve = make_control_class(
165
215
  * @returns {Promise<void>}
166
216
  */
167
217
  /**
168
- * Gets the value of the DynamicGainFloor property. The return value indicates whether the data was successfully retrieved.
218
+ * Gets the value of the DynamicGainFloor property. The return value indicates
219
+ * whether the data was successfully retrieved.
169
220
  * The return values of this method are
170
221
  *
171
222
  * - Gain of type ``number``
@@ -176,7 +227,8 @@ export const OcaDynamicsCurve = make_control_class(
176
227
  * @returns {Promise<Arguments<number,number,number>>}
177
228
  */
178
229
  /**
179
- * Sets the value of the DynamicGainFloor property. The return value indicates whether the data was successfully set.
230
+ * Sets the value of the DynamicGainFloor property. The return value indicates
231
+ * whether the data was successfully set.
180
232
  *
181
233
  * @method OcaDynamicsCurve#SetDynamicGainFloor
182
234
  * @param {number} Gain
@@ -184,62 +236,58 @@ export const OcaDynamicsCurve = make_control_class(
184
236
  * @returns {Promise<void>}
185
237
  */
186
238
  /**
187
- * Sets some or all dynamics curve 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.
239
+ * Sets some or all dynamics curve parameters. The return value indicates if the
240
+ * parameters were successfully set. The action of this method is atomic - if
241
+ * any of the value changes fails, none of the changes are made.
188
242
  *
189
243
  * @method OcaDynamicsCurve#SetMultiple
190
- * @param {number} Mask
191
- *
244
+ * @param {IOcaParameterMask} Mask
192
245
  * @param {number} nSegments
193
- *
194
- * @param {OcaDBr[]} Threshold
195
- *
246
+ * @param {IOcaDBr[]} Threshold
196
247
  * @param {number[]} Slope
197
- *
198
248
  * @param {number[]} KneeParameter
199
- *
200
249
  * @param {number} DynamicGainFloor
201
- *
202
250
  * @param {number} DynamicGainCeiling
203
251
  *
204
252
  * @returns {Promise<void>}
205
253
  */
206
254
  /**
207
- * This event is emitted when the property NSegments changes in the remote object.
255
+ * This event is emitted when the property ``NSegments`` changes in the remote object.
208
256
  * The property ``NSegments`` is described in the AES70 standard as follows.
209
257
  * Number of curve segments.
210
258
  *
211
259
  * @member {PropertyEvent<number>} OcaDynamicsCurve#OnNSegmentsChanged
212
260
  */
213
261
  /**
214
- * This event is emitted when the property Threshold changes in the remote object.
262
+ * This event is emitted when the property ``Threshold`` changes in the remote object.
215
263
  * The property ``Threshold`` is described in the AES70 standard as follows.
216
- * <b>T[1..n-1]</b>. See class description for details.
264
+ * **T[1..n-1]**. See class description for details.
217
265
  *
218
266
  * @member {PropertyEvent<OcaDBr[]>} OcaDynamicsCurve#OnThresholdChanged
219
267
  */
220
268
  /**
221
- * This event is emitted when the property Slope changes in the remote object.
269
+ * This event is emitted when the property ``Slope`` changes in the remote object.
222
270
  * The property ``Slope`` is described in the AES70 standard as follows.
223
- * <b>S[1..n]</b>. See class description for details.
271
+ * **S[1..n]**. See class description for details.
224
272
  *
225
273
  * @member {PropertyEvent<number[]>} OcaDynamicsCurve#OnSlopeChanged
226
274
  */
227
275
  /**
228
- * This event is emitted when the property KneeParameter changes in the remote object.
276
+ * This event is emitted when the property ``KneeParameter`` changes in the remote object.
229
277
  * The property ``KneeParameter`` is described in the AES70 standard as follows.
230
- * <b>K[1..n]</b>. See class description for details.
278
+ * **K[1..n]**. See class description for details.
231
279
  *
232
280
  * @member {PropertyEvent<number[]>} OcaDynamicsCurve#OnKneeParameterChanged
233
281
  */
234
282
  /**
235
- * This event is emitted when the property DynamicGainFloor changes in the remote object.
283
+ * This event is emitted when the property ``DynamicGainFloor`` changes in the remote object.
236
284
  * The property ``DynamicGainFloor`` is described in the AES70 standard as follows.
237
285
  * Lowest allowed dynamic gain value. See class description for details.
238
286
  *
239
287
  * @member {PropertyEvent<number>} OcaDynamicsCurve#OnDynamicGainFloorChanged
240
288
  */
241
289
  /**
242
- * This event is emitted when the property DynamicGainCeiling changes in the remote object.
290
+ * This event is emitted when the property ``DynamicGainCeiling`` changes in the remote object.
243
291
  * The property ``DynamicGainCeiling`` is described in the AES70 standard as follows.
244
292
  * Highest allowed dynamic gain value. See class description for details.
245
293
  *
@@ -1,10 +1,12 @@
1
- import { RemoteDevice } from '../remote_device';
2
- import { OcaActuator } from './OcaActuator';
1
+ import {
2
+ IOcaLevelDetectionLaw,
3
+ OcaLevelDetectionLaw,
4
+ } from '../../types/OcaLevelDetectionLaw';
5
+ import { IOcaParameterMask } from '../../types/OcaParameterMask';
3
6
  import { Arguments } from '../arguments';
4
-
5
7
  import { PropertyEvent } from '../property_event';
6
- import { IOcaLevelDetectionLaw } from '../../types/OcaLevelDetectionLaw';
7
- import { OcaLevelDetectionLaw } from '../../types/OcaLevelDetectionLaw';
8
+ import { RemoteDevice } from '../remote_device';
9
+ import { OcaActuator } from './OcaActuator';
8
10
 
9
11
  /**
10
12
  * Dynamics element : side-chain detector.
@@ -35,7 +37,8 @@ export declare class OcaDynamicsDetector extends OcaActuator {
35
37
  constructor(objectNumber: number, device: RemoteDevice);
36
38
 
37
39
  /**
38
- * Gets the value of the Law property. Return status indicates whether the value was successfully retrieved.
40
+ * Gets the value of the Law property. Return status indicates whether the
41
+ * value was successfully retrieved.
39
42
  *
40
43
  * @method OcaDynamicsDetector#GetLaw
41
44
  * @returns {Promise<OcaLevelDetectionLaw>}
@@ -44,17 +47,19 @@ export declare class OcaDynamicsDetector extends OcaActuator {
44
47
  GetLaw(): Promise<OcaLevelDetectionLaw>;
45
48
 
46
49
  /**
47
- * Sets the value of the Law property. Return status indicates whether the value was successfully set.
50
+ * Sets the value of the Law property. Return status indicates whether the
51
+ * value was successfully set.
48
52
  *
49
53
  * @method OcaDynamicsDetector#SetLaw
50
- * @param {OcaLevelDetectionLaw} Law
54
+ * @param {IOcaLevelDetectionLaw} Law
51
55
  *
52
56
  * @returns {Promise<void>}
53
57
  */
54
58
  SetLaw(Law: IOcaLevelDetectionLaw): Promise<void>;
55
59
 
56
60
  /**
57
- * Gets the value of the AttackTime property. The return value indicates if the value was successfully retrieved.
61
+ * Gets the value of the AttackTime property. The return value indicates if
62
+ * the value was successfully retrieved.
58
63
  * The return values of this method are
59
64
  *
60
65
  * - Time of type ``number``
@@ -67,7 +72,8 @@ export declare class OcaDynamicsDetector extends OcaActuator {
67
72
  GetAttackTime(): Promise<Arguments<[number, number, number]>>;
68
73
 
69
74
  /**
70
- * Sets the value of the AttackTime property. The return value indicates whether the property was successfully set.
75
+ * Sets the value of the AttackTime property. The return value indicates
76
+ * whether the property was successfully set.
71
77
  *
72
78
  * @method OcaDynamicsDetector#SetAttackTime
73
79
  * @param {number} Time
@@ -77,7 +83,8 @@ export declare class OcaDynamicsDetector extends OcaActuator {
77
83
  SetAttackTime(Time: number): Promise<void>;
78
84
 
79
85
  /**
80
- * Gets the value of the ReleaseTime property. The return value indicates if the value was successfully retrieved.
86
+ * Gets the value of the ReleaseTime property. The return value indicates if
87
+ * the value was successfully retrieved.
81
88
  * The return values of this method are
82
89
  *
83
90
  * - Time of type ``number``
@@ -90,7 +97,8 @@ export declare class OcaDynamicsDetector extends OcaActuator {
90
97
  GetReleaseTime(): Promise<Arguments<[number, number, number]>>;
91
98
 
92
99
  /**
93
- * Sets the value of the ReleaseTime property. The return value indicates whether the property was successfully set.
100
+ * Sets the value of the ReleaseTime property. The return value indicates
101
+ * whether the property was successfully set.
94
102
  *
95
103
  * @method OcaDynamicsDetector#SetReleaseTime
96
104
  * @param {number} Time
@@ -100,7 +108,8 @@ export declare class OcaDynamicsDetector extends OcaActuator {
100
108
  SetReleaseTime(Time: number): Promise<void>;
101
109
 
102
110
  /**
103
- * Gets the value of the HoldTime property. The return value indicates if the value was successfully retrieved.
111
+ * Gets the value of the HoldTime property. The return value indicates if the
112
+ * value was successfully retrieved.
104
113
  * The return values of this method are
105
114
  *
106
115
  * - Time of type ``number``
@@ -113,7 +122,8 @@ export declare class OcaDynamicsDetector extends OcaActuator {
113
122
  GetHoldTime(): Promise<Arguments<[number, number, number]>>;
114
123
 
115
124
  /**
116
- * Sets the value of the HoldTime property. The return value indicates whether the property was successfully set.
125
+ * Sets the value of the HoldTime property. The return value indicates whether
126
+ * the property was successfully set.
117
127
  *
118
128
  * @method OcaDynamicsDetector#SetHoldTime
119
129
  * @param {number} Time
@@ -123,23 +133,21 @@ export declare class OcaDynamicsDetector extends OcaActuator {
123
133
  SetHoldTime(Time: number): Promise<void>;
124
134
 
125
135
  /**
126
- * Sets some or all detector 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.
136
+ * Sets some or all detector parameters. The return value indicates if the
137
+ * parameters were successfully set. The action of this method is atomic - if
138
+ * any of the value changes fails, none of the changes are made.
127
139
  *
128
140
  * @method OcaDynamicsDetector#SetMultiple
129
- * @param {number} Mask
130
- *
131
- * @param {OcaLevelDetectionLaw} Law
132
- *
141
+ * @param {IOcaParameterMask} Mask
142
+ * @param {IOcaLevelDetectionLaw} Law
133
143
  * @param {number} AttackTime
134
- *
135
144
  * @param {number} ReleaseTime
136
- *
137
145
  * @param {number} HoldTime
138
146
  *
139
147
  * @returns {Promise<void>}
140
148
  */
141
149
  SetMultiple(
142
- Mask: number,
150
+ Mask: IOcaParameterMask,
143
151
  Law: IOcaLevelDetectionLaw,
144
152
  AttackTime: number,
145
153
  ReleaseTime: number,