@mafalda-sfu/mediasoup-cluster-cli
module.exports ⏏
CLI for Mediasoup cluster.
new module.exports(options)
Creates a new instance of the MediasoupClusterCli class.
| Param | Type | Description | ||
|---|---|---|---|---|
| options | object |
The options for the MediasoupClusterCli instance. // Mediasoup Cluster CLI | ||
| [options.clients] | Array.<string> |
List of remote Mediasoup servers URLs // ROPE WebSocket server | ||
| [options.cert] | string |
Path to the certificate file | ||
| [options.key] | string |
Path to the key file | ||
| [options.pfx] | string |
Path to the PFX file // Remote Mediasoup | ||
| [options.announcedIp] | string |
Announced IP address | ||
| [options.appDataManager] | AppDataManager |
App data manager | ||
| [options.extraMethodsFactory] | function |
Extra methods factory | ||
| [options.listenIps] |
|
List of listening IP addresses // ROPE server | ||
| [options.connectionPayload] | function |
Connection payload | ||
| [options.logResponseErrors] | boolean |
If we should log response errors // JsonRpc | ||
| [options.errorConstructors] | object |
Map of error constructors | ||
| [options.onWarn] | function |
Function to call on warnings | ||
| [options.sendFullErrors] | boolean |
If we should send full errors // Rpc | ||
| [options.logMessages] | boolean |
If we should log messages | ||
| [options.send] | function |
Function to send messages |