跳转到正文

快速入门

GitHub

你可以使用我们的 AI 辅助设置来安装插件。使用以下命令将 Capgo skills 添加到你的 AI 工具中:

终端窗口
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下 prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-brightness` plugin in my project.

如果你更想手动设置,请运行以下命令安装插件,并按照下方各平台的说明操作:

终端窗口
bun add @capgo/capacitor-brightness
npx cap sync
import { CapgoBrightness } from '@capgo/capacitor-brightness';
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getBrightness();
console.log(result);
import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.setBrightness({ brightness: 0.5 });
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getSystemBrightness();
console.log(result);
  • 权限: 调用 checkPermissions() 然后 requestPermissions() 在需要时。
  • 原生同步:运行 npx cap sync 在插件升级后。
  • 唯一可信来源:信任 src/definitions.ts 在 GitHub 仓库中。

获取设备主屏幕当前的亮度值。

import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getBrightness();
console.log(result);

设置设备主屏幕的亮度值。

在 iOS 上,亮度会一直保持,直到设备锁定。 在 Android 上,亮度只对当前 Activity 生效。

import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.setBrightness({ brightness: 0.5 });

获取系统全局屏幕亮度。

import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getSystemBrightness();
console.log(result);

设置系统全局屏幕亮度。 在 Android 上需要 WRITE_SETTINGS 权限。 这还会将亮度模式改为 MANUAL。

import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.setSystemBrightness({ brightness: 0.5 });

获取当前系统亮度模式(自动或手动)。 在 Android 上需要 WRITE_SETTINGS 权限。

import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getSystemBrightnessMode();
console.log(result);

设置系统亮度模式(自动或手动)。 在 Android 上需要 WRITE_SETTINGS 权限。

import { CapgoBrightness, BrightnessMode } from '@capgo/capacitor-brightness';
await CapgoBrightness.setSystemBrightnessMode({ mode: BrightnessMode.AUTOMATIC });

检查当前 Activity 是否正在使用系统全局亮度值。

import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.isUsingSystemBrightness();
console.log(result);

将当前 Activity 的亮度设置重置为使用系统全局值。

import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.restoreSystemBrightness();

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

import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.isAvailable();
console.log(result);

检查用户访问系统亮度的权限。

import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.checkPermissions();
console.log(result);

请求访问系统亮度的权限。 在 Android 上,这会打开系统设置以授予 WRITE_SETTINGS 权限。

import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.requestPermissions();
console.log(result);

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

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

getSystemBrightnessMode 的结果。

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

setSystemBrightnessMode 的选项。

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

isUsingSystemBrightness 的结果。

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

isAvailable 的结果。

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

权限状态结果。

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

getPluginVersion 的结果。

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

亮度模式。

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,
}

权限状态。

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

本页面由插件的 src/definitions.ts生成。当上游的公共 API 发生变化时,请重新运行 sync。

如果你正在使用 快速入门 要规划 dashboard 和 API 操作,请将其连接到 使用 @capgo/capacitor-brightness 在“使用 @capgo/capacitor-brightness”中的原生功能 API 概览 关于 API Overview 中的实现细节, 简介 关于 Introduction 中的实现细节, API 密钥 有关 API Keys 的实现细节,以及 设备 有关 Devices 的实现细节。