https://github.com/Cap-go/capacitor-screen-recorder
Record the screen of the phone with native API
https://github.com/Cap-go/capacitor-screen-recorder
capacitor capacitor-plugin ionic
Last synced: about 2 months ago
JSON representation
Record the screen of the phone with native API
- Host: GitHub
- URL: https://github.com/Cap-go/capacitor-screen-recorder
- Owner: Cap-go
- Created: 2021-11-12T04:22:12.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-28T05:14:16.000Z (2 months ago)
- Last Synced: 2025-05-05T08:21:20.747Z (about 2 months ago)
- Topics: capacitor, capacitor-plugin, ionic
- Language: Swift
- Homepage: https://capgo.app
- Size: 1.09 MB
- Stars: 12
- Watchers: 3
- Forks: 8
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- awesome-capacitorjs - @capgo/capacitor-screen-recorder - Record screen and save to pelicule. (Plugins / Community Plugins)
- awesome-capacitor - Screen recorder - Record screen and save to pelicule. ([Capgo plugins](https://capgo.app/))
README
# Capacitor-screen-recorder
➡️ Get Instant updates for your App with Capgo 🚀
Fix your annoying bug now, Hire a Capacitor expert 💪
Record device's screen
## Install
```bash
npm install @capgo/capacitor-screen-recorder
npx cap sync
```
## IOS
add NSPhotoLibraryUsageDescription in your info.plist
## Android
increase project's minSdk version to 23, it's required by the dependency HBRecorder
Add these permissions in your `AndroidManifest.xml`:
```xml
```
### Add JitPack Repository
Add JitPack repository to your Android app's build.gradle (android/app/build.gradle):
```gradle
allprojects {
repositories {
google()
mavenCentral()
maven { url 'https://jitpack.io/' }
}
}
```
### Variables
This plugin will use the following project variables (defined in your app's `variables.gradle` file):
- `$kotlinVersion` version of `org.jetbrains.kotlin:kotlin-stdlib-jdk7` (default: `1.7.21`)
If you have compilation issue `Duplicate class androidx.lifecycle.ViewModelLazy`
i found in this the solution who worked for me:
https://stackoverflow.com/questions/73406969/duplicate-class-androidx-lifecycle-viewmodellazy-found-in-modules-lifecycle-view
Add this
```
configurations {
all {
exclude group: 'androidx.lifecycle', module: 'lifecycle-runtime-ktx'
exclude group: 'androidx.lifecycle', module: 'lifecycle-viewmodel-ktx'
}
}
an
```
line 2 in file `android/app/build.gradle`
## Configuration
No configuration required for this plugin.
## API
* [`start(...)`](#start)
* [`stop()`](#stop)
### start(...)
```typescript
start(options?: { recordAudio?: boolean | undefined; } | undefined) => Promise
```
start the recording
| Param | Type | Description |
| ------------- | --------------------------------------- | ----------------- |
| **`options`** | { recordAudio?: boolean; } | Recording options |
--------------------
### stop()
```typescript
stop() => Promise
```
stop the recording
--------------------