快速入门

复制包含安装步骤和该插件完整 Markdown 指南的配置 prompt。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-screen-recorder`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/screen-recorder/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

安装

你可以使用我们的 AI 辅助设置来安装插件。使用以下命令将 Capgo skills 添加到你的 AI 工具中：

bunx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下 prompt：

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

如果你更想手动设置，请运行以下命令安装插件，并按照下方各平台的说明操作：

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

导入

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

快速入门

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

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

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

// Start recording as MOV on iOS
await ScreenRecorder.start({ format: 'mov' });

示例：停止

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

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

常见坑点

监听器: 在页面卸载时移除句柄。
原生同步：运行 bunx cap sync 在插件升级后。
唯一可信来源：信任 src/definitions.ts 在 GitHub 仓库中。

API 概览

`start`

开始录制设备屏幕。

启动屏幕录制，可选择同时录制音频。如果尚未授予屏幕录制权限，系统会提示用户授权。在 iOS 上会显示系统录制界面；在 Android 上，授权后会立即开始录制。

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

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

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

`stop`

停止当前的屏幕录制。

停止当前的屏幕录制，并将视频保存到设备的相机胶卷或相册中。在 iOS 上，系统会显示录制预览。在 Android 上，视频将直接保存到相册。

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

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

单一事实来源

本页面由插件的 src/definitions.ts生成。当上游的公共 API 发生变化时，请重新运行 sync。

从入门指南继续

如果你正在使用 快速入门 来规划原生媒体和界面行为，并将其与使用 @capgo/capacitor-screen-recorder 在“使用 @capgo/capacitor-screen-recorder”中实现原生能力，使用 @capgo/capacitor-live-activities 用于使用 @capgo/capacitor-live-activities 时的原生能力， @capgo/capacitor-live-activities 在 @capgo/capacitor-live-activities 中的实现细节，使用 @capgo/capacitor-video-player 有关使用 @capgo/capacitor-video-player 时的原生能力，以及 @capgo/capacitor-video-player 关于 @capgo/capacitor-video-player. 中的实现细节