Provides support for creating and using Wica streams.
Classes
- StreamManager
Type Definitions
Parameters:
| Name |
Type |
Description |
metadataMap |
Object.<WicaChannelName, WicaChannelMetadata>
|
Map of channel names and their
associated metadata. See WicaChannelName and
WicaChannelMetadata. |
Returns:
-
Type
-
void
ChannelValuesUpdatedCallback(valueMap) → {void}
Parameters:
| Name |
Type |
Description |
valueMap |
Object.<WicaChannelName, Array.<WicaChannelValue>>
|
Map of channel names and array of
associated values that have been received for the channel in chronological order.
See WicaChannelName and
WicaChannelValue. |
Returns:
-
Type
-
void
StreamClosedCallback(id) → {void}
Callback invoked when the stream is closed (that's to say when the connection with the server
has been shut down).
Parameters:
| Name |
Type |
Description |
id |
string
|
The ID of the stream that was closed. This information is useful mainly
for debug purposes (for example for outputting a message to the console). |
Returns:
-
Type
-
void
StreamConnectCallback(count) → {void}
Callback invoked when the stream connect sequence begins.
Parameters:
| Name |
Type |
Description |
count |
number
|
The connection request counter. The counter, set to 1 initially, increments
after every stream connection attempt. This information is useful mainly for debug purposes (for
example for outputting a message to the console). |
Returns:
-
Type
-
void
StreamOpenedCallback(id) → {void}
Callback invoked when the stream is opened (that's to say when the connection with the server
has been successfully established).
Parameters:
| Name |
Type |
Description |
id |
string
|
The ID of the stream that was opened. This information is useful mainly
for debug purposes (for example for outputting a message to the console). |
Returns:
-
Type
-
void