Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jan 10, 2025
1 parent b6ebe31 commit 5c855fe
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 15 deletions.
9 changes: 0 additions & 9 deletions docs/Mediasoup-server-CLI/API.md
Original file line number Diff line number Diff line change
@@ -1,9 +0,0 @@
<a name="close"></a>

## close(callback)
**Kind**: global function

| Param | Type |
| --- | --- |
| callback | <code>\*</code> |

10 changes: 4 additions & 6 deletions docs/Mediasoup-server-CLI/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Remote Mediasoup server CLI
# Mediasoup server CLI

[![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/mafalda-bot/27d772a9a3a8a945b34fd9676de40486/raw/Remote-Mediasoup-server-CLI.json)](https://gist.github.com/Mafalda-bot/27d772a9a3a8a945b34fd9676de40486#file-Remote-Mediasoup-server-CLI-json)
[![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/mafalda-bot/27d772a9a3a8a945b34fd9676de40486/raw/Mediasoup-server-CLI.json)](https://gist.github.com/Mafalda-bot/27d772a9a3a8a945b34fd9676de40486#file-Mediasoup-server-CLI-json)

[Mediasoup](https://mediasoup.org) as a Service

This CLI tool starts a WebSocket server to offer access to a Mediasoup instance,
to be able to use it remotely in combination of
[Remote Mediasoup client](https://mafalda.io/Remote-Mediasoup-client).
[Mediasoup client](https://mafalda.io/Mediasoup-client).

## CLI usage

Expand All @@ -26,10 +26,8 @@ You can gracefully stop the server with `Ctrl+C` or `Ctrl+D` (`SIGINT` and
## API

Module exports a single function with signature
`async function(mediasoup, {closeOwnWorkers, ...options} = {})`:
`async function({argv: [...]} = {})`:

- `mediasoup`: object with same API than exported by
[Mediasoup](https://mediasoup.org) package.
- `[options]`: obtional options bag
- `[argv]`: obtional array of strings, arguments to parse. Same ones of the
[CLI usage](#cli-usage), including leading dashes on keys, and being key and
Expand Down

0 comments on commit 5c855fe

Please sign in to comment.