Skip to main content
Capgo logo
Back to plugins
@capgo/capacitor-screen-recorder
Tutorial
@capgo/capacitor-screen-recorder

Screen Recorder

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

Downloads/month

20.4k

GitHub Stars

26

Guide

Tutorial on Screen Recorder

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.