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,5 +1,3 @@
1
- import { make_control_class } from '../make_control_class.js';
2
- import { OcaAgent } from './OcaAgent.js';
3
1
  import { OcaBlob } from '../../OCP1/OcaBlob.js';
4
2
  import { OcaMap } from '../../OCP1/OcaMap.js';
5
3
  import { OcaNetworkMediaSourceOrSink } from '../../OCP1/OcaNetworkMediaSourceOrSink.js';
@@ -7,15 +5,38 @@ import { OcaStream } from '../../OCP1/OcaStream.js';
7
5
  import { OcaStreamConnectorStatus } from '../../OCP1/OcaStreamConnectorStatus.js';
8
6
  import { OcaUint16 } from '../../OCP1/OcaUint16.js';
9
7
  import { OcaUint32 } from '../../OCP1/OcaUint32.js';
8
+ import { make_control_class } from '../make_control_class.js';
9
+ import { OcaAgent } from './OcaAgent.js';
10
10
 
11
11
  /**
12
- * **DEPRECATED CLASS** *Replaced by the* **OcaMediaSinkConnector ** *and* **OcaMediaSourceConnector ** *datatypes in version 3 of Connection Management (CM3)* Agent class for objects ("connectors") that allow connection of streams to the device. Streams may be single channels or multichannel groups. A connector is either a *source* or a *sink.* Sources are sometimes called "talkers". Sinks are sometimes called "listeners". Each connector links to zero or more **OcaStream** data objects. Each **OcaStream** object represents a signal flow to or from a local connector to a remote connector. The remote connector is usually, but not necessarily, in a different node. Each connector collects zero or more *signal channels* . A signal channel is an instance of **OcaNetworkSignalChannel.** Each signal channel exposes one media channel of the stream to the interior of the device. A signal channel therefore is a Worker that contains exactly one **OcaPort** data object. Each **OcaStreamConnector** object belongs to a particular instance of **OcaStreamNetwork** or a subclass of **OcaStreamNetwork** **.** Each **OcaStreamConnector** is linked to its network through the **Owner** property.
13
- *
14
- * - When a controller creates an **OcaStreamConnector** object dynamically, the controller must store the Object Number of the corresponding **OcaStreamNetwork** object in the **Owner** property.
15
- *
16
- *
17
- * - Upon receiving the **Owner** property change, the **OcaStreamConnector** object must register itself with the given stream network object via some internal means.
18
- * This class may be subclassed to support various network types.
12
+ * **DEPRECATED CLASS** *Replaced by the* **OcaMediaSinkConnector ***and*
13
+ * **OcaMediaSourceConnector ***datatypes in version 3 of Connection Management
14
+ * (CM3)* Agent class for objects ("connectors") that allow connection of
15
+ * streams to the device. Streams may be single channels or multichannel groups.
16
+ * A connector is either a *source* or a *sink.* Sources are sometimes called
17
+ * "talkers". Sinks are sometimes called "listeners". Each connector links to
18
+ * zero or more **OcaStream** data objects. Each **OcaStream** object represents
19
+ * a signal flow to or from a local connector to a remote connector. The remote
20
+ * connector is usually, but not necessarily, in a different node. Each
21
+ * connector collects zero or more *signal channels*. A signal channel is an
22
+ * instance of **OcaNetworkSignalChannel.** Each signal channel exposes one
23
+ * media channel of the stream to the interior of the device. A signal channel
24
+ * therefore is a Worker that contains exactly one **OcaPort** data object. Each
25
+ * **OcaStreamConnector** object belongs to a particular instance of
26
+ * **OcaStreamNetwork** or a subclass of **OcaStreamNetwork** **.** Each
27
+ * **OcaStreamConnector** is linked to its network through the **Owner**
28
+ * property.
29
+ *
30
+ * - When a controller creates an **OcaStreamConnector** object dynamically,
31
+ * the controller must store the Object Number of the corresponding
32
+ * **OcaStreamNetwork** object in the **Owner** property.
33
+ *
34
+ * - Upon receiving the **Owner** property change, the **OcaStreamConnector**
35
+ * object must register itself with the given stream network object via some
36
+ * internal means.
37
+ *
38
+ *
39
+ * This class may be subclassed to support various network types. ** **
19
40
  * @extends OcaAgent
20
41
  * @class OcaStreamConnector
21
42
  */
@@ -50,16 +71,18 @@ export const OcaStreamConnector = make_control_class(
50
71
  );
51
72
 
52
73
  /**
53
- * Connects a stream to this connector. Return status indicates success of operation.
74
+ * Connects a stream to this connector. Return status indicates success of
75
+ * operation.
54
76
  *
55
77
  * @method OcaStreamConnector#ConnectStream
56
- * @param {OcaStream} Stream
78
+ * @param {IOcaStream} Stream
57
79
  *
58
80
  * @returns {Promise<number>}
59
81
  * A promise which resolves to a single value of type ``number``.
60
82
  */
61
83
  /**
62
- * Disconnects a stream from this connector. Return status indicates success of operation.
84
+ * Disconnects a stream from this connector. Return status indicates success of
85
+ * operation.
63
86
  *
64
87
  * @method OcaStreamConnector#DisconnectStream
65
88
  * @param {number} StreamID
@@ -67,49 +90,56 @@ export const OcaStreamConnector = make_control_class(
67
90
  * @returns {Promise<void>}
68
91
  */
69
92
  /**
70
- * Gets the value of the IDAdvertised property. Return status indicates success of operation.
93
+ * Gets the value of the IDAdvertised property. Return status indicates success
94
+ * of operation.
71
95
  *
72
96
  * @method OcaStreamConnector#GetIDAdvertised
73
97
  * @returns {Promise<Uint8Array>}
74
98
  * A promise which resolves to a single value of type ``Uint8Array``.
75
99
  */
76
100
  /**
77
- * Gets the object number of the **OcaStreamNetwork** object to which this connector belongs. Return status indicates success of operation.
101
+ * Gets the object number of the **OcaStreamNetwork** object to which this
102
+ * connector belongs. Return status indicates success of operation.
78
103
  *
79
104
  * @method OcaStreamConnector#GetOwnerNetwork
80
105
  * @returns {Promise<number>}
81
106
  * A promise which resolves to a single value of type ``number``.
82
107
  */
83
108
  /**
84
- * Gets the list of object numbers of **OcaNetworkSignalChannel** objects connected to this connector. Return status indicates success of operation.
109
+ * Gets the list of object numbers of **OcaNetworkSignalChannel** objects
110
+ * connected to this connector. Return status indicates success of operation.
85
111
  *
86
112
  * @method OcaStreamConnector#GetPins
87
113
  * @returns {Promise<Map<number, number>>}
88
114
  * A promise which resolves to a single value of type ``Map<number, number>``.
89
115
  */
90
116
  /**
91
- * Gets the value of the SourceOrSink property. Return status indicates success of operation.
117
+ * Gets the value of the SourceOrSink property. Return status indicates success
118
+ * of operation.
92
119
  *
93
120
  * @method OcaStreamConnector#GetSourceOrSink
94
121
  * @returns {Promise<OcaNetworkMediaSourceOrSink>}
95
122
  * A promise which resolves to a single value of type :class:`OcaNetworkMediaSourceOrSink`.
96
123
  */
97
124
  /**
98
- * Gets the value of the Status property. Return status indicates success of operation.
125
+ * Gets the value of the Status property. Return status indicates success of
126
+ * operation.
99
127
  *
100
128
  * @method OcaStreamConnector#GetStatus
101
129
  * @returns {Promise<OcaStreamConnectorStatus>}
102
130
  * A promise which resolves to a single value of type :class:`OcaStreamConnectorStatus`.
103
131
  */
104
132
  /**
105
- * Gets the map of OcaStream items connected to this connector. Return status indicates success of operation.
133
+ * Gets the map of OcaStream items connected to this connector. Return status
134
+ * indicates success of operation.
106
135
  *
107
136
  * @method OcaStreamConnector#GetStreams
108
137
  * @returns {Promise<Map<number, OcaStream>>}
109
138
  * A promise which resolves to a single value of type ``Map<number, OcaStream>``.
110
139
  */
111
140
  /**
112
- * Sets the value of the IDAdvertised property. Return status indicates success of operation.
141
+ * Sets the value of the IDAdvertised property. Return status indicates success
142
+ * of operation.
113
143
  *
114
144
  * @method OcaStreamConnector#SetIDAdvertised
115
145
  * @param {Uint8Array} IDAdvertised
@@ -117,7 +147,9 @@ export const OcaStreamConnector = make_control_class(
117
147
  * @returns {Promise<void>}
118
148
  */
119
149
  /**
120
- * Sets the object number of the **OcaStreamNetwork** object to which this connector belongs. Return status indicates success of operation. Only implemented for reconfigurable devices.
150
+ * Sets the object number of the **OcaStreamNetwork** object to which this
151
+ * connector belongs. Return status indicates success of operation. Only
152
+ * implemented for reconfigurable devices.
121
153
  *
122
154
  * @method OcaStreamConnector#SetOwnerNetwork
123
155
  * @param {number} Network
@@ -125,67 +157,67 @@ export const OcaStreamConnector = make_control_class(
125
157
  * @returns {Promise<void>}
126
158
  */
127
159
  /**
128
- * Sets the value of the SourceOrSink property. Return status indicates success of operation. Only implemented for reconfigurable devices. Note that this method can only be called when the SignalChannels property is empty, i.e. does not contain any actual channels.
160
+ * Sets the value of the SourceOrSink property. Return status indicates success
161
+ * of operation. Only implemented for reconfigurable devices. Note that this
162
+ * method can only be called when the SignalChannels property is empty, i.e.
163
+ * does not contain any actual channels.
129
164
  *
130
165
  * @method OcaStreamConnector#SetSourceOrSink
131
- * @param {OcaNetworkMediaSourceOrSink} SourceOrSink
166
+ * @param {IOcaNetworkMediaSourceOrSink} SourceOrSink
132
167
  *
133
168
  * @returns {Promise<void>}
134
169
  */
135
170
  /**
136
- * This event is emitted when the property IDAdvertised changes in the remote object.
171
+ * This event is emitted when the property ``IDAdvertised`` changes in the remote object.
137
172
  * The property ``IDAdvertised`` is described in the AES70 standard as follows.
138
- * Character name or binary identifier of this connector. This ID is
139
- * advertised on the network to be found by other devices' discovery
140
- * processes.
173
+ * Character name or binary identifier of this connector. This ID is advertised
174
+ * on the network to be found by other devices' discovery processes.
141
175
  *
142
176
  * @member {PropertyEvent<Uint8Array>} OcaStreamConnector#OnIDAdvertisedChanged
143
177
  */
144
178
  /**
145
- * This event is emitted when the property OwnerNetwork changes in the remote object.
179
+ * This event is emitted when the property ``OwnerNetwork`` changes in the remote object.
146
180
  * The property ``OwnerNetwork`` is described in the AES70 standard as follows.
147
- * Object number of stream network object (<b>OcaStreamNetwork</b> or one
148
- * of its subclasses) to which this connector belongs. In reconfigurable
149
- * devices, a controller that creates an <b>OcaStreamConnector </b>object
150
- * must store the appropriate stream network object number into this
151
- * property. It is assumed that, upon receiving a value into its
152
- * <b>Owner</b> property, the terminus object will by internal means
153
- * register itself with the identified stream network.
181
+ * Object number of stream network object (**OcaStreamNetwork** or one of its
182
+ * subclasses) to which this connector belongs. In reconfigurable devices, a
183
+ * controller that creates an **OcaStreamConnector** object must store the
184
+ * appropriate stream network object number into this property. It is assumed
185
+ * that, upon receiving a value into its **Owner** property, the terminus object
186
+ * will by internal means register itself with the identified stream network.
154
187
  *
155
188
  * @member {PropertyEvent<number>} OcaStreamConnector#OnOwnerNetworkChanged
156
189
  */
157
190
  /**
158
- * This event is emitted when the property Pins changes in the remote object.
191
+ * This event is emitted when the property ``Pins`` changes in the remote object.
159
192
  * The property ``Pins`` is described in the AES70 standard as follows.
160
- * The map of connector pin indexes to
161
- * <b>OcaNetworkSignalChannel[Source|Sink] </b>objects collected by this
162
- * connector. The pin indexes are <u>fixed indexes</u> 1 to n, where n is
163
- * the number of channels the connector accommodates (determined when the
164
- * connector is created). If a certain pin in the connector is currently
165
- * not attached the OcaONo of that index is 0.
193
+ * The map of connector pin indexes to **OcaNetworkSignalChannel[Source|Sink]**
194
+ * objects collected by this connector. The pin indexes are fixed indexes 1 to
195
+ * n, where n is the number of channels the connector accommodates (determined
196
+ * when the connector is created). If a certain pin in the connector is
197
+ * currently not attached the OcaONo of that index is 0.
166
198
  *
167
199
  * @member {PropertyEvent<Map<number, number>>} OcaStreamConnector#OnPinsChanged
168
200
  */
169
201
  /**
170
- * This event is emitted when the property SourceOrSink changes in the remote object.
202
+ * This event is emitted when the property ``SourceOrSink`` changes in the remote object.
171
203
  * The property ``SourceOrSink`` is described in the AES70 standard as follows.
172
- * Specifies whether this connector is for output (source) or input
173
- * (sink) signal channels.
204
+ * Specifies whether this connector is for output (source) or input (sink)
205
+ * signal channels.
174
206
  *
175
207
  * @member {PropertyEvent<OcaNetworkMediaSourceOrSink>} OcaStreamConnector#OnSourceOrSinkChanged
176
208
  */
177
209
  /**
178
- * This event is emitted when the property Status changes in the remote object.
210
+ * This event is emitted when the property ``Status`` changes in the remote object.
179
211
  * The property ``Status`` is described in the AES70 standard as follows.
180
212
  * Status of this terminus.
181
213
  *
182
214
  * @member {PropertyEvent<OcaStreamConnectorStatus>} OcaStreamConnector#OnStatusChanged
183
215
  */
184
216
  /**
185
- * This event is emitted when the property Streams changes in the remote object.
217
+ * This event is emitted when the property ``Streams`` changes in the remote object.
186
218
  * The property ``Streams`` is described in the AES70 standard as follows.
187
- * The list of <b>OcaStream </b>data objects contained in (i.e. connected
188
- * to) this connector.
219
+ * The list of **OcaStream** data objects contained in (i.e. connected to) this
220
+ * connector.
189
221
  *
190
222
  * @member {PropertyEvent<Map<number, OcaStream>>} OcaStreamConnector#OnStreamsChanged
191
223
  */
@@ -1,17 +1,23 @@
1
- import { RemoteDevice } from '../remote_device';
2
- import { OcaAgent } from './OcaAgent';
3
-
4
- import { PropertyEvent } from '../property_event';
5
- import { IOcaNetworkSystemInterfaceID } from '../../types/OcaNetworkSystemInterfaceID';
6
1
  import { OcaNetworkControlProtocol } from '../../types/OcaNetworkControlProtocol';
7
2
  import { OcaNetworkLinkType } from '../../types/OcaNetworkLinkType';
8
3
  import { OcaNetworkMediaProtocol } from '../../types/OcaNetworkMediaProtocol';
9
4
  import { OcaNetworkStatistics } from '../../types/OcaNetworkStatistics';
10
5
  import { OcaNetworkStatus } from '../../types/OcaNetworkStatus';
11
- import { OcaNetworkSystemInterfaceID } from '../../types/OcaNetworkSystemInterfaceID';
6
+ import {
7
+ IOcaNetworkSystemInterfaceID,
8
+ OcaNetworkSystemInterfaceID,
9
+ } from '../../types/OcaNetworkSystemInterfaceID';
10
+ import { PropertyEvent } from '../property_event';
11
+ import { RemoteDevice } from '../remote_device';
12
+ import { OcaAgent } from './OcaAgent';
12
13
 
13
14
  /**
14
- * **DEPRECATED CLASS** *Replaced by class* **OcaMediaTransportNetwork ** *in version 3 of Connection Management (CM3)* Abstract base class for defining network classes to which this device belongs. May be a media transport network, a control and monitoring network, or a network that does both. There shall be one OcaStreamNetwork instance for each network to which the device belongs. This class may be subclassed to support networks of various types.
15
+ * **DEPRECATED CLASS** *Replaced by class* **OcaMediaTransportNetwork ***in
16
+ * version 3 of Connection Management (CM3)* Abstract base class for defining
17
+ * network classes to which this device belongs. May be a media transport
18
+ * network, a control and monitoring network, or a network that does both. There
19
+ * shall be one OcaStreamNetwork instance for each network to which the device
20
+ * belongs. This class may be subclassed to support networks of various types.
15
21
  * @extends OcaAgent
16
22
  * @class OcaStreamNetwork
17
23
  */
@@ -69,7 +75,8 @@ export declare class OcaStreamNetwork extends OcaAgent {
69
75
  constructor(objectNumber: number, device: RemoteDevice);
70
76
 
71
77
  /**
72
- * Gets the network's link type (wired Ethernet, USB, etc.). Return status indicates whether the operation was successful.
78
+ * Gets the network's link type (wired Ethernet, USB, etc.). Return status
79
+ * indicates whether the operation was successful.
73
80
  *
74
81
  * @method OcaStreamNetwork#GetLinkType
75
82
  * @returns {Promise<OcaNetworkLinkType>}
@@ -78,7 +85,8 @@ export declare class OcaStreamNetwork extends OcaAgent {
78
85
  GetLinkType(): Promise<OcaNetworkLinkType>;
79
86
 
80
87
  /**
81
- * Gets the network's IDAdvertised. Return status indicates whether the operation was successful.
88
+ * Gets the network's IDAdvertised. Return status indicates whether the
89
+ * operation was successful.
82
90
  *
83
91
  * @method OcaStreamNetwork#GetIDAdvertised
84
92
  * @returns {Promise<Uint8Array>}
@@ -87,7 +95,8 @@ export declare class OcaStreamNetwork extends OcaAgent {
87
95
  GetIDAdvertised(): Promise<Uint8Array>;
88
96
 
89
97
  /**
90
- * Sets the network's IDAdvertised. Return status indicates whether the operation was successful.
98
+ * Sets the network's IDAdvertised. Return status indicates whether the
99
+ * operation was successful.
91
100
  *
92
101
  * @method OcaStreamNetwork#SetIDAdvertised
93
102
  * @param {Uint8Array} Name
@@ -97,7 +106,8 @@ export declare class OcaStreamNetwork extends OcaAgent {
97
106
  SetIDAdvertised(Name: Uint8Array): Promise<void>;
98
107
 
99
108
  /**
100
- * Gets the network's ControlProtocol property. Return status indicates whether the operation was successful.
109
+ * Gets the network's ControlProtocol property. Return status indicates
110
+ * whether the operation was successful.
101
111
  *
102
112
  * @method OcaStreamNetwork#GetControlProtocol
103
113
  * @returns {Promise<OcaNetworkControlProtocol>}
@@ -106,7 +116,8 @@ export declare class OcaStreamNetwork extends OcaAgent {
106
116
  GetControlProtocol(): Promise<OcaNetworkControlProtocol>;
107
117
 
108
118
  /**
109
- * Gets the network's MediaProtocol property. Return status indicates whether the operation was successful.
119
+ * Gets the network's MediaProtocol property. Return status indicates whether
120
+ * the operation was successful.
110
121
  *
111
122
  * @method OcaStreamNetwork#GetMediaProtocol
112
123
  * @returns {Promise<OcaNetworkMediaProtocol>}
@@ -115,7 +126,8 @@ export declare class OcaStreamNetwork extends OcaAgent {
115
126
  GetMediaProtocol(): Promise<OcaNetworkMediaProtocol>;
116
127
 
117
128
  /**
118
- * Retrieves the network's status. Return status indicates whether the status was successfully retrieved.
129
+ * Retrieves the network's status. Return status indicates whether the status
130
+ * was successfully retrieved.
119
131
  *
120
132
  * @method OcaStreamNetwork#GetStatus
121
133
  * @returns {Promise<OcaNetworkStatus>}
@@ -124,7 +136,8 @@ export declare class OcaStreamNetwork extends OcaAgent {
124
136
  GetStatus(): Promise<OcaNetworkStatus>;
125
137
 
126
138
  /**
127
- * Retrieves network error statistics counter values. Return status indicates whether the values were successfully retrieved.
139
+ * Retrieves network error statistics counter values. Return status indicates
140
+ * whether the values were successfully retrieved.
128
141
  *
129
142
  * @method OcaStreamNetwork#GetStatistics
130
143
  * @returns {Promise<OcaNetworkStatistics>}
@@ -133,7 +146,8 @@ export declare class OcaStreamNetwork extends OcaAgent {
133
146
  GetStatistics(): Promise<OcaNetworkStatistics>;
134
147
 
135
148
  /**
136
- * Resets network error statistics counters. Return status indicates whether the counters were successfully reset.
149
+ * Resets network error statistics counters. Return status indicates whether
150
+ * the counters were successfully reset.
137
151
  *
138
152
  * @method OcaStreamNetwork#ResetStatistics
139
153
  * @returns {Promise<void>}
@@ -141,19 +155,22 @@ export declare class OcaStreamNetwork extends OcaAgent {
141
155
  ResetStatistics(): Promise<void>;
142
156
 
143
157
  /**
144
- * Gets the list of system interface IDs that this network is using. Return status indicates success of the operation.
158
+ * Gets the list of system interface IDs that this network is using. Return
159
+ * status indicates success of the operation.
145
160
  *
146
161
  * @method OcaStreamNetwork#GetSystemInterfaces
147
162
  * @returns {Promise<OcaNetworkSystemInterfaceID[]>}
148
- * A promise which resolves to a single value of type ``OcaNetworkSystemInterfaceID[]``.
163
+ * A promise which resolves to a single value of type :class:`OcaNetworkSystemInterfaceID[]`.
149
164
  */
150
165
  GetSystemInterfaces(): Promise<OcaNetworkSystemInterfaceID[]>;
151
166
 
152
167
  /**
153
- * Sets the list of system interface IDs that this network will use. Return status indicates success of the operation. This method is not implemented by all network implementations.
168
+ * Sets the list of system interface IDs that this network will use. Return
169
+ * status indicates success of the operation. This method is not implemented
170
+ * by all network implementations.
154
171
  *
155
172
  * @method OcaStreamNetwork#SetSystemInterfaces
156
- * @param {OcaNetworkSystemInterfaceID[]} Interfaces
173
+ * @param {IOcaNetworkSystemInterfaceID[]} Interfaces
157
174
  *
158
175
  * @returns {Promise<void>}
159
176
  */
@@ -162,7 +179,14 @@ export declare class OcaStreamNetwork extends OcaAgent {
162
179
  ): Promise<void>;
163
180
 
164
181
  /**
165
- * Gets the list of object numbers of Source **OcaStreamConnector** objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when **OcaStreamConnector** objects' **Owner** properties are updated, or when **OcaStreamConnector** objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
182
+ * Gets the list of object numbers of Source **OcaStreamConnector** objects
183
+ * owned by this network. Return status indicates success of the operation. If
184
+ * the value of the network's MediaProtocol property is NONE, this method will
185
+ * return the status value InvalidRequest. Members are added to and deleted
186
+ * from this list when **OcaStreamConnector** objects' **Owner** properties
187
+ * are updated, or when **OcaStreamConnector** objects are deleted. For
188
+ * reconfigurable devices, such changes may be initiated by controllers during
189
+ * device operation.
166
190
  *
167
191
  * @method OcaStreamNetwork#GetStreamConnectorsSource
168
192
  * @returns {Promise<number[]>}
@@ -171,7 +195,14 @@ export declare class OcaStreamNetwork extends OcaAgent {
171
195
  GetStreamConnectorsSource(): Promise<number[]>;
172
196
 
173
197
  /**
174
- * Sets the list of object numbers of Source **OcaStreamConnector** objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when **OcaStreamConnector** objects' **Owner** properties are updated, or when **OcaStreamConnector** objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
198
+ * Sets the list of object numbers of Source **OcaStreamConnector** objects
199
+ * owned by this network. Return status indicates success of the operation. If
200
+ * the value of the network's MediaProtocol property is NONE, this method will
201
+ * return the status value InvalidRequest. Members are added to and deleted
202
+ * from this list when **OcaStreamConnector** objects' **Owner** properties
203
+ * are updated, or when **OcaStreamConnector** objects are deleted. For
204
+ * reconfigurable devices, such changes may be initiated by controllers during
205
+ * device operation.
175
206
  *
176
207
  * @method OcaStreamNetwork#SetStreamConnectorsSource
177
208
  * @param {number[]} StreamConnectors
@@ -181,7 +212,14 @@ export declare class OcaStreamNetwork extends OcaAgent {
181
212
  SetStreamConnectorsSource(StreamConnectors: number[]): Promise<void>;
182
213
 
183
214
  /**
184
- * Gets the list of object numbers of Sink **OcaStreamConnector** objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when **OcaStreamConnector** objects' **Owner** properties are updated, or when **OcaStreamConnector** objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
215
+ * Gets the list of object numbers of Sink **OcaStreamConnector** objects
216
+ * owned by this network. Return status indicates success of the operation. If
217
+ * the value of the network's MediaProtocol property is NONE, this method will
218
+ * return the status value InvalidRequest. Members are added to and deleted
219
+ * from this list when **OcaStreamConnector** objects' **Owner** properties
220
+ * are updated, or when **OcaStreamConnector** objects are deleted. For
221
+ * reconfigurable devices, such changes may be initiated by controllers during
222
+ * device operation.
185
223
  *
186
224
  * @method OcaStreamNetwork#GetStreamConnectorsSink
187
225
  * @returns {Promise<number[]>}
@@ -190,7 +228,14 @@ export declare class OcaStreamNetwork extends OcaAgent {
190
228
  GetStreamConnectorsSink(): Promise<number[]>;
191
229
 
192
230
  /**
193
- * Sets the list of object numbers of Sink **OcaStreamConnector** objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when **OcaStreamConnector** objects' **Owner** properties are updated, or when **OcaStreamConnector** objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
231
+ * Sets the list of object numbers of Sink **OcaStreamConnector** objects
232
+ * owned by this network. Return status indicates success of the operation. If
233
+ * the value of the network's MediaProtocol property is NONE, this method will
234
+ * return the status value InvalidRequest. Members are added to and deleted
235
+ * from this list when **OcaStreamConnector** objects' **Owner** properties
236
+ * are updated, or when **OcaStreamConnector** objects are deleted. For
237
+ * reconfigurable devices, such changes may be initiated by controllers during
238
+ * device operation.
194
239
  *
195
240
  * @method OcaStreamNetwork#SetStreamConnectorsSink
196
241
  * @param {number[]} StreamConnectors
@@ -200,7 +245,14 @@ export declare class OcaStreamNetwork extends OcaAgent {
200
245
  SetStreamConnectorsSink(StreamConnectors: number[]): Promise<void>;
201
246
 
202
247
  /**
203
- * Gets the list of object numbers of Source **OcaNetworkSignalChannel** objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when **OcaNetworkSignalChannel** objects' **Owner** properties are updated, or when **OcaNetworkSignalChannel** objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
248
+ * Gets the list of object numbers of Source **OcaNetworkSignalChannel**
249
+ * objects owned by this network. Return status indicates success of the
250
+ * operation. If the value of the network's MediaProtocol property is NONE,
251
+ * this method will return the status value InvalidRequest. Members are added
252
+ * to and deleted from this list when **OcaNetworkSignalChannel** objects'
253
+ * **Owner** properties are updated, or when **OcaNetworkSignalChannel**
254
+ * objects are deleted. For reconfigurable devices, such changes may be
255
+ * initiated by controllers during device operation.
204
256
  *
205
257
  * @method OcaStreamNetwork#GetSignalChannelsSource
206
258
  * @returns {Promise<number[]>}
@@ -209,7 +261,14 @@ export declare class OcaStreamNetwork extends OcaAgent {
209
261
  GetSignalChannelsSource(): Promise<number[]>;
210
262
 
211
263
  /**
212
- * Sets the list of object numbers of Source **OcaNetworkSignalChannel** objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when **OcaNetworkSignalChannel** objects' **Owner** properties are updated, or when **OcaNetworkSignalChannel** objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
264
+ * Sets the list of object numbers of Source **OcaNetworkSignalChannel**
265
+ * objects owned by this network. Return status indicates success of the
266
+ * operation. If the value of the network's MediaProtocol property is NONE,
267
+ * this method will return the status value InvalidRequest. Members are added
268
+ * to and deleted from this list when **OcaNetworkSignalChannel** objects'
269
+ * **Owner** properties are updated, or when **OcaNetworkSignalChannel**
270
+ * objects are deleted. For reconfigurable devices, such changes may be
271
+ * initiated by controllers during device operation.
213
272
  *
214
273
  * @method OcaStreamNetwork#SetSignalChannelsSource
215
274
  * @param {number[]} SignalChannels
@@ -219,7 +278,14 @@ export declare class OcaStreamNetwork extends OcaAgent {
219
278
  SetSignalChannelsSource(SignalChannels: number[]): Promise<void>;
220
279
 
221
280
  /**
222
- * Gets the list of object numbers of Sink **OcaNetworkSignalChannel** objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when **OcaNetworkSignalChannel** objects' **Owner** properties are updated, or when **OcaNetworkSignalChannel** objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
281
+ * Gets the list of object numbers of Sink **OcaNetworkSignalChannel** objects
282
+ * owned by this network. Return status indicates success of the operation. If
283
+ * the value of the network's MediaProtocol property is NONE, this method will
284
+ * return the status value InvalidRequest. Members are added to and deleted
285
+ * from this list when **OcaNetworkSignalChannel** objects' **Owner**
286
+ * properties are updated, or when **OcaNetworkSignalChannel** objects are
287
+ * deleted. For reconfigurable devices, such changes may be initiated by
288
+ * controllers during device operation.
223
289
  *
224
290
  * @method OcaStreamNetwork#GetSignalChannelsSink
225
291
  * @returns {Promise<number[]>}
@@ -228,7 +294,14 @@ export declare class OcaStreamNetwork extends OcaAgent {
228
294
  GetSignalChannelsSink(): Promise<number[]>;
229
295
 
230
296
  /**
231
- * Sets the list of object numbers of Sink **OcaNetworkSignalChannel** objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when **OcaNetworkSignalChannel** objects' **Owner** properties are updated, or when **OcaNetworkSignalChannel** objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
297
+ * Sets the list of object numbers of Sink **OcaNetworkSignalChannel** objects
298
+ * owned by this network. Return status indicates success of the operation. If
299
+ * the value of the network's MediaProtocol property is NONE, this method will
300
+ * return the status value InvalidRequest. Members are added to and deleted
301
+ * from this list when **OcaNetworkSignalChannel** objects' **Owner**
302
+ * properties are updated, or when **OcaNetworkSignalChannel** objects are
303
+ * deleted. For reconfigurable devices, such changes may be initiated by
304
+ * controllers during device operation.
232
305
  *
233
306
  * @method OcaStreamNetwork#SetSignalChannelsSink
234
307
  * @param {number[]} SignalChannels