diff options
| author | Joas Schilling <coding@schilljs.com> | 2020-05-25 11:51:16 +0300 |
|---|---|---|
| committer | backportbot[bot] <backportbot[bot]@users.noreply.github.com> | 2020-05-26 13:17:48 +0300 |
| commit | 1cf3d5b74befa5dc5db6377f510b885043e8b3ee (patch) | |
| tree | 28abdb58e713ab6b23205c8fb2a67861bcd4fc76 /docs | |
| parent | 6a33ea1594f10da5f6b3acce8bfa29827989d967 (diff) | |
Add docs for the HPB conversation clustering
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/constants.md | 6 | ||||
| -rw-r--r-- | docs/internal-signaling.md | 23 |
2 files changed, 24 insertions, 5 deletions
diff --git a/docs/constants.md b/docs/constants.md index 86ecff848..fe007a44b 100644 --- a/docs/constants.md +++ b/docs/constants.md @@ -40,3 +40,9 @@ title: Constants ## Webinary lobby states * `0` no lobby * `1` lobby for non moderators + + +## Signaling modes +* `internal` No external signaling server is used +* `external` A single external signaling server is used +* `conversation_cluster` A external signaling server is assigned per conversation diff --git a/docs/internal-signaling.md b/docs/internal-signaling.md index 118995786..7e28e6c6e 100644 --- a/docs/internal-signaling.md +++ b/docs/internal-signaling.md @@ -1,6 +1,4 @@ -# Internal signaling API - -See [External Signaling API](standalone-signaling-api-v1.md) for the Signaling of the High-Performance Backend. +# Signaling API Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` @@ -12,10 +10,19 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` field | type | Description ------|------|------------ - `stunservers` | array | STUN servers - `turnservers` | array | TURN servers + `token` | string | The conversation to get the signaling settings for + +* Response: + + field | type | Description + ------|------|------------ + `signalingMode` | string | See [Signaling modes](constants.md#Signaling_modes) + `userId` | string | Current user id + `hideWarning` | string | Don't show a performance warning although internal signaling is used `server` | string | URL of the external signaling server `ticket` | string | Ticket for the external signaling server + `stunservers` | array | STUN servers + `turnservers` | array | TURN servers - STUN server @@ -37,4 +44,10 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` + `200 OK` + `404 Not Found` +### Internal signaling API + +Todo + ### External signaling API + +See [External signaling API](standalone-signaling-api-v1.md) for the Signaling of the High-Performance Backend. |