Creepso/multi-downloader-nx_mirror
1
0
Fork 0
mirror of https://github.com/anidl/multi-downloader-nx.git synced 2026-03-11 17:45:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #1106 from HyperNylium/master
Some checks failed
auto-documentation / documentation (push) Has been cancelled
Details
build and push docker image / build-node (push) Has been cancelled
Details
Style and build test / tsc (push) Has been cancelled
Details
Style and build test / eslint (push) Has been cancelled
Details
Style and build test / prettier (push) Has been cancelled
Details
Style and build test / build-test-arm64 (push) Has been cancelled
Details
Style and build test / build-test-x64 (push) Has been cancelled
Details

Browse source 
Add endpoint notes section to get started guide
This commit is contained in:
Stratuma 2025-10-20 10:12:32 +02:00 committed by GitHub
commit 8ff257f2e8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 21 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
docs/GET-STARTED.md
View file

@ -1,4 +1,4 @@
# multi-downloader-nx (v5.5.3)
# multi-downloader-nx (v5.6.1)
If you find any bugs in this documentation or in the program itself please report it [over on GitHub](https://github.com/anidl/multi-downloader-nx/issues).
@ -23,6 +23,7 @@ This tool is not responsible for your actions; please make an informed decision
- [Playready CDM](#playready)
- [Installation](#installation)
- [Configuration](#configuration)
- [Endpoint Notes](#endpoint-notes)
- [Usage](#usage)
- [Authentication](#authentication)
- [Output Directory](#output-directory)
@ -214,6 +215,25 @@ If you wanted to set `--tsd` to `true`, you would do it like this:
tsd: true
```
## Endpoint Notes
This section explains what each endpoint is capable of, and what subscription level is required to use it. \
If you are new to the project, please use the defaults found in the [`cli-defaults.yml`](https://github.com/HyperNylium/multi-downloader-nx/blob/master/config/cli-defaults.yml) file, as those are the recommended settings.
| Endpoint | Video quality | Audio quality | Subscription level required |
|--------------|-----------------------------|---------------|-----------------------------|
| `android` | 4-6k variable bitrate (VBR) | 192kbps | "Fan" or higher |
| `androidtab` | 4-6k variable bitrate (VBR) | 128kbps | "Fan" or higher |
| `androidtv` | 8k constent bitrate (CBR) | 128kbps | "Fan" or higher |
> [!NOTE]
> If you pick 192kbps audio (`--astream android`) with 8k CBR video (`--vstream androidtv`) but don’t have "Mega Fan" sub or higher,
> the audio will fall back to 128 kbps, which will download the CBR video with 128 kbps audio.
> [!NOTE]
> 192 kbps audio comes from the `android` endpoint. CBR video comes from `androidtv` endpoint. \
> Using both means you are using **two streams**, which needs the "Mega Fan" tier or higher.
## Usage
### Authentication