mirrors/cobalt
1
0
Fork 0
mirror of https://github.com/imputnet/cobalt.git synced 2025-06-30 10:28:28 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

docs/api: add subtitleLang, sublanguage, and update localProcessing
Some checks failed
CodeQL / Analyze (${{ matrix.language }}) (none, javascript-typescript) (push) Waiting to run
Details
Run tests / check lockfile correctness (push) Waiting to run
Details
Run tests / web sanity check (push) Waiting to run
Details
Run tests / api sanity check (push) Waiting to run
Details
Run service tests / test service functionality (push) Has been cancelled
Details
Run service tests / test service: ${{ matrix.service }} (push) Has been cancelled
Details

Browse Source
This commit is contained in:
wukko 2025-06-28 21:50:43 +06:00
parent a60e94d628
commit 214af73a1e
No known key found for this signature in database
GPG Key ID: 3E30B3F26C7B4AA2
1 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/api.md
View File

@ -68,17 +68,18 @@ you can read [the api schema](/api/src/processing/schema.js) directly from code
all keys except for `url` are optional. value options are separated by `/`. all keys except for `url` are optional. value options are separated by `/`.
#### general #### general
| key | type | description/value | default | | key | type | description/value | default |
|:-----------------------|:----------|:----------------------------------------------------------------|:-----------| |:------------------|:----------|:----------------------------------------------------------------|:-----------|
| `url` | `string` | source URL | *required* | | `url` | `string` | source URL | *required* |
| `audioBitrate` | `string` | `320 / 256 / 128 / 96 / 64 / 8` (kbps) | `128` | | `audioBitrate` | `string` | `320 / 256 / 128 / 96 / 64 / 8` (kbps) | `128` |
| `audioFormat` | `string` | `best / mp3 / ogg / wav / opus` | `mp3` | | `audioFormat` | `string` | `best / mp3 / ogg / wav / opus` | `mp3` |
| `downloadMode` | `string` | `auto / audio / mute` | `auto` | | `downloadMode` | `string` | `auto / audio / mute` | `auto` |
| `filenameStyle` | `string` | `classic / pretty / basic / nerdy` | `basic` | | `filenameStyle` | `string` | `classic / pretty / basic / nerdy` | `basic` |
| `videoQuality` | `string` | `max / 4320 / 2160 / 1440 / 1080 / 720 / 480 / 360 / 240 / 144` | `1080` | | `videoQuality` | `string` | `max / 4320 / 2160 / 1440 / 1080 / 720 / 480 / 360 / 240 / 144` | `1080` |
| `disableMetadata` | `boolean` | title, artist, and other info will not be added to the file | `false` | | `disableMetadata` | `boolean` | title, artist, and other info will not be added to the file | `false` |
| `alwaysProxy` | `boolean` | always tunnel all files, even when not necessary | `false` | | `alwaysProxy` | `boolean` | always tunnel all files, even when not necessary | `false` |
| `localProcessing` | `boolean` | remux/transcode files locally instead of the server | `false` | | `localProcessing` | `string` | `disabled / preferred / forced` | `disabled` |
| `subtitleLang` | `string` | any valid language code, such as: `en` or `zh-CN` | *none* |
#### service-specific options #### service-specific options
| key | type | description/value | default | | key | type | description/value | default |
@ -142,6 +143,7 @@ all keys in this table are optional.
| `album_artist` | `string` | album's artist or creator name | | `album_artist` | `string` | album's artist or creator name |
| `track` | `string` | track number or position in album | | `track` | `string` | track number or position in album |
| `date` | `string` | release date or creation date | | `date` | `string` | release date or creation date |
| `sublanguage` | `string` | subtitle language code (ISO 639-2) |
#### audio object #### audio object
| key | type | value | | key | type | value |