시작하기

설치

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

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

Manual Setup을 선호한다면, 다음 명령어를 실행하여 플러그인을 설치하고 아래의 플랫폼별 지침을 따르세요:

bun add @capgo/capacitor-brightness
npx cap sync

가져오기

import { CapgoBrightness } from '@capgo/capacitor-brightness';

빠른 시작

import { CapgoBrightness } from '@capgo/capacitor-brightness';

const result = await CapgoBrightness.getBrightness();
console.log(result);

예시: setBrightness

import { CapgoBrightness } from '@capgo/capacitor-brightness';

await CapgoBrightness.setBrightness({ brightness: 0.5 });

예시: getSystemBrightness

import { CapgoBrightness } from '@capgo/capacitor-brightness';

const result = await CapgoBrightness.getSystemBrightness();
console.log(result);

자주 하는 실수

• 권한: 호출 checkPermissions() 그다음 requestPermissions() 필요할 때.
• 네이티브 동기화: 실행 npx cap sync 플러그인 업그레이드 후.
• 단일 진실 공급원: 신뢰 src/definitions.ts GitHub 레포지토리에서.

API 개요

getBrightness

기기 메인 화면의 현재 밝기 값을 가져옵니다.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

const result = await CapgoBrightness.getBrightness();
console.log(result);

setBrightness

기기 메인 화면의 밝기 값을 설정합니다.

iOS에서는 기기가 잠길 때까지 밝기가 유지됩니다. Android에서는 현재 액티비티에만 밝기가 적용됩니다.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

await CapgoBrightness.setBrightness({ brightness: 0.5 });

getSystemBrightness

시스템 전체의 화면 밝기를 가져옵니다.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

const result = await CapgoBrightness.getSystemBrightness();
console.log(result);

setSystemBrightness

시스템 전체의 화면 밝기를 설정합니다. Android에서는 WRITE_SETTINGS 권한이 필요합니다. 설정 시 밝기 모드가 MANUAL로 변경됩니다.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

await CapgoBrightness.setSystemBrightness({ brightness: 0.5 });

getSystemBrightnessMode

현재 시스템 밝기 모드(automatic 또는 manual)를 가져옵니다. Android에서는 WRITE_SETTINGS 권한이 필요합니다.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

const result = await CapgoBrightness.getSystemBrightnessMode();
console.log(result);

setSystemBrightnessMode

시스템 밝기 모드(automatic 또는 manual)를 설정합니다. Android에서는 WRITE_SETTINGS 권한이 필요합니다.

import { CapgoBrightness, BrightnessMode } from '@capgo/capacitor-brightness';

await CapgoBrightness.setSystemBrightnessMode({ mode: BrightnessMode.AUTOMATIC });

isUsingSystemBrightness

현재 액티비티가 시스템 전체 밝기 값을 사용 중인지 확인합니다.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

const result = await CapgoBrightness.isUsingSystemBrightness();
console.log(result);

restoreSystemBrightness

현재 액티비티의 밝기 설정을 시스템 전체 값으로 초기화합니다.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

await CapgoBrightness.restoreSystemBrightness();

isAvailable

현재 기기에서 Brightness API 사용이 가능한지 확인합니다.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

const result = await CapgoBrightness.isAvailable();
console.log(result);

checkPermissions

시스템 밝기 접근에 대한 사용자 권한을 확인합니다.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

const result = await CapgoBrightness.checkPermissions();
console.log(result);

requestPermissions

시스템 밝기 접근 권한을 요청합니다. Android의 경우, WRITE_SETTINGS 권한을 부여하기 위해 시스템 설정 화면이 열립니다.

import { CapgoBrightness } from '@capgo/capacitor-brightness';

const result = await CapgoBrightness.requestPermissions();
console.log(result);

타입 참조

GetBrightnessResult

getBrightness 또는 getSystemBrightness의 결과값입니다.

export interface GetBrightnessResult {
  /**
   * The brightness value from 0 to 1.
   * 0 is the minimum brightness, 1 is the maximum brightness.
   *
   * @since 8.0.0
   */
  brightness: number;
}

SetBrightnessOptions

setBrightness 또는 setSystemBrightness의 옵션입니다.

export interface SetBrightnessOptions {
  /**
   * The brightness value from 0 to 1.
   * 0 is the minimum brightness, 1 is the maximum brightness.
   *
   * @since 8.0.0
   */
  brightness: number;
}

GetBrightnessModeResult

getSystemBrightnessMode의 결과값입니다.

export interface GetBrightnessModeResult {
  /**
   * The current brightness mode.
   *
   * @since 8.0.0
   */
  mode: BrightnessMode;
}

SetBrightnessModeOptions

setSystemBrightnessMode를 위한 옵션입니다.

export interface SetBrightnessModeOptions {
  /**
   * The brightness mode to set.
   * Cannot be set to UNKNOWN.
   *
   * @since 8.0.0
   */
  mode: BrightnessMode;
}

IsUsingSystemBrightnessResult

isUsingSystemBrightness의 결과값입니다.

export interface IsUsingSystemBrightnessResult {
  /**
   * Whether the current activity is using the system-wide brightness value.
   *
   * @since 8.0.0
   */
  isUsing: boolean;
}

IsAvailableResult

isAvailable의 결과값입니다.

export interface IsAvailableResult {
  /**
   * Whether the Brightness API is available on the current device.
   *
   * @since 8.0.0
   */
  available: boolean;
}

PermissionStatus

권한 상태 결과.

export interface PermissionStatus {
  /**
   * Whether the permission to modify system brightness is granted.
   *
   * @since 8.0.0
   */
  brightness: PermissionState;
}

GetPluginVersionResult

getPluginVersion의 결과.

export interface GetPluginVersionResult {
  /**
   * The native plugin version.
   *
   * @since 8.0.0
   */
  version: string;
}

BrightnessMode

밝기 모드.

export enum BrightnessMode {
  /**
   * The brightness mode is unknown.
   *
   * @since 8.0.0
   */
  UNKNOWN = 0,
  /**
   * The brightness is automatically adjusted by the system.
   *
   * @since 8.0.0
   */
  AUTOMATIC = 1,
  /**
   * The brightness is manually set by the user.
   *
   * @since 8.0.0
   */
  MANUAL = 2,
}

PermissionState

권한 상태.

export type PermissionState = 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';

기준 소스

이 페이지는 플러그인의 src/definitions.ts에서 생성되었습니다. public API가 업스트림에서 변경되면 동기화를 다시 실행하세요.

Getting Started에서 계속하기

사용 중인 경우 시작하기 대시보드와 API 운영을 계획하려면, 이를 다음 항목과 연결하세요: @capgo/capacitor-brightness 사용하기 @capgo/capacitor-brightness를 사용하여 네이티브 기능을 구현할 때, API 개요 API Overview의 구현 상세 내용은 소개 Introduction의 구현 상세 내용은 API 키 API Keys의 구현 세부 사항은, 디바이스 Devices의 구현 세부 사항은.