Skip to main content
Back to plugins
@capgo/capacitor-screen-recorder
Tutorial
by github.com/Cap-go

Screen Recorder

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

Guide

Tutorial on Screen Recorder

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