aes70 1.3.8 → 1.4.1

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 (438) hide show
  1. package/Changelog +26 -1
  2. package/dist/AES70.es5.js +1 -1
  3. package/package.json +1 -1
  4. package/src/OCP1/FixedLengthArray.js +5 -0
  5. package/src/OCP1/OcaBlockMember.js +1 -1
  6. package/src/OCP1/OcaClassAuthorityID.js +1 -1
  7. package/src/OCP1/OcaClassIdentification.js +1 -1
  8. package/src/OCP1/OcaDBr.js +1 -1
  9. package/src/OCP1/OcaDelayValue.js +1 -1
  10. package/src/OCP1/OcaEvent.js +1 -1
  11. package/src/OCP1/OcaEventID.js +1 -1
  12. package/src/OCP1/OcaGlobalTypeIdentifier.js +1 -1
  13. package/src/OCP1/OcaGrouperCitizen.js +1 -1
  14. package/src/OCP1/OcaGrouperEnrollment.js +1 -1
  15. package/src/OCP1/OcaGrouperGroup.js +1 -1
  16. package/src/OCP1/OcaGrouperStatusChangeEventData.js +1 -3
  17. package/src/OCP1/OcaImpedance.js +1 -1
  18. package/src/OCP1/OcaLibParamSetAssignment.js +1 -1
  19. package/src/OCP1/OcaLibVol.js +1 -1
  20. package/src/OCP1/OcaLibVolChangedEventData.js +1 -3
  21. package/src/OCP1/OcaLibVolData_ParamSet.js +1 -1
  22. package/src/OCP1/OcaLibVolIdentifier.js +1 -1
  23. package/src/OCP1/OcaLibVolMetadata.js +1 -1
  24. package/src/OCP1/OcaLibVolType.js +1 -1
  25. package/src/OCP1/OcaLibraryIdentifier.js +1 -1
  26. package/src/OCP1/OcaManagerDescriptor.js +1 -1
  27. package/src/OCP1/OcaMediaClockRate.js +1 -1
  28. package/src/OCP1/OcaMediaCoding.js +1 -1
  29. package/src/OCP1/OcaMediaConnection.js +1 -1
  30. package/src/OCP1/OcaMediaConnectorElement.js +2 -2
  31. package/src/OCP1/OcaMediaConnectorStatus.js +1 -1
  32. package/src/OCP1/OcaMediaConnectorStatusChangedEventData.js +1 -3
  33. package/src/OCP1/OcaMediaSinkConnector.js +1 -1
  34. package/src/OCP1/OcaMediaSinkConnectorChangedEventData.js +1 -3
  35. package/src/OCP1/OcaMediaSourceConnector.js +1 -1
  36. package/src/OCP1/OcaMediaSourceConnectorChangedEventData.js +1 -3
  37. package/src/OCP1/OcaMethod.js +1 -1
  38. package/src/OCP1/OcaMethodID.js +1 -1
  39. package/src/OCP1/OcaModelDescription.js +1 -1
  40. package/src/OCP1/OcaModelGUID.js +1 -1
  41. package/src/OCP1/OcaNetworkStatistics.js +1 -1
  42. package/src/OCP1/OcaNetworkSystemInterfaceDescriptor.js +1 -1
  43. package/src/OCP1/OcaNetworkSystemInterfaceID.js +1 -1
  44. package/src/OCP1/OcaOPath.js +1 -1
  45. package/src/OCP1/OcaObjectIdentification.js +1 -1
  46. package/src/OCP1/OcaObjectListEventData.js +1 -3
  47. package/src/OCP1/OcaObjectSearchResult.js +1 -1
  48. package/src/OCP1/OcaObservationEventData.js +1 -3
  49. package/src/OCP1/OcaObservationListEventData.js +1 -3
  50. package/src/OCP1/OcaParameterMask.js +3 -0
  51. package/src/OCP1/OcaPilotToneDetectorSpec.js +1 -1
  52. package/src/OCP1/OcaPort.js +1 -1
  53. package/src/OCP1/OcaPortID.js +1 -1
  54. package/src/OCP1/OcaPositionDescriptor.js +5 -4
  55. package/src/OCP1/OcaPositionDescriptorFieldFlags.js +3 -0
  56. package/src/OCP1/OcaProperty.js +1 -1
  57. package/src/OCP1/OcaPropertyDescriptor.js +1 -1
  58. package/src/OCP1/OcaPropertyID.js +1 -1
  59. package/src/OCP1/OcaProtoObjectIdentification.js +1 -1
  60. package/src/OCP1/OcaProtoPort.js +1 -1
  61. package/src/OCP1/OcaProtoPortID.js +1 -1
  62. package/src/OCP1/OcaProtoSignalPath.js +1 -1
  63. package/src/OCP1/OcaSignalPath.js +1 -1
  64. package/src/OCP1/OcaStream.js +1 -1
  65. package/src/OCP1/OcaStreamConnectorIdentification.js +1 -1
  66. package/src/OCP1/OcaTask.js +1 -1
  67. package/src/OCP1/OcaTaskStateChangedEventData.js +1 -1
  68. package/src/OCP1/OcaTaskStatus.js +1 -1
  69. package/src/OCP1/OcaTimePTP.js +1 -1
  70. package/src/OCP1/OcaTransferFunction.js +1 -1
  71. package/src/OCP1/OcaVersion.js +1 -1
  72. package/src/connection.js +7 -5
  73. package/src/controller/ControlClasses/OcaActuator.d.ts +3 -1
  74. package/src/controller/ControlClasses/OcaActuator.js +3 -1
  75. package/src/controller/ControlClasses/OcaAgent.d.ts +10 -7
  76. package/src/controller/ControlClasses/OcaAgent.js +12 -8
  77. package/src/controller/ControlClasses/OcaApplicationNetwork.d.ts +35 -21
  78. package/src/controller/ControlClasses/OcaApplicationNetwork.js +43 -32
  79. package/src/controller/ControlClasses/OcaAudioLevelSensor.d.ts +14 -8
  80. package/src/controller/ControlClasses/OcaAudioLevelSensor.js +13 -9
  81. package/src/controller/ControlClasses/OcaAudioProcessingManager.d.ts +3 -2
  82. package/src/controller/ControlClasses/OcaAudioProcessingManager.js +3 -2
  83. package/src/controller/ControlClasses/OcaBitstringActuator.d.ts +11 -8
  84. package/src/controller/ControlClasses/OcaBitstringActuator.js +13 -9
  85. package/src/controller/ControlClasses/OcaBitstringSensor.d.ts +7 -5
  86. package/src/controller/ControlClasses/OcaBitstringSensor.js +9 -6
  87. package/src/controller/ControlClasses/OcaBlock.d.ts +88 -74
  88. package/src/controller/ControlClasses/OcaBlock.js +80 -63
  89. package/src/controller/ControlClasses/OcaBlockFactory.d.ts +73 -29
  90. package/src/controller/ControlClasses/OcaBlockFactory.js +69 -42
  91. package/src/controller/ControlClasses/OcaBooleanActuator.d.ts +5 -4
  92. package/src/controller/ControlClasses/OcaBooleanActuator.js +6 -4
  93. package/src/controller/ControlClasses/OcaBooleanSensor.d.ts +3 -3
  94. package/src/controller/ControlClasses/OcaBooleanSensor.js +4 -3
  95. package/src/controller/ControlClasses/OcaCodingManager.d.ts +10 -7
  96. package/src/controller/ControlClasses/OcaCodingManager.js +17 -13
  97. package/src/controller/ControlClasses/OcaControlNetwork.d.ts +4 -5
  98. package/src/controller/ControlClasses/OcaControlNetwork.js +5 -6
  99. package/src/controller/ControlClasses/OcaCurrentSensor.d.ts +4 -4
  100. package/src/controller/ControlClasses/OcaCurrentSensor.js +4 -3
  101. package/src/controller/ControlClasses/OcaDelay.d.ts +6 -5
  102. package/src/controller/ControlClasses/OcaDelay.js +6 -4
  103. package/src/controller/ControlClasses/OcaDelayExtended.d.ts +18 -15
  104. package/src/controller/ControlClasses/OcaDelayExtended.js +17 -12
  105. package/src/controller/ControlClasses/OcaDeviceManager.d.ts +56 -31
  106. package/src/controller/ControlClasses/OcaDeviceManager.js +75 -51
  107. package/src/controller/ControlClasses/OcaDeviceTimeManager.d.ts +33 -16
  108. package/src/controller/ControlClasses/OcaDeviceTimeManager.js +36 -18
  109. package/src/controller/ControlClasses/OcaDiagnosticManager.d.ts +6 -3
  110. package/src/controller/ControlClasses/OcaDiagnosticManager.js +8 -5
  111. package/src/controller/ControlClasses/OcaDynamics.d.ts +89 -61
  112. package/src/controller/ControlClasses/OcaDynamics.js +101 -79
  113. package/src/controller/ControlClasses/OcaDynamicsCurve.d.ts +77 -30
  114. package/src/controller/ControlClasses/OcaDynamicsCurve.js +85 -37
  115. package/src/controller/ControlClasses/OcaDynamicsDetector.d.ts +30 -22
  116. package/src/controller/ControlClasses/OcaDynamicsDetector.js +36 -24
  117. package/src/controller/ControlClasses/OcaEventHandler.d.ts +8 -6
  118. package/src/controller/ControlClasses/OcaEventHandler.js +9 -6
  119. package/src/controller/ControlClasses/OcaFilterArbitraryCurve.d.ts +13 -9
  120. package/src/controller/ControlClasses/OcaFilterArbitraryCurve.js +15 -12
  121. package/src/controller/ControlClasses/OcaFilterClassical.d.ts +43 -30
  122. package/src/controller/ControlClasses/OcaFilterClassical.js +40 -31
  123. package/src/controller/ControlClasses/OcaFilterFIR.d.ts +12 -8
  124. package/src/controller/ControlClasses/OcaFilterFIR.js +19 -14
  125. package/src/controller/ControlClasses/OcaFilterParametric.d.ts +34 -25
  126. package/src/controller/ControlClasses/OcaFilterParametric.js +39 -33
  127. package/src/controller/ControlClasses/OcaFilterPolynomial.d.ts +6 -6
  128. package/src/controller/ControlClasses/OcaFilterPolynomial.js +11 -10
  129. package/src/controller/ControlClasses/OcaFirmwareManager.d.ts +71 -21
  130. package/src/controller/ControlClasses/OcaFirmwareManager.js +71 -22
  131. package/src/controller/ControlClasses/OcaFloat32Actuator.d.ts +6 -5
  132. package/src/controller/ControlClasses/OcaFloat32Actuator.js +6 -4
  133. package/src/controller/ControlClasses/OcaFloat32Sensor.d.ts +4 -4
  134. package/src/controller/ControlClasses/OcaFloat32Sensor.js +4 -3
  135. package/src/controller/ControlClasses/OcaFloat64Actuator.d.ts +6 -5
  136. package/src/controller/ControlClasses/OcaFloat64Actuator.js +6 -4
  137. package/src/controller/ControlClasses/OcaFloat64Sensor.d.ts +4 -4
  138. package/src/controller/ControlClasses/OcaFloat64Sensor.js +4 -3
  139. package/src/controller/ControlClasses/OcaFrequencyActuator.d.ts +6 -5
  140. package/src/controller/ControlClasses/OcaFrequencyActuator.js +6 -4
  141. package/src/controller/ControlClasses/OcaFrequencySensor.d.ts +4 -4
  142. package/src/controller/ControlClasses/OcaFrequencySensor.js +4 -3
  143. package/src/controller/ControlClasses/OcaGain.d.ts +6 -5
  144. package/src/controller/ControlClasses/OcaGain.js +6 -4
  145. package/src/controller/ControlClasses/OcaGainSensor.d.ts +6 -5
  146. package/src/controller/ControlClasses/OcaGainSensor.js +6 -4
  147. package/src/controller/ControlClasses/OcaGrouper.d.ts +138 -58
  148. package/src/controller/ControlClasses/OcaGrouper.js +139 -61
  149. package/src/controller/ControlClasses/OcaIdentificationActuator.d.ts +9 -10
  150. package/src/controller/ControlClasses/OcaIdentificationActuator.js +10 -10
  151. package/src/controller/ControlClasses/OcaIdentificationSensor.d.ts +6 -4
  152. package/src/controller/ControlClasses/OcaIdentificationSensor.js +5 -3
  153. package/src/controller/ControlClasses/OcaImpedanceSensor.d.ts +8 -8
  154. package/src/controller/ControlClasses/OcaImpedanceSensor.js +7 -6
  155. package/src/controller/ControlClasses/OcaInt16Actuator.d.ts +6 -5
  156. package/src/controller/ControlClasses/OcaInt16Actuator.js +6 -4
  157. package/src/controller/ControlClasses/OcaInt16Sensor.d.ts +4 -4
  158. package/src/controller/ControlClasses/OcaInt16Sensor.js +4 -3
  159. package/src/controller/ControlClasses/OcaInt32Actuator.d.ts +6 -5
  160. package/src/controller/ControlClasses/OcaInt32Actuator.js +6 -4
  161. package/src/controller/ControlClasses/OcaInt32Sensor.d.ts +4 -4
  162. package/src/controller/ControlClasses/OcaInt32Sensor.js +4 -3
  163. package/src/controller/ControlClasses/OcaInt64Actuator.d.ts +6 -5
  164. package/src/controller/ControlClasses/OcaInt64Actuator.js +6 -4
  165. package/src/controller/ControlClasses/OcaInt64Sensor.d.ts +4 -4
  166. package/src/controller/ControlClasses/OcaInt64Sensor.js +4 -3
  167. package/src/controller/ControlClasses/OcaInt8Actuator.d.ts +6 -5
  168. package/src/controller/ControlClasses/OcaInt8Actuator.js +6 -4
  169. package/src/controller/ControlClasses/OcaInt8Sensor.d.ts +4 -4
  170. package/src/controller/ControlClasses/OcaInt8Sensor.js +4 -3
  171. package/src/controller/ControlClasses/OcaLevelSensor.d.ts +4 -4
  172. package/src/controller/ControlClasses/OcaLevelSensor.js +4 -3
  173. package/src/controller/ControlClasses/OcaLibrary.d.ts +50 -25
  174. package/src/controller/ControlClasses/OcaLibrary.js +54 -26
  175. package/src/controller/ControlClasses/OcaLibraryManager.d.ts +22 -16
  176. package/src/controller/ControlClasses/OcaLibraryManager.js +22 -17
  177. package/src/controller/ControlClasses/OcaManager.d.ts +4 -1
  178. package/src/controller/ControlClasses/OcaManager.js +4 -1
  179. package/src/controller/ControlClasses/OcaMatrix.d.ts +69 -20
  180. package/src/controller/ControlClasses/OcaMatrix.js +86 -38
  181. package/src/controller/ControlClasses/OcaMediaClock.d.ts +33 -19
  182. package/src/controller/ControlClasses/OcaMediaClock.js +30 -19
  183. package/src/controller/ControlClasses/OcaMediaClock3.d.ts +37 -22
  184. package/src/controller/ControlClasses/OcaMediaClock3.js +39 -27
  185. package/src/controller/ControlClasses/OcaMediaClockManager.d.ts +15 -9
  186. package/src/controller/ControlClasses/OcaMediaClockManager.js +28 -23
  187. package/src/controller/ControlClasses/OcaMediaTransportNetwork.d.ts +106 -74
  188. package/src/controller/ControlClasses/OcaMediaTransportNetwork.js +121 -111
  189. package/src/controller/ControlClasses/OcaMute.d.ts +7 -7
  190. package/src/controller/ControlClasses/OcaMute.js +7 -5
  191. package/src/controller/ControlClasses/OcaNetwork.d.ts +38 -20
  192. package/src/controller/ControlClasses/OcaNetwork.js +58 -42
  193. package/src/controller/ControlClasses/OcaNetworkManager.d.ts +20 -9
  194. package/src/controller/ControlClasses/OcaNetworkManager.js +33 -23
  195. package/src/controller/ControlClasses/OcaNetworkSignalChannel.d.ts +43 -19
  196. package/src/controller/ControlClasses/OcaNetworkSignalChannel.js +67 -44
  197. package/src/controller/ControlClasses/OcaNumericObserver.d.ts +77 -38
  198. package/src/controller/ControlClasses/OcaNumericObserver.js +95 -59
  199. package/src/controller/ControlClasses/OcaNumericObserverList.d.ts +96 -45
  200. package/src/controller/ControlClasses/OcaNumericObserverList.js +129 -80
  201. package/src/controller/ControlClasses/OcaPanBalance.d.ts +10 -7
  202. package/src/controller/ControlClasses/OcaPanBalance.js +14 -11
  203. package/src/controller/ControlClasses/OcaPhysicalPosition.d.ts +31 -18
  204. package/src/controller/ControlClasses/OcaPhysicalPosition.js +43 -18
  205. package/src/controller/ControlClasses/OcaPolarity.d.ts +10 -7
  206. package/src/controller/ControlClasses/OcaPolarity.js +7 -5
  207. package/src/controller/ControlClasses/OcaPowerManager.d.ts +20 -14
  208. package/src/controller/ControlClasses/OcaPowerManager.js +27 -21
  209. package/src/controller/ControlClasses/OcaPowerSupply.d.ts +24 -15
  210. package/src/controller/ControlClasses/OcaPowerSupply.js +31 -23
  211. package/src/controller/ControlClasses/OcaRamper.d.ts +55 -34
  212. package/src/controller/ControlClasses/OcaRamper.js +58 -37
  213. package/src/controller/ControlClasses/OcaRoot.d.ts +28 -14
  214. package/src/controller/ControlClasses/OcaRoot.js +32 -24
  215. package/src/controller/ControlClasses/OcaSecurityManager.d.ts +29 -13
  216. package/src/controller/ControlClasses/OcaSecurityManager.js +31 -14
  217. package/src/controller/ControlClasses/OcaSensor.d.ts +4 -4
  218. package/src/controller/ControlClasses/OcaSensor.js +6 -5
  219. package/src/controller/ControlClasses/OcaSignalGenerator.d.ts +48 -38
  220. package/src/controller/ControlClasses/OcaSignalGenerator.js +57 -46
  221. package/src/controller/ControlClasses/OcaSignalInput.d.ts +4 -1
  222. package/src/controller/ControlClasses/OcaSignalInput.js +4 -1
  223. package/src/controller/ControlClasses/OcaSignalOutput.d.ts +4 -1
  224. package/src/controller/ControlClasses/OcaSignalOutput.js +4 -1
  225. package/src/controller/ControlClasses/OcaStreamConnector.d.ts +59 -24
  226. package/src/controller/ControlClasses/OcaStreamConnector.js +80 -48
  227. package/src/controller/ControlClasses/OcaStreamNetwork.d.ts +100 -27
  228. package/src/controller/ControlClasses/OcaStreamNetwork.js +124 -54
  229. package/src/controller/ControlClasses/OcaStringActuator.d.ts +5 -4
  230. package/src/controller/ControlClasses/OcaStringActuator.js +7 -5
  231. package/src/controller/ControlClasses/OcaStringSensor.d.ts +7 -5
  232. package/src/controller/ControlClasses/OcaStringSensor.js +10 -7
  233. package/src/controller/ControlClasses/OcaSubscriptionManager.d.ts +73 -46
  234. package/src/controller/ControlClasses/OcaSubscriptionManager.js +78 -51
  235. package/src/controller/ControlClasses/OcaSummingPoint.d.ts +2 -1
  236. package/src/controller/ControlClasses/OcaSummingPoint.js +2 -1
  237. package/src/controller/ControlClasses/OcaSwitch.d.ts +23 -15
  238. package/src/controller/ControlClasses/OcaSwitch.js +31 -23
  239. package/src/controller/ControlClasses/OcaTaskManager.d.ts +47 -38
  240. package/src/controller/ControlClasses/OcaTaskManager.js +48 -37
  241. package/src/controller/ControlClasses/OcaTemperatureActuator.d.ts +6 -5
  242. package/src/controller/ControlClasses/OcaTemperatureActuator.js +6 -4
  243. package/src/controller/ControlClasses/OcaTemperatureSensor.d.ts +4 -4
  244. package/src/controller/ControlClasses/OcaTemperatureSensor.js +4 -3
  245. package/src/controller/ControlClasses/OcaTimeIntervalSensor.d.ts +4 -4
  246. package/src/controller/ControlClasses/OcaTimeIntervalSensor.js +4 -3
  247. package/src/controller/ControlClasses/OcaTimeSource.d.ts +38 -22
  248. package/src/controller/ControlClasses/OcaTimeSource.js +41 -27
  249. package/src/controller/ControlClasses/OcaUint16Actuator.d.ts +6 -5
  250. package/src/controller/ControlClasses/OcaUint16Actuator.js +6 -4
  251. package/src/controller/ControlClasses/OcaUint16Sensor.d.ts +4 -4
  252. package/src/controller/ControlClasses/OcaUint16Sensor.js +4 -3
  253. package/src/controller/ControlClasses/OcaUint32Actuator.d.ts +6 -5
  254. package/src/controller/ControlClasses/OcaUint32Actuator.js +6 -4
  255. package/src/controller/ControlClasses/OcaUint32Sensor.d.ts +4 -4
  256. package/src/controller/ControlClasses/OcaUint32Sensor.js +4 -3
  257. package/src/controller/ControlClasses/OcaUint64Actuator.d.ts +6 -5
  258. package/src/controller/ControlClasses/OcaUint64Actuator.js +6 -4
  259. package/src/controller/ControlClasses/OcaUint64Sensor.d.ts +4 -4
  260. package/src/controller/ControlClasses/OcaUint64Sensor.js +4 -3
  261. package/src/controller/ControlClasses/OcaUint8Actuator.d.ts +6 -5
  262. package/src/controller/ControlClasses/OcaUint8Actuator.js +6 -4
  263. package/src/controller/ControlClasses/OcaUint8Sensor.d.ts +4 -4
  264. package/src/controller/ControlClasses/OcaUint8Sensor.js +4 -3
  265. package/src/controller/ControlClasses/OcaVoltageSensor.d.ts +4 -4
  266. package/src/controller/ControlClasses/OcaVoltageSensor.js +4 -3
  267. package/src/controller/ControlClasses/OcaWorker.d.ts +38 -28
  268. package/src/controller/ControlClasses/OcaWorker.js +50 -40
  269. package/src/controller/abstract_udp_connection.js +12 -8
  270. package/src/controller/client_connection.d.ts +1 -1
  271. package/src/controller/node_udp.js +3 -4
  272. package/src/controller/property_event.js +1 -1
  273. package/src/controller/websocket_connection.d.ts +17 -0
  274. package/src/controller/websocket_connection.js +4 -46
  275. package/src/controller/websocket_connection_base.d.ts +18 -0
  276. package/src/controller/websocket_connection_base.js +70 -0
  277. package/src/controller/websocket_connection_node.d.ts +18 -0
  278. package/src/controller/websocket_connection_node.js +5 -49
  279. package/src/types/OcaBlockMember.d.ts +1 -2
  280. package/src/types/OcaClassAuthorityID.d.ts +14 -3
  281. package/src/types/OcaClassAuthorityID.js +8 -2
  282. package/src/types/OcaClassIdentification.d.ts +4 -3
  283. package/src/types/OcaClassIdentification.js +2 -2
  284. package/src/types/OcaComponent.d.ts +3 -1
  285. package/src/types/OcaComponent.js +3 -1
  286. package/src/types/OcaDBr.d.ts +6 -4
  287. package/src/types/OcaDBr.js +3 -2
  288. package/src/types/OcaDelayValue.d.ts +1 -2
  289. package/src/types/OcaDeviceState.d.ts +4 -6
  290. package/src/types/OcaDeviceState.js +4 -9
  291. package/src/types/OcaDynamicsFunction.d.ts +2 -1
  292. package/src/types/OcaDynamicsFunction.js +2 -1
  293. package/src/types/OcaEvent.d.ts +3 -3
  294. package/src/types/OcaEvent.js +2 -1
  295. package/src/types/OcaEventID.d.ts +3 -1
  296. package/src/types/OcaEventID.js +3 -1
  297. package/src/types/OcaGlobalTypeIdentifier.d.ts +10 -4
  298. package/src/types/OcaGlobalTypeIdentifier.js +5 -2
  299. package/src/types/OcaGrouperCitizen.d.ts +7 -5
  300. package/src/types/OcaGrouperCitizen.js +4 -2
  301. package/src/types/OcaGrouperEnrollment.d.ts +8 -4
  302. package/src/types/OcaGrouperEnrollment.js +4 -2
  303. package/src/types/OcaGrouperGroup.d.ts +4 -2
  304. package/src/types/OcaGrouperGroup.js +2 -1
  305. package/src/types/OcaGrouperMode.d.ts +1 -1
  306. package/src/types/OcaGrouperMode.js +1 -1
  307. package/src/types/OcaGrouperStatusChangeEventData.d.ts +7 -19
  308. package/src/types/OcaGrouperStatusChangeEventData.js +5 -8
  309. package/src/types/OcaGrouperStatusChangeType.d.ts +2 -1
  310. package/src/types/OcaGrouperStatusChangeType.js +2 -1
  311. package/src/types/OcaLevelDetectionLaw.d.ts +2 -1
  312. package/src/types/OcaLevelDetectionLaw.js +2 -1
  313. package/src/types/OcaLibParamSetAssignment.d.ts +3 -3
  314. package/src/types/OcaLibParamSetAssignment.js +2 -1
  315. package/src/types/OcaLibVol.d.ts +3 -3
  316. package/src/types/OcaLibVol.js +3 -2
  317. package/src/types/OcaLibVolChangedEventData.d.ts +4 -21
  318. package/src/types/OcaLibVolChangedEventData.js +3 -7
  319. package/src/types/OcaLibVolData_ParamSet.d.ts +13 -3
  320. package/src/types/OcaLibVolData_ParamSet.js +11 -3
  321. package/src/types/OcaLibVolMetadata.d.ts +4 -5
  322. package/src/types/OcaLibVolMetadata.js +1 -1
  323. package/src/types/OcaLibVolType.d.ts +12 -4
  324. package/src/types/OcaLibVolType.js +6 -2
  325. package/src/types/OcaLibraryIdentifier.d.ts +3 -3
  326. package/src/types/OcaLibraryIdentifier.js +2 -1
  327. package/src/types/OcaManagerDefaultObjectNumbers.d.ts +58 -116
  328. package/src/types/OcaManagerDefaultObjectNumbers.js +2 -2
  329. package/src/types/OcaManagerDescriptor.d.ts +4 -0
  330. package/src/types/OcaManagerDescriptor.js +2 -0
  331. package/src/types/OcaMediaClockRate.d.ts +12 -6
  332. package/src/types/OcaMediaClockRate.js +6 -3
  333. package/src/types/OcaMediaCoding.d.ts +4 -2
  334. package/src/types/OcaMediaCoding.js +2 -1
  335. package/src/types/OcaMediaConnection.d.ts +21 -8
  336. package/src/types/OcaMediaConnection.js +18 -5
  337. package/src/types/OcaMediaConnectorStatus.d.ts +5 -4
  338. package/src/types/OcaMediaConnectorStatus.js +2 -1
  339. package/src/types/OcaMediaConnectorStatusChangedEventData.d.ts +2 -17
  340. package/src/types/OcaMediaConnectorStatusChangedEventData.js +1 -7
  341. package/src/types/OcaMediaSinkConnector.d.ts +43 -15
  342. package/src/types/OcaMediaSinkConnector.js +23 -7
  343. package/src/types/OcaMediaSinkConnectorChangedEventData.d.ts +20 -30
  344. package/src/types/OcaMediaSinkConnectorChangedEventData.js +8 -11
  345. package/src/types/OcaMediaSourceConnector.d.ts +33 -13
  346. package/src/types/OcaMediaSourceConnector.js +17 -7
  347. package/src/types/OcaMediaSourceConnectorChangedEventData.d.ts +20 -30
  348. package/src/types/OcaMediaSourceConnectorChangedEventData.js +8 -11
  349. package/src/types/OcaMethod.d.ts +8 -5
  350. package/src/types/OcaMethod.js +5 -2
  351. package/src/types/OcaMethodID.d.ts +3 -1
  352. package/src/types/OcaMethodID.js +3 -1
  353. package/src/types/OcaModelGUID.d.ts +4 -2
  354. package/src/types/OcaModelGUID.js +5 -4
  355. package/src/types/OcaNetworkMediaSourceOrSink.d.ts +2 -1
  356. package/src/types/OcaNetworkMediaSourceOrSink.js +2 -1
  357. package/src/types/OcaNetworkSystemInterfaceDescriptor.d.ts +2 -1
  358. package/src/types/OcaNetworkSystemInterfaceDescriptor.js +3 -2
  359. package/src/types/OcaNetworkSystemInterfaceID.d.ts +2 -1
  360. package/src/types/OcaNetworkSystemInterfaceID.js +3 -2
  361. package/src/types/OcaNotificationDeliveryMode.d.ts +2 -1
  362. package/src/types/OcaNotificationDeliveryMode.js +2 -1
  363. package/src/types/OcaOPath.d.ts +2 -1
  364. package/src/types/OcaOPath.js +2 -1
  365. package/src/types/OcaObjectIdentification.d.ts +3 -3
  366. package/src/types/OcaObjectIdentification.js +2 -1
  367. package/src/types/OcaObjectListEventData.d.ts +3 -16
  368. package/src/types/OcaObjectListEventData.js +4 -8
  369. package/src/types/OcaObjectSearchResult.d.ts +5 -3
  370. package/src/types/OcaObjectSearchResult.js +4 -1
  371. package/src/types/OcaObjectSearchResultFlags.d.ts +1 -6
  372. package/src/types/OcaObjectSearchResultFlags.js +1 -9
  373. package/src/types/OcaObservationEventData.d.ts +8 -16
  374. package/src/types/OcaObservationEventData.js +8 -7
  375. package/src/types/OcaObservationListEventData.d.ts +8 -16
  376. package/src/types/OcaObservationListEventData.js +9 -8
  377. package/src/types/OcaParameterMask.d.ts +13 -0
  378. package/src/types/OcaParameterMask.js +11 -0
  379. package/src/types/OcaPilotToneDetectorSpec.d.ts +1 -2
  380. package/src/types/OcaPort.d.ts +3 -3
  381. package/src/types/OcaPort.js +2 -1
  382. package/src/types/OcaPortID.d.ts +4 -3
  383. package/src/types/OcaPortID.js +3 -1
  384. package/src/types/OcaPositionCoordinateSystem.d.ts +2 -1
  385. package/src/types/OcaPositionCoordinateSystem.js +2 -1
  386. package/src/types/OcaPositionDescriptor.d.ts +26 -25
  387. package/src/types/OcaPositionDescriptor.js +13 -15
  388. package/src/types/OcaPositionDescriptorFieldFlags.d.ts +13 -0
  389. package/src/types/OcaPositionDescriptorFieldFlags.js +11 -0
  390. package/src/types/OcaPowerState.d.ts +2 -1
  391. package/src/types/OcaPowerState.js +2 -1
  392. package/src/types/OcaPresentationUnit.d.ts +8 -1
  393. package/src/types/OcaPresentationUnit.js +8 -1
  394. package/src/types/OcaProperty.d.ts +3 -3
  395. package/src/types/OcaProperty.js +2 -1
  396. package/src/types/OcaPropertyDescriptor.d.ts +9 -9
  397. package/src/types/OcaPropertyDescriptor.js +4 -3
  398. package/src/types/OcaPropertyID.d.ts +3 -1
  399. package/src/types/OcaPropertyID.js +3 -1
  400. package/src/types/OcaProtoObjectIdentification.d.ts +3 -3
  401. package/src/types/OcaProtoObjectIdentification.js +2 -1
  402. package/src/types/OcaProtoPort.d.ts +9 -5
  403. package/src/types/OcaProtoPort.js +5 -2
  404. package/src/types/OcaProtoPortID.d.ts +4 -3
  405. package/src/types/OcaProtoPortID.js +3 -1
  406. package/src/types/OcaProtoSignalPath.d.ts +1 -2
  407. package/src/types/OcaRamperCommand.d.ts +1 -1
  408. package/src/types/OcaRamperCommand.js +1 -1
  409. package/src/types/OcaRamperState.d.ts +15 -10
  410. package/src/types/OcaRamperState.js +15 -10
  411. package/src/types/OcaSensorReadingState.d.ts +2 -1
  412. package/src/types/OcaSensorReadingState.js +2 -1
  413. package/src/types/OcaSignalPath.d.ts +1 -2
  414. package/src/types/OcaStream.d.ts +23 -10
  415. package/src/types/OcaStream.js +17 -5
  416. package/src/types/OcaStreamConnectorIdentification.d.ts +17 -7
  417. package/src/types/OcaStreamConnectorIdentification.js +15 -6
  418. package/src/types/OcaSubscriptionManagerState.d.ts +1 -1
  419. package/src/types/OcaSubscriptionManagerState.js +1 -1
  420. package/src/types/OcaTask.d.ts +27 -13
  421. package/src/types/OcaTask.js +14 -6
  422. package/src/types/OcaTaskManagerState.d.ts +13 -9
  423. package/src/types/OcaTaskManagerState.js +13 -9
  424. package/src/types/OcaTaskState.d.ts +3 -1
  425. package/src/types/OcaTaskState.js +3 -1
  426. package/src/types/OcaTaskStateChangedEventData.d.ts +6 -6
  427. package/src/types/OcaTaskStateChangedEventData.js +2 -2
  428. package/src/types/OcaTaskStatus.d.ts +6 -5
  429. package/src/types/OcaTaskStatus.js +5 -3
  430. package/src/types/OcaTimeMode.d.ts +1 -1
  431. package/src/types/OcaTimeMode.js +1 -1
  432. package/src/types/OcaTimePTP.d.ts +8 -3
  433. package/src/types/OcaTimePTP.js +6 -2
  434. package/src/types/OcaTransferFunction.js +3 -3
  435. package/src/types/OcaUnitOfMeasure.d.ts +5 -1
  436. package/src/types/OcaUnitOfMeasure.js +5 -1
  437. package/src/types/OcaVersion.d.ts +7 -5
  438. package/src/types/OcaVersion.js +4 -2
@@ -1,21 +1,27 @@
1
- import { RemoteDevice } from '../remote_device';
2
- import { OcaWorker } from './OcaWorker';
3
-
4
- import { PropertyEvent } from '../property_event';
5
- import { IOcaLibVolIdentifier } from '../../types/OcaLibVolIdentifier';
6
- import { IOcaObjectSearchResultFlags } from '../../types/OcaObjectSearchResultFlags';
7
- import { IOcaSignalPath } from '../../types/OcaSignalPath';
8
- import { IOcaStringComparisonType } from '../../types/OcaStringComparisonType';
9
1
  import { OcaBlockMember } from '../../types/OcaBlockMember';
10
2
  import { OcaGlobalTypeIdentifier } from '../../types/OcaGlobalTypeIdentifier';
11
3
  import { OcaLibVolData_ParamSet } from '../../types/OcaLibVolData_ParamSet';
12
- import { OcaLibVolIdentifier } from '../../types/OcaLibVolIdentifier';
4
+ import {
5
+ IOcaLibVolIdentifier,
6
+ OcaLibVolIdentifier,
7
+ } from '../../types/OcaLibVolIdentifier';
13
8
  import { OcaObjectIdentification } from '../../types/OcaObjectIdentification';
14
9
  import { OcaObjectSearchResult } from '../../types/OcaObjectSearchResult';
15
- import { OcaSignalPath } from '../../types/OcaSignalPath';
10
+ import { IOcaObjectSearchResultFlags } from '../../types/OcaObjectSearchResultFlags';
11
+ import { IOcaSignalPath, OcaSignalPath } from '../../types/OcaSignalPath';
12
+ import { IOcaStringComparisonType } from '../../types/OcaStringComparisonType';
13
+ import { PropertyEvent } from '../property_event';
14
+ import { RemoteDevice } from '../remote_device';
15
+ import { OcaWorker } from './OcaWorker';
16
16
 
17
17
  /**
18
- * A block is an object with three aspects: - It can contain other blocks. - It can contain workers. - It can contain agents. - It can contain data networks. - It can contain application networks. - It has a signal flow topology. We refer to an object inside a block as a **member** of that block. We refer to the block which contains an object as the object's **container.** **1** Normally, a block contains a set of members that together function as a processing unit -- for example, a crossover channel or mixer strip.
18
+ * A block is an object with three aspects: - It can contain other blocks. - It
19
+ * can contain workers. - It can contain agents. - It can contain data networks.
20
+ * - It can contain application networks. - It has a signal flow topology. We
21
+ * refer to an object inside a block as a **member** of that block. We refer to
22
+ * the block which contains an object as the object's **container.1** Normally,
23
+ * a block contains a set of members that together function as a processing unit
24
+ * -- for example, a crossover channel or mixer strip.
19
25
  * @extends OcaWorker
20
26
  * @class OcaBlock
21
27
  */
@@ -38,7 +44,11 @@ export declare class OcaBlock extends OcaWorker {
38
44
  constructor(objectNumber: number, device: RemoteDevice);
39
45
 
40
46
  /**
41
- * Gets the block type. For statically-defined blocks, the block type is a Uint32 with a value corresponding to the unique configuration of this block. For dynamically-defined blocks, the block type is the object number of the block's factory. For the root block, the value of this property is 1.
47
+ * Gets the block type. For statically-defined blocks, the block type is a
48
+ * Uint32 with a value corresponding to the unique configuration of this
49
+ * block. For dynamically-defined blocks, the block type is the object number
50
+ * of the block's factory. For the root block, the value of this property is
51
+ * 1.
42
52
  *
43
53
  * @method OcaBlock#GetType
44
54
  * @returns {Promise<number>}
@@ -47,23 +57,9 @@ export declare class OcaBlock extends OcaWorker {
47
57
  GetType(): Promise<number>;
48
58
 
49
59
  /**
50
- * Constructs an object according to the given construction specification and adds it to the block. The return value indicates whether the member was successfully created and added.
51
- *
52
- * @method OcaBlock#ConstructMember
53
- * @param {string} ClassID
54
- *
55
- * @param {any} ConstructionParameters
56
- *
57
- * @returns {Promise<number>}
58
- * A promise which resolves to a single value of type ``number``.
59
- */
60
- ConstructMember(
61
- ClassID: string,
62
- ConstructionParameters: any
63
- ): Promise<number>;
64
-
65
- /**
66
- * Invokes a factory to construct an instance of the given class, then adds it to the block. The return value indicates whether the member was successfully created and added.
60
+ * Invokes a factory to construct an instance of the given class, then adds it
61
+ * to the block. The return value indicates whether the member was
62
+ * successfully created and added.
67
63
  *
68
64
  * @method OcaBlock#ConstructMemberUsingFactory
69
65
  * @param {number} FactoryONo
@@ -74,7 +70,9 @@ export declare class OcaBlock extends OcaWorker {
74
70
  ConstructMemberUsingFactory(FactoryONo: number): Promise<number>;
75
71
 
76
72
  /**
77
- * Removes a member from the block and destroys the object. . Deletes all signal paths attached to its ports. The return value indicates whether the member was successfully removed and destroyed.
73
+ * Removes a member from the block and destroys the object. . Deletes all
74
+ * signal paths attached to its ports. The return value indicates whether the
75
+ * member was successfully removed and destroyed.
78
76
  *
79
77
  * @method OcaBlock#DeleteMember
80
78
  * @param {number} ObjectNumber
@@ -84,28 +82,35 @@ export declare class OcaBlock extends OcaWorker {
84
82
  DeleteMember(ObjectNumber: number): Promise<void>;
85
83
 
86
84
  /**
87
- * Gets the list of block members. Does not recurse inner blocks. Each inner block is included in the returned list as a single object -- its contents are not enumerated. The return value indicates whether the list was successfully retrieved.
85
+ * Gets the list of block members. Does not recurse inner blocks. Each inner
86
+ * block is included in the returned list as a single object -- its contents
87
+ * are not enumerated. The return value indicates whether the list was
88
+ * successfully retrieved.
88
89
  *
89
90
  * @method OcaBlock#GetMembers
90
91
  * @returns {Promise<OcaObjectIdentification[]>}
91
- * A promise which resolves to a single value of type ``OcaObjectIdentification[]``.
92
+ * A promise which resolves to a single value of type :class:`OcaObjectIdentification[]`.
92
93
  */
93
94
  GetMembers(): Promise<OcaObjectIdentification[]>;
94
95
 
95
96
  /**
96
- * Gets the list of block members. Recurses inner blocks. Each inner block is included in the returned list as a single object, amd its contents are enumerated. The return value indicates whether the list was successfully retrieved.
97
+ * Gets the list of block members. Recurses inner blocks. Each inner block is
98
+ * included in the returned list as a single object, amd its contents are
99
+ * enumerated. The return value indicates whether the list was successfully
100
+ * retrieved.
97
101
  *
98
102
  * @method OcaBlock#GetMembersRecursive
99
103
  * @returns {Promise<OcaBlockMember[]>}
100
- * A promise which resolves to a single value of type ``OcaBlockMember[]``.
104
+ * A promise which resolves to a single value of type :class:`OcaBlockMember[]`.
101
105
  */
102
106
  GetMembersRecursive(): Promise<OcaBlockMember[]>;
103
107
 
104
108
  /**
105
- * Adds a signal path to the block. The return value indicates whether the signal path was successfully added.
109
+ * Adds a signal path to the block. The return value indicates whether the
110
+ * signal path was successfully added.
106
111
  *
107
112
  * @method OcaBlock#AddSignalPath
108
- * @param {OcaSignalPath} Path
113
+ * @param {IOcaSignalPath} Path
109
114
  *
110
115
  * @returns {Promise<number>}
111
116
  * A promise which resolves to a single value of type ``number``.
@@ -113,7 +118,8 @@ export declare class OcaBlock extends OcaWorker {
113
118
  AddSignalPath(Path: IOcaSignalPath): Promise<number>;
114
119
 
115
120
  /**
116
- * Deletes a signal path from the block. The return value indicates whether the signal path was successfully added.
121
+ * Deletes a signal path from the block. The return value indicates whether
122
+ * the signal path was successfully added.
117
123
  *
118
124
  * @method OcaBlock#DeleteSignalPath
119
125
  * @param {number} Index
@@ -123,7 +129,8 @@ export declare class OcaBlock extends OcaWorker {
123
129
  DeleteSignalPath(Index: number): Promise<void>;
124
130
 
125
131
  /**
126
- * Gets the map of signal paths in the block. Does not recurse inner blocks. The return value indicates whether the list was successfully retrieved.
132
+ * Gets the map of signal paths in the block. Does not recurse inner blocks.
133
+ * The return value indicates whether the list was successfully retrieved.
127
134
  *
128
135
  * @method OcaBlock#GetSignalPaths
129
136
  * @returns {Promise<Map<number, OcaSignalPath>>}
@@ -132,7 +139,8 @@ export declare class OcaBlock extends OcaWorker {
132
139
  GetSignalPaths(): Promise<Map<number, OcaSignalPath>>;
133
140
 
134
141
  /**
135
- * Gets the mapof signal paths in the block. Recurses inner blocks. The return value indicates whether the list was successfully retrieved.
142
+ * Gets the mapof signal paths in the block. Recurses inner blocks. The return
143
+ * value indicates whether the list was successfully retrieved.
136
144
  *
137
145
  * @method OcaBlock#GetSignalPathsRecursive
138
146
  * @returns {Promise<Map<number, OcaSignalPath>>}
@@ -150,7 +158,9 @@ export declare class OcaBlock extends OcaWorker {
150
158
  GetMostRecentParamSetIdentifier(): Promise<OcaLibVolIdentifier>;
151
159
 
152
160
  /**
153
- * Applies the referenced paramset to this block, and sets the MostRecentParamSet property. The return value indicates whether the paramset was successfully applied.
161
+ * Applies the referenced paramset to this block, and sets the
162
+ * MostRecentParamSet property. The return value indicates whether the
163
+ * paramset was successfully applied.
154
164
  *
155
165
  * @method OcaBlock#ApplyParamSet
156
166
  * @returns {Promise<OcaLibVolIdentifier>}
@@ -159,7 +169,8 @@ export declare class OcaBlock extends OcaWorker {
159
169
  ApplyParamSet(): Promise<OcaLibVolIdentifier>;
160
170
 
161
171
  /**
162
- * Returns a paramset library volume data block which represents the current state of the block -- i.e. a "snapshot".
172
+ * Returns a paramset library volume data block which represents the current
173
+ * state of the block -- i.e. a "snapshot".
163
174
  *
164
175
  * @method OcaBlock#GetCurrentParamSetData
165
176
  * @returns {Promise<OcaLibVolData_ParamSet>}
@@ -168,10 +179,12 @@ export declare class OcaBlock extends OcaWorker {
168
179
  GetCurrentParamSetData(): Promise<OcaLibVolData_ParamSet>;
169
180
 
170
181
  /**
171
- * Stores a paramset library volume data block which represents the current state of the block ("snapshot") in the given library. **Replaces** the library volume at the specified LibVolIdentifier.
182
+ * Stores a paramset library volume data block which represents the current
183
+ * state of the block ("snapshot") in the given library. **Replaces** the
184
+ * library volume at the specified LibVolIdentifier.
172
185
  *
173
186
  * @method OcaBlock#StoreCurrentParamSetData
174
- * @param {OcaLibVolIdentifier} LibVolIdentifier
187
+ * @param {IOcaLibVolIdentifier} LibVolIdentifier
175
188
  *
176
189
  * @returns {Promise<void>}
177
190
  */
@@ -180,7 +193,10 @@ export declare class OcaBlock extends OcaWorker {
180
193
  ): Promise<void>;
181
194
 
182
195
  /**
183
- * Gets the global blocktype. The return value indicates whether the type was successfully retrieved. If this block has no global blocktype, the **Authority** field of the returned **GlobalType** parameter will be zero. **Added in version 2 of this class.**
196
+ * Gets the global blocktype. The return value indicates whether the type was
197
+ * successfully retrieved. If this block has no global blocktype, the
198
+ * **Authority** field of the returned **GlobalType** parameter will be zero.
199
+ * **Added in version 2 of this class.**
184
200
  *
185
201
  * @method OcaBlock#GetGlobalType
186
202
  * @returns {Promise<OcaGlobalTypeIdentifier>}
@@ -189,7 +205,8 @@ export declare class OcaBlock extends OcaWorker {
189
205
  GetGlobalType(): Promise<OcaGlobalTypeIdentifier>;
190
206
 
191
207
  /**
192
- * Gets the block's ONo map. The return value indicates whether the map was successfully retrieved. **Added in version 2 of this class.**
208
+ * Gets the block's ONo map. The return value indicates whether the map was
209
+ * successfully retrieved. **Added in version 2 of this class.**
193
210
  *
194
211
  * @method OcaBlock#GetONoMap
195
212
  * @returns {Promise<Map<number, number>>}
@@ -198,84 +215,81 @@ export declare class OcaBlock extends OcaWorker {
198
215
  GetONoMap(): Promise<Map<number, number>>;
199
216
 
200
217
  /**
201
- * Returns object identifications of all objects in the block that match the given Role search string and Class ID. Return value indicates whether the method succeeded. **Added in version 2 of this class.**
218
+ * Returns object identifications of all objects in the block that match the
219
+ * given Role search string and Class ID. Return value indicates whether the
220
+ * method succeeded. **Added in version 2 of this class.**
202
221
  *
203
222
  * @method OcaBlock#FindObjectsByRole
204
223
  * @param {string} SearchName
205
- *
206
- * @param {OcaStringComparisonType} NameComparisonType
207
- *
224
+ * @param {IOcaStringComparisonType} NameComparisonType
208
225
  * @param {string} SearchClassID
209
- *
210
- * @param {number} ResultFlags
226
+ * @param {IOcaObjectSearchResultFlags} ResultFlags
211
227
  *
212
228
  * @returns {Promise<OcaObjectSearchResult[]>}
213
- * A promise which resolves to a single value of type ``OcaObjectSearchResult[]``.
229
+ * A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
214
230
  */
215
231
  FindObjectsByRole(
216
232
  SearchName: string,
217
233
  NameComparisonType: IOcaStringComparisonType,
218
234
  SearchClassID: string,
219
- ResultFlags: number
235
+ ResultFlags: IOcaObjectSearchResultFlags
220
236
  ): Promise<OcaObjectSearchResult[]>;
221
237
 
222
238
  /**
223
- * Returns block member descriptors of all objects in the block and all contained blocks that match the given Role search string and Class ID. **Added in version 2 of this class.**
239
+ * Returns block member descriptors of all objects in the block and all
240
+ * contained blocks that match the given Role search string and Class ID.
241
+ * **Added in version 2 of this class.**
224
242
  *
225
243
  * @method OcaBlock#FindObjectsByRoleRecursive
226
244
  * @param {string} SearchName
227
- *
228
- * @param {OcaStringComparisonType} NameComparisonType
229
- *
245
+ * @param {IOcaStringComparisonType} NameComparisonType
230
246
  * @param {string} SearchClassID
231
- *
232
- * @param {number} ResultFlags
247
+ * @param {IOcaObjectSearchResultFlags} ResultFlags
233
248
  *
234
249
  * @returns {Promise<OcaObjectSearchResult[]>}
235
- * A promise which resolves to a single value of type ``OcaObjectSearchResult[]``.
250
+ * A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
236
251
  */
237
252
  FindObjectsByRoleRecursive(
238
253
  SearchName: string,
239
254
  NameComparisonType: IOcaStringComparisonType,
240
255
  SearchClassID: string,
241
- ResultFlags: number
256
+ ResultFlags: IOcaObjectSearchResultFlags
242
257
  ): Promise<OcaObjectSearchResult[]>;
243
258
 
244
259
  /**
245
- * Returns object identifications of all objects with the given name path. **Added in version 2 of this class.**
260
+ * Returns object identifications of all objects with the given name path.
261
+ * **Added in version 2 of this class.**
246
262
  *
247
263
  * @method OcaBlock#FindObjectsByPath
248
264
  * @param {string[]} SearchPath
249
- *
250
- * @param {number} ResultFlags
265
+ * @param {IOcaObjectSearchResultFlags} ResultFlags
251
266
  *
252
267
  * @returns {Promise<OcaObjectSearchResult[]>}
253
- * A promise which resolves to a single value of type ``OcaObjectSearchResult[]``.
268
+ * A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
254
269
  */
255
270
  FindObjectsByPath(
256
271
  SearchPath: string[],
257
- ResultFlags: number
272
+ ResultFlags: IOcaObjectSearchResultFlags
258
273
  ): Promise<OcaObjectSearchResult[]>;
259
274
 
260
275
  /**
261
- * Returns block member descriptors of all objects in the block and all contained blocks that match the given Label search string and Class ID. **Added in version 2 of this class.**
276
+ * Returns block member descriptors of all objects in the block and all
277
+ * contained blocks that match the given Label search string and Class ID.
278
+ * **Added in version 2 of this class.**
262
279
  *
263
280
  * @method OcaBlock#FindObjectsByLabelRecursive
264
281
  * @param {string} SearchName
265
- *
266
- * @param {OcaStringComparisonType} NameComparisonType
267
- *
282
+ * @param {IOcaStringComparisonType} NameComparisonType
268
283
  * @param {string} SearchClassID
269
- *
270
- * @param {number} ResultFlags
284
+ * @param {IOcaObjectSearchResultFlags} ResultFlags
271
285
  *
272
286
  * @returns {Promise<OcaObjectSearchResult[]>}
273
- * A promise which resolves to a single value of type ``OcaObjectSearchResult[]``.
287
+ * A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
274
288
  */
275
289
  FindObjectsByLabelRecursive(
276
290
  SearchName: string,
277
291
  NameComparisonType: IOcaStringComparisonType,
278
292
  SearchClassID: string,
279
- ResultFlags: number
293
+ ResultFlags: IOcaObjectSearchResultFlags
280
294
  ): Promise<OcaObjectSearchResult[]>;
281
295
  }
@@ -1,5 +1,3 @@
1
- import { make_control_class } from '../make_control_class.js';
2
- import { OcaWorker } from './OcaWorker.js';
3
1
  import { OcaBlockMember } from '../../OCP1/OcaBlockMember.js';
4
2
  import { OcaGlobalTypeIdentifier } from '../../OCP1/OcaGlobalTypeIdentifier.js';
5
3
  import { OcaLibVolData_ParamSet } from '../../OCP1/OcaLibVolData_ParamSet.js';
@@ -15,9 +13,17 @@ import { OcaStringComparisonType } from '../../OCP1/OcaStringComparisonType.js';
15
13
  import { OcaUint16 } from '../../OCP1/OcaUint16.js';
16
14
  import { OcaUint32 } from '../../OCP1/OcaUint32.js';
17
15
  import { String16 } from '../../OCP1/String16.js';
16
+ import { make_control_class } from '../make_control_class.js';
17
+ import { OcaWorker } from './OcaWorker.js';
18
18
 
19
19
  /**
20
- * A block is an object with three aspects: - It can contain other blocks. - It can contain workers. - It can contain agents. - It can contain data networks. - It can contain application networks. - It has a signal flow topology. We refer to an object inside a block as a **member** of that block. We refer to the block which contains an object as the object's **container.** **1** Normally, a block contains a set of members that together function as a processing unit -- for example, a crossover channel or mixer strip.
20
+ * A block is an object with three aspects: - It can contain other blocks. - It
21
+ * can contain workers. - It can contain agents. - It can contain data networks.
22
+ * - It can contain application networks. - It has a signal flow topology. We
23
+ * refer to an object inside a block as a **member** of that block. We refer to
24
+ * the block which contains an object as the object's **container.1** Normally,
25
+ * a block contains a set of members that together function as a processing unit
26
+ * -- for example, a crossover channel or mixer strip.
21
27
  * @extends OcaWorker
22
28
  * @class OcaBlock
23
29
  */
@@ -29,7 +35,6 @@ export const OcaBlock = make_control_class(
29
35
  OcaWorker,
30
36
  [
31
37
  ['GetType', 3, 1, [], [OcaUint32]],
32
- ,
33
38
  ['ConstructMemberUsingFactory', 3, 3, [OcaUint32], [OcaUint32]],
34
39
  ['DeleteMember', 3, 4, [OcaUint32], []],
35
40
  ['GetMembers', 3, 5, [], [OcaList(OcaObjectIdentification)]],
@@ -116,25 +121,19 @@ export const OcaBlock = make_control_class(
116
121
  );
117
122
 
118
123
  /**
119
- * Gets the block type. For statically-defined blocks, the block type is a Uint32 with a value corresponding to the unique configuration of this block. For dynamically-defined blocks, the block type is the object number of the block's factory. For the root block, the value of this property is 1.
124
+ * Gets the block type. For statically-defined blocks, the block type is a
125
+ * Uint32 with a value corresponding to the unique configuration of this block.
126
+ * For dynamically-defined blocks, the block type is the object number of the
127
+ * block's factory. For the root block, the value of this property is 1.
120
128
  *
121
129
  * @method OcaBlock#GetType
122
130
  * @returns {Promise<number>}
123
131
  * A promise which resolves to a single value of type ``number``.
124
132
  */
125
133
  /**
126
- * Constructs an object according to the given construction specification and adds it to the block. The return value indicates whether the member was successfully created and added.
127
- *
128
- * @method OcaBlock#ConstructMember
129
- * @param {string} ClassID
130
- *
131
- * @param {any} ConstructionParameters
132
- *
133
- * @returns {Promise<number>}
134
- * A promise which resolves to a single value of type ``number``.
135
- */
136
- /**
137
- * Invokes a factory to construct an instance of the given class, then adds it to the block. The return value indicates whether the member was successfully created and added.
134
+ * Invokes a factory to construct an instance of the given class, then adds it
135
+ * to the block. The return value indicates whether the member was successfully
136
+ * created and added.
138
137
  *
139
138
  * @method OcaBlock#ConstructMemberUsingFactory
140
139
  * @param {number} FactoryONo
@@ -143,7 +142,9 @@ export const OcaBlock = make_control_class(
143
142
  * A promise which resolves to a single value of type ``number``.
144
143
  */
145
144
  /**
146
- * Removes a member from the block and destroys the object. . Deletes all signal paths attached to its ports. The return value indicates whether the member was successfully removed and destroyed.
145
+ * Removes a member from the block and destroys the object. . Deletes all signal
146
+ * paths attached to its ports. The return value indicates whether the member
147
+ * was successfully removed and destroyed.
147
148
  *
148
149
  * @method OcaBlock#DeleteMember
149
150
  * @param {number} ObjectNumber
@@ -151,30 +152,38 @@ export const OcaBlock = make_control_class(
151
152
  * @returns {Promise<void>}
152
153
  */
153
154
  /**
154
- * Gets the list of block members. Does not recurse inner blocks. Each inner block is included in the returned list as a single object -- its contents are not enumerated. The return value indicates whether the list was successfully retrieved.
155
+ * Gets the list of block members. Does not recurse inner blocks. Each inner
156
+ * block is included in the returned list as a single object -- its contents are
157
+ * not enumerated. The return value indicates whether the list was successfully
158
+ * retrieved.
155
159
  *
156
160
  * @method OcaBlock#GetMembers
157
161
  * @returns {Promise<OcaObjectIdentification[]>}
158
- * A promise which resolves to a single value of type ``OcaObjectIdentification[]``.
162
+ * A promise which resolves to a single value of type :class:`OcaObjectIdentification[]`.
159
163
  */
160
164
  /**
161
- * Gets the list of block members. Recurses inner blocks. Each inner block is included in the returned list as a single object, amd its contents are enumerated. The return value indicates whether the list was successfully retrieved.
165
+ * Gets the list of block members. Recurses inner blocks. Each inner block is
166
+ * included in the returned list as a single object, amd its contents are
167
+ * enumerated. The return value indicates whether the list was successfully
168
+ * retrieved.
162
169
  *
163
170
  * @method OcaBlock#GetMembersRecursive
164
171
  * @returns {Promise<OcaBlockMember[]>}
165
- * A promise which resolves to a single value of type ``OcaBlockMember[]``.
172
+ * A promise which resolves to a single value of type :class:`OcaBlockMember[]`.
166
173
  */
167
174
  /**
168
- * Adds a signal path to the block. The return value indicates whether the signal path was successfully added.
175
+ * Adds a signal path to the block. The return value indicates whether the
176
+ * signal path was successfully added.
169
177
  *
170
178
  * @method OcaBlock#AddSignalPath
171
- * @param {OcaSignalPath} Path
179
+ * @param {IOcaSignalPath} Path
172
180
  *
173
181
  * @returns {Promise<number>}
174
182
  * A promise which resolves to a single value of type ``number``.
175
183
  */
176
184
  /**
177
- * Deletes a signal path from the block. The return value indicates whether the signal path was successfully added.
185
+ * Deletes a signal path from the block. The return value indicates whether the
186
+ * signal path was successfully added.
178
187
  *
179
188
  * @method OcaBlock#DeleteSignalPath
180
189
  * @param {number} Index
@@ -182,14 +191,16 @@ export const OcaBlock = make_control_class(
182
191
  * @returns {Promise<void>}
183
192
  */
184
193
  /**
185
- * Gets the map of signal paths in the block. Does not recurse inner blocks. The return value indicates whether the list was successfully retrieved.
194
+ * Gets the map of signal paths in the block. Does not recurse inner blocks. The
195
+ * return value indicates whether the list was successfully retrieved.
186
196
  *
187
197
  * @method OcaBlock#GetSignalPaths
188
198
  * @returns {Promise<Map<number, OcaSignalPath>>}
189
199
  * A promise which resolves to a single value of type ``Map<number, OcaSignalPath>``.
190
200
  */
191
201
  /**
192
- * Gets the mapof signal paths in the block. Recurses inner blocks. The return value indicates whether the list was successfully retrieved.
202
+ * Gets the mapof signal paths in the block. Recurses inner blocks. The return
203
+ * value indicates whether the list was successfully retrieved.
193
204
  *
194
205
  * @method OcaBlock#GetSignalPathsRecursive
195
206
  * @returns {Promise<Map<number, OcaSignalPath>>}
@@ -203,116 +214,122 @@ export const OcaBlock = make_control_class(
203
214
  * A promise which resolves to a single value of type :class:`OcaLibVolIdentifier`.
204
215
  */
205
216
  /**
206
- * Applies the referenced paramset to this block, and sets the MostRecentParamSet property. The return value indicates whether the paramset was successfully applied.
217
+ * Applies the referenced paramset to this block, and sets the
218
+ * MostRecentParamSet property. The return value indicates whether the paramset
219
+ * was successfully applied.
207
220
  *
208
221
  * @method OcaBlock#ApplyParamSet
209
222
  * @returns {Promise<OcaLibVolIdentifier>}
210
223
  * A promise which resolves to a single value of type :class:`OcaLibVolIdentifier`.
211
224
  */
212
225
  /**
213
- * Returns a paramset library volume data block which represents the current state of the block -- i.e. a "snapshot".
226
+ * Returns a paramset library volume data block which represents the current
227
+ * state of the block -- i.e. a "snapshot".
214
228
  *
215
229
  * @method OcaBlock#GetCurrentParamSetData
216
230
  * @returns {Promise<OcaLibVolData_ParamSet>}
217
231
  * A promise which resolves to a single value of type :class:`OcaLibVolData_ParamSet`.
218
232
  */
219
233
  /**
220
- * Stores a paramset library volume data block which represents the current state of the block ("snapshot") in the given library. **Replaces** the library volume at the specified LibVolIdentifier.
234
+ * Stores a paramset library volume data block which represents the current
235
+ * state of the block ("snapshot") in the given library. **Replaces** the
236
+ * library volume at the specified LibVolIdentifier.
221
237
  *
222
238
  * @method OcaBlock#StoreCurrentParamSetData
223
- * @param {OcaLibVolIdentifier} LibVolIdentifier
239
+ * @param {IOcaLibVolIdentifier} LibVolIdentifier
224
240
  *
225
241
  * @returns {Promise<void>}
226
242
  */
227
243
  /**
228
- * Gets the global blocktype. The return value indicates whether the type was successfully retrieved. If this block has no global blocktype, the **Authority** field of the returned **GlobalType** parameter will be zero. **Added in version 2 of this class.**
244
+ * Gets the global blocktype. The return value indicates whether the type was
245
+ * successfully retrieved. If this block has no global blocktype, the
246
+ * **Authority** field of the returned **GlobalType** parameter will be zero.
247
+ * **Added in version 2 of this class.**
229
248
  *
230
249
  * @method OcaBlock#GetGlobalType
231
250
  * @returns {Promise<OcaGlobalTypeIdentifier>}
232
251
  * A promise which resolves to a single value of type :class:`OcaGlobalTypeIdentifier`.
233
252
  */
234
253
  /**
235
- * Gets the block's ONo map. The return value indicates whether the map was successfully retrieved. **Added in version 2 of this class.**
254
+ * Gets the block's ONo map. The return value indicates whether the map was
255
+ * successfully retrieved. **Added in version 2 of this class.**
236
256
  *
237
257
  * @method OcaBlock#GetONoMap
238
258
  * @returns {Promise<Map<number, number>>}
239
259
  * A promise which resolves to a single value of type ``Map<number, number>``.
240
260
  */
241
261
  /**
242
- * Returns object identifications of all objects in the block that match the given Role search string and Class ID. Return value indicates whether the method succeeded. **Added in version 2 of this class.**
262
+ * Returns object identifications of all objects in the block that match the
263
+ * given Role search string and Class ID. Return value indicates whether the
264
+ * method succeeded. **Added in version 2 of this class.**
243
265
  *
244
266
  * @method OcaBlock#FindObjectsByRole
245
267
  * @param {string} SearchName
246
- *
247
- * @param {OcaStringComparisonType} NameComparisonType
248
- *
268
+ * @param {IOcaStringComparisonType} NameComparisonType
249
269
  * @param {string} SearchClassID
250
- *
251
- * @param {number} ResultFlags
270
+ * @param {IOcaObjectSearchResultFlags} ResultFlags
252
271
  *
253
272
  * @returns {Promise<OcaObjectSearchResult[]>}
254
- * A promise which resolves to a single value of type ``OcaObjectSearchResult[]``.
273
+ * A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
255
274
  */
256
275
  /**
257
- * Returns block member descriptors of all objects in the block and all contained blocks that match the given Role search string and Class ID. **Added in version 2 of this class.**
276
+ * Returns block member descriptors of all objects in the block and all
277
+ * contained blocks that match the given Role search string and Class ID.
278
+ * **Added in version 2 of this class.**
258
279
  *
259
280
  * @method OcaBlock#FindObjectsByRoleRecursive
260
281
  * @param {string} SearchName
261
- *
262
- * @param {OcaStringComparisonType} NameComparisonType
263
- *
282
+ * @param {IOcaStringComparisonType} NameComparisonType
264
283
  * @param {string} SearchClassID
265
- *
266
- * @param {number} ResultFlags
284
+ * @param {IOcaObjectSearchResultFlags} ResultFlags
267
285
  *
268
286
  * @returns {Promise<OcaObjectSearchResult[]>}
269
- * A promise which resolves to a single value of type ``OcaObjectSearchResult[]``.
287
+ * A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
270
288
  */
271
289
  /**
272
- * Returns object identifications of all objects with the given name path. **Added in version 2 of this class.**
290
+ * Returns object identifications of all objects with the given name path.
291
+ * **Added in version 2 of this class.**
273
292
  *
274
293
  * @method OcaBlock#FindObjectsByPath
275
294
  * @param {string[]} SearchPath
276
- *
277
- * @param {number} ResultFlags
295
+ * @param {IOcaObjectSearchResultFlags} ResultFlags
278
296
  *
279
297
  * @returns {Promise<OcaObjectSearchResult[]>}
280
- * A promise which resolves to a single value of type ``OcaObjectSearchResult[]``.
298
+ * A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
281
299
  */
282
300
  /**
283
- * Returns block member descriptors of all objects in the block and all contained blocks that match the given Label search string and Class ID. **Added in version 2 of this class.**
301
+ * Returns block member descriptors of all objects in the block and all
302
+ * contained blocks that match the given Label search string and Class ID.
303
+ * **Added in version 2 of this class.**
284
304
  *
285
305
  * @method OcaBlock#FindObjectsByLabelRecursive
286
306
  * @param {string} SearchName
287
- *
288
- * @param {OcaStringComparisonType} NameComparisonType
289
- *
307
+ * @param {IOcaStringComparisonType} NameComparisonType
290
308
  * @param {string} SearchClassID
291
- *
292
- * @param {number} ResultFlags
309
+ * @param {IOcaObjectSearchResultFlags} ResultFlags
293
310
  *
294
311
  * @returns {Promise<OcaObjectSearchResult[]>}
295
- * A promise which resolves to a single value of type ``OcaObjectSearchResult[]``.
312
+ * A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
296
313
  */
297
314
  /**
298
- * This event is emitted when the property Members changes in the remote object.
315
+ * This event is emitted when the property ``Members`` changes in the remote object.
299
316
  * The property ``Members`` is described in the AES70 standard as follows.
300
317
  * List of members in the block.
301
318
  *
302
319
  * @member {PropertyEvent<OcaObjectIdentification[]>} OcaBlock#OnMembersChanged
303
320
  */
304
321
  /**
305
- * This event is emitted when the property SignalPaths changes in the remote object.
322
+ * This event is emitted when the property ``SignalPaths`` changes in the remote object.
306
323
  * The property ``SignalPaths`` is described in the AES70 standard as follows.
307
324
  * List of signal paths in the block.
308
325
  *
309
326
  * @member {PropertyEvent<Map<number, OcaSignalPath>>} OcaBlock#OnSignalPathsChanged
310
327
  */
311
328
  /**
312
- * This event is emitted when the property MostRecentParamSetIdentifier changes in the remote object.
329
+ * This event is emitted when the property ``MostRecentParamSetIdentifier`` changes in the remote object.
313
330
  * The property ``MostRecentParamSetIdentifier`` is described in the AES70 standard as follows.
314
- * Library volume identifier of the paramset most recently applied to
315
- * this block.
331
+ * Library volume identifier of the paramset most recently applied to this
332
+ * block.
316
333
  *
317
334
  * @member {PropertyEvent<OcaLibVolIdentifier>} OcaBlock#OnMostRecentParamSetIdentifierChanged
318
335
  */