Skip to content

Commit 8f11ab5

Browse files
committed
Improve readme
1 parent 52c541c commit 8f11ab5

File tree

1 file changed

+9
-34
lines changed

1 file changed

+9
-34
lines changed

README.md

+9-34
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,10 @@ The `--edit` option is how auto-editor makes automated cuts.
4343
For example, edit out motionlessness in a video by setting `--edit motion`.
4444

4545
```
46-
# cut out sections where percentage of motion is less than 2.
47-
auto-editor example.mp4 --edit motion:threshold=2%
46+
# cut out sections where the total motion is less than 2%.
47+
auto-editor example.mp4 --edit motion:threshold=0.02
4848
49-
# --edit is set to "audio:threshold=4%" by default.
49+
# `--edit audio:threshold=0.04,stream=all` is used by defaut.
5050
auto-editor example.mp4
5151
5252
# Different tracks can be set with different attribute.
@@ -56,34 +56,14 @@ auto-editor multi-track.mov --edit "(or audio:stream=0 audio:threshold=10%,strea
5656
Different editing methods can be used together.
5757
```
5858
# 'threshold' is always the first argument for edit-method objects
59-
auto-editor example.mp4 --edit "(or audio:3% motion:6%)"
59+
auto-editor example.mp4 --edit "(or audio:0.03 motion:0.06)"
6060
```
6161

6262
You can also use `dB` unit, a volume unit familiar to video-editors (case sensitive):
6363
```
64-
auto-editor example.mp4 --edit audio:threshold=-19dB
64+
auto-editor example.mp4 --edit audio:-19dB
6565
auto-editor example.mp4 --edit audio:-7dB
6666
auto-editor example.mp4 --edit motion:-19dB
67-
68-
# The `dB` unit is a just a macro that expands into an S-expression:
69-
# '-19dB
70-
# > '(pow 10 (/ -19 20))
71-
# (eval '(pow 10 (/ -19 20)))
72-
# > 0.11220184543019636
73-
```
74-
75-
### Working With Multiple Audio Tracks
76-
By default, only the first audio track will used for editing (track 0). You can change this with these commands.
77-
78-
Use all audio tracks for editing:
79-
```
80-
auto-editor multi-track.mov --edit audio:stream=all
81-
```
82-
83-
Use only the second, fourth, and sixth audio track:
84-
```
85-
# track numbers start at 0
86-
auto-editor so-many-tracks.mp4 --edit "(or audio:stream=1 audio:stream=3 audio:stream=5)"
8767
```
8868

8969
### See What Auto-Editor Cuts Out
@@ -102,12 +82,10 @@ auto-editor example.mp4 --export premiere
10282
```
10383

10484
Auto-Editor can also export to:
105-
10685
- DaVinci Resolve with `--export resolve`
10786
- Final Cut Pro with `--export final-cut-pro`
10887
- ShotCut with `--export shotcut`
109-
110-
Other editors, like Sony Vegas, can understand the `premiere` format. If your favorite editor doesn't, you can use ` --export clip-sequence` which creates many video clips that can be imported and manipulated like normal.
88+
- Individual media clips with `--export clip-sequence`
11189

11290
### Naming Timelines
11391
By default, auto-editor will name the timeline to "Auto-Editor Media Group" if the export supports naming.
@@ -171,14 +149,11 @@ List all available options:
171149
auto-editor --help
172150
```
173151

174-
Use `--help` with a specific option for more information:
152+
Use `--help` with a specific option to learn more about it:
175153

176154
```
177-
auto-editor --scale --help
178-
--scale NUM
179-
180-
default: 1.0
181-
Scale the output video's resolution by NUM factor
155+
auto-editor -c:v --help
156+
auto-editor --margin --help
182157
```
183158

184159
<h3 align="center">Auto-Editor is available on all major platforms</h3>

0 commit comments

Comments
 (0)