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,47 +1,43 @@
1
- import { RemoteDevice } from '../remote_device';
2
- import { OcaManager } from './OcaManager';
3
- import { Event } from '../event';
4
-
5
- import { PropertyEvent } from '../property_event';
6
1
  import { IOcaEvent } from '../../types/OcaEvent';
7
2
  import { IOcaMethod } from '../../types/OcaMethod';
8
3
  import { IOcaNotificationDeliveryMode } from '../../types/OcaNotificationDeliveryMode';
9
4
  import { IOcaPropertyID } from '../../types/OcaPropertyID';
10
5
  import { OcaSubscriptionManagerState } from '../../types/OcaSubscriptionManagerState';
6
+ import { Event } from '../event';
7
+ import { PropertyEvent } from '../property_event';
8
+ import { RemoteDevice } from '../remote_device';
9
+ import { OcaManager } from './OcaManager';
11
10
 
12
11
  /**
13
12
  * Manager that collects and controls the event subscriptions of the device.
14
13
  *
15
14
  * - Must be instantiated once in every device that supports subscriptions.
16
15
  *
17
- *
18
16
  * - May be instantiated at most once in any device.
19
17
  *
20
- *
21
18
  * - If instantiated, must have object number 4.
22
- * Absence of an **OcaSubscriptionManager** object signifies that the device does not support event subscriptions.
19
+ *
20
+ *
21
+ * Absence of an **OcaSubscriptionManager** object signifies that the device
22
+ * does not support event subscriptions.
23
23
  * @extends OcaManager
24
24
  * @class OcaSubscriptionManager
25
25
  */
26
26
  export declare class OcaSubscriptionManager extends OcaManager {
27
27
  /**
28
- * Event that is raised when the value of the **State** property changes from **Normal ** to **EventsDisabled.**
28
+ * Event that is raised when the value of the **State** property changes from
29
+ * **Normal **to **EventsDisabled.**
29
30
  * @member OcaSubscriptionManager#OnNotificationsDisabled {Event}
30
- * Event that is raised when the value of the <b>State </b>property
31
- * changes from <b><i>Normal </i></b>to <b><i>EventsDisabled.</i></b>
32
31
  */
33
32
  OnNotificationsDisabled: Event;
34
33
 
35
34
  /**
36
- * Event that is raised when the value of the **State** property changes from **EventsDisabled ** to **Normal.** Event data includes a lists of which objects changed state during the period that notifications were disabled.
35
+ * Event that is raised when the value of the **State** property changes from
36
+ * **EventsDisabled **to **Normal.** Event data includes a lists of which
37
+ * objects changed state during the period that notifications were disabled.
37
38
  * @member OcaSubscriptionManager#OnSynchronizeState {Event}
38
- * Event that is raised when the value of the <b>State </b>property
39
- * changes from <b><i>EventsDisabled </i></b>to <b><i>Normal.</i></b>
40
- * Event data includes a lists of which objects changed state during the
41
- * period that notifications were disabled.
42
39
  */
43
40
  OnSynchronizeState: Event;
44
-
45
41
  /**
46
42
  * This event is emitted whenever State changes.
47
43
  */
@@ -50,29 +46,32 @@ export declare class OcaSubscriptionManager extends OcaManager {
50
46
  constructor(objectNumber: number, device: RemoteDevice);
51
47
 
52
48
  /**
53
- * Removes all subscriptions to the given event with the given **OcaMethod** . The return value indicates whether the subscription(s) was (were) successfully removed.
49
+ * Removes all subscriptions to the given event with the given **OcaMethod**.
50
+ * The return value indicates whether the subscription(s) was (were)
51
+ * successfully removed.
54
52
  *
55
53
  * @method OcaSubscriptionManager#RemoveSubscription
56
- * @param {OcaEvent} Event
57
- *
58
- * @param {OcaMethod} Subscriber
54
+ * @param {IOcaEvent} Event
55
+ * @param {IOcaMethod} Subscriber
59
56
  *
60
57
  * @returns {Promise<void>}
61
58
  */
62
59
  RemoveSubscription(Event: IOcaEvent, Subscriber: IOcaMethod): Promise<void>;
63
60
 
64
61
  /**
65
- * Adds a subscription to an event. The subscription is added for the session on which the command came in. If a subscription identical to the one being requested already exists, an additional one shall not be added. Two subscriptions are identical if the **Event, Subscriber, NotificationDeliveryMode** , and **DestinationInformation** parameters are all identical. The return value indicates whether the subscription succeeded.
62
+ * Adds a subscription to an event. The subscription is added for the session
63
+ * on which the command came in. If a subscription identical to the one being
64
+ * requested already exists, an additional one shall not be added. Two
65
+ * subscriptions are identical if the **Event, Subscriber,
66
+ * NotificationDeliveryMode**, and **DestinationInformation** parameters are
67
+ * all identical. The return value indicates whether the subscription
68
+ * succeeded.
66
69
  *
67
70
  * @method OcaSubscriptionManager#AddSubscription
68
- * @param {OcaEvent} Event
69
- *
70
- * @param {OcaMethod} Subscriber
71
- *
71
+ * @param {IOcaEvent} Event
72
+ * @param {IOcaMethod} Subscriber
72
73
  * @param {Uint8Array} SubscriberContext
73
- *
74
- * @param {OcaNotificationDeliveryMode} NotificationDeliveryMode
75
- *
74
+ * @param {IOcaNotificationDeliveryMode} NotificationDeliveryMode
76
75
  * @param {Uint8Array} DestinationInformation
77
76
  *
78
77
  * @returns {Promise<void>}
@@ -86,7 +85,17 @@ export declare class OcaSubscriptionManager extends OcaManager {
86
85
  ): Promise<void>;
87
86
 
88
87
  /**
89
- * Temporarily disables emitting of event notifications (to all subscribers, not just to the subscriber calling this method). Events from the Subscription Manager itself are not disabled. This method can be used if either a controller or the local device knows that it is going to change the state of the device significantly, which could lead to a notification storm of events. Invoking this method will prevent the notification storm. The event '03e01 EventsDisabled' will be raised to notify all controllers of the fact that events are temporarily disabled. The subscription manager will start collecting the object numbers of the objects that raise events, so that it can pass a list of changed objects once the events are re-enabled. The return value indicates if disabling events succeeded.
88
+ * Temporarily disables emitting of event notifications (to all subscribers,
89
+ * not just to the subscriber calling this method). Events from the
90
+ * Subscription Manager itself are not disabled. This method can be used if
91
+ * either a controller or the local device knows that it is going to change
92
+ * the state of the device significantly, which could lead to a notification
93
+ * storm of events. Invoking this method will prevent the notification storm.
94
+ * The event '03e01 EventsDisabled' will be raised to notify all controllers
95
+ * of the fact that events are temporarily disabled. The subscription manager
96
+ * will start collecting the object numbers of the objects that raise events,
97
+ * so that it can pass a list of changed objects once the events are
98
+ * re-enabled. The return value indicates if disabling events succeeded.
90
99
  *
91
100
  * @method OcaSubscriptionManager#DisableNotifications
92
101
  * @returns {Promise<void>}
@@ -94,7 +103,15 @@ export declare class OcaSubscriptionManager extends OcaManager {
94
103
  DisableNotifications(): Promise<void>;
95
104
 
96
105
  /**
97
- * Re-enables the sending of event notifications to all subscribers. When events are re-enabled, the subscription manager will raise the **SynchronizeState** event, passing the list of objects that have changed state. Subsequently, the subscription manager will transmit all notifications as normal. If the connection to the controller that invoked the DisableEvents() is lost, this method will be called automatically to prevent the situation in which the raising of events would never be re-enabled. The return value indicates if re-enabling the event-based events succeeded.
106
+ * Re-enables the sending of event notifications to all subscribers. When
107
+ * events are re-enabled, the subscription manager will raise the
108
+ * **SynchronizeState** event, passing the list of objects that have changed
109
+ * state. Subsequently, the subscription manager will transmit all
110
+ * notifications as normal. If the connection to the controller that invoked
111
+ * the DisableEvents() is lost, this method will be called automatically to
112
+ * prevent the situation in which the raising of events would never be
113
+ * re-enabled. The return value indicates if re-enabling the event-based
114
+ * events succeeded.
98
115
  *
99
116
  * @method OcaSubscriptionManager#ReEnableNotifications
100
117
  * @returns {Promise<void>}
@@ -102,19 +119,22 @@ export declare class OcaSubscriptionManager extends OcaManager {
102
119
  ReEnableNotifications(): Promise<void>;
103
120
 
104
121
  /**
105
- * Adds a subscription to the PropertyChanged event in the object Emitter for changes of the property Property. If the NotificationDeliveryMode is Fast, the subscription is added for the session on which the command came in. If a subscription identical to the one being requested already exists, an additional one shall not be added. Two subscriptions are identical if the Emitter, Property, Subscriber, SubsciberContext, NotificationDeliveryMode, and DestinationInformation parameters are all identical. The return value indicates whether the subscription succeeded. Added in v2 of this class, in AES70-2017.
122
+ * Adds a subscription to the PropertyChanged event in the object Emitter for
123
+ * changes of the property Property. If the NotificationDeliveryMode is Fast,
124
+ * the subscription is added for the session on which the command came in. If
125
+ * a subscription identical to the one being requested already exists, an
126
+ * additional one shall not be added. Two subscriptions are identical if the
127
+ * Emitter, Property, Subscriber, SubsciberContext, NotificationDeliveryMode,
128
+ * and DestinationInformation parameters are all identical. The return value
129
+ * indicates whether the subscription succeeded. Added in v2 of this class, in
130
+ * AES70-2017.
106
131
  *
107
132
  * @method OcaSubscriptionManager#AddPropertyChangeSubscription
108
133
  * @param {number} Emitter
109
- *
110
- * @param {OcaPropertyID} Property
111
- *
112
- * @param {OcaMethod} Subscriber
113
- *
134
+ * @param {IOcaPropertyID} Property
135
+ * @param {IOcaMethod} Subscriber
114
136
  * @param {Uint8Array} SubscriberContext
115
- *
116
- * @param {OcaNotificationDeliveryMode} NotificationDeliveryMode
117
- *
137
+ * @param {IOcaNotificationDeliveryMode} NotificationDeliveryMode
118
138
  * @param {Uint8Array} DestinationInformation
119
139
  *
120
140
  * @returns {Promise<void>}
@@ -129,14 +149,16 @@ export declare class OcaSubscriptionManager extends OcaManager {
129
149
  ): Promise<void>;
130
150
 
131
151
  /**
132
- * Removes any subscription to a PropertyChanged event with the given Emitter, Property, Subscriber, SubscriberContext, NotificationDeliveryMode, and DestinationInformation. The return value indicates whether the subscription(s) was (were) successfully removed. Added in v2 of this class, in AES70-2017.
152
+ * Removes any subscription to a PropertyChanged event with the given Emitter,
153
+ * Property, Subscriber, SubscriberContext, NotificationDeliveryMode, and
154
+ * DestinationInformation. The return value indicates whether the
155
+ * subscription(s) was (were) successfully removed. Added in v2 of this class,
156
+ * in AES70-2017.
133
157
  *
134
158
  * @method OcaSubscriptionManager#RemovePropertyChangeSubscription
135
159
  * @param {number} Emitter
136
- *
137
- * @param {OcaPropertyID} Property
138
- *
139
- * @param {OcaMethod} Subscriber
160
+ * @param {IOcaPropertyID} Property
161
+ * @param {IOcaMethod} Subscriber
140
162
  *
141
163
  * @returns {Promise<void>}
142
164
  */
@@ -147,7 +169,12 @@ export declare class OcaSubscriptionManager extends OcaManager {
147
169
  ): Promise<void>;
148
170
 
149
171
  /**
150
- * Returns maximum byte length of payload of subscriber context parameter that this device supports. This returned value shall be either zero or four. If the returned payload length is not zero, it shall be four. No other values shall be allowed, and the returned value shall not change once the device has initialized. NOTE: In AES70-2015, arbitrary subscriber context lengths were allowed; this is no longer true.
172
+ * Returns maximum byte length of payload of subscriber context parameter that
173
+ * this device supports. This returned value shall be either zero or four. If
174
+ * the returned payload length is not zero, it shall be four. No other values
175
+ * shall be allowed, and the returned value shall not change once the device
176
+ * has initialized. NOTE: In AES70-2015, arbitrary subscriber context lengths
177
+ * were allowed; this is no longer true.
151
178
  *
152
179
  * @method OcaSubscriptionManager#GetMaximumSubscriberContextLength
153
180
  * @returns {Promise<number>}
@@ -1,26 +1,27 @@
1
- import { make_control_class } from '../make_control_class.js';
2
- import { OcaManager } from './OcaManager.js';
3
1
  import { OcaBlob } from '../../OCP1/OcaBlob.js';
4
2
  import { OcaEvent } from '../../OCP1/OcaEvent.js';
5
- import { OcaList } from '../../OCP1/OcaList.js';
6
3
  import { OcaMethod } from '../../OCP1/OcaMethod.js';
7
4
  import { OcaNotificationDeliveryMode } from '../../OCP1/OcaNotificationDeliveryMode.js';
5
+ import { OcaObjectListEventData } from '../../OCP1/OcaObjectListEventData.js';
8
6
  import { OcaPropertyID } from '../../OCP1/OcaPropertyID.js';
9
7
  import { OcaSubscriptionManagerState } from '../../OCP1/OcaSubscriptionManagerState.js';
10
8
  import { OcaUint16 } from '../../OCP1/OcaUint16.js';
11
9
  import { OcaUint32 } from '../../OCP1/OcaUint32.js';
10
+ import { make_control_class } from '../make_control_class.js';
11
+ import { OcaManager } from './OcaManager.js';
12
12
 
13
13
  /**
14
14
  * Manager that collects and controls the event subscriptions of the device.
15
15
  *
16
16
  * - Must be instantiated once in every device that supports subscriptions.
17
17
  *
18
- *
19
18
  * - May be instantiated at most once in any device.
20
19
  *
21
- *
22
20
  * - If instantiated, must have object number 4.
23
- * Absence of an **OcaSubscriptionManager** object signifies that the device does not support event subscriptions.
21
+ *
22
+ *
23
+ * Absence of an **OcaSubscriptionManager** object signifies that the device
24
+ * does not support event subscriptions.
24
25
  * @extends OcaManager
25
26
  * @class OcaSubscriptionManager
26
27
  */
@@ -67,108 +68,134 @@ export const OcaSubscriptionManager = make_control_class(
67
68
  [['State', [OcaSubscriptionManagerState], 3, 1, false, false, null]],
68
69
  [
69
70
  ['NotificationsDisabled', 3, 1, []],
70
- ['SynchronizeState', 3, 2, [OcaList(OcaUint32)]],
71
+ ['SynchronizeState', 3, 2, [OcaObjectListEventData]],
71
72
  ]
72
73
  );
73
74
 
74
75
  /**
75
- * Removes all subscriptions to the given event with the given **OcaMethod** . The return value indicates whether the subscription(s) was (were) successfully removed.
76
+ * Removes all subscriptions to the given event with the given **OcaMethod**.
77
+ * The return value indicates whether the subscription(s) was (were)
78
+ * successfully removed.
76
79
  *
77
80
  * @method OcaSubscriptionManager#RemoveSubscription
78
- * @param {OcaEvent} Event
79
- *
80
- * @param {OcaMethod} Subscriber
81
+ * @param {IOcaEvent} Event
82
+ * @param {IOcaMethod} Subscriber
81
83
  *
82
84
  * @returns {Promise<void>}
83
85
  */
84
86
  /**
85
- * Adds a subscription to an event. The subscription is added for the session on which the command came in. If a subscription identical to the one being requested already exists, an additional one shall not be added. Two subscriptions are identical if the **Event, Subscriber, NotificationDeliveryMode** , and **DestinationInformation** parameters are all identical. The return value indicates whether the subscription succeeded.
87
+ * Adds a subscription to an event. The subscription is added for the session on
88
+ * which the command came in. If a subscription identical to the one being
89
+ * requested already exists, an additional one shall not be added. Two
90
+ * subscriptions are identical if the **Event, Subscriber,
91
+ * NotificationDeliveryMode**, and **DestinationInformation** parameters are all
92
+ * identical. The return value indicates whether the subscription succeeded.
86
93
  *
87
94
  * @method OcaSubscriptionManager#AddSubscription
88
- * @param {OcaEvent} Event
89
- *
90
- * @param {OcaMethod} Subscriber
91
- *
95
+ * @param {IOcaEvent} Event
96
+ * @param {IOcaMethod} Subscriber
92
97
  * @param {Uint8Array} SubscriberContext
93
- *
94
- * @param {OcaNotificationDeliveryMode} NotificationDeliveryMode
95
- *
98
+ * @param {IOcaNotificationDeliveryMode} NotificationDeliveryMode
96
99
  * @param {Uint8Array} DestinationInformation
97
100
  *
98
101
  * @returns {Promise<void>}
99
102
  */
100
103
  /**
101
- * Temporarily disables emitting of event notifications (to all subscribers, not just to the subscriber calling this method). Events from the Subscription Manager itself are not disabled. This method can be used if either a controller or the local device knows that it is going to change the state of the device significantly, which could lead to a notification storm of events. Invoking this method will prevent the notification storm. The event '03e01 EventsDisabled' will be raised to notify all controllers of the fact that events are temporarily disabled. The subscription manager will start collecting the object numbers of the objects that raise events, so that it can pass a list of changed objects once the events are re-enabled. The return value indicates if disabling events succeeded.
104
+ * Temporarily disables emitting of event notifications (to all subscribers, not
105
+ * just to the subscriber calling this method). Events from the Subscription
106
+ * Manager itself are not disabled. This method can be used if either a
107
+ * controller or the local device knows that it is going to change the state of
108
+ * the device significantly, which could lead to a notification storm of events.
109
+ * Invoking this method will prevent the notification storm. The event '03e01
110
+ * EventsDisabled' will be raised to notify all controllers of the fact that
111
+ * events are temporarily disabled. The subscription manager will start
112
+ * collecting the object numbers of the objects that raise events, so that it
113
+ * can pass a list of changed objects once the events are re-enabled. The return
114
+ * value indicates if disabling events succeeded.
102
115
  *
103
116
  * @method OcaSubscriptionManager#DisableNotifications
104
117
  * @returns {Promise<void>}
105
118
  */
106
119
  /**
107
- * Re-enables the sending of event notifications to all subscribers. When events are re-enabled, the subscription manager will raise the **SynchronizeState** event, passing the list of objects that have changed state. Subsequently, the subscription manager will transmit all notifications as normal. If the connection to the controller that invoked the DisableEvents() is lost, this method will be called automatically to prevent the situation in which the raising of events would never be re-enabled. The return value indicates if re-enabling the event-based events succeeded.
120
+ * Re-enables the sending of event notifications to all subscribers. When events
121
+ * are re-enabled, the subscription manager will raise the **SynchronizeState**
122
+ * event, passing the list of objects that have changed state. Subsequently, the
123
+ * subscription manager will transmit all notifications as normal. If the
124
+ * connection to the controller that invoked the DisableEvents() is lost, this
125
+ * method will be called automatically to prevent the situation in which the
126
+ * raising of events would never be re-enabled. The return value indicates if
127
+ * re-enabling the event-based events succeeded.
108
128
  *
109
129
  * @method OcaSubscriptionManager#ReEnableNotifications
110
130
  * @returns {Promise<void>}
111
131
  */
112
132
  /**
113
- * Adds a subscription to the PropertyChanged event in the object Emitter for changes of the property Property. If the NotificationDeliveryMode is Fast, the subscription is added for the session on which the command came in. If a subscription identical to the one being requested already exists, an additional one shall not be added. Two subscriptions are identical if the Emitter, Property, Subscriber, SubsciberContext, NotificationDeliveryMode, and DestinationInformation parameters are all identical. The return value indicates whether the subscription succeeded. Added in v2 of this class, in AES70-2017.
133
+ * Adds a subscription to the PropertyChanged event in the object Emitter for
134
+ * changes of the property Property. If the NotificationDeliveryMode is Fast,
135
+ * the subscription is added for the session on which the command came in. If a
136
+ * subscription identical to the one being requested already exists, an
137
+ * additional one shall not be added. Two subscriptions are identical if the
138
+ * Emitter, Property, Subscriber, SubsciberContext, NotificationDeliveryMode,
139
+ * and DestinationInformation parameters are all identical. The return value
140
+ * indicates whether the subscription succeeded. Added in v2 of this class, in
141
+ * AES70-2017.
114
142
  *
115
143
  * @method OcaSubscriptionManager#AddPropertyChangeSubscription
116
144
  * @param {number} Emitter
117
- *
118
- * @param {OcaPropertyID} Property
119
- *
120
- * @param {OcaMethod} Subscriber
121
- *
145
+ * @param {IOcaPropertyID} Property
146
+ * @param {IOcaMethod} Subscriber
122
147
  * @param {Uint8Array} SubscriberContext
123
- *
124
- * @param {OcaNotificationDeliveryMode} NotificationDeliveryMode
125
- *
148
+ * @param {IOcaNotificationDeliveryMode} NotificationDeliveryMode
126
149
  * @param {Uint8Array} DestinationInformation
127
150
  *
128
151
  * @returns {Promise<void>}
129
152
  */
130
153
  /**
131
- * Removes any subscription to a PropertyChanged event with the given Emitter, Property, Subscriber, SubscriberContext, NotificationDeliveryMode, and DestinationInformation. The return value indicates whether the subscription(s) was (were) successfully removed. Added in v2 of this class, in AES70-2017.
154
+ * Removes any subscription to a PropertyChanged event with the given Emitter,
155
+ * Property, Subscriber, SubscriberContext, NotificationDeliveryMode, and
156
+ * DestinationInformation. The return value indicates whether the
157
+ * subscription(s) was (were) successfully removed. Added in v2 of this class,
158
+ * in AES70-2017.
132
159
  *
133
160
  * @method OcaSubscriptionManager#RemovePropertyChangeSubscription
134
161
  * @param {number} Emitter
135
- *
136
- * @param {OcaPropertyID} Property
137
- *
138
- * @param {OcaMethod} Subscriber
162
+ * @param {IOcaPropertyID} Property
163
+ * @param {IOcaMethod} Subscriber
139
164
  *
140
165
  * @returns {Promise<void>}
141
166
  */
142
167
  /**
143
- * Returns maximum byte length of payload of subscriber context parameter that this device supports. This returned value shall be either zero or four. If the returned payload length is not zero, it shall be four. No other values shall be allowed, and the returned value shall not change once the device has initialized. NOTE: In AES70-2015, arbitrary subscriber context lengths were allowed; this is no longer true.
168
+ * Returns maximum byte length of payload of subscriber context parameter that
169
+ * this device supports. This returned value shall be either zero or four. If
170
+ * the returned payload length is not zero, it shall be four. No other values
171
+ * shall be allowed, and the returned value shall not change once the device has
172
+ * initialized. NOTE: In AES70-2015, arbitrary subscriber context lengths were
173
+ * allowed; this is no longer true.
144
174
  *
145
175
  * @method OcaSubscriptionManager#GetMaximumSubscriberContextLength
146
176
  * @returns {Promise<number>}
147
177
  * A promise which resolves to a single value of type ``number``.
148
178
  */
149
179
  /**
150
- * Event that is raised when the value of the **State** property changes from **Normal ** to **EventsDisabled.**
180
+ * Event that is raised when the value of the **State** property changes from
181
+ * **Normal **to **EventsDisabled.**
151
182
  * @member OcaSubscriptionManager#OnNotificationsDisabled {Event}
152
- * Event that is raised when the value of the <b>State </b>property
153
- * changes from <b><i>Normal </i></b>to <b><i>EventsDisabled.</i></b>
154
183
  */
155
184
  /**
156
- * Event that is raised when the value of the **State** property changes from **EventsDisabled ** to **Normal.** Event data includes a lists of which objects changed state during the period that notifications were disabled.
185
+ * Event that is raised when the value of the **State** property changes from
186
+ * **EventsDisabled **to **Normal.** Event data includes a lists of which
187
+ * objects changed state during the period that notifications were disabled.
157
188
  * @member OcaSubscriptionManager#OnSynchronizeState {Event}
158
- * Event that is raised when the value of the <b>State </b>property
159
- * changes from <b><i>EventsDisabled </i></b>to <b><i>Normal.</i></b>
160
- * Event data includes a lists of which objects changed state during the
161
- * period that notifications were disabled.
162
189
  */
163
190
  /**
164
- * This event is emitted when the property State changes in the remote object.
191
+ * This event is emitted when the property ``State`` changes in the remote object.
165
192
  * The property ``State`` is described in the AES70 standard as follows.
166
- * Events enabled or disabled. When events are disabled, (1) Only
167
- * notification from the subscription manager itself are sent to
168
- * subscribers, and (2) the subscription manager saves the object numbers
169
- * of all objects that raise events while notifications are disabled. The
170
- * saved numbers are eventually returned by the <b>SynchronizeState
171
- * </b>event that occurs when notifications are re-enabled.
193
+ * Events enabled or disabled. When events are disabled, (1) Only notification
194
+ * from the subscription manager itself are sent to subscribers, and (2) the
195
+ * subscription manager saves the object numbers of all objects that raise
196
+ * events while notifications are disabled. The saved numbers are eventually
197
+ * returned by the **SynchronizeState** event that occurs when notifications are
198
+ * re-enabled.
172
199
  *
173
200
  * @member {PropertyEvent<OcaSubscriptionManagerState>} OcaSubscriptionManager#OnStateChanged
174
201
  */
@@ -2,7 +2,8 @@ import { RemoteDevice } from '../remote_device';
2
2
  import { OcaActuator } from './OcaActuator';
3
3
 
4
4
  /**
5
- * Actuator with no control parameters, used as a simple node to represent summations in block signal flows.
5
+ * Actuator with no control parameters, used as a simple node to represent
6
+ * summations in block signal flows.
6
7
  * @extends OcaActuator
7
8
  * @class OcaSummingPoint
8
9
  */
@@ -2,7 +2,8 @@ import { make_control_class } from '../make_control_class.js';
2
2
  import { OcaActuator } from './OcaActuator.js';
3
3
 
4
4
  /**
5
- * Actuator with no control parameters, used as a simple node to represent summations in block signal flows.
5
+ * Actuator with no control parameters, used as a simple node to represent
6
+ * summations in block signal flows.
6
7
  * @extends OcaActuator
7
8
  * @class OcaSummingPoint
8
9
  */
@@ -1,8 +1,7 @@
1
- import { RemoteDevice } from '../remote_device';
2
- import { OcaActuator } from './OcaActuator';
3
1
  import { Arguments } from '../arguments';
4
-
5
2
  import { PropertyEvent } from '../property_event';
3
+ import { RemoteDevice } from '../remote_device';
4
+ import { OcaActuator } from './OcaActuator';
6
5
 
7
6
  /**
8
7
  * (n)-position single-pole switch.
@@ -28,7 +27,9 @@ export declare class OcaSwitch extends OcaActuator {
28
27
  constructor(objectNumber: number, device: RemoteDevice);
29
28
 
30
29
  /**
31
- * Gets the value of the Position property and, optionally, its implementation min and max. The return value indicates whether the data was successfully retrieved.
30
+ * Gets the value of the Position property and, optionally, its implementation
31
+ * min and max. The return value indicates whether the data was successfully
32
+ * retrieved.
32
33
  * The return values of this method are
33
34
  *
34
35
  * - position of type ``number``
@@ -41,7 +42,8 @@ export declare class OcaSwitch extends OcaActuator {
41
42
  GetPosition(): Promise<Arguments<[number, number, number]>>;
42
43
 
43
44
  /**
44
- * Sets the value of the Position property. The return value indicates whether the property was successfully set.
45
+ * Sets the value of the Position property. The return value indicates whether
46
+ * the property was successfully set.
45
47
  *
46
48
  * @method OcaSwitch#SetPosition
47
49
  * @param {number} position
@@ -51,7 +53,8 @@ export declare class OcaSwitch extends OcaActuator {
51
53
  SetPosition(position: number): Promise<void>;
52
54
 
53
55
  /**
54
- * Gets the name assigned to a given switch position. The return value indicates whether the name was successfully retrieved.
56
+ * Gets the name assigned to a given switch position. The return value
57
+ * indicates whether the name was successfully retrieved.
55
58
  *
56
59
  * @method OcaSwitch#GetPositionName
57
60
  * @param {number} Index
@@ -62,11 +65,11 @@ export declare class OcaSwitch extends OcaActuator {
62
65
  GetPositionName(Index: number): Promise<string>;
63
66
 
64
67
  /**
65
- * Assigns a name to a given switch position. The return value indicates whether the name was successfully assigned.
68
+ * Assigns a name to a given switch position. The return value indicates
69
+ * whether the name was successfully assigned.
66
70
  *
67
71
  * @method OcaSwitch#SetPositionName
68
72
  * @param {number} Index
69
- *
70
73
  * @param {string} Name
71
74
  *
72
75
  * @returns {Promise<void>}
@@ -74,7 +77,8 @@ export declare class OcaSwitch extends OcaActuator {
74
77
  SetPositionName(Index: number, Name: string): Promise<void>;
75
78
 
76
79
  /**
77
- * Gets list of names assigned to the switch's positions. The return value indicates whether the names were successfully retrieved.
80
+ * Gets list of names assigned to the switch's positions. The return value
81
+ * indicates whether the names were successfully retrieved.
78
82
  *
79
83
  * @method OcaSwitch#GetPositionNames
80
84
  * @returns {Promise<string[]>}
@@ -83,7 +87,8 @@ export declare class OcaSwitch extends OcaActuator {
83
87
  GetPositionNames(): Promise<string[]>;
84
88
 
85
89
  /**
86
- * Assigns names to the switch's positions. The return value indicates whether the names were successfully assigned.
90
+ * Assigns names to the switch's positions. The return value indicates whether
91
+ * the names were successfully assigned.
87
92
  *
88
93
  * @method OcaSwitch#SetPositionNames
89
94
  * @param {string[]} Names
@@ -93,7 +98,8 @@ export declare class OcaSwitch extends OcaActuator {
93
98
  SetPositionNames(Names: string[]): Promise<void>;
94
99
 
95
100
  /**
96
- * Gets the Enabled flag assigned to a given switch position. The return value indicates whether the flag was successfully retrieved.
101
+ * Gets the Enabled flag assigned to a given switch position. The return value
102
+ * indicates whether the flag was successfully retrieved.
97
103
  *
98
104
  * @method OcaSwitch#GetPositionEnabled
99
105
  * @param {number} Index
@@ -104,11 +110,11 @@ export declare class OcaSwitch extends OcaActuator {
104
110
  GetPositionEnabled(Index: number): Promise<boolean>;
105
111
 
106
112
  /**
107
- * Sets the Enabled flag assigned to a given switch position. The return value indicates whether the flag was successfully set.
113
+ * Sets the Enabled flag assigned to a given switch position. The return value
114
+ * indicates whether the flag was successfully set.
108
115
  *
109
116
  * @method OcaSwitch#SetPositionEnabled
110
117
  * @param {number} Index
111
- *
112
118
  * @param {boolean} enabled
113
119
  *
114
120
  * @returns {Promise<void>}
@@ -116,7 +122,8 @@ export declare class OcaSwitch extends OcaActuator {
116
122
  SetPositionEnabled(Index: number, enabled: boolean): Promise<void>;
117
123
 
118
124
  /**
119
- * Gets list of Enabled flags assigned to the switch's positions. The return value indicates whether the flags were successfully retrieved.
125
+ * Gets list of Enabled flags assigned to the switch's positions. The return
126
+ * value indicates whether the flags were successfully retrieved.
120
127
  *
121
128
  * @method OcaSwitch#GetPositionEnableds
122
129
  * @returns {Promise<boolean[]>}
@@ -125,7 +132,8 @@ export declare class OcaSwitch extends OcaActuator {
125
132
  GetPositionEnableds(): Promise<boolean[]>;
126
133
 
127
134
  /**
128
- * Sets list of Enabled flags for the switch's positions. The return value indicates whether the flags were successfully set.
135
+ * Sets list of Enabled flags for the switch's positions. The return value
136
+ * indicates whether the flags were successfully set.
129
137
  *
130
138
  * @method OcaSwitch#SetPositionEnableds
131
139
  * @param {boolean[]} enableds