Skip to content
This repository has been archived by the owner on Nov 13, 2024. It is now read-only.

Commit

Permalink
Fix API links (#33)
Browse files Browse the repository at this point in the history
  • Loading branch information
sgfn authored Sep 18, 2023
1 parent 74e5a71 commit f1ca46a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/getting_started/components/hls.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ Creates HLS playlist that is ready to be broadcasted via CDN.
## Requirements

* The [Room](../../introduction/basic_concepts\#room) in which the HLS component is created must have the video codec set to H264.
See [API](../../api_reference/rest_api#tag/room/operation/JellyfishWeb.RoomController.create) for more information.
See [API](../../api_reference/rest_api#tag/room/operation/create_room) for more information.
* Max 1 HLS component allowed per room.

## Configuration options

See [API](../../api_reference/rest_api#tag/component/operation/JellyfishWeb.ComponentController.create) for more information.
See [API](../../api_reference/rest_api#tag/room/operation/add_component) for more information.

### Optional

Expand Down
4 changes: 2 additions & 2 deletions docs/getting_started/components/rtsp.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ Supports H264 streams only.
## Requirements
* If the [Room](../../introduction/basic_concepts\#room) in which the RTSP component is created enforces a video codec,
it must be set to H264.
See [API](../../api_reference/rest_api#tag/room/operation/JellyfishWeb.RoomController.create) for more information.
See [API](../../api_reference/rest_api#tag/room/operation/create_room) for more information.

## Configuration options

See [API](../../api_reference/rest_api#tag/component/operation/JellyfishWeb.ComponentController.create) for more information.
See [API](../../api_reference/rest_api#tag/room/operation/add_component) for more information.

### Required

Expand Down
4 changes: 2 additions & 2 deletions docs/getting_started/peers/webrtc.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ WebRTC peer allows you to connect to Jellyfish via WebRTC standard.

## Configuration options

See [API](../../api_reference/rest_api#tag/peer/operation/JellyfishWeb.PeerController.create) for more information.
See [API](../../api_reference/rest_api#tag/room/operation/add_peer) for more information.

### Optional

* `enableSimulcast` (boolean, default: true) - Enables the peer to use simulcast

## Env variables:
## Env variables

* `WEBRTC_USED` - has to be `true` if WebRTC peers will be used
* `INTEGRATED_TURN_LISTEN_IP` - the IP address on which TURN servers will listen.
Expand Down

0 comments on commit f1ca46a

Please sign in to comment.