开始

安装

bun add @capgo/capacitor-brightness
bunx cap sync

导入

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 权限。 此操作也会将亮度模式更改为手动模式。

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

await CapgoBrightness.setSystemBrightness({} as SetBrightnessOptions);

getSystemBrightnessMode

复制到剪贴板

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

await CapgoBrightness.getSystemBrightnessMode();

setSystemBrightnessMode

是否正在使用系统亮度

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

检查亮度API在当前设备上是否可用。

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

await CapgoBrightness.isAvailable();

checkPermissions

复制到剪贴板

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

await CapgoBrightness.checkPermissions();

requestPermissions

__CAPGO_KEEP_0__

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

await CapgoBrightness.requestPermissions();

__CAPGO_KEEP_2__

GetBrightnessResult

__CAPGO_KEEP_5__

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

__CAPGO_KEEP_8__

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

__CAPGO_KEEP_11__

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当公共API上游更改时，请重新同步。

从 Getting Started 继续

如果您正在使用 Getting Started 来规划仪表板和API操作，请将其与 使用 @capgo/capacitor-brightness 连接到使用 @capgo/capacitor-brightness API Overview API Overview 来获取__CAPGO_KEEP_0__ Overview 中实现细节的信息 在介绍中实现细节 API 键 在 API 键中实现细节， 设备 在设备中实现细节。