Skip to content

Commit c828895

Browse files
1 parent de18830 commit c828895

File tree

2 files changed

+70
-0
lines changed

2 files changed

+70
-0
lines changed
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<a name="module_@mafalda-sfu/mediasoup-vertical-proxy-cli"></a>
2+
3+
## @mafalda-sfu/mediasoup-vertical-proxy-cli
4+
5+
* [@mafalda-sfu/mediasoup-vertical-proxy-cli](#module_@mafalda-sfu/mediasoup-vertical-proxy-cli)
6+
* [module.exports](#exp_module_@mafalda-sfu/mediasoup-vertical-proxy-cli--module.exports)
7+
* [new module.exports(url, options)](#new_module_@mafalda-sfu/mediasoup-vertical-proxy-cli--module.exports_new)
8+
9+
<a name="exp_module_@mafalda-sfu/mediasoup-vertical-proxy-cli--module.exports"></a>
10+
11+
### module.exports ⏏
12+
CLI for [Mediasoup proxy](https://mafalda.io/Mediasoup-vertical-proxy-CLI).
13+
14+
**Kind**: Exported class
15+
<a name="new_module_@mafalda-sfu/mediasoup-vertical-proxy-cli--module.exports_new"></a>
16+
17+
#### new module.exports(url, options)
18+
Creates a new instance of the [MediasoupClusterCli](MediasoupClusterCli) class.
19+
20+
21+
| Param | Type | Description |
22+
| --- | --- | --- |
23+
| url | | remote Mediasoup servers URL |
24+
| options | <code>object</code> | The options for the [MediasoupClusterCli](MediasoupClusterCli) instance. // ROPE WebSocket server |
25+
| [options.cert] | <code>string</code> | Path to the certificate file |
26+
| [options.key] | <code>string</code> | Path to the key file |
27+
| [options.pfx] | <code>string</code> | Path to the PFX file // Remote Mediasoup |
28+
| [options.announcedIp] | <code>string</code> | Announced IP address |
29+
| [options.appDataManager] | <code>AppDataManager</code> | App data manager |
30+
| [options.extraMethodsFactory] | <code>function</code> | Extra methods factory |
31+
| [options.listenIps] | <code>string</code> \| <code>Array.&lt;string&gt;</code> | List of listening IP addresses // ROPE server |
32+
| [options.connectionPayload] | <code>function</code> | Connection payload |
33+
| [options.logResponseErrors] | <code>boolean</code> | If we should log response errors // JsonRpc |
34+
| [options.errorConstructors] | <code>object</code> | Map of error constructors |
35+
| [options.onWarn] | <code>function</code> | Function to call on warnings |
36+
| [options.sendFullErrors] | <code>boolean</code> | If we should send full errors // Rpc |
37+
| [options.logMessages] | <code>boolean</code> | If we should log messages |
38+
| [options.send] | <code>function</code> | Function to send messages |
39+
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Mediasoup vertical proxy CLI
2+
3+
[![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/mafalda-bot/27d772a9a3a8a945b34fd9676de40486/raw/Mediasoup-vertical-proxy-CLI.json)](https://gist.github.com/Mafalda-bot/27d772a9a3a8a945b34fd9676de40486#file-Mediasoup-vertical-proxy-CLI-json)
4+
5+
Remote Mediasoup proxy server that provides access to another instance of a
6+
[Remote Mediasoup server](https://mafalda.io/Remote-Mediasoup-server/) or a
7+
`Remote Mediasoup` protocol compatible server.
8+
9+
## Install
10+
11+
```sh
12+
npm install @mafalda-sfu/mediasoup-vertical-proxy-cli
13+
```
14+
15+
Alternatively, you can use `npx` to run the CLI without installing it:
16+
17+
```sh
18+
npx @mafalda-sfu/mediasoup-vertical-proxy-cli
19+
```
20+
21+
## Javascript API
22+
23+
See [API documentation](https://mafalda.io/Mediasoup-vertical-proxy-CLI/API).
24+
25+
## CLI usage
26+
27+
```sh
28+
mediasoup-vertical-proxy-cli --help
29+
```
30+
31+
Options are the same of the API.

0 commit comments

Comments
 (0)