Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/datarhei/core-streamfile
Streamfiles to datarhei Core API
https://github.com/datarhei/core-streamfile
Last synced: 3 months ago
JSON representation
Streamfiles to datarhei Core API
- Host: GitHub
- URL: https://github.com/datarhei/core-streamfile
- Owner: datarhei
- License: mit
- Created: 2023-02-24T13:18:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-02-24T13:51:30.000Z (over 1 year ago)
- Last Synced: 2024-04-07T23:34:27.574Z (7 months ago)
- Language: Python
- Size: 11.7 KB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# datarhei Core - Streamfile importer
This Python application (Python 3.10, [Core PyClient](https://github.com/datarhei/core-client-python)) demonstrates how to interact with the [datarhei Core](https://github.com/datarhei/core). The application enables local files to generate FFmpeg processes, which consider the file name and file content (stream URL) and make the corresponding stream URL available as HLS, RTMP, and/or SRT streams.
The application is designed to be responsive to new files, file changes, and file deletions. However, it currently only supports H.264 and AAC live-streams.
## Installation steps (Linux/macOS example)
1. Start the Core and enable the built-in RTMP and SRT servers
```sh
docker run -d --name core \
--security-opt seccomp=unconfined \
-p 8080:8080 -p 1935:1935 -p 6000:6000/udp \
-e CORE_RTMP_ENABLE=true -e CORE_SRT_ENABLE=true \
datarhei/core:latest
```
2. Get the internal `CORE_ADDRESS`
```sh
docker inspect -f '{{ .NetworkSettings.IPAddress }}' core
```
Example: 172.17.0.2
*This allows the application to communicate with the Core. As an alternative, you can also use the IP address of the host system.*
3. Build and start the Streamfile-Importer
```sh
git clone github.com/datarhei/core-streamfile
cd core-streamfile
docker build -t core-streamfile .
docker run -d --name core-streamfile \
-v $PWD/streamfiles:/streamfiles \
-e CORE_ADDRESS=http://172.17.0.2:8080 \
-e PROCESS_OUTPUT_PROTOCOL="hls,rtmp,srt" \
core-streamfile
```
4. Create a streamfile in the `streamfiles` directory
```sh
echo 'https://demo.datarhei.com/memfs/1f33d538-d714-4c7e-9559-46ddb8118f03.m3u8' > mystream.stream
```
The file content (stream url) can be any streaming url such as HTTP, RTSP, RTMP, SRT.
*The default `SYNC_INTERVAL_SECONDS` is 10.*
5. Check the stream is running
- `Core API`: http://127.0.0.1:8080/api/v3/process/mystream
- `HLS` Stream: http://127.0.0.1:8080/memfs/mystream.m3u8
- `RTMP` Stream: rtmp://127.0.0.1/mystream
- `SRT` Stream: srt://127.0.0.1:6000/?streamid=mystream
## Enviroments
- `CORE_ADDRESS` (default: unset)
- `CORE_USERNMAE` (default: unset)
- `CORE_PASSWORD` (default: unset)
- `PROCESS_OUTPUT_PROTOCOL` (default: hls, max: hls,rtmp,srt)
- `PROCESS_REFERENCE` (default: streamfile)
- `STREAMFILE_FOLDER` (default: /streamfiles)
- `SYNC_INTERVAL_SECONDS` (default: 10)
## Contributing
We welcome contributions to this project. If you find a bug or have a suggestion for a new feature, please create an issue on the repository's issue tracker. If you would like to contribute code, please fork the repository and create a pull request with your changes.
# License
This application is released under the MIT License.