Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/omguptaind/recorder
Live-streaming / Recording using Xvfb, ffmpeg, and PulseAudio.
https://github.com/omguptaind/recorder
chromium ffmpeg livestream livestreaming pulseaudio recorder streaming video-conferencing xvfb youtube
Last synced: about 1 month ago
JSON representation
Live-streaming / Recording using Xvfb, ffmpeg, and PulseAudio.
- Host: GitHub
- URL: https://github.com/omguptaind/recorder
- Owner: OmGuptaIND
- Created: 2024-08-04T11:10:57.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-01T18:08:28.000Z (4 months ago)
- Last Synced: 2024-10-13T08:22:28.140Z (2 months ago)
- Topics: chromium, ffmpeg, livestream, livestreaming, pulseaudio, recorder, streaming, video-conferencing, xvfb, youtube
- Language: Go
- Homepage:
- Size: 98.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Livestreaming / Recording using Xvfb, ffmpeg, and PulseAudio.
System works very simply, it uses Xvfb to create a virtual display, PulseAudio to create a virtual audio device, and ffmpeg to record the screen and audio. Setups chromedp for the browser automation to record any browser url.
## Requirements
- docker.
## Usage
```base
docker build -t recorder-dev .
```
Preffred to use the docker-compose to run the container.
```base
docker-compose up
```
SSH into the container to run the server.
```base
make run
```
`NOTE: Check you are inside the app working directory.`
Check the server is running by visiting the `http://localhost:3000/`.
```
Sometimes Pulse Audio just doesn't want to start, so to give it a little push,
After you SSH inside the container, run the following command.
`./pulseaudio.sh`
```
### ENVIRONMENT VARIABLES
- `BUCKET_ENDPOINT` - AWS S3 Bucket Endpoint.
- `BUCKET_NAME` - AWS S3 Bucket Name.
- `BUCKET_KEY_ID` - AWS S3 Bucket Key ID.
- `BUCKET_APP_KEY` - AWS S3 Bucket Secret Key.
- `BUCKET_REGION` - AWS S3 Bucket Region.
### API ENDPOINTS
- `/ping` - To check the server is running.
```curl
curl --location 'http://localhost:3000/ping'
```
- `/start-recording` - To start the recording.
```curl
curl --location 'http://localhost:3000/start-recording' \
--header 'Content-Type: application/json' \
--data '{
"record_url": "https://www.youtube.com/watch?v=cii6ruuycQA&ab_channel=OliviaRodrigoVEVO"
"stream_url: "rtmp://a.rtmp.youtube.com/live2/"
}'
```
- `/stop-recording` - To stop the recording.
Use the id from the start-recording response.
```curl
curl --location --request PATCH 'http://localhost:3000/stop-recording' \
--header 'Content-Type: application/json' \
--data '{
"id": "pipeline_1725213615468"
}'
```
## TODO
- [x] Add API server Capabilties to make custom recording calls.
- [x] Ability to record multiple recordings at the same time. ( Took some time to figure out the pulse audio thing )
- [x] Do proper file system implementation to handle different recordings.
- [x] Add Capabilties to do livestreaming onto multiple rtmp, rtmps endpoints ( Hopefully ffmpeg will make it easy )
- [ ] Maybe do the kubernetes thing for auto scaling.
- [ ] Benchmarking, because I know sometimes recordings will fail to record propely, because its life.
- [ ] Add more documentation.
- [ ] Add more tests
## Scripts
- To get all the running pulse audio
```bash
pactl list short sources
```
- To Close the pulse audio
```bash
pulseaudio -k
```
- To Close all the Pulse Sink
```bash
pactl unload-module module-null-sink
```
- To Read all the running Process
```bash
ps aux
```
very useful to check for memory leaks, and zombie processes.