시작하기

설치

AI-Assisted Setup으로 플러그인을 설치할 수 있습니다. 다음 명령어로 AI 도구에 Capgo 스킬을 추가하세요:

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

그런 다음 아래 프롬프트를 사용하세요:

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를 표시하기 전에.
• 웹: proximity 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;
}

Source of Truth

이 페이지는 플러그인의 src/definitions.tsupstream에서 public API가 변경되면 sync를 다시 실행하세요.

시작하기 다음 단계

사용 중이라면 시작하기 대시보드 및 API 운영을 계획하려면, 이를 다음과 연결하세요 @capgo/capacitor-proximity 사용하기 @capgo/capacitor-proximity 사용에서 네이티브 기능을 위해 API 개요 구현 세부 사항은 API 개요에서 소개 구현 세부 사항은 소개에서 API 키 API Keys의 구현 세부 사항은, 기기 Devices의 구현 세부 사항은.