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
|
||||
```
|
||||
|
||||
**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
|
||||
|
||||
```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
|
||||
@@ -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` |
|
||||
| `-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` |
|
||||
| `-m, --muted` | Disable audio track | flag | off | `-m` |
|
||||
|
||||
### Examples
|
||||
|
||||
@@ -87,6 +102,9 @@ create-vod video.mp4 -c h264 -e nvenc -d cpu
|
||||
|
||||
# Combined parameters
|
||||
create-vod video.mp4 ./output -r 720,1080@60,1440@60 -p 00:00:10
|
||||
|
||||
# No audio
|
||||
create-vod video.mp4 -m
|
||||
```
|
||||
|
||||
### Supported resolutions
|
||||
|
||||
Reference in New Issue
Block a user