Capacitor Screen Recorder

Description

The Capacitor Screen Recorder plugin is a powerful tool for mobile app developers looking to enhance their applications with screen recording functionality. Seamlessly integrated with the Capacitor framework, this plugin allows users to effortlessly capture, save, and share video recordings of their app interactions. With customizable settings for video quality and recording controls, developers can provide users with a versatile and user-friendly recording experience. Whether for tutorial creation, bug reporting, or user engagement, the Capacitor Screen Recorder plugin offers a straightforward solution to incorporate screen recording capabilities into Capacitor-powered apps, enhancing their overall utility and user experience

Credits

This plugin makes use of the HBRecorder Android library for its screen recording features. Big thanks to the authors of the library for their hard work!

Supported Native Platform

Android : This plugin currently support Android Screen Recording

iOS : Coming Soon (No IOS Support)

Web : No Support

Documentation

Install

npm install @srikant-kumar/capacitor-screen-recorder
npx cap sync

Add Jitpack

Add in Main App build.gradle located add your capacitor android folder

allprojects {
    repositories {
        google()
        mavenCentral()
        //Add Here
        maven {
            url "https://jitpack.io"
        }
    }
}

npm install @srikant-kumar/capacitor-screen-recorder
npx cap sync

Add Jitpack

Add in Main App build.gradle located add your capacitor android folder

allprojects {
    repositories {
        google()
        mavenCentral()
        //Add Here
        maven {
            url "https://jitpack.io"
        }
    }
}

API

• start(...)
• stop(...)
• recorder_status(...)
• addListener('onRecordingStarted', ...)
• addListener('onRecordingComplete', ...)
• addListener('onRecordingError', ...)
• Interfaces

start(...)

start(options: any) => Promise<any>

| Param | Type | | ------------- | ---------------- | | options | any |

Returns: Promise<any>

stop(...)

stop(options: any) => Promise<any>

| Param | Type | | ------------- | ---------------- | | options | any |

Returns: Promise<any>

recorder_status(...)

recorder_status(options: any) => Promise<any>

| Param | Type | | ------------- | ---------------- | | options | any |

Returns: Promise<any>

addListener('onRecordingStarted', ...)

addListener(eventName: 'onRecordingStarted', listenerFunc: (data: any) => { status: true; message: "Recording Started"; }) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | ------------------------------------------------------------------------------ | | eventName | 'onRecordingStarted' | | listenerFunc | (data: any) => { status: true; message: 'Recording Started'; } |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('onRecordingComplete', ...)

addListener(eventName: 'onRecordingComplete', listenerFunc: (data: any) => { status: true; message: "Recording Stopped"; file_name: "2023-08-25-10-10-10.mp4"; file_path: "/storage/emulated/0/Movies/ScreenRecordings/2023-08-25-10-10-10.mp4"; }) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | eventName | 'onRecordingComplete' | | listenerFunc | (data: any) => { status: true; message: 'Recording Stopped'; file_name: '2023-08-25-10-10-10.mp4'; file_path: '/storage/emulated/0/Movies/ScreenRecordings/2023-08-25-10-10-10.mp4'; } |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('onRecordingError', ...)

addListener(eventName: 'onRecordingError', listenerFunc: (data: any) => { status: false; message: "Error Message"; }) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | --------------------------------------------------------------------------- | | eventName | 'onRecordingError' | | listenerFunc | (data: any) => { status: false; message: 'Error Message'; } |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Interfaces

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |