@ovos-media/play-live-realtime-ws-client

ovos Play Live Realtime WebSocket Client

This is a WebSocket browser-side client for ovos Play Live Realtime server.

The client is optimized for data transfer size, the package is compressed in high rate. It's suitable especially for mobile platform.

Usage

Establish connection to the server

realtime.init(params, callback);

Example with possible parameters:

realtime.init({
  host: host,
  port: port,
  user: {}, // optional, user defined json data
  handshakeCallback : function(data){} // optional, handshake callback function
}, function() {
  console.log('success');
});

Send message with callback

realtime.request(route, msg, callback);

Example:

realtime.request("connector.entryHandler.ping", {
  foo: "bar"
}, function(response) {
  console.log(response);
});

Send message without callback

realtime.notify(route, msg);

Example:

realtime.request("connector.entryHandler.ping", {
  foo: "bar"
});

Receive message from the server

realtime.on(route, callback);

Example:

realtime.on('status.info', function(data) {
  console.log(data);
});

Authors

• NetEase, Inc.

• Krzysztof Gutkowski - [e-mail]

License

Copyright (c) 2012-2018 NetEase, Inc. and other contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.