aes70 1.6.0 → 1.6.2
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.
- package/Changelog +30 -0
- package/dist/AES70.es5.js +5795 -1
- package/package.json +1 -1
- package/src/OCP1/encoded_arguments.js +31 -19
- package/src/connection.d.ts +5 -0
- package/src/controller/ControlClasses/OcaBlock.d.ts +15 -15
- package/src/controller/ControlClasses/OcaBlock.js +16 -16
- package/src/controller/ControlClasses/OcaControlNetwork.d.ts +5 -0
- package/src/controller/ControlClasses/OcaControlNetwork.js +5 -0
- package/src/controller/ControlClasses/OcaFilterParametric.d.ts +4 -0
- package/src/controller/ControlClasses/OcaFilterParametric.js +5 -0
- package/src/controller/ControlClasses/OcaGrouper.d.ts +12 -0
- package/src/controller/ControlClasses/OcaGrouper.js +15 -0
- package/src/controller/ControlClasses/OcaMediaClockManager.d.ts +4 -0
- package/src/controller/ControlClasses/OcaMediaClockManager.js +5 -0
- package/src/controller/ControlClasses/OcaMediaTransportNetwork.d.ts +4 -0
- package/src/controller/ControlClasses/OcaMediaTransportNetwork.js +5 -0
- package/src/controller/ControlClasses/OcaNetworkSignalChannel.d.ts +68 -68
- package/src/controller/ControlClasses/OcaNetworkSignalChannel.js +72 -72
- package/src/controller/ControlClasses/OcaSecurityManager.d.ts +31 -31
- package/src/controller/ControlClasses/OcaSecurityManager.js +29 -29
- package/src/controller/ControlClasses/OcaStreamConnector.d.ts +70 -70
- package/src/controller/ControlClasses/OcaStreamConnector.js +80 -80
- package/src/controller/ControlClasses/OcaStreamNetwork.d.ts +18 -18
- package/src/controller/ControlClasses/OcaStreamNetwork.js +49 -49
- package/src/controller/ControlClasses/OcaSubscriptionManager.d.ts +13 -13
- package/src/controller/ControlClasses/OcaSubscriptionManager.js +12 -12
- package/src/controller/base_event.js +2 -2
- package/src/controller/client_connection.js +7 -3
- package/src/controller/fetch_device_content.js +8 -3
- package/src/controller/make_control_class.js +30 -4
- package/src/controller/object_base.d.ts +34 -0
- package/src/controller/tcp_connection.d.ts +8 -4
- package/src/controller/tcp_connection.js +23 -6
|
@@ -32,22 +32,22 @@ export const OcaNetworkSignalChannel = make_control_class(
|
|
|
32
32
|
2,
|
|
33
33
|
OcaWorker,
|
|
34
34
|
[
|
|
35
|
-
['AddToConnector', 3, 6, [OcaUint32, OcaUint16], []],
|
|
36
|
-
['GetConnectorPins', 3, 5, [], [OcaMap(OcaUint32, OcaUint16)]],
|
|
37
35
|
['GetIDAdvertised', 3, 1, [], [OcaBlob]],
|
|
36
|
+
['SetIDAdvertised', 3, 2, [OcaBlob], []],
|
|
38
37
|
['GetNetwork', 3, 3, [], [OcaUint32]],
|
|
38
|
+
['SetNetwork', 3, 4, [OcaUint32], []],
|
|
39
|
+
['GetConnectorPins', 3, 5, [], [OcaMap(OcaUint32, OcaUint16)]],
|
|
40
|
+
['AddToConnector', 3, 6, [OcaUint32, OcaUint16], []],
|
|
41
|
+
['RemoveFromConnector', 3, 7, [OcaUint32], []],
|
|
39
42
|
['GetRemoteChannelID', 3, 8, [], [OcaBlob]],
|
|
43
|
+
['SetRemoteChannelID', 3, 9, [OcaBlob], []],
|
|
40
44
|
['GetSourceOrSink', 3, 10, [], [OcaNetworkMediaSourceOrSink]],
|
|
41
45
|
['GetStatus', 3, 11, [], [OcaNetworkSignalChannelStatus]],
|
|
42
|
-
['RemoveFromConnector', 3, 7, [OcaUint32], []],
|
|
43
|
-
['SetIDAdvertised', 3, 2, [OcaBlob], []],
|
|
44
|
-
['SetNetwork', 3, 4, [OcaUint32], []],
|
|
45
|
-
['SetRemoteChannelID', 3, 9, [OcaBlob], []],
|
|
46
46
|
],
|
|
47
47
|
[
|
|
48
|
-
['ConnectorPins', [OcaMap(OcaUint32, OcaUint16)], 3, 3, false, false, null],
|
|
49
48
|
['IDAdvertised', [OcaBlob], 3, 1, false, false, null],
|
|
50
49
|
['Network', [OcaUint32], 3, 2, false, false, null],
|
|
50
|
+
['ConnectorPins', [OcaMap(OcaUint32, OcaUint16)], 3, 3, false, false, null],
|
|
51
51
|
['RemoteChannelID', [OcaBlob], 3, 4, false, false, null],
|
|
52
52
|
['SourceOrSink', [OcaNetworkMediaSourceOrSink], 3, 5, false, false, null],
|
|
53
53
|
['Status', [OcaNetworkSignalChannelStatus], 3, 6, false, false, null],
|
|
@@ -55,26 +55,6 @@ export const OcaNetworkSignalChannel = make_control_class(
|
|
|
55
55
|
[]
|
|
56
56
|
);
|
|
57
57
|
|
|
58
|
-
/**
|
|
59
|
-
* Adds the object number of the stream connector object to which this media
|
|
60
|
-
* port belongs, and specifies on what index of the stream connector this
|
|
61
|
-
* channel can be found. Return status indicates success of operation.
|
|
62
|
-
*
|
|
63
|
-
* @method OcaNetworkSignalChannel#AddToConnector
|
|
64
|
-
* @param {number} Connector
|
|
65
|
-
* @param {number} Index
|
|
66
|
-
*
|
|
67
|
-
* @returns {Promise<void>}
|
|
68
|
-
*/
|
|
69
|
-
/**
|
|
70
|
-
* Gets the object number of the stream connector object to which this media
|
|
71
|
-
* port belongs, if any. If port does not belong to a stream connector, returns
|
|
72
|
-
* zero. Return status indicates success of operation.
|
|
73
|
-
*
|
|
74
|
-
* @method OcaNetworkSignalChannel#GetConnectorPins
|
|
75
|
-
* @returns {Promise<Map<number, number>>}
|
|
76
|
-
* A promise which resolves to a single value of type ``Map<number, number>``.
|
|
77
|
-
*/
|
|
78
58
|
/**
|
|
79
59
|
* Gets the value of the IDAdvertised property. Return status indicates success
|
|
80
60
|
* of operation.
|
|
@@ -83,6 +63,15 @@ export const OcaNetworkSignalChannel = make_control_class(
|
|
|
83
63
|
* @returns {Promise<Uint8Array>}
|
|
84
64
|
* A promise which resolves to a single value of type ``Uint8Array``.
|
|
85
65
|
*/
|
|
66
|
+
/**
|
|
67
|
+
* Sets the value of the IDAdvertised property. Return status indicates success
|
|
68
|
+
* of operation.
|
|
69
|
+
*
|
|
70
|
+
* @method OcaNetworkSignalChannel#SetIDAdvertised
|
|
71
|
+
* @param {Uint8Array} IDAdvertised
|
|
72
|
+
*
|
|
73
|
+
* @returns {Promise<void>}
|
|
74
|
+
*/
|
|
86
75
|
/**
|
|
87
76
|
* Gets the object number of the stream network object to which this media port
|
|
88
77
|
* belongs. Return status indicates success of operation.
|
|
@@ -92,58 +81,53 @@ export const OcaNetworkSignalChannel = make_control_class(
|
|
|
92
81
|
* A promise which resolves to a single value of type ``number``.
|
|
93
82
|
*/
|
|
94
83
|
/**
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
* the remote channel ID will always be empty).
|
|
84
|
+
* Sets the object number of the stream network object to which this media port
|
|
85
|
+
* belongs. Return status indicates success of operation. Only implemented for
|
|
86
|
+
* reconfigurable devices.
|
|
99
87
|
*
|
|
100
|
-
* @method OcaNetworkSignalChannel#
|
|
101
|
-
* @
|
|
102
|
-
* A promise which resolves to a single value of type ``Uint8Array``.
|
|
103
|
-
*/
|
|
104
|
-
/**
|
|
105
|
-
* Gets the value of the SourceOrSink property. Return status indicates success
|
|
106
|
-
* of operation.
|
|
88
|
+
* @method OcaNetworkSignalChannel#SetNetwork
|
|
89
|
+
* @param {number} Network
|
|
107
90
|
*
|
|
108
|
-
* @
|
|
109
|
-
* @returns {Promise<OcaNetworkMediaSourceOrSink>}
|
|
110
|
-
* A promise which resolves to a single value of type :class:`OcaNetworkMediaSourceOrSink`.
|
|
91
|
+
* @returns {Promise<void>}
|
|
111
92
|
*/
|
|
112
93
|
/**
|
|
113
|
-
* Gets the
|
|
114
|
-
*
|
|
94
|
+
* Gets the object number of the stream connector object to which this media
|
|
95
|
+
* port belongs, if any. If port does not belong to a stream connector, returns
|
|
96
|
+
* zero. Return status indicates success of operation.
|
|
115
97
|
*
|
|
116
|
-
* @method OcaNetworkSignalChannel#
|
|
117
|
-
* @returns {Promise<
|
|
118
|
-
* A promise which resolves to a single value of type
|
|
98
|
+
* @method OcaNetworkSignalChannel#GetConnectorPins
|
|
99
|
+
* @returns {Promise<Map<number, number>>}
|
|
100
|
+
* A promise which resolves to a single value of type ``Map<number, number>``.
|
|
119
101
|
*/
|
|
120
102
|
/**
|
|
121
|
-
*
|
|
122
|
-
*
|
|
103
|
+
* Adds the object number of the stream connector object to which this media
|
|
104
|
+
* port belongs, and specifies on what index of the stream connector this
|
|
105
|
+
* channel can be found. Return status indicates success of operation.
|
|
123
106
|
*
|
|
124
|
-
* @method OcaNetworkSignalChannel#
|
|
107
|
+
* @method OcaNetworkSignalChannel#AddToConnector
|
|
125
108
|
* @param {number} Connector
|
|
109
|
+
* @param {number} Index
|
|
126
110
|
*
|
|
127
111
|
* @returns {Promise<void>}
|
|
128
112
|
*/
|
|
129
113
|
/**
|
|
130
|
-
*
|
|
131
|
-
* of operation.
|
|
114
|
+
* Removes this channel from the passed stream connector. Return status
|
|
115
|
+
* indicates success of operation.
|
|
132
116
|
*
|
|
133
|
-
* @method OcaNetworkSignalChannel#
|
|
134
|
-
* @param {
|
|
117
|
+
* @method OcaNetworkSignalChannel#RemoveFromConnector
|
|
118
|
+
* @param {number} Connector
|
|
135
119
|
*
|
|
136
120
|
* @returns {Promise<void>}
|
|
137
121
|
*/
|
|
138
122
|
/**
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
* @method OcaNetworkSignalChannel#SetNetwork
|
|
144
|
-
* @param {number} Network
|
|
123
|
+
* Gets the remote channel ID to which this channel is connected. Empty if the
|
|
124
|
+
* channel is not connected (at least not directly to another channel). For
|
|
125
|
+
* stream-oriented connection management this functionality is not used (i.e.
|
|
126
|
+
* the remote channel ID will always be empty).
|
|
145
127
|
*
|
|
146
|
-
* @
|
|
128
|
+
* @method OcaNetworkSignalChannel#GetRemoteChannelID
|
|
129
|
+
* @returns {Promise<Uint8Array>}
|
|
130
|
+
* A promise which resolves to a single value of type ``Uint8Array``.
|
|
147
131
|
*/
|
|
148
132
|
/**
|
|
149
133
|
* Sets the remote channel ID to which this channel must be connected. Only used
|
|
@@ -158,19 +142,20 @@ export const OcaNetworkSignalChannel = make_control_class(
|
|
|
158
142
|
* @returns {Promise<void>}
|
|
159
143
|
*/
|
|
160
144
|
/**
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
* Map of object numbers of **OcaStreamConnector** objects to
|
|
164
|
-
* **OcaStreamConnectorPinIndex** of these connectors. This map identifies which
|
|
165
|
-
* **OcaStreamConnector** objects contain this network signal channel, and
|
|
166
|
-
* indicates at what pin of the connector this channel is found. If the
|
|
167
|
-
* **OcaNetworkSignalChannel** object is not part of any **OcaStreamConnector**
|
|
168
|
-
* this map is empty. Note that **OcaNetworkSignalChannel** objects of type
|
|
169
|
-
* **Sink** cannot have more than one entry in the map, else it would implicitly
|
|
170
|
-
* perform mixing. **OcaNetworkSignalChannel** objects of type **Source** can
|
|
171
|
-
* have multiple entries in the map.
|
|
145
|
+
* Gets the value of the SourceOrSink property. Return status indicates success
|
|
146
|
+
* of operation.
|
|
172
147
|
*
|
|
173
|
-
* @
|
|
148
|
+
* @method OcaNetworkSignalChannel#GetSourceOrSink
|
|
149
|
+
* @returns {Promise<OcaNetworkMediaSourceOrSink>}
|
|
150
|
+
* A promise which resolves to a single value of type :class:`OcaNetworkMediaSourceOrSink`.
|
|
151
|
+
*/
|
|
152
|
+
/**
|
|
153
|
+
* Gets the value of the Status property. Return status indicates success of
|
|
154
|
+
* operation.
|
|
155
|
+
*
|
|
156
|
+
* @method OcaNetworkSignalChannel#GetStatus
|
|
157
|
+
* @returns {Promise<OcaNetworkSignalChannelStatus>}
|
|
158
|
+
* A promise which resolves to a single value of type :class:`OcaNetworkSignalChannelStatus`.
|
|
174
159
|
*/
|
|
175
160
|
/**
|
|
176
161
|
* This event is emitted when the property ``IDAdvertised`` changes in the remote object.
|
|
@@ -191,6 +176,21 @@ export const OcaNetworkSignalChannel = make_control_class(
|
|
|
191
176
|
*
|
|
192
177
|
* @member {PropertyEvent<number>} OcaNetworkSignalChannel#OnNetworkChanged
|
|
193
178
|
*/
|
|
179
|
+
/**
|
|
180
|
+
* This event is emitted when the property ``ConnectorPins`` changes in the remote object.
|
|
181
|
+
* The property ``ConnectorPins`` is described in the AES70 standard as follows.
|
|
182
|
+
* Map of object numbers of **OcaStreamConnector** objects to
|
|
183
|
+
* **OcaStreamConnectorPinIndex** of these connectors. This map identifies which
|
|
184
|
+
* **OcaStreamConnector** objects contain this network signal channel, and
|
|
185
|
+
* indicates at what pin of the connector this channel is found. If the
|
|
186
|
+
* **OcaNetworkSignalChannel** object is not part of any **OcaStreamConnector**
|
|
187
|
+
* this map is empty. Note that **OcaNetworkSignalChannel** objects of type
|
|
188
|
+
* **Sink** cannot have more than one entry in the map, else it would implicitly
|
|
189
|
+
* perform mixing. **OcaNetworkSignalChannel** objects of type **Source** can
|
|
190
|
+
* have multiple entries in the map.
|
|
191
|
+
*
|
|
192
|
+
* @member {PropertyEvent<Map<number, number>>} OcaNetworkSignalChannel#OnConnectorPinsChanged
|
|
193
|
+
*/
|
|
194
194
|
/**
|
|
195
195
|
* This event is emitted when the property ``RemoteChannelID`` changes in the remote object.
|
|
196
196
|
* The property ``RemoteChannelID`` is described in the AES70 standard as follows.
|
|
@@ -26,19 +26,26 @@ export declare class OcaSecurityManager extends OcaManager {
|
|
|
26
26
|
constructor(objectNumber: number, device: RemoteDevice);
|
|
27
27
|
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* been turned on. If this is not the case the method will return DeviceError.
|
|
29
|
+
* Enables security of control data (OCA messages). After calling this method
|
|
30
|
+
* all OCA messages are sent and received using a secure connection. The
|
|
31
|
+
* return value indicates whether the operation succeeded. If the operation
|
|
32
|
+
* fails security is not enabled.
|
|
34
33
|
*
|
|
35
|
-
* @method OcaSecurityManager#
|
|
36
|
-
* @
|
|
37
|
-
|
|
34
|
+
* @method OcaSecurityManager#EnableControlSecurity
|
|
35
|
+
* @returns {Promise<void>}
|
|
36
|
+
*/
|
|
37
|
+
EnableControlSecurity(): Promise<void>;
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* Disables security of control data (OCA messages). After calling this method
|
|
41
|
+
* all OCA messages can be sent and received both on insecure and secure
|
|
42
|
+
* connections. The return value indicates whether the operation succeeded. If
|
|
43
|
+
* the operation fails security is not disabled.
|
|
38
44
|
*
|
|
45
|
+
* @method OcaSecurityManager#DisableControlSecurity
|
|
39
46
|
* @returns {Promise<void>}
|
|
40
47
|
*/
|
|
41
|
-
|
|
48
|
+
DisableControlSecurity(): Promise<void>;
|
|
42
49
|
|
|
43
50
|
/**
|
|
44
51
|
* Changes the pre-shared key identified by the passed identity. Note that
|
|
@@ -54,6 +61,21 @@ export declare class OcaSecurityManager extends OcaManager {
|
|
|
54
61
|
*/
|
|
55
62
|
ChangePreSharedKey(identity: string, newKey: Uint8Array): Promise<void>;
|
|
56
63
|
|
|
64
|
+
/**
|
|
65
|
+
* Adds a pre-shared key (identified by the passed identity) to the device. By
|
|
66
|
+
* having multiple PSKs the device is able to participate in multiple secure
|
|
67
|
+
* systems. Note that adding a PSK over the network will only work if the
|
|
68
|
+
* controller has a secure connection to the device and control security has
|
|
69
|
+
* been turned on. If this is not the case the method will return DeviceError.
|
|
70
|
+
*
|
|
71
|
+
* @method OcaSecurityManager#AddPreSharedKey
|
|
72
|
+
* @param {string} identity
|
|
73
|
+
* @param {Uint8Array} key
|
|
74
|
+
*
|
|
75
|
+
* @returns {Promise<void>}
|
|
76
|
+
*/
|
|
77
|
+
AddPreSharedKey(identity: string, key: Uint8Array): Promise<void>;
|
|
78
|
+
|
|
57
79
|
/**
|
|
58
80
|
* Deletes a pre-shared key (identified by the passed identity) on the device.
|
|
59
81
|
* After deleting the pre-shared key the device will no longer be able to
|
|
@@ -68,26 +90,4 @@ export declare class OcaSecurityManager extends OcaManager {
|
|
|
68
90
|
* @returns {Promise<void>}
|
|
69
91
|
*/
|
|
70
92
|
DeletePreSharedKey(identity: string): Promise<void>;
|
|
71
|
-
|
|
72
|
-
/**
|
|
73
|
-
* Disables security of control data (OCA messages). After calling this method
|
|
74
|
-
* all OCA messages can be sent and received both on insecure and secure
|
|
75
|
-
* connections. The return value indicates whether the operation succeeded. If
|
|
76
|
-
* the operation fails security is not disabled.
|
|
77
|
-
*
|
|
78
|
-
* @method OcaSecurityManager#DisableControlSecurity
|
|
79
|
-
* @returns {Promise<void>}
|
|
80
|
-
*/
|
|
81
|
-
DisableControlSecurity(): Promise<void>;
|
|
82
|
-
|
|
83
|
-
/**
|
|
84
|
-
* Enables security of control data (OCA messages). After calling this method
|
|
85
|
-
* all OCA messages are sent and received using a secure connection. The
|
|
86
|
-
* return value indicates whether the operation succeeded. If the operation
|
|
87
|
-
* fails security is not enabled.
|
|
88
|
-
*
|
|
89
|
-
* @method OcaSecurityManager#EnableControlSecurity
|
|
90
|
-
* @returns {Promise<void>}
|
|
91
|
-
*/
|
|
92
|
-
EnableControlSecurity(): Promise<void>;
|
|
93
93
|
}
|
|
@@ -26,27 +26,32 @@ export const OcaSecurityManager = make_control_class(
|
|
|
26
26
|
2,
|
|
27
27
|
OcaManager,
|
|
28
28
|
[
|
|
29
|
-
['
|
|
29
|
+
['EnableControlSecurity', 3, 1, [], []],
|
|
30
|
+
['DisableControlSecurity', 3, 2, [], []],
|
|
30
31
|
['ChangePreSharedKey', 3, 3, [OcaString, OcaBlob], []],
|
|
32
|
+
['AddPreSharedKey', 3, 4, [OcaString, OcaBlob], []],
|
|
31
33
|
['DeletePreSharedKey', 3, 5, [OcaString], []],
|
|
32
|
-
['DisableControlSecurity', 3, 2, [], []],
|
|
33
|
-
['EnableControlSecurity', 3, 1, [], []],
|
|
34
34
|
],
|
|
35
35
|
[['secureControlData', [OcaBoolean], 3, 1, false, false, null]],
|
|
36
36
|
[]
|
|
37
37
|
);
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
* been turned on. If this is not the case the method will return DeviceError.
|
|
40
|
+
* Enables security of control data (OCA messages). After calling this method
|
|
41
|
+
* all OCA messages are sent and received using a secure connection. The return
|
|
42
|
+
* value indicates whether the operation succeeded. If the operation fails
|
|
43
|
+
* security is not enabled.
|
|
45
44
|
*
|
|
46
|
-
* @method OcaSecurityManager#
|
|
47
|
-
* @
|
|
48
|
-
|
|
45
|
+
* @method OcaSecurityManager#EnableControlSecurity
|
|
46
|
+
* @returns {Promise<void>}
|
|
47
|
+
*/
|
|
48
|
+
/**
|
|
49
|
+
* Disables security of control data (OCA messages). After calling this method
|
|
50
|
+
* all OCA messages can be sent and received both on insecure and secure
|
|
51
|
+
* connections. The return value indicates whether the operation succeeded. If
|
|
52
|
+
* the operation fails security is not disabled.
|
|
49
53
|
*
|
|
54
|
+
* @method OcaSecurityManager#DisableControlSecurity
|
|
50
55
|
* @returns {Promise<void>}
|
|
51
56
|
*/
|
|
52
57
|
/**
|
|
@@ -61,6 +66,19 @@ export const OcaSecurityManager = make_control_class(
|
|
|
61
66
|
*
|
|
62
67
|
* @returns {Promise<void>}
|
|
63
68
|
*/
|
|
69
|
+
/**
|
|
70
|
+
* Adds a pre-shared key (identified by the passed identity) to the device. By
|
|
71
|
+
* having multiple PSKs the device is able to participate in multiple secure
|
|
72
|
+
* systems. Note that adding a PSK over the network will only work if the
|
|
73
|
+
* controller has a secure connection to the device and control security has
|
|
74
|
+
* been turned on. If this is not the case the method will return DeviceError.
|
|
75
|
+
*
|
|
76
|
+
* @method OcaSecurityManager#AddPreSharedKey
|
|
77
|
+
* @param {string} identity
|
|
78
|
+
* @param {Uint8Array} key
|
|
79
|
+
*
|
|
80
|
+
* @returns {Promise<void>}
|
|
81
|
+
*/
|
|
64
82
|
/**
|
|
65
83
|
* Deletes a pre-shared key (identified by the passed identity) on the device.
|
|
66
84
|
* After deleting the pre-shared key the device will no longer be able to
|
|
@@ -74,24 +92,6 @@ export const OcaSecurityManager = make_control_class(
|
|
|
74
92
|
*
|
|
75
93
|
* @returns {Promise<void>}
|
|
76
94
|
*/
|
|
77
|
-
/**
|
|
78
|
-
* Disables security of control data (OCA messages). After calling this method
|
|
79
|
-
* all OCA messages can be sent and received both on insecure and secure
|
|
80
|
-
* connections. The return value indicates whether the operation succeeded. If
|
|
81
|
-
* the operation fails security is not disabled.
|
|
82
|
-
*
|
|
83
|
-
* @method OcaSecurityManager#DisableControlSecurity
|
|
84
|
-
* @returns {Promise<void>}
|
|
85
|
-
*/
|
|
86
|
-
/**
|
|
87
|
-
* Enables security of control data (OCA messages). After calling this method
|
|
88
|
-
* all OCA messages are sent and received using a secure connection. The return
|
|
89
|
-
* value indicates whether the operation succeeded. If the operation fails
|
|
90
|
-
* security is not enabled.
|
|
91
|
-
*
|
|
92
|
-
* @method OcaSecurityManager#EnableControlSecurity
|
|
93
|
-
* @returns {Promise<void>}
|
|
94
|
-
*/
|
|
95
95
|
/**
|
|
96
96
|
* This event is emitted when the property ``secureControlData`` changes in the remote object.
|
|
97
97
|
* The property ``secureControlData`` is described in the AES70 standard as follows.
|
|
@@ -41,20 +41,15 @@ import { OcaAgent } from './OcaAgent';
|
|
|
41
41
|
* @class OcaStreamConnector
|
|
42
42
|
*/
|
|
43
43
|
export declare class OcaStreamConnector extends OcaAgent {
|
|
44
|
-
/**
|
|
45
|
-
* This event is emitted whenever IDAdvertised changes.
|
|
46
|
-
*/
|
|
47
|
-
OnIDAdvertisedChanged: PropertyEvent<Uint8Array>;
|
|
48
|
-
|
|
49
44
|
/**
|
|
50
45
|
* This event is emitted whenever OwnerNetwork changes.
|
|
51
46
|
*/
|
|
52
47
|
OnOwnerNetworkChanged: PropertyEvent<number>;
|
|
53
48
|
|
|
54
49
|
/**
|
|
55
|
-
* This event is emitted whenever
|
|
50
|
+
* This event is emitted whenever IDAdvertised changes.
|
|
56
51
|
*/
|
|
57
|
-
|
|
52
|
+
OnIDAdvertisedChanged: PropertyEvent<Uint8Array>;
|
|
58
53
|
|
|
59
54
|
/**
|
|
60
55
|
* This event is emitted whenever SourceOrSink changes.
|
|
@@ -62,39 +57,43 @@ export declare class OcaStreamConnector extends OcaAgent {
|
|
|
62
57
|
OnSourceOrSinkChanged: PropertyEvent<OcaNetworkMediaSourceOrSink>;
|
|
63
58
|
|
|
64
59
|
/**
|
|
65
|
-
* This event is emitted whenever
|
|
60
|
+
* This event is emitted whenever Streams changes.
|
|
66
61
|
*/
|
|
67
|
-
|
|
62
|
+
OnStreamsChanged: PropertyEvent<Map<number, OcaStream>>;
|
|
68
63
|
|
|
69
64
|
/**
|
|
70
|
-
* This event is emitted whenever
|
|
65
|
+
* This event is emitted whenever Pins changes.
|
|
71
66
|
*/
|
|
72
|
-
|
|
67
|
+
OnPinsChanged: PropertyEvent<Map<number, number>>;
|
|
68
|
+
|
|
69
|
+
/**
|
|
70
|
+
* This event is emitted whenever Status changes.
|
|
71
|
+
*/
|
|
72
|
+
OnStatusChanged: PropertyEvent<OcaStreamConnectorStatus>;
|
|
73
73
|
|
|
74
74
|
constructor(objectNumber: number, device: RemoteDevice);
|
|
75
75
|
|
|
76
76
|
/**
|
|
77
|
-
*
|
|
78
|
-
* operation.
|
|
79
|
-
*
|
|
80
|
-
* @method OcaStreamConnector#ConnectStream
|
|
81
|
-
* @param {IOcaStream} Stream
|
|
77
|
+
* Gets the object number of the **OcaStreamNetwork** object to which this
|
|
78
|
+
* connector belongs. Return status indicates success of operation.
|
|
82
79
|
*
|
|
80
|
+
* @method OcaStreamConnector#GetOwnerNetwork
|
|
83
81
|
* @returns {Promise<number>}
|
|
84
82
|
* A promise which resolves to a single value of type ``number``.
|
|
85
83
|
*/
|
|
86
|
-
|
|
84
|
+
GetOwnerNetwork(): Promise<number>;
|
|
87
85
|
|
|
88
86
|
/**
|
|
89
|
-
*
|
|
90
|
-
* of operation.
|
|
87
|
+
* Sets the object number of the **OcaStreamNetwork** object to which this
|
|
88
|
+
* connector belongs. Return status indicates success of operation. Only
|
|
89
|
+
* implemented for reconfigurable devices.
|
|
91
90
|
*
|
|
92
|
-
* @method OcaStreamConnector#
|
|
93
|
-
* @param {number}
|
|
91
|
+
* @method OcaStreamConnector#SetOwnerNetwork
|
|
92
|
+
* @param {number} Network
|
|
94
93
|
*
|
|
95
94
|
* @returns {Promise<void>}
|
|
96
95
|
*/
|
|
97
|
-
|
|
96
|
+
SetOwnerNetwork(Network: number): Promise<void>;
|
|
98
97
|
|
|
99
98
|
/**
|
|
100
99
|
* Gets the value of the IDAdvertised property. Return status indicates
|
|
@@ -107,24 +106,15 @@ export declare class OcaStreamConnector extends OcaAgent {
|
|
|
107
106
|
GetIDAdvertised(): Promise<Uint8Array>;
|
|
108
107
|
|
|
109
108
|
/**
|
|
110
|
-
*
|
|
111
|
-
*
|
|
109
|
+
* Sets the value of the IDAdvertised property. Return status indicates
|
|
110
|
+
* success of operation.
|
|
112
111
|
*
|
|
113
|
-
* @method OcaStreamConnector#
|
|
114
|
-
* @
|
|
115
|
-
* A promise which resolves to a single value of type ``number``.
|
|
116
|
-
*/
|
|
117
|
-
GetOwnerNetwork(): Promise<number>;
|
|
118
|
-
|
|
119
|
-
/**
|
|
120
|
-
* Gets the list of object numbers of **OcaNetworkSignalChannel** objects
|
|
121
|
-
* connected to this connector. Return status indicates success of operation.
|
|
112
|
+
* @method OcaStreamConnector#SetIDAdvertised
|
|
113
|
+
* @param {Uint8Array} IDAdvertised
|
|
122
114
|
*
|
|
123
|
-
* @
|
|
124
|
-
* @returns {Promise<Map<number, number>>}
|
|
125
|
-
* A promise which resolves to a single value of type ``Map<number, number>``.
|
|
115
|
+
* @returns {Promise<void>}
|
|
126
116
|
*/
|
|
127
|
-
|
|
117
|
+
SetIDAdvertised(IDAdvertised: Uint8Array): Promise<void>;
|
|
128
118
|
|
|
129
119
|
/**
|
|
130
120
|
* Gets the value of the SourceOrSink property. Return status indicates
|
|
@@ -137,58 +127,68 @@ export declare class OcaStreamConnector extends OcaAgent {
|
|
|
137
127
|
GetSourceOrSink(): Promise<OcaNetworkMediaSourceOrSink>;
|
|
138
128
|
|
|
139
129
|
/**
|
|
140
|
-
*
|
|
141
|
-
* operation.
|
|
130
|
+
* Sets the value of the SourceOrSink property. Return status indicates
|
|
131
|
+
* success of operation. Only implemented for reconfigurable devices. Note
|
|
132
|
+
* that this method can only be called when the SignalChannels property is
|
|
133
|
+
* empty, i.e. does not contain any actual channels.
|
|
142
134
|
*
|
|
143
|
-
* @method OcaStreamConnector#
|
|
144
|
-
* @
|
|
145
|
-
*
|
|
135
|
+
* @method OcaStreamConnector#SetSourceOrSink
|
|
136
|
+
* @param {IOcaNetworkMediaSourceOrSink} SourceOrSink
|
|
137
|
+
*
|
|
138
|
+
* @returns {Promise<void>}
|
|
146
139
|
*/
|
|
147
|
-
|
|
140
|
+
SetSourceOrSink(SourceOrSink: IOcaNetworkMediaSourceOrSink): Promise<void>;
|
|
148
141
|
|
|
149
142
|
/**
|
|
150
|
-
*
|
|
151
|
-
*
|
|
143
|
+
* Connects a stream to this connector. Return status indicates success of
|
|
144
|
+
* operation.
|
|
152
145
|
*
|
|
153
|
-
* @method OcaStreamConnector#
|
|
154
|
-
* @
|
|
155
|
-
*
|
|
146
|
+
* @method OcaStreamConnector#ConnectStream
|
|
147
|
+
* @param {IOcaStream} Stream
|
|
148
|
+
*
|
|
149
|
+
* @returns {Promise<number>}
|
|
150
|
+
* A promise which resolves to a single value of type ``number``.
|
|
156
151
|
*/
|
|
157
|
-
|
|
152
|
+
ConnectStream(Stream: IOcaStream): Promise<number>;
|
|
158
153
|
|
|
159
154
|
/**
|
|
160
|
-
*
|
|
161
|
-
*
|
|
155
|
+
* Disconnects a stream from this connector. Return status indicates success
|
|
156
|
+
* of operation.
|
|
162
157
|
*
|
|
163
|
-
* @method OcaStreamConnector#
|
|
164
|
-
* @param {
|
|
158
|
+
* @method OcaStreamConnector#DisconnectStream
|
|
159
|
+
* @param {number} StreamID
|
|
165
160
|
*
|
|
166
161
|
* @returns {Promise<void>}
|
|
167
162
|
*/
|
|
168
|
-
|
|
163
|
+
DisconnectStream(StreamID: number): Promise<void>;
|
|
169
164
|
|
|
170
165
|
/**
|
|
171
|
-
*
|
|
172
|
-
*
|
|
173
|
-
* implemented for reconfigurable devices.
|
|
174
|
-
*
|
|
175
|
-
* @method OcaStreamConnector#SetOwnerNetwork
|
|
176
|
-
* @param {number} Network
|
|
166
|
+
* Gets the map of OcaStream items connected to this connector. Return status
|
|
167
|
+
* indicates success of operation.
|
|
177
168
|
*
|
|
178
|
-
* @
|
|
169
|
+
* @method OcaStreamConnector#GetStreams
|
|
170
|
+
* @returns {Promise<Map<number, OcaStream>>}
|
|
171
|
+
* A promise which resolves to a single value of type ``Map<number, OcaStream>``.
|
|
179
172
|
*/
|
|
180
|
-
|
|
173
|
+
GetStreams(): Promise<Map<number, OcaStream>>;
|
|
181
174
|
|
|
182
175
|
/**
|
|
183
|
-
*
|
|
184
|
-
*
|
|
185
|
-
* that this method can only be called when the SignalChannels property is
|
|
186
|
-
* empty, i.e. does not contain any actual channels.
|
|
176
|
+
* Gets the list of object numbers of **OcaNetworkSignalChannel** objects
|
|
177
|
+
* connected to this connector. Return status indicates success of operation.
|
|
187
178
|
*
|
|
188
|
-
* @method OcaStreamConnector#
|
|
189
|
-
* @
|
|
179
|
+
* @method OcaStreamConnector#GetPins
|
|
180
|
+
* @returns {Promise<Map<number, number>>}
|
|
181
|
+
* A promise which resolves to a single value of type ``Map<number, number>``.
|
|
182
|
+
*/
|
|
183
|
+
GetPins(): Promise<Map<number, number>>;
|
|
184
|
+
|
|
185
|
+
/**
|
|
186
|
+
* Gets the value of the Status property. Return status indicates success of
|
|
187
|
+
* operation.
|
|
190
188
|
*
|
|
191
|
-
* @
|
|
189
|
+
* @method OcaStreamConnector#GetStatus
|
|
190
|
+
* @returns {Promise<OcaStreamConnectorStatus>}
|
|
191
|
+
* A promise which resolves to a single value of type :class:`OcaStreamConnectorStatus`.
|
|
192
192
|
*/
|
|
193
|
-
|
|
193
|
+
GetStatus(): Promise<OcaStreamConnectorStatus>;
|
|
194
194
|
}
|