{"id":20980895,"url":"https://github.com/cap-go/capacitor-screen-recorder","last_synced_at":"2026-05-11T09:54:53.446Z","repository":{"id":49325457,"uuid":"427230607","full_name":"Cap-go/capacitor-screen-recorder","owner":"Cap-go","description":"Capacitor plugin to record the screen of the phone in native","archived":false,"fork":false,"pushed_at":"2026-04-06T06:21:58.000Z","size":1734,"stargazers_count":22,"open_issues_count":9,"forks_count":11,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-04-06T08:41:19.259Z","etag":null,"topics":["capacitor","capacitor-plugin","ionic"],"latest_commit_sha":null,"homepage":"https://capgo.app","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cap-go.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null},"funding":{"github":"Cap-go","patreon":null,"open_collective":"capgo","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2021-11-12T04:22:12.000Z","updated_at":"2026-04-06T06:21:19.000Z","dependencies_parsed_at":"2026-01-19T14:11:43.860Z","dependency_job_id":"0cfc5c9f-c9a5-453d-a26e-d8e6faa4445d","html_url":"https://github.com/Cap-go/capacitor-screen-recorder","commit_stats":{"total_commits":360,"total_committers":4,"mean_commits":90.0,"dds":0.5416666666666667,"last_synced_commit":"3316897802a9a7665b36dc6dda845199e2831262"},"previous_names":["riderx/capacitor-screen-recorder"],"tags_count":249,"template":false,"template_full_name":null,"purl":"pkg:github/Cap-go/capacitor-screen-recorder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-screen-recorder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-screen-recorder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-screen-recorder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-screen-recorder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cap-go","download_url":"https://codeload.github.com/Cap-go/capacitor-screen-recorder/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-screen-recorder/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31746113,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T06:26:45.479Z","status":"ssl_error","status_checked_at":"2026-04-13T06:26:44.645Z","response_time":93,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["capacitor","capacitor-plugin","ionic"],"created_at":"2024-11-19T05:31:15.254Z","updated_at":"2026-04-13T09:01:09.968Z","avatar_url":"https://github.com/Cap-go.png","language":"Swift","funding_links":["https://github.com/sponsors/Cap-go","https://opencollective.com/capgo"],"categories":[],"sub_categories":[],"readme":"# Capacitor-screen-recorder\n \u003ca href=\"https://capgo.app/\"\u003e\u003cimg src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ch2\u003e\u003ca href=\"https://capgo.app/?ref=plugin_screen_recorder\"\u003e ➡️ Get Instant updates for your App with Capgo\u003c/a\u003e\u003c/h2\u003e\n  \u003ch2\u003e\u003ca href=\"https://capgo.app/consulting/?ref=plugin_screen_recorder\"\u003e Missing a feature? We’ll build the plugin for you 💪\u003c/a\u003e\u003c/h2\u003e\n\u003c/div\u003e\nRecord device's screen\n\n## Documentation\n\nThe most complete doc is available here: https://capgo.app/docs/plugins/screen-recorder/\n\n## Compatibility\n\n| Plugin version | Capacitor compatibility | Maintained |\n| -------------- | ----------------------- | ---------- |\n| v8.\\*.\\*       | v8.\\*.\\*                | ✅          |\n| v7.\\*.\\*       | v7.\\*.\\*                | On demand   |\n| v6.\\*.\\*       | v6.\\*.\\*                | ❌          |\n| v5.\\*.\\*       | v5.\\*.\\*                | ❌          |\n\n\u003e **Note:** The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.\n\n## Install\n\n```bash\nnpm install @capgo/capacitor-screen-recorder\nnpx cap sync\n```\n\n## IOS\n\nadd NSPhotoLibraryUsageDescription in your info.plist\n\n## Android\nincrease project's minSdk version to 23, it's required by the dependency HBRecorder\n\nAdd these permissions in your `AndroidManifest.xml`:\n```xml\n\u003cuses-permission android:name=\"android.permission.WRITE_EXTERNAL_STORAGE\" /\u003e\n\u003cuses-permission android:name=\"android.permission.WRITE_INTERNAL_STORAGE\" /\u003e\n\u003cuses-permission android:name=\"android.permission.RECORD_AUDIO\" /\u003e\n\u003cuses-permission android:name=\"android.permission.FOREGROUND_SERVICE\" /\u003e\n\u003cuses-permission android:name=\"android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION\" /\u003e\n```\n\n### Add JitPack Repository\nAdd JitPack repository to your Android app's build.gradle (android/app/build.gradle):\n\n```gradle\nallprojects {\n    repositories {\n        google()\n        mavenCentral()\n        maven { url 'https://jitpack.io/' }\n    }\n}\n```\n\n### Variables\n\nThis plugin will use the following project variables (defined in your app's `variables.gradle` file):\n- `$kotlinVersion` version of `org.jetbrains.kotlin:kotlin-stdlib-jdk7` (default: `1.7.21`)\n\nIf you have compilation issue `Duplicate class androidx.lifecycle.ViewModelLazy`\ni found in this the solution who worked for me:\nhttps://stackoverflow.com/questions/73406969/duplicate-class-androidx-lifecycle-viewmodellazy-found-in-modules-lifecycle-view\n\nAdd this\n```\nconfigurations {\n    all {\n        exclude group: 'androidx.lifecycle', module: 'lifecycle-runtime-ktx'\n        exclude group: 'androidx.lifecycle', module: 'lifecycle-viewmodel-ktx'\n    }\n}\nan\n```\nline 2 in file `android/app/build.gradle`\n\n## Configuration\n\nNo configuration required for this plugin.\n\n## API\n\n\u003cdocgen-index\u003e\n\n* [`start(...)`](#start)\n* [`stop()`](#stop)\n* [`getPluginVersion()`](#getpluginversion)\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\nCapacitor Screen Recorder Plugin for recording the device screen.\nAllows you to capture video recordings of the screen with optional audio.\n\n### start(...)\n\n```typescript\nstart(options?: { recordAudio?: boolean | undefined; } | undefined) =\u003e Promise\u003cvoid\u003e\n```\n\nStart recording the device screen.\n\nInitiates screen recording with optional audio capture. The user will be\nprompted to grant screen recording permissions if not already granted.\nOn iOS, the system recording UI will be displayed. On Android, the recording\nstarts immediately after permission is granted.\n\n| Param         | Type                                    | Description                       |\n| ------------- | --------------------------------------- | --------------------------------- |\n| **`options`** | \u003ccode\u003e{ recordAudio?: boolean; }\u003c/code\u003e | - Recording configuration options |\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### stop()\n\n```typescript\nstop() =\u003e Promise\u003cvoid\u003e\n```\n\nStop the current screen recording.\n\nStops the active screen recording and saves the video to the device's\ncamera roll or gallery. On iOS, the system will show a preview of the\nrecording. On Android, the video is saved directly to the gallery.\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### getPluginVersion()\n\n```typescript\ngetPluginVersion() =\u003e Promise\u003c{ version: string; }\u003e\n```\n\nGet the native Capacitor plugin version.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ version: string; }\u0026gt;\u003c/code\u003e\n\n**Since:** 1.0.0\n\n--------------------\n\n\u003c/docgen-api\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcap-go%2Fcapacitor-screen-recorder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcap-go%2Fcapacitor-screen-recorder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcap-go%2Fcapacitor-screen-recorder/lists"}