快速入门

安装

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

npx 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-proximity` plugin in my project.

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

bun add @capgo/capacitor-proximity
bunx cap sync

导入

import { CapacitorProximity } from '@capgo/capacitor-proximity';

快速入门

import { CapacitorProximity } from '@capgo/capacitor-proximity';

const { available } = await CapacitorProximity.getStatus();
if (!available) return;

await CapacitorProximity.enable();
// start VoIP or voice playback UI

示例：语音消息播放

await CapacitorProximity.enable();
await playVoiceNote();
await CapacitorProximity.disable();

常见坑点

• 始终禁用: 调用 disable() 中的 finally 阻止亮度在错误后恢复。
• 无传感器设备：检查 getStatus() 在显示耳部接近 UX 之前。
• Web 端：接近 API 未暴露，仅保留原生调用。

API 概览

enable

启用距离感应监控。

在 iOS 上，这会启用 UIDevice.isProximityMonitoringEnabled。 在 Android 上，这会开始监听 TYPE_PROXIMITY ，并在传感器被遮挡时调暗当前应用窗口。

import { CapacitorProximity } from '@capgo/capacitor-proximity';

await CapacitorProximity.enable();

disable

禁用距离感应监控。

这将恢复默认的应用窗口行为，并停止传感器监控。

import { CapacitorProximity } from '@capgo/capacitor-proximity';

await CapacitorProximity.disable();

getStatus

获取当前传感器可用性及插件启用状态。

import { CapacitorProximity } from '@capgo/capacitor-proximity';

const status = await CapacitorProximity.getStatus();

类型参考

ProximityStatusResult

返回结果： getStatus().

export interface ProximityStatusResult {
  /**
   * Whether the current device exposes a usable proximity sensor.
   *
   * @since 0.0.1
   */
  available: boolean;

  /**
   * Whether proximity monitoring is currently enabled by the plugin.
   *
   * @since 0.0.1
   */
  enabled: boolean;

  /**
   * Platform label returned by the native or web implementation.
   *
   * @since 0.0.1
   */
  platform: 'ios' | 'android' | 'web';
}

PluginVersionResult

请求插件版本时返回的结果。

export interface PluginVersionResult {
  /**
   * Native plugin version string.
   *
   * @since 0.0.1
   */
  version: string;
}

单一事实来源

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

从入门指南继续

如果你正在使用 快速入门 要规划 dashboard 和 API 操作，请将其连接到 使用 @capgo/capacitor-proximity 在“使用 @capgo/capacitor-proximity”中的原生功能 API 概览 关于 API Overview 中的实现细节， 简介 关于 Introduction 中的实现细节， API 密钥 有关 API Keys 的实现细节，以及 设备 有关 Devices 的实现细节。