-
Notifications
You must be signed in to change notification settings - Fork 38
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add destinationPath
option to .startRecording()
#11
Closed
Closed
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
cef40cd
appends `destination` option string for `.startRecording()`
alectrocute edd8878
Update readme.md
alectrocute 55730ae
Update index.js
alectrocute 95c7dc3
Update index.js
alectrocute 5adcfe6
add to example
alectrocute 92925a7
changes to
alectrocute c7341da
Update readme.md
alectrocute 5773ad1
Update readme.md
alectrocute d699b1e
Update readme.md
alectrocute 7b868a1
Update readme.md
alectrocute File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
|
||
# aperture-node [![Build Status](https://travis-ci.org/wulkano/aperture-node.svg?branch=master)](https://travis-ci.org/wulkano/aperture-node) | ||
|
||
> Record the screen on macOS from Node.js | ||
|
@@ -32,7 +33,7 @@ const options = { | |
await aperture.startRecording(options); | ||
await delay(3000); | ||
console.log(await aperture.stopRecording()); | ||
//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/cdf4f7df426c97880f8c10a1600879f7.mp4' | ||
//=> '/private/var/folders/3x/jf5977fn79j/T/cdf4f7df426c97880f8c10a1600879f7.mp4' | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Don't do unrelated changes. |
||
})(); | ||
``` | ||
|
||
|
@@ -88,14 +89,25 @@ Map { | |
|
||
Returns a `Promise` for the path to the screen recording file. | ||
|
||
Fullfills when the recording starts or rejects if the recording didn't start after 5 seconds. | ||
Fulfills when the recording starts or rejects if the recording didn't start after 5 seconds. | ||
|
||
#### recorder.stopRecording() | ||
|
||
Returns a `Promise` for the path to the screen recording file. | ||
|
||
## Options | ||
|
||
#### destinationPath | ||
|
||
Type: `string`<br> | ||
Default: `undefined` | ||
|
||
Destination of the output file. When `undefined`, destination will be generated using [tempy](https://github.com/sindresorhus/tempy) (default). | ||
|
||
`destinationPath` can be useful when needing to store temporary data on a different external network or local drive, allowing for higher capacity file storage ([further discussion](https://github.com/wulkano/aperture-node/pull/7#issuecomment-533199701)). | ||
|
||
This option should only be used when necessary. If `destinationPath` is not defined, then [tempy](https://github.com/sindresorhus/tempy) is used to generate an available filename and path in the user's temporary directory, eg. `/private/var/folders/3x/jf5977fn79j/T/vid.mp4`. | ||
|
||
#### fps | ||
|
||
Type: `number`<br> | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't do unrelated changes.