Classes
Classes
-
RemoteMediasoupClient ⇐
EventEmitter
Functions
RemoteMediasoupClient ⇐ EventEmitter
Kind: global class
Summary: Connection class
Extends: EventEmitter
See: Remote Mediasoup client
Author: Jesús Leganés-Combarro ‘piranna’ piranna@gmail.com
-
RemoteMediasoupClient ⇐
EventEmitter
new RemoteMediasoupClient()
Facade class to don’t give access to RopeClient._connection to the user.
RemoteMediasoupClient.module.exports
Kind: static class of RemoteMediasoupClient
Summary: Creates an instance of RemoteMediasoupClient.
Author: Jesús Leganés-Combarro ‘piranna’ piranna@gmail.com
new module.exports([url], [options])
| Param | Type | Description | ||
|---|---|---|---|---|
| [url] |
|
URL of the Remote Mediasoup server. If it’s not provided, the RemoteMediasoupClient object will remain in closed state. | ||
| [options] | object |
Options for the connection |
RemoteMediasoupClient.mediasoup ⇒
This object is API compatible with the
Mediasoup API
provided by the
Mediasoup package.
In case there’s a disconnection, it will reconnect transparently by itself. The object will preserve its state so it can be accessed and requested while it’s disconnected, and will update and synchronize its state automatically.
Kind: static property of RemoteMediasoupClient
Summary: Get a mediasoup-like object.
Returns: object exposing the same API of Mediasoup
Read only: true
See: https://mediasoup.org/documentation/v3/mediasoup/api/
Author: Jesús Leganés-Combarro ‘piranna’ piranna@gmail.com
RemoteMediasoupClient.readyState ⇒ number
In addition of the states defined for the WebSocket connection
readyState
property, this property can have a ‘connected’ state
to indicate that the
Remote Mediasoup server
payload with its internal state has been received and sync’ed, and so the
Remote Mediasoup connection has been fully established.
Kind: static property of RemoteMediasoupClient
Summary: Get the current readyState of the client.
Returns: number - The current readyState of the client
Read only: true
See: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/readyState
Author: Jesús Leganés-Combarro ‘piranna’ piranna@gmail.com
RemoteMediasoupClient.close()
If it’s already closed, this method does nothing
Kind: static method of RemoteMediasoupClient
Summary: Close the client.
Author: Jesús Leganés-Combarro ‘piranna’ piranna@gmail.com
RemoteMediasoupClient.open([url]) ⇒ RemoteMediasoupClient
If it’s already open, it will throw an exception
Kind: static method of RemoteMediasoupClient
Summary: Open the client to the given URL.
Returns: RemoteMediasoupClient - the Remote Mediasoup client itself
Author: Jesús Leganés-Combarro ‘piranna’ piranna@gmail.com
| Param | Type | Description |
|---|---|---|
| [url] | string |
URL of the Remote Mediasoup server. If not provided, it will re-open the connection to the last provided URL, and if was not provided, it will throw an exception |
changeFactory(root0)
Kind: global function
| Param |
|---|
| root0 |
| root0.appDatas |
| root0.deserialize |