spencer/nu-ffmpeg
1
0
Fork 0
mirror of https://github.com/sbrow/nu-ffmpeg.git synced 2026-02-27 02:51:44 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: Improved README.md.

Browse Source
This commit is contained in:
Spencer Brower
2024-02-03 22:57:33 -05:00
parent 25a3868dca
commit 55d04eb66e
8 changed files with 113 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -1,3 +1,4 @@
# nu-ffmpeg
Utility commands for working with ffmpeg in nushell.
@@ -15,7 +16,7 @@ Utility commands for working with ffmpeg in nushell.
The `ffmpeg` and `ffprobe` commands are required to be installed and available
in your path; they are not installed for you.
Currently nushell versions 0.87.0 - 0.88.1 are supported.
Currently only nushell version 0.89.0 is supported.
After that, clone this repository and add the following code to your scripts,
or to your `config.nu` file:
@@ -24,3 +25,30 @@ or to your `config.nu` file:
use <path-to-repository>/ffprobe
use <path-to-repository>/filters *
```
## FFProbe
### Commands
| name | usage |
| --------------------- | ---------------------------------------------------------------- |
| ffprobe | Run ffprobe on a list of files and return the output as a table. |
| ffprobe dimensions | Get the dimensions of a video stream |
| ffprobe streams | Retrieve all the streams from a list of ffprobe outputs |
| ffprobe streams audio | Retrieve all the audio streams from a list of ffprobe outputs |
| ffprobe streams video | Retrieve all the video streams from a list of ffprobe outputs |
## FFMpeg
## Supported Filters
| name | usage |
| ------- | -------------------------------------------------------------------------------------------------- |
| crop | Crop the input video to given dimensions. |
| fps | Convert the video to specified constant frame rate by duplicating or dropping frames as necessary. |
| loop | loop video frames |
| overlay | Overlay one video on top of another. |
| split | |
| vflip | Flip the input video vertically. |