Getting Started

__CAPGO_KEEP_8__

AI-Assisted 설치를 사용하여 플러그인을 설치할 수 있습니다. Capgo 스킬을 AI 도구에 추가하려면 다음 명령어를 사용하세요:

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

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

__CAPGO_KEEP_2__ 사용 중 시스템 밝기 여부.

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

IsAvailableResult

__CAPGO_KEEP_2__ 사용 가능 여부.

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

PermissionStatus

__CAPGO_KEEP_2__ 권한 상태 결과.

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

GetPluginVersionResult

__CAPGO_KEEP_2__ 플러그인 버전 가져오기.

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';

진실의 원천

이 페이지는 플러그인의 __CAPGO_KEEP_0__에서 생성되었습니다. src/definitions.ts업스트림에서 공공 API이 변경되었을 때 다시 싱크를 실행하세요.

Getting Started에서 계속 진행하세요.

__CAPGO_KEEP_0__을 사용 중이라면 시작하기 API과 API 연동을 위해 capgo/capacitor-brightness를 사용하여 Using @capgo/capacitor-brightness의 네이티브 기능을 사용하여 API 개요 API 개요의 구현 세부 정보를 위해 소개 소개의 구현 세부 정보를 위해 API 키 API 키의 구현 세부 정보를 위해 기기 기기 구현 세부 사항에 대한 자세한 내용.