diff --git a/docs/README.md b/docs/README.md index 6376565..e57bf62 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,6 +8,10 @@
Promise
Delays process for specified amount of time in milliseconds.
Log function wrapper that can silences logs when +QUIET == true
+string
Pads a numerical value with preceding zeros to make strings same length.
Shuffles an array into a random state.
Clears the temporary directory of all files. +
Clears the temporary directory of all files. Establishes a directory if none exists.
string
string
Exports all frames from video. Appends number to the string to keep frames in alternating order to be quickly stitched together or re-sorted.
Shells out to run a sub command on every frame to perform effects
+Re-arranges the frames into the order specified in the pattern.
Calls patternSort()
to perform the rename and unlink actions
Ramdomly sort frames for re-stitching.
Render the frames into a video using ffmpeg.
integer
| Milliseconds to delay for |
+
+
+## log()
+Log function wrapper that can silences logs when
+QUIET == true
+
+**Kind**: global function
## zeroPad(i, max) ⇒ string
@@ -97,13 +111,13 @@ Shuffles an array into a random state.
## clear()
-Clears the temporary directory of all files.
+Clears the temporary directory of all files.
Establishes a directory if none exists.
**Kind**: global function
-## frames(video, order) ⇒ string
+## frames(video, order, avconv) ⇒ string
Exports all frames from video. Appends number to the string
to keep frames in alternating order to be quickly stitched together
or re-sorted.
@@ -115,10 +129,22 @@ Exports all frames from video. Appends number to the string
| --- | --- | --- |
| video | string
| String representing path to video |
| order | integer
| Integer to be appended to pathname of file |
+| avconv | boolean
| Whether or not to use avconv instead of ffmpeg |
+
+
+
+## subExec(cmd)
+Shells out to run a sub command on every frame to perform effects
+
+**Kind**: global function
+
+| Param | Type | Description |
+| --- | --- | --- |
+| cmd | string
| Command to execute on every frame |
-## weave(pattern, realtime)
+## weave(pattern, realtime, random)
Re-arranges the frames into the order specified in the pattern.
Calls `patternSort()` to perform the rename and unlink actions
@@ -128,6 +154,7 @@ Re-arranges the frames into the order specified in the pattern.
| --- | --- | --- |
| pattern | array
| Pattern of the frames per input |
| realtime | boolean
| Flag to turn on or off realtime behavior (drop frames / number of vids) |
+| random | boolean
| Whether or not to randomize frames |
@@ -170,7 +197,7 @@ Ramdomly sort frames for re-stitching.
-## render(output)
+## render(output, avconv)
Render the frames into a video using ffmpeg.
**Kind**: global function
@@ -178,6 +205,7 @@ Render the frames into a video using ffmpeg.
| Param | Type | Description |
| --- | --- | --- |
| output | string
| Path to export the video to |
+| avconv | boolean
| Whether or not to use avconv in place of ffmpeg |