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

Commit

Permalink
chore(docs): added more information about listen and aliases
Browse files Browse the repository at this point in the history
  • Loading branch information
Roverr committed Apr 5, 2020
1 parent c6f3a6b commit 6b1b915
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,17 @@ docker run -v `pwd`/rtsp-stream.yml:/app/rtsp-stream.yml \

More commands around docker at [debugging](../debugging#Docker)

```yaml
listen:
- alias: camera1
uri: rtp://user:pass@host/camera/123
enabled: false
```
**listen** is used for preloading streams into the system. While ID generation here is not possible, the introduction of aliases helps in overcoming this issue. Listen is an array of streams to preload into the system.
* alias - Used as the reference when starting a stream
* uri - The URI for the camera source
* enabled - Indicates if the system should load the given record or not
### POST /start
Expand All @@ -97,6 +108,9 @@ Response:
}
```

**alias** is now available as a secondary reference for the stream. This means that you can reference a stream, by using its alias instead of its ID.<br/>
Existing aliases can be overwritten. As the API is still URI based, the best case for using them is when preloading a stream.

### GET /stream/{id}/*file

Simple static file serving which is used when fetching chunks of `HLS`. This will be called by the client (browser) to fetch the chunks of the stream based on the given `index.m3u8`.
Expand Down

0 comments on commit 6b1b915

Please sign in to comment.