시작하기

설치, 동기화, 소스 마크다운 가이드를 포함합니다.

bun add @capgo/capacitor-brightness
bunx cap sync

클립보드에 복사하기

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

API Overview

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

__CAPGO_KEEP_0__

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

await CapgoBrightness.getSystemBrightness();

setSystemBrightness

__CAPGO_KEEP_0__ __CAPGO_KEEP_3__ __CAPGO_KEEP_4__

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

await CapgoBrightness.setSystemBrightness({} as SetBrightnessOptions);

getSystemBrightnessMode

__CAPGO_KEEP_2__

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

await CapgoBrightness.getSystemBrightnessMode();

setSystemBrightnessMode

__CAPGO_KEEP_7__ __CAPGO_KEEP_3__ __CAPGO_KEEP_4__

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

__CAPGO_KEEP_0__에 대한 시스템 밝기 접근 권한을 요청하십시오. 안드로이드에서 이 버튼을 클릭하면 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

시스템 밝기 모드를 설정하는 옵션입니다.

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

__CAPGO_KEEP_2__의 결과

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

BrightnessMode

__CAPGO_KEEP_2__의 밝기 모드

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

__CAPGO_KEEP_2__의 권한 상태

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

__CAPGO_KEEP_2__의 원천

이 페이지는 플러그인의 src/definitions.ts. upstream에서 API이 변경되었을 때 다시 싱크를 실행하세요.

Getting Started에서 계속하세요

Capacitor를 사용하는 경우 Getting Started Capacitor를 사용하여 대시보드와 API를 계획하고 운영하기 위해 Using @capgo/capacitor-brightness Using @capgo/capacitor-brightness에서 native capability를 사용하기 위해 API Overview API Overview에서 구현 세부 정보를 참조하세요. 소개 __CAPGO_KEEP_0__ 구현 세부 정보에서 API 키 API 키의 구현 세부 정보에서, 및 장치 장치의 구현 세부 정보에서.