Skip to main content
@capgo/capacitor-screen-recorder Media Open source

Screen Recorder Capacitor plugin

Capture screen recordings with audio for tutorials, demos, and bug reports

Install

bun add @capgo/capacitor-screen-recorder bunx cap sync
npm, pnpm or yarn
  • npm install @capgo/capacitor-screen-recorder
  • pnpm add @capgo/capacitor-screen-recorder
  • yarn add @capgo/capacitor-screen-recorder

Guide

How to use Screen Recorder in Capacitor

Test on device

Download the Capgo app, then scan the QR code.

App Store Google Play
Screen Recorder plugin preview QR code

Using @capgo/capacitor-screen-recorder

Capacitor Screen Recorder Plugin for recording the device screen. Allows you to capture video recordings of the screen with optional audio.

Install

bun add @capgo/capacitor-screen-recorder
bunx cap sync

What This Plugin Exposes

  • start - Start recording the device screen.
  • stop - Stop the current screen recording.

Example Usage

start

Start recording the device screen.

import { ScreenRecorder } from '@capgo/capacitor-screen-recorder';

// Start recording without audio
await ScreenRecorder.start();

// Start recording with audio
await ScreenRecorder.start({ recordAudio: true });

stop

Stop the current screen recording.

import { ScreenRecorder } from '@capgo/capacitor-screen-recorder';

await ScreenRecorder.stop();
console.log('Recording saved to gallery');

Full Reference

Keep going from Using @capgo/capacitor-screen-recorder

If you are using Using @capgo/capacitor-screen-recorder to plan native media and interface behavior, connect it with @capgo/capacitor-screen-recorder for the implementation detail in @capgo/capacitor-screen-recorder, Getting Started for the implementation detail in Getting Started, Using @capgo/capacitor-live-activities for the native capability in Using @capgo/capacitor-live-activities, @capgo/capacitor-live-activities for the implementation detail in @capgo/capacitor-live-activities, and Using @capgo/capacitor-video-player for the native capability in Using @capgo/capacitor-video-player.

FAQ

Screen Recorder plugin FAQ

How do I install the Screen Recorder plugin in a Capacitor app?

Run "bun add @capgo/capacitor-screen-recorder" (or "npm install @capgo/capacitor-screen-recorder"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-screen-recorder" in your app code.

Does @capgo/capacitor-screen-recorder work with React, Vue and Angular?

Yes. Screen Recorder is a Capacitor package, so it works with any web framework that runs inside Capacitor, including Ionic, React, Vue, Angular, Svelte and plain JavaScript.

Which Capacitor version does @capgo/capacitor-screen-recorder support?

Capgo plugins follow Capacitor's major version: use the plugin major version that matches your Capacitor major version (for example plugin v8 with Capacitor 8). The compatibility table in the GitHub README lists the maintained versions.

Is @capgo/capacitor-screen-recorder free and open source?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-screen-recorder/ and the package is free to install from npm. Bug reports and pull requests are welcome.

Can I update code that uses Screen Recorder without an App Store review?

Installing or upgrading the plugin changes native code, so it needs a new store build. After that, JavaScript, HTML and CSS changes that call the plugin can ship instantly with Capgo live updates.

Media

Related plugins

Browse all plugins →

Ship Screen Recorder changes without waiting for app review

Once the plugin is in your store build, Capgo live updates push your JavaScript, HTML and CSS changes to users in minutes.

Start with Capgo