{"id":13800991,"url":"https://github.com/xulihang/capacitor-plugin-camera","last_synced_at":"2025-04-04T14:31:29.769Z","repository":{"id":63442090,"uuid":"567150815","full_name":"xulihang/capacitor-plugin-camera","owner":"xulihang","description":"Capacitor camera plugin","archived":false,"fork":false,"pushed_at":"2025-03-12T09:39:17.000Z","size":917,"stargazers_count":14,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-20T14:47:54.954Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xulihang.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-17T07:13:06.000Z","updated_at":"2025-03-12T09:38:00.000Z","dependencies_parsed_at":"2025-01-11T05:18:01.161Z","dependency_job_id":"44420ec0-a404-4379-8e58-6389c9f06315","html_url":"https://github.com/xulihang/capacitor-plugin-camera","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xulihang%2Fcapacitor-plugin-camera","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xulihang%2Fcapacitor-plugin-camera/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xulihang%2Fcapacitor-plugin-camera/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xulihang%2Fcapacitor-plugin-camera/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xulihang","download_url":"https://codeload.github.com/xulihang/capacitor-plugin-camera/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247194047,"owners_count":20899423,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-04T00:01:18.315Z","updated_at":"2025-04-04T14:31:29.764Z","avatar_url":"https://github.com/xulihang.png","language":"Java","funding_links":[],"categories":["Other plugins"],"sub_categories":["Specialized Hardware"],"readme":"# capacitor-plugin-camera\n\nA capacitor camera plugin.\n\n[Online demo](https://dazzling-cactus-692f14.netlify.app/)\n\n## Supported Platforms\n\n* Android (based on CameraX)\n* iOS (based on AVCaptureSession)\n* Web (based on getUserMedia with Dynamsoft Camera Enhancer)\n\n## Versions\n\nFor Capacitor 5, use versions 1.x.\n\nFor Capacitor 6, use versions 2.x.\n\nFor Capacitor 7, use versions 3.x.\n\n## Install\n\n```bash\nnpm install capacitor-plugin-camera\nnpx cap sync\n```\n## Get Bitmap/UIImage via Reflection\n\nIf you are developing a plugin, you can use reflection to get the camera frames as Bitmap or UIImage on the native side.\n\nJava:\n\n```java\nClass cls = Class.forName(\"com.tonyxlh.capacitor.camera.CameraPreviewPlugin\");\nMethod m = cls.getMethod(\"getBitmap\",null);\nBitmap bitmap = (Bitmap) m.invoke(null, null);\n```\n\nObjective-C:\n\n```obj-c\n- (UIImage*)getUIImage{\n    UIImage *image = ((UIImage* (*)(id, SEL))objc_msgSend)(objc_getClass(\"CameraPreviewPlugin\"), sel_registerName(\"getBitmap\"));\n    return image;\n}\n```\n\nYou have to call `saveFrame` beforehand.\n\n## Declare Permissions\n\nTo use camera and microphone, we need to declare permissions.\n\nAdd the following to Android's `AndroidManifest.xml`:\n\n```xml\n\u003cuses-permission android:name=\"android.permission.CAMERA\" /\u003e\n\u003cuses-permission android:name=\"android.permission.RECORD_AUDIO\" /\u003e\n```\n\nAdd the following to iOS's `Info.plist`:\n\n```xml\n\u003ckey\u003eNSCameraUsageDescription\u003c/key\u003e\n\u003cstring\u003eFor camera usage\u003c/string\u003e\n\u003ckey\u003eNSMicrophoneUsageDescription\u003c/key\u003e\n\u003cstring\u003eFor video recording\u003c/string\u003e\n```\n\n## FAQ\n\nWhy I cannot see the camera?\n\nFor native platforms, the plugin puts the native camera view behind the webview and sets the webview as transparent so that we can display HTML elements above the camera.\n\nYou may need to add the style below on your app's HTML or body element to avoid blocking the camera view:\n\n```css\nion-content {\n  --background: transparent;\n}\n```\n\nIn dark mode, it is neccessary to set the `--ion-blackground-color` property. You can do this with the following code:\n\n```js\ndocument.documentElement.style.setProperty('--ion-background-color', 'transparent');\n```\n\n## API\n\n\u003cdocgen-index\u003e\n\n* [`initialize()`](#initialize)\n* [`getResolution()`](#getresolution)\n* [`setResolution(...)`](#setresolution)\n* [`getAllCameras()`](#getallcameras)\n* [`getSelectedCamera()`](#getselectedcamera)\n* [`selectCamera(...)`](#selectcamera)\n* [`setScanRegion(...)`](#setscanregion)\n* [`setZoom(...)`](#setzoom)\n* [`setFocus(...)`](#setfocus)\n* [`setDefaultUIElementURL(...)`](#setdefaultuielementurl)\n* [`setElement(...)`](#setelement)\n* [`startCamera()`](#startcamera)\n* [`stopCamera()`](#stopcamera)\n* [`takeSnapshot(...)`](#takesnapshot)\n* [`saveFrame()`](#saveframe)\n* [`takeSnapshot2(...)`](#takesnapshot2)\n* [`takePhoto(...)`](#takephoto)\n* [`toggleTorch(...)`](#toggletorch)\n* [`getOrientation()`](#getorientation)\n* [`startRecording()`](#startrecording)\n* [`stopRecording(...)`](#stoprecording)\n* [`setLayout(...)`](#setlayout)\n* [`requestCameraPermission()`](#requestcamerapermission)\n* [`requestMicroPhonePermission()`](#requestmicrophonepermission)\n* [`isOpen()`](#isopen)\n* [`addListener('onPlayed', ...)`](#addlisteneronplayed-)\n* [`addListener('onOrientationChanged', ...)`](#addlisteneronorientationchanged-)\n* [`removeAllListeners()`](#removealllisteners)\n* [Interfaces](#interfaces)\n* [Type Aliases](#type-aliases)\n\n\u003c/docgen-index\u003e\n\n\u003cdocgen-api\u003e\n\u003c!--Update the source file JSDoc comments and rerun docgen to update the docs below--\u003e\n\n### initialize()\n\n```typescript\ninitialize() =\u003e Promise\u003cvoid\u003e\n```\n\n--------------------\n\n\n### getResolution()\n\n```typescript\ngetResolution() =\u003e Promise\u003c{ resolution: string; }\u003e\n```\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ resolution: string; }\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### setResolution(...)\n\n```typescript\nsetResolution(options: { resolution: number; }) =\u003e Promise\u003cvoid\u003e\n```\n\n| Param         | Type                                 |\n| ------------- | ------------------------------------ |\n| **`options`** | \u003ccode\u003e{ resolution: number; }\u003c/code\u003e |\n\n--------------------\n\n\n### getAllCameras()\n\n```typescript\ngetAllCameras() =\u003e Promise\u003c{ cameras: string[]; }\u003e\n```\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ cameras: string[]; }\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### getSelectedCamera()\n\n```typescript\ngetSelectedCamera() =\u003e Promise\u003c{ selectedCamera: string; }\u003e\n```\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ selectedCamera: string; }\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### selectCamera(...)\n\n```typescript\nselectCamera(options: { cameraID: string; }) =\u003e Promise\u003cvoid\u003e\n```\n\n| Param         | Type                               |\n| ------------- | ---------------------------------- |\n| **`options`** | \u003ccode\u003e{ cameraID: string; }\u003c/code\u003e |\n\n--------------------\n\n\n### setScanRegion(...)\n\n```typescript\nsetScanRegion(options: { region: ScanRegion; }) =\u003e Promise\u003cvoid\u003e\n```\n\n| Param         | Type                                                           |\n| ------------- | -------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e{ region: \u003ca href=\"#scanregion\"\u003eScanRegion\u003c/a\u003e; }\u003c/code\u003e |\n\n--------------------\n\n\n### setZoom(...)\n\n```typescript\nsetZoom(options: { factor: number; }) =\u003e Promise\u003cvoid\u003e\n```\n\n| Param         | Type                             |\n| ------------- | -------------------------------- |\n| **`options`** | \u003ccode\u003e{ factor: number; }\u003c/code\u003e |\n\n--------------------\n\n\n### setFocus(...)\n\n```typescript\nsetFocus(options: { x: number; y: number; }) =\u003e Promise\u003cvoid\u003e\n```\n\n| Param         | Type                                   |\n| ------------- | -------------------------------------- |\n| **`options`** | \u003ccode\u003e{ x: number; y: number; }\u003c/code\u003e |\n\n--------------------\n\n\n### setDefaultUIElementURL(...)\n\n```typescript\nsetDefaultUIElementURL(url: string) =\u003e Promise\u003cvoid\u003e\n```\n\nWeb Only\n\n| Param     | Type                |\n| --------- | ------------------- |\n| **`url`** | \u003ccode\u003estring\u003c/code\u003e |\n\n--------------------\n\n\n### setElement(...)\n\n```typescript\nsetElement(ele: any) =\u003e Promise\u003cvoid\u003e\n```\n\nWeb Only\n\n| Param     | Type             |\n| --------- | ---------------- |\n| **`ele`** | \u003ccode\u003eany\u003c/code\u003e |\n\n--------------------\n\n\n### startCamera()\n\n```typescript\nstartCamera() =\u003e Promise\u003cvoid\u003e\n```\n\n--------------------\n\n\n### stopCamera()\n\n```typescript\nstopCamera() =\u003e Promise\u003cvoid\u003e\n```\n\n--------------------\n\n\n### takeSnapshot(...)\n\n```typescript\ntakeSnapshot(options: { quality?: number; }) =\u003e Promise\u003c{ base64: string; }\u003e\n```\n\ntake a snapshot as base64.\n\n| Param         | Type                               |\n| ------------- | ---------------------------------- |\n| **`options`** | \u003ccode\u003e{ quality?: number; }\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ base64: string; }\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### saveFrame()\n\n```typescript\nsaveFrame() =\u003e Promise\u003c{ success: boolean; }\u003e\n```\n\nsave a frame internally. Android and iOS only.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ success: boolean; }\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### takeSnapshot2(...)\n\n```typescript\ntakeSnapshot2(options: { canvas: HTMLCanvasElement; maxLength?: number; }) =\u003e Promise\u003c{ scaleRatio?: number; }\u003e\n```\n\ntake a snapshot on to a canvas. Web Only\n\n| Param         | Type                                              |\n| ------------- | ------------------------------------------------- |\n| **`options`** | \u003ccode\u003e{ canvas: any; maxLength?: number; }\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ scaleRatio?: number; }\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### takePhoto(...)\n\n```typescript\ntakePhoto(options: { pathToSave?: string; includeBase64?: boolean; }) =\u003e Promise\u003c{ path?: string; base64?: string; blob?: Blob; }\u003e\n```\n\n| Param         | Type                                                           |\n| ------------- | -------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e{ pathToSave?: string; includeBase64?: boolean; }\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ path?: string; base64?: string; blob?: any; }\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### toggleTorch(...)\n\n```typescript\ntoggleTorch(options: { on: boolean; }) =\u003e Promise\u003cvoid\u003e\n```\n\n| Param         | Type                          |\n| ------------- | ----------------------------- |\n| **`options`** | \u003ccode\u003e{ on: boolean; }\u003c/code\u003e |\n\n--------------------\n\n\n### getOrientation()\n\n```typescript\ngetOrientation() =\u003e Promise\u003c{ \"orientation\": \"PORTRAIT\" | \"LANDSCAPE\"; }\u003e\n```\n\nget the orientation of the device.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ orientation: 'PORTRAIT' | 'LANDSCAPE'; }\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### startRecording()\n\n```typescript\nstartRecording() =\u003e Promise\u003cvoid\u003e\n```\n\n--------------------\n\n\n### stopRecording(...)\n\n```typescript\nstopRecording(options: { includeBase64?: boolean; }) =\u003e Promise\u003c{ path?: string; base64?: string; blob?: Blob; }\u003e\n```\n\n| Param         | Type                                      |\n| ------------- | ----------------------------------------- |\n| **`options`** | \u003ccode\u003e{ includeBase64?: boolean; }\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ path?: string; base64?: string; blob?: any; }\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### setLayout(...)\n\n```typescript\nsetLayout(options: { top: string; left: string; width: string; height: string; }) =\u003e Promise\u003cvoid\u003e\n```\n\n| Param         | Type                                                                       |\n| ------------- | -------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e{ top: string; left: string; width: string; height: string; }\u003c/code\u003e |\n\n--------------------\n\n\n### requestCameraPermission()\n\n```typescript\nrequestCameraPermission() =\u003e Promise\u003cvoid\u003e\n```\n\n--------------------\n\n\n### requestMicroPhonePermission()\n\n```typescript\nrequestMicroPhonePermission() =\u003e Promise\u003cvoid\u003e\n```\n\n--------------------\n\n\n### isOpen()\n\n```typescript\nisOpen() =\u003e Promise\u003c{ isOpen: boolean; }\u003e\n```\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ isOpen: boolean; }\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### addListener('onPlayed', ...)\n\n```typescript\naddListener(eventName: 'onPlayed', listenerFunc: onPlayedListener) =\u003e Promise\u003cPluginListenerHandle\u003e\n```\n\n| Param              | Type                                                          |\n| ------------------ | ------------------------------------------------------------- |\n| **`eventName`**    | \u003ccode\u003e'onPlayed'\u003c/code\u003e                                       |\n| **`listenerFunc`** | \u003ccode\u003e\u003ca href=\"#onplayedlistener\"\u003eonPlayedListener\u003c/a\u003e\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pluginlistenerhandle\"\u003ePluginListenerHandle\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### addListener('onOrientationChanged', ...)\n\n```typescript\naddListener(eventName: 'onOrientationChanged', listenerFunc: onOrientationChangedListener) =\u003e Promise\u003cPluginListenerHandle\u003e\n```\n\n| Param              | Type                                                                                  |\n| ------------------ | ------------------------------------------------------------------------------------- |\n| **`eventName`**    | \u003ccode\u003e'onOrientationChanged'\u003c/code\u003e                                                   |\n| **`listenerFunc`** | \u003ccode\u003e\u003ca href=\"#onorientationchangedlistener\"\u003eonOrientationChangedListener\u003c/a\u003e\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pluginlistenerhandle\"\u003ePluginListenerHandle\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### removeAllListeners()\n\n```typescript\nremoveAllListeners() =\u003e Promise\u003cvoid\u003e\n```\n\n--------------------\n\n\n### Interfaces\n\n\n#### ScanRegion\n\nmeasuredByPercentage: 0 in pixel, 1 in percent\n\n| Prop                       | Type                |\n| -------------------------- | ------------------- |\n| **`left`**                 | \u003ccode\u003enumber\u003c/code\u003e |\n| **`top`**                  | \u003ccode\u003enumber\u003c/code\u003e |\n| **`right`**                | \u003ccode\u003enumber\u003c/code\u003e |\n| **`bottom`**               | \u003ccode\u003enumber\u003c/code\u003e |\n| **`measuredByPercentage`** | \u003ccode\u003enumber\u003c/code\u003e |\n\n\n#### PluginListenerHandle\n\n| Prop         | Type                                      |\n| ------------ | ----------------------------------------- |\n| **`remove`** | \u003ccode\u003e() =\u0026gt; Promise\u0026lt;void\u0026gt;\u003c/code\u003e |\n\n\n### Type Aliases\n\n\n#### onPlayedListener\n\n\u003ccode\u003e(result: { resolution: string; }): void\u003c/code\u003e\n\n\n#### onOrientationChangedListener\n\n\u003ccode\u003e(): void\u003c/code\u003e\n\n\u003c/docgen-api\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxulihang%2Fcapacitor-plugin-camera","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxulihang%2Fcapacitor-plugin-camera","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxulihang%2Fcapacitor-plugin-camera/lists"}