aperture - npm Package Compare versions
Comparing version
| { | ||
| "name": "aperture", | ||
| "version": "5.1.0", | ||
| "version": "5.2.0", | ||
| "description": "Record the screen on macOS", | ||
| "license": "MIT", | ||
| "repository": "wulkano/aperture", | ||
| "repository": "wulkano/aperture-node", | ||
| "engines": { | ||
@@ -12,3 +12,3 @@ "node": ">=8" | ||
| "test": "xo && ava", | ||
| "build": "cd swift && xcodebuild archive -derivedDataPath $(mktemp -d) -scheme aperture", | ||
| "build": "swift build --configuration=release --static-swift-stdlib -Xswiftc '-target' -Xswiftc 'x86_64-apple-macosx10.12' && mv .build/release/aperture .", | ||
| "prepublish": "npm run build" | ||
@@ -21,14 +21,14 @@ }, | ||
| "dependencies": { | ||
| "electron-util": "^0.9.1", | ||
| "electron-util": "^0.11.0", | ||
| "execa": "^1.0.0", | ||
| "file-url": "^2.0.2", | ||
| "macos-version": "^4.0.1", | ||
| "macos-version": "^5.0.0", | ||
| "tempy": "^0.2.1" | ||
| }, | ||
| "devDependencies": { | ||
| "ava": "^0.25.0", | ||
| "delay": "^4.0.1", | ||
| "file-type": "^9.0.0", | ||
| "ava": "^1.2.1", | ||
| "delay": "^4.1.0", | ||
| "file-type": "^10.8.0", | ||
| "read-chunk": "^3.0.0", | ||
| "xo": "^0.23.0" | ||
| "xo": "^0.24.0" | ||
| }, | ||
@@ -35,0 +35,0 @@ "xo": { |
@@ -1,8 +0,6 @@ | ||
| <p align="center"> | ||
| <img src="https://getkap.co/images/aperture.svg" height="64"> | ||
| <h3 align="center">Aperture</h3> | ||
| <p align="center">Record the screen on macOS</p> | ||
| <p align="center"><a href="https://travis-ci.org/wulkano/aperture"><img src="https://travis-ci.org/wulkano/aperture.svg?branch=master" alt="Build Status: macOS"></a> <a href="https://github.com/sindresorhus/xo"><img src="https://img.shields.io/badge/code_style-XO-5ed9c7.svg" alt="XO code style"></a></p> | ||
| </p> | ||
| # aperture-node [](https://travis-ci.org/wulkano/aperture-node) | ||
| > Record the screen on macOS from Node.js | ||
| ## Install | ||
@@ -46,3 +44,3 @@ | ||
| ### aperture.screens() -> `Promise<Array>` | ||
| #### aperture.screens() -> `Promise<Object[]>` | ||
@@ -60,3 +58,3 @@ Get a list of screens. The first screen is the primary screen. | ||
| ### aperture.audioDevices() -> `Promise<Array>` | ||
| #### aperture.audioDevices() -> `Promise<Object[]>` | ||
@@ -74,3 +72,3 @@ Get a list of audio devices. | ||
| ### aperture.videoCodecs -> `Map` | ||
| #### aperture.videoCodecs -> `Map` | ||
@@ -90,5 +88,5 @@ Get a list of available video codecs. The key is the `videoCodec` option name and the value is the codec name. It only returns `hevc` if you're on macOS 10.13 or newer and your computer supports HEVC hardware encoding. | ||
| ### recorder = `aperture()` | ||
| #### recorder = `aperture()` | ||
| ### recorder.startRecording([[options]](#options)) | ||
| #### recorder.startRecording([[options]](#options)) | ||
@@ -99,9 +97,9 @@ Returns a `Promise` for the path to the screen recording file. | ||
| ### recorder.stopRecording() | ||
| #### recorder.stopRecording() | ||
| Returns a `Promise` for the path to the screen recording file. | ||
| #### options | ||
| ## Options | ||
| ##### fps | ||
| #### fps | ||
@@ -113,3 +111,3 @@ Type: `number`<br> | ||
| ##### cropArea | ||
| #### cropArea | ||
@@ -121,3 +119,3 @@ Type: `Object`<br> | ||
| ##### showCursor | ||
| #### showCursor | ||
@@ -129,3 +127,3 @@ Type: `boolean`<br> | ||
| ##### highlightClicks | ||
| #### highlightClicks | ||
@@ -139,3 +137,3 @@ Type: `boolean`<br> | ||
| ##### screenId | ||
| #### screenId | ||
@@ -147,3 +145,3 @@ Type: `number`<br> | ||
| ##### audioDeviceId | ||
| #### audioDeviceId | ||
@@ -155,3 +153,3 @@ Type: `string`<br> | ||
| ##### videoCodec | ||
| #### videoCodec | ||
@@ -169,3 +167,3 @@ Type: `string`<br> | ||
| Aperture was built to fulfill the needs of [Kap](https://github.com/wulkano/kap), providing a JavaScript interface to the **best** available method for recording the screen. That's why it's currently a wrapper for a [Swift script](swift/aperture/main.swift) that records the screen using the [AVFoundation framework](https://developer.apple.com/av-foundation/). | ||
| Aperture was built to fulfill the needs of [Kap](https://github.com/wulkano/kap), providing a JavaScript interface to the **best** available method for recording the screen. That's why it's currently a wrapper for a [Swift script](Sources/ApertureCLI/main.swift) that records the screen using the [AVFoundation framework](https://developer.apple.com/av-foundation/). | ||
@@ -185,20 +183,9 @@ #### But you can use `ffmpeg -f avfoundation...` | ||
| ## Linux and Windows | ||
| ## Related | ||
| We want to bring Aperture to Linux and Windows, but we don't have time or resources for such tasks (we're Mac users), so **any help is more than welcome**. We just want to enforce two things: **performance** and **quality** – it doesn't matter how (`ffmpeg`, custom built native lib, etc) they are achieved. | ||
| - [Aperture](https://github.com/wulkano/Aperture) - The Swift framework used in this package | ||
| ## Upcoming | ||
| Aperture is in its early days. We're working on adding more features, such as *export to GIF*, compression options, support for multiple displays, support for audio, and much more. Check out our [Aperture](https://github.com/wulkano/kap/issues?q=is%3Aissue+is%3Aopen+label%3Aaperture) issues on **Kap** to learn more. | ||
| ## Maintainers | ||
| - [Matheus Fernandes](https://github.com/matheuss) | ||
| - [Sindre Sorhus](https://github.com/sindresorhus) | ||
| ## License | ||
| MIT |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
Fixed alerts
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
10774643
-0.45%- Number of lines in readme file
179
-6.77%Dependency changes
+ Added
electron-is-dev@1.2.0(transitive)+ Added
electron-util@0.11.0(transitive)+ Added
macos-version@5.2.1(transitive)+ Added
new-github-issue-url@0.2.1(transitive)- Removed
electron-is-dev@0.3.0(transitive)- Removed
electron-util@0.9.1(transitive)- Removed
macos-version@4.1.0(transitive)Updated
electron-util@^0.11.0Updated
macos-version@^5.0.0