Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcopeocchi/yt-dlp-rpc
yt-dlp RPC proof of concept implemented in Golang
https://github.com/marcopeocchi/yt-dlp-rpc
rpc rpc-server yt-dlp yt-dlp-rpc
Last synced: 4 months ago
JSON representation
yt-dlp RPC proof of concept implemented in Golang
- Host: GitHub
- URL: https://github.com/marcopeocchi/yt-dlp-rpc
- Owner: marcopeocchi
- License: gpl-3.0
- Created: 2022-11-07T21:36:41.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-01-02T15:14:05.000Z (about 2 years ago)
- Last Synced: 2023-04-25T12:49:39.140Z (almost 2 years ago)
- Topics: rpc, rpc-server, yt-dlp, yt-dlp-rpc
- Language: Go
- Homepage:
- Size: 4.66 MB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# yt-dlp-RPC Proof of Concept
JSON-RPC 1.0 compliant RPC server for yt-dlp. Heavily inspired from Aria2 RPC.
HTTP POST and WebSockets are the available transport protocols.
## RPC overview
| Function | Parameters | Description |
|-------------------|-----------------------------------|-------------------------------------------------------------------|
| Service.Exec | { URL: string, Params: string[] } | Starts a new process. Params is a list of yt-dlp params/arguments |
| Service.Result | string | Progress of a single process |
| Service.Running | null | List of of all running processes progress |
| Service.Kill | string | Kills a process given its id |
| Service.KillAll | null | Kills all processes |
| Service.FreeSpace | null | Gets download directory writable bytes (free space) in GBs |
## Response sent to RPC client
Client sends ->
```json5
{
"id": 1, //seq number (optional)
"method":"Service.Exec",
"params":[{
"URL":"my-url",
"Params":["--no-mtime", "--my-param"]
}]
}
```
Client periodically sends (busy-waiting) ->
```json
{"id":2,"method":"Service.Running","params":[]}
```
<- Client Receives
```json5
{
"id": 2, // seq number
"result":[
{
"id": "4d5e97d7-25b1-4f5f-bf3e-b8e086ab6b9e",
"progress": {
"percentage": " 29.1%", // completion %
"speed": 5387927, // speed in Bps
"eta": 20 // ETA in seconds
},
"info": {
"url": "my-url",
"title": "my-url title",
"thumbnail": "my-url thumbnail",
"resolution": "3840x2160",
"filesize_approx": 83294723, // filesize in bytes
"acodec": "opus",
"vcodec": "webm"
}
}
],
"error":null
}
```
## How to run
```sh
# example
go run *.go --driver=/usr/local/bin/yt-dlp --port 7900
# driver flag defaults to "yt-dlp" (ensure yt-dlp is in PATH)
# port flag defaults to port 4444
```
### Run with Docker
```sh
docker build -t yt-dlp-rpc .
docker run --name=yt-dlp-rpc -d -p 4444:4444 -v :/usr/src/yt-dlp-rpc/downloads yt-dlp-rpc:latest
```
## Examples
A fully-fledged example for this RPC server is [yt-dlp-vue](https://github.com/marcopeocchi/yt-dlp-vue), a simple web fronted.
All examples are in the [examples](https://github.com/marcopeocchi/yt-dlp-rpc/tree/master/examples) folder.
```js
//HTTP POST RPC example
// get all jobs
fetch('http://127.0.0.1:4444/rpc', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
'method': 'Service.Running',
'params': []
})
})
// start a download
fetch('http://127.0.0.1:4444/rpc', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
'method': 'Service.Exec',
'params': [{
'URL': 'https://...',
'Params': ['-r', '500K', '--no-mtime'] // any compatible arg,
}]
})
})
```
## Notes
Updating yt-dlp executable has to be done from the running container
```sh
docker exec -it container-name /usr/src/yt-dlp-rpc/fetch-yt-dlp.sh
```