@capgo/capacitor-screen-recorder

中文文档
8.4.7发布于 2026/11/09MPL-2.0TypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 4.3万

记录设备的屏幕

中文使用文档
文档目录18 节
  1. *免费开始*
  2. 主要特点
  3. 文档
  4. 兼容性
  5. 安装
  6. 监督办
  7. 机器人
  8. 添加 JitPack 仓库
  9. 变量
  10. 配置
  11. API 密码
  12. 启动(...)
  13. 停止( )
  14. 添加聆听器( “ 停止 ” ,...)
  15. 删除所有收听器( )
  16. 获取 PluginVersion ()
  17. 接口
  18. 类型异名

电容-屏幕-记录器

从您的 Capacitor app 中记录设备屏幕, 并带有可选的音频, 用于错误报告、 教程和演示 .

Capgo - Build Capacitor apps with AI, ship updates instantly

队长:在几分钟内将修正推给您的 Capacitor 用户,在没有Mac的情况下构建已签名的iOS和Android apps,并在一击中回滚.

*免费开始*

14天无限自由审判. 不需要信用卡

🤖 建筑与AI编码代理? 安装 Capgo 技能 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 @capgo/capacitor-screen-recorder 在您的电容应用程序中: npx skills add Cap-go/capgo-skills。然后问你的经纪人: 添加@capgo/capor-screen-recorder到我的Capacitor应用软件上并把它接上" 代理设置指南 • 妇女 主机磁共振

@capgo/capacitor-screen-recorder for Capacitor apps

主要特点

  • 开始数字 : start() 系统同意后开始录制 .
  • 停下来数字 : stop() 结束录音.
  • 音频设置 recordAudio 用视频捕捉声音.
  • 本地捕获:在iOS上重放Kit,保存到相片库上,和Android上的MediaProjection.
  • 平台: iOS和Android. 互联网档案馆的存檔,存档日期2013-12-21. 在网上不可用.

文档

这里有最完整的医生: https://capgo.app/docs/plugins/screen-recorder/ 页面存档备份,存于互联网档案馆

兼容性

插件版本电容兼容性维护
联合国联合国✅
页:1页:1应要求
页:1页:1❌
页:1页:1❌

说明: 此插件的主要版本沿用了Capacitor的主要版本. 使用匹配您的 Capacitor 安装的版本( 如 Capacitor 8 的插件 v8) 。 只有最新的主要版本得到积极维护.

安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

然后使用下列提示:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-screen-recorder` plugin in my project.

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

npm install @capgo/capacitor-screen-recorder
npx cap sync

监督办

在您的信息. plist 中添加 NSPhotoLibraryAddUsage 描述

机器人

将工程的 minSdk 版本增加为 23, 这是依赖 HBRecord 所需要的

在您的权限中添加这些权限 AndroidManifest.xml数字 :

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_INTERNAL_STORAGE" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION" />

添加 JitPack 仓库

将 JitPack 寄存器添加到您的 Android app 所创建的. gradle (android/app/build.gradle) 中 :

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

变量

此插件将使用以下工程变量( 在您的应用程序中定义) variables.gradle 文件名 :

  • $kotlinVersion 版本 org.jetbrains.kotlin:kotlin-stdlib-jdk7 (默认 : 1.7.21(中文(简体) )

如果您有汇编问题 Duplicate class androidx.lifecycle.ViewModelLazy 我在这里找到了为我工作的解决方案: https://stackoverflow.com/ questions/73406969/ 二重级-同级-机器人-生命周期-观光模型lazy-found-in-modules-lifecycle-view 互联网档案馆的存檔,存档日期2013-10-02

添加这个

configurations {
    all {
        exclude group: 'androidx.lifecycle', module: 'lifecycle-runtime-ktx'
        exclude group: 'androidx.lifecycle', module: 'lifecycle-viewmodel-ktx'
    }
}
an

文件行 2 android/app/build.gradle

配置

此插件不需要配置 .

API 密码

用于记录设备屏幕的 Capacitor Screen Recorder 插件 . 允许您用可选的音频获取屏幕的录像.

启动(...)

start(options?: StartRecordingOptions | undefined) => Promise<void>

开始录制设备屏幕.

启动可选音频捕获的屏幕记录 。 用户将 提醒您如果尚未授予屏幕记录权限, 则会给予此权限 . 在iOS上,将显示录制UI的系统. 在Android上,录音 批准后立即启动.

参数类型说明
optionsStartRecordingOptions- 记录配置选项

自: 1.0.0 (单位:千美元)


停止( )

stop() => Promise<void>

停止当前屏幕记录 .

停止活动屏幕录制并将视频保存到设备的 摄影机或画廊。 在iOS上,系统将显示预览 记录。 在Android上,视频被直接保存到画廊.

自: 1.0.0 (单位:千美元)


添加聆听器( “ 停止 ” ,...)

addListener(eventName: 'onStopped', listenerFunc: (event: ScreenRecorderStoppedEvent) => void) => Promise<PluginListenerHandle>

听录制结束,没有被调用.

参数类型说明
eventName'onStopped'- 说吧 onStopped
listenerFunc(event: ScreenRecorderStoppedEvent) => void- 召见一个 ScreenRecorderStoppedEvent (单位:千美元)url 和可选 error当录音结束在外 stop()。 。 。 .

回返情况: Promise<PluginListenerHandle>

自: 8.4.0 (单位:百万美元)


删除所有收听器( )

removeAllListeners() => Promise<void>

删除所有使用 QQlink 添加Listener 注册的听众 .

自: 8.4.0 (单位:百万美元)


获取 PluginVersion ()

getPluginVersion() => Promise<{ version: string; }>

获取本地 Capacitor 插件版本 .

回返情况: Promise<{ version: string; }>

自: 1.0.0 (单位:千美元)


接口

开始记录选项

QQlink ScreenRecorderPlugin. start 的选项 .

Prop类型说明默认自兹
recordAudioboolean是否随屏幕视频一起记录音频 .false1.0.0 (单位:千美元)
formatScreenRecorderVideoFormat | 'video/mp4' | 'video/quicktime'保存记录的视频容器格式 。 接受 mp4, (中文(简体) ), mov类型 video/mp4 财务报告和审定财务报表 video/quicktimeiOS 支持两者 mp4 财务报告和审定财务报表 mov. Android records MPEG-4 (英语:.mp4),无论这一值.'mp4'8.3.0 (单位:千美元)

插件听筒

Prop类型
remove() => Promise<void>

屏幕反馈命令已停止

有效载荷 onStopped 活动.

当一个录制结束而没有QQlink ScreenRecorderPlugin.stop} 时被解除 调用:用户停止从系统UI中捕获(Android"停止共享"), 记录器达到限制(最大持续时间或最大文件大小),或系统 被中断的抓取( iOS, 例如一个来电) .

Prop类型说明自兹
urlstring完成录制的本地 URI(file:// (原始内容存档于2018-09-21). Android. 无法解析文件路径时的空字符串 .8.4.0 (单位:百万美元)
errorstring录音以失败结束时出错消息 .8.4.0 (单位:百万美元)

类型异名

屏幕反馈视频格式

支持用于屏幕录音的视频容器格式.

'mp4' | 'mov'

版本与发布记录

@capgo/capacitor-screen-recorder 共发布 271 个版本,首次发布于 2022/07/24;过去 12 个月发布了 72 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
8.4.7latest2026/11/09今天
8.4.62026/11/026 天前
8.4.52026/10/2613 天前
8.4.42026/10/1921 天前
8.4.32026/10/1525 天前
8.4.22026/10/1327 天前

关于 @capgo/capacitor-screen-recorder 的常见问题

@capgo/capacitor-screen-recorder 是什么?

记录设备的屏幕

如何安装 @capgo/capacitor-screen-recorder?

在项目目录运行 npm install @capgo/capacitor-screen-recorder,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@capacitor/core(>=8.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@capgo/capacitor-screen-recorder 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@capgo/capacitor-screen-recorder 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@capgo/capacitor-screen-recorder 可以商用吗?

@capgo/capacitor-screen-recorder 使用 MPL-2.0 许可。弱 Copyleft:可以商用,也可以和闭源代码一起使用;但如果分发时修改了 MPL 授权的文件,这些文件的修改需以 MPL 开源。以上为概括,不构成法律意见,请以许可原文为准。

@capgo/capacitor-screen-recorder 的下载量有多少?

根据 npm 官方下载统计,@capgo/capacitor-screen-recorder 在 2026/10/09 – 2026/11/07 这 30 天内被下载 43,489 次,日均约 1,450 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@capgo/capacitor-screen-recorder 还在维护吗?

最新版本 8.4.7 发布于 2026/11/09(今天);至今共发布 271 个版本,其中过去 12 个月发布了 72 个;首次发布于 2022/07/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。