docs: Updated README to mention flag completions.

This commit is contained in:
Spencer Brower
2024-02-24 11:57:21 -05:00
parent ee0ae79a5d
commit e45cfdfbe5
3 changed files with 12 additions and 2 deletions

View File

@@ -9,6 +9,7 @@ Utility commands for working with ffmpeg in nushell.
- `ffprobe` multiple files at once - `ffprobe` multiple files at once
- Use `streams`, `streams video`, and `streams audio` to filter `ffprobe` output - Use `streams`, `streams video`, and `streams audio` to filter `ffprobe` output
- get the `dimensions` of a video stream as a record - get the `dimensions` of a video stream as a record
- Tab-completion for filter options. i.e. `fps --round<tab>` will yield `zero inf down up near`
- Apply and parse complex filters to a video (Work In Progress) - Apply and parse complex filters to a video (Work In Progress)
## Setup ## Setup

View File

@@ -14,6 +14,7 @@ Utility commands for working with ffmpeg in nushell.
- `ffprobe` multiple files at once - `ffprobe` multiple files at once
- Use `streams`, `streams video`, and `streams audio` to filter `ffprobe` output - Use `streams`, `streams video`, and `streams audio` to filter `ffprobe` output
- get the `dimensions` of a video stream as a record - get the `dimensions` of a video stream as a record
- Tab-completion for filter options. i.e. `fps --round<tab>` will yield `zero inf down up near`
- Apply and parse complex filters to a video (Work In Progress) - Apply and parse complex filters to a video (Work In Progress)
## Setup ## Setup

View File

@@ -29,8 +29,7 @@ export def fps [
--output (-o): list<string>: = [] --output (-o): list<string>: = []
--start-time (-s) # Assume the first PTS should be the given value, in seconds. --start-time (-s) # Assume the first PTS should be the given value, in seconds.
# This allows for padding/trimming at the start of stream. By default, no assumption is made about the first frames expected PTS, so no padding or trimming is done. For example, this could be set to 0 to pad the beginning with duplicates of the first frame if a video stream starts after the audio stream or to trim any frames with a negative PTS. # This allows for padding/trimming at the start of stream. By default, no assumption is made about the first frames expected PTS, so no padding or trimming is done. For example, this could be set to 0 to pad the beginning with duplicates of the first frame if a video stream starts after the audio stream or to trim any frames with a negative PTS.
--round (-r): string # Timestamp (PTS) rounding method. --round (-r): string@fps-round-options # Timestamp (PTS) rounding method. use completion to view available options.
# Possible values are: "zero", "inf", "down", "up", "near".
--eof-action (-e): string # Action performed when reading the last frame. Possible values are: "round", "pass" --eof-action (-e): string # Action performed when reading the last frame. Possible values are: "round", "pass"
fps: string = '25' # The desired output frame rate. It accepts expressions containing the following constants: fps: string = '25' # The desired output frame rate. It accepts expressions containing the following constants:
# "source_fps": The inputs frame rate # "source_fps": The inputs frame rate
@@ -44,6 +43,15 @@ export def fps [
] ]
} }
def fps-round-options [] {
[
'zero'
'inf'
'down'
'up'
'near'
]
}
export def split [ export def split [
--input (-i): list<string>: = [] --input (-i): list<string>: = []
output: list<string> output: list<string>