style: update Readme
This commit is contained in:
22
README.md
22
README.md
@@ -36,12 +36,26 @@ npm install -g @gromlab/create-vod
|
|||||||
create-vod video.mp4
|
create-vod video.mp4
|
||||||
```
|
```
|
||||||
|
|
||||||
**Output:** A folder `video/` in the current directory with segments under `{profile}-{codec}/`, DASH/HLS manifests in the root, poster, and thumbnail sprite/VTT (both DASH and HLS are always generated).
|
**Output:** In the current directory you'll get:
|
||||||
|
```
|
||||||
|
video/
|
||||||
|
├── manifest.mpd # DASH manifest
|
||||||
|
├── master.m3u8 # HLS master playlist
|
||||||
|
├── poster.jpg # Poster frame
|
||||||
|
├── thumbnails.{jpg,vtt} # Sprite + VTT cues
|
||||||
|
├── audio/ # Audio init + segments (AAC)
|
||||||
|
├── 1080p/ # H.264 1080p init + segments
|
||||||
|
├── 720p/ # H.264 720p
|
||||||
|
├── 480p/ # H.264 480p
|
||||||
|
├── 360p/ # H.264 360p
|
||||||
|
├── 1080p-av1/ # AV1 1080p (if av1 selected)
|
||||||
|
└── ... # Other profiles/codecs as {profile}-{codec}
|
||||||
|
```
|
||||||
|
|
||||||
## CLI Usage
|
## CLI Usage
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
create-vod <input-video> [output-dir] [-r resolutions] [-c codec] [-p poster-timecode] [-e encoder] [-d decoder]
|
create-vod <input-video> [output-dir] [-r resolutions] [-c codec] [-p poster-timecode] [-e encoder] [-d decoder] [-m]
|
||||||
```
|
```
|
||||||
|
|
||||||
### Main arguments
|
### Main arguments
|
||||||
@@ -60,6 +74,7 @@ create-vod <input-video> [output-dir] [-r resolutions] [-c codec] [-p poster-tim
|
|||||||
| `-p, --poster` | Poster timecode | `HH:MM:SS` or seconds | `00:00:00` | `-p 00:00:05` or `-p 10` |
|
| `-p, --poster` | Poster timecode | `HH:MM:SS` or seconds | `00:00:00` | `-p 00:00:05` or `-p 10` |
|
||||||
| `-e, --encoder` | Video encoder | `auto`, `nvenc`, `qsv`, `amf`, `vaapi`, `videotoolbox`, `v4l2`, `cpu` | `auto` | `-e nvenc` |
|
| `-e, --encoder` | Video encoder | `auto`, `nvenc`, `qsv`, `amf`, `vaapi`, `videotoolbox`, `v4l2`, `cpu` | `auto` | `-e nvenc` |
|
||||||
| `-d, --decoder` | Video decoder (hwaccel) | `auto`, `nvenc`, `qsv`, `vaapi`, `videotoolbox`, `v4l2`, `cpu` | `auto` | `-d cpu` |
|
| `-d, --decoder` | Video decoder (hwaccel) | `auto`, `nvenc`, `qsv`, `vaapi`, `videotoolbox`, `v4l2`, `cpu` | `auto` | `-d cpu` |
|
||||||
|
| `-m, --muted` | Disable audio track | flag | off | `-m` |
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
|
||||||
@@ -87,6 +102,9 @@ create-vod video.mp4 -c h264 -e nvenc -d cpu
|
|||||||
|
|
||||||
# Combined parameters
|
# Combined parameters
|
||||||
create-vod video.mp4 ./output -r 720,1080@60,1440@60 -p 00:00:10
|
create-vod video.mp4 ./output -r 720,1080@60,1440@60 -p 00:00:10
|
||||||
|
|
||||||
|
# No audio
|
||||||
|
create-vod video.mp4 -m
|
||||||
```
|
```
|
||||||
|
|
||||||
### Supported resolutions
|
### Supported resolutions
|
||||||
|
|||||||
23
README_RU.md
23
README_RU.md
@@ -35,12 +35,27 @@ npm install -g @gromlab/create-vod
|
|||||||
create-vod video.mp4
|
create-vod video.mp4
|
||||||
```
|
```
|
||||||
|
|
||||||
**Результат:** В текущей директории будет создана папка `video/` с сегментами в папках `{profile}-{codec}/`, манифестами DASH и HLS в корне, постером и превью спрайтами.
|
**Результат:** В текущей директории появится структура выходных файлов:
|
||||||
|
```
|
||||||
|
video/
|
||||||
|
├── manifest.mpd # DASH манифест
|
||||||
|
├── master.m3u8 # HLS мастер-плейлист
|
||||||
|
├── poster.jpg # Постер с указанного таймкода
|
||||||
|
├── thumbnails.jpg # Спрайт превью
|
||||||
|
├── thumbnails.vtt # Таймкоды превью
|
||||||
|
├── audio/ # Аудиосегменты (init + m4s)
|
||||||
|
├── 1080p/ # Сегменты H.264 1080p
|
||||||
|
├── 720p/ # Сегменты H.264 720p
|
||||||
|
├── 480p/ # Сегменты H.264 480p
|
||||||
|
├── 360p/ # Сегменты H.264 360p
|
||||||
|
├── 1080p-av1/ # Сегменты AV1 1080p (если выбран av1)
|
||||||
|
└── ... # Остальные профили/кодеки по схеме {profile}-{codec}
|
||||||
|
```
|
||||||
|
|
||||||
## Параметры CLI
|
## Параметры CLI
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
create-vod <input-video> [output-dir] [-r resolutions] [-c codec] [-p poster-timecode] [-e encoder] [-d decoder]
|
create-vod <input-video> [output-dir] [-r resolutions] [-c codec] [-p poster-timecode] [-e encoder] [-d decoder] [-m]
|
||||||
```
|
```
|
||||||
|
|
||||||
### Основные параметры
|
### Основные параметры
|
||||||
@@ -59,6 +74,7 @@ create-vod <input-video> [output-dir] [-r resolutions] [-c codec] [-p poster-tim
|
|||||||
| `-p, --poster` | Таймкод для постера | `HH:MM:SS` или секунды | `00:00:00` | `-p 00:00:05` или `-p 10` |
|
| `-p, --poster` | Таймкод для постера | `HH:MM:SS` или секунды | `00:00:00` | `-p 00:00:05` или `-p 10` |
|
||||||
| `-e, --encoder` | Видео энкодер | `auto`, `nvenc`, `qsv`, `amf`, `vaapi`, `videotoolbox`, `v4l2`, `cpu` | `auto` | `-e nvenc` |
|
| `-e, --encoder` | Видео энкодер | `auto`, `nvenc`, `qsv`, `amf`, `vaapi`, `videotoolbox`, `v4l2`, `cpu` | `auto` | `-e nvenc` |
|
||||||
| `-d, --decoder` | Видео декодер (hwaccel) | `auto`, `nvenc`, `qsv`, `vaapi`, `videotoolbox`, `v4l2`, `cpu` | `auto` | `-d cpu` |
|
| `-d, --decoder` | Видео декодер (hwaccel) | `auto`, `nvenc`, `qsv`, `vaapi`, `videotoolbox`, `v4l2`, `cpu` | `auto` | `-d cpu` |
|
||||||
|
| `-m, --muted` | Отключить аудио дорожку в выходных файлах | `flag` | `off` | `-m` |
|
||||||
|
|
||||||
### Примеры использования
|
### Примеры использования
|
||||||
|
|
||||||
@@ -80,6 +96,9 @@ create-vod video.mp4 -p 5
|
|||||||
|
|
||||||
# Комбинация параметров
|
# Комбинация параметров
|
||||||
create-vod video.mp4 ./output -r 720,1080@60,1440@60 -p 00:00:10
|
create-vod video.mp4 ./output -r 720,1080@60,1440@60 -p 00:00:10
|
||||||
|
|
||||||
|
# Без звука
|
||||||
|
create-vod video.mp4 -m
|
||||||
```
|
```
|
||||||
|
|
||||||
### Поддерживаемые разрешения
|
### Поддерживаемые разрешения
|
||||||
|
|||||||
Reference in New Issue
Block a user