Getting Started

설치

플러그인을 설치하기 위해 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-brightness` plugin in my project.

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

bun add @capgo/capacitor-brightness
bunx cap sync

Import

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

API 개요

getBrightness

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

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

await CapgoBrightness.getBrightness();

setBrightness

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

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

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

await CapgoBrightness.setBrightness({} as SetBrightnessOptions);

getSystemBrightness

시스템 전반적인 화면 밝기를 가져옵니다.

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

await CapgoBrightness.getSystemBrightness();

setSystemBrightness

시스템 전반적인 화면 밝기를 설정합니다. Android에서는 WRITE_SETTINGS 권한이 필요합니다. 이 또한 밝기 모드를 MANUAL로 변경합니다.

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

await CapgoBrightness.setSystemBrightness({} as SetBrightnessOptions);

getSystemBrightnessMode

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

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

await CapgoBrightness.getSystemBrightnessMode();

setSystemBrightnessMode

시스템 밝기 모드를 자동 또는 수동으로 설정합니다. Android에서 WRITE_SETTINGS 권한이 필요합니다.

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

await CapgoBrightness.setSystemBrightnessMode({} as SetBrightnessModeOptions);

isUsingSystemBrightness

현재 활동이 시스템 전체 밝기 값을 사용하는지 확인합니다.

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

await CapgoBrightness.isUsingSystemBrightness();

restoreSystemBrightness

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

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

await CapgoBrightness.restoreSystemBrightness();

isAvailable

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

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

await CapgoBrightness.isAvailable();

checkPermissions

시스템 밝기 접근을 위한 사용자의 권한을 확인하세요.

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

await CapgoBrightness.checkPermissions();

requestPermissions

시스템 밝기 접근을 위한 권한을 요청하세요. 안드로이드에서 이건 시스템 설정을 열어 WRITE_SETTINGS 권한을 부여하도록 합니다.

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

await CapgoBrightness.requestPermissions();

타입 참조

GetBrightnessResult

클립보드에 복사

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

시스템 밝기 모드 결과

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

SetBrightnessModeOptions

시스템 밝기 모드 설정 옵션

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

IsUsingSystemBrightnessResult

시스템 밝기 사용 여부 결과

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

IsAvailableResult

사용 가능 여부 결과

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

플러그인 버전 결과.

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. upstream의 공개 API이 변경될 때 다시 싱크를 실행하세요.

Getting Started에서 계속

이 플러그인을 사용하는 경우 Getting Started 계획 대시보드 및 API 운영을 위해 Using @capgo/capacitor-brightness Using @capgo/capacitor-brightness API 개요 API 구현 세부 정보를 위한 소개 __CAPGO_KEEP_0__ 구현 세부 정보를 위한 API 키 API 구현 세부 정보를 위한, 장치 __CAPGO_KEEP_0__ 구현 세부 정보를 위한.