Getting Started

설치

AI 도움을 받아 플러그인을 설치할 수 있습니다. 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 Overview

getBrightness

Import

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

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

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

await CapgoBrightness.getSystemBrightnessMode();

setSystemBrightnessMode

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

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

await CapgoBrightness.setSystemBrightnessMode({} as SetBrightnessModeOptions);

isUsingSystemBrightness

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

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

await CapgoBrightness.isUsingSystemBrightness();

restoreSystemBrightness

__CAPGO_KEEP_0__ 현재 액티비티의 밝기 설정을 시스템 전체 값으로 되돌립니다.

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

await CapgoBrightness.restoreSystemBrightness();

isAvailable

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

isUsingSystemBrightness의 결과.

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_3__

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

GetPluginVersionResult

__CAPGO_KEEP_4__

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

BrightnessMode

__CAPGO_KEEP_0__

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에서 변경된 경우 pubic API를 다시 동기화하세요.

Getting Started에서 계속

__CAPGO_TARGET_LANGUAGE__에서 사용 중인 경우 Getting Started API 대시보드를 계획하고 API 운영을 연결하세요. @capgo/capacitor-brightness를 사용하여 @capgo/capacitor-brightness를 사용하여 native 기능을 사용하세요. API 개요 API 개요에서 구현 세부 정보를 참조하세요. 소개 소개에서 구현 세부 정보를 참조하세요. API 키 API 키에서 구현 세부 정보를 참조하세요. 그리고 기기 기기에서 구현 세부 정보를 참조하세요.