jon/web-dslr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
ICheered
2023-08-03 18:23:21 +02:00
parent 6e09c9d037
commit 8c21f708be
1 changed files with 33 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
README.md
View File

@@ -12,70 +12,46 @@ yarn add web-gphoto2
``` ```
## Usage ## Usage
**Note: This package ONLY runs in the browser context**. It will not work in NodeJS. If you are using a build-tool make sure to dynamically import this package so it is only imported in the browser context.
A short example on how to use this package:
```ts ```ts
let initModule: any; import Camera from 'web-gphoto2';
if (typeof window !== 'undefined') { let camera = new Camera();
import('web-gphoto2').then((module) => {
initModule = module.default; async function connectCamera() {
}).catch((error) => { // @ts-ignore
console.error("Error loading web-gphoto2", error); await navigator.usb.requestDevice({
filters: [{ classCode: 6, subclassCode: 1 }]
}); });
} else { await camera.connect();
console.warn("web-gphoto2 is only available in the browser"); }
async function getSupportedOps() {
const ops = await camera.getSupportedOps();
console.log('Supported Ops:', ops);
}
async function getCameraConfig() {
const config = await camera.getConfig();
console.log('Config:', config);
}
async function updateConfig() {
await camera.setConfigValue('iso', '800');
}
async function capturePreviewAsBlob() {
const blob = await camera.capturePreviewAsBlob();
console.log('Blob:', blob);
}
async function captureImageAsFile() {
const file = await camera.captureImageAsFile();
console.log('File:', file);
} }
``` ```
A short example on how to use this package to obtain the camera config:
```ts
// After importing the initModule from web-gphoto2
const ModulePromise = initModule();
export function rethrowIfCritical(err) {
if (err.constructor !== Error) throw err;
}
export async function connect() {
const Module = await ModulePromise;
let context = await new Module.Context();
let supportedOps = await context.supportedOps();
let queue = Promise.resolve();
function schedule(op) {
let res = queue.then(() => op(context));
queue = res.catch(rethrowIfCritical);
return res;
}
return {
supportedOps,
schedule,
disconnect() {
context.delete();
}
};
}
// Select the camera, connect, and obtain the config. Error handling is omitted for brevity but should be included, check the example for details.
await navigator.usb.requestDevice({
filters: [
{
classCode: 6, // PTP
subclassCode: 1 // MTP
}
]
});
let connection = await connect();
let config = await connection.schedule((context: any) => context.configToJS());
console.log('Obtained config: ', config);
```
More information can be found in the example included in the Github repository.
## Common Issues ## Common Issues
### SharedArrayBuffer can not be found ### SharedArrayBuffer can not be found
SharedArrayBuffer has been disabled across all browsers due to the Spectre vulnerability. This package uses SharedArrayBuffer to communicate with the WebAssembly module. To work around this issue, you need to set two response headers for your document: SharedArrayBuffer has been disabled across all browsers due to the Spectre vulnerability. This package uses SharedArrayBuffer to communicate with the WebAssembly module. To work around this issue, you need to set two response headers for your document: