Classes
Classes
-
RemoteMediasoupClientMock ⇐
EventEmitter
Constants
- OPEN
- CLOSED
-
CONNECTED :
number
-
Additional state to the WebSocket connection readyState property 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.
RemoteMediasoupClientMock ⇐ EventEmitter
Kind: global class
Summary: Remote Mediasoup client mock class
Extends: EventEmitter
Date: 30/04/2023
See: Remote Mediasoup client
Author: Jesús Leganés-Combarro ‘piranna’ piranna@gmail.com
-
RemoteMediasoupClientMock ⇐
EventEmitter
RemoteMediasoupClientMock.module.exports
Kind: static class of RemoteMediasoupClientMock
Summary: Creates an instance of RemoteMediasoupClientMock.
Date: 30/04/2023
Author: Jesús Leganés-Combarro ‘piranna’ piranna@gmail.com
new module.exports([url], [WebSocket])
Param | Type | Description | ||
---|---|---|---|---|
[url] |
|
URL of the Remote Mediasoup server. If it’s not provided, the RemoteMediasoupClientMock object will remain in closed state. | ||
[WebSocket] | object |
WebSocket class to be used to create the connections with the Remote Mediasoup server |
RemoteMediasoupClientMock.mediasoup
This object is API compatible with the
Mediasoup API
provided by the
Mediasoup
package.
Kind: static property of RemoteMediasoupClientMock
Summary: Get a reference to the mediasoup
package exported object.
Read only: true
Date: 30/04/2023
See: https://mediasoup.org/documentation/v3/mediasoup/api/
Author: Jesús Leganés-Combarro ‘piranna’ piranna@gmail.com
RemoteMediasoupClientMock.readyState
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 RemoteMediasoupClientMock
Summary: Get the current readyState
of the client.
Read only: true
Date: 30/04/2023
See: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/readyState
Author: Jesús Leganés-Combarro ‘piranna’ piranna@gmail.com
RemoteMediasoupClientMock.close()
If it’s already closed, this method does nothing
Kind: static method of RemoteMediasoupClientMock
Summary: Close the client.
Date: 30/04/2023
Author: Jesús Leganés-Combarro ‘piranna’ piranna@gmail.com
RemoteMediasoupClientMock.open([url]) ⇒ RemoteMediasoupClientMock
If it’s already open, it will throw an exception
Kind: static method of RemoteMediasoupClientMock
Summary: Open the client to the given URL.
Date: 30/04/2023
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 |
OPEN
Kind: global constant
See: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/readyState#value
CLOSED
Kind: global constant
See: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/readyState#value
CONNECTED : number
Additional state to the WebSocket connection
readyState
property 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: global constant
Default: 4