Getting Started

Instalar

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

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

Luego utilice la siguiente solicitud:

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

Si prefiere la configuración manual, instale el complemento ejecutando los siguientes comandos y siguiendo las instrucciones específicas de la plataforma a continuación:

bun add @capgo/capacitor-brightness
bunx cap sync

Importar

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

API Resumen

getBrightness

Obtenga el nivel de brillo actual de la pantalla principal del dispositivo.

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

const result = await CapgoBrightness.getBrightness();
console.log(result);

setBrightness

Establezca el nivel de brillo de la pantalla principal del dispositivo.

En iOS, el brillo persistirá hasta que el dispositivo esté bloqueado. En Android, el brillo solo se aplica a la actividad actual.

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

await CapgoBrightness.setBrightness({ brightness: 0.5 });

getSystemBrightness

Obtén la luminosidad de pantalla del sistema.

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

const result = await CapgoBrightness.getSystemBrightness();
console.log(result);

setSystemBrightness

Establecer la intensidad de pantalla del sistema en general. Requiere permiso WRITE_SETTINGS en Android. También cambia el modo de intensidad a MANUAL.

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

await CapgoBrightness.setSystemBrightness({ brightness: 0.5 });

getSystemBrightnessMode

Obtenga el modo de brillo del sistema actual (automático o manual). Requiere permiso WRITE_SETTINGS en Android.

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

const result = await CapgoBrightness.getSystemBrightnessMode();
console.log(result);

setSystemBrightnessMode

Establecer el modo de brillo del sistema (automático o manual). Requiere permiso WRITE_SETTINGS en Android.

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

await CapgoBrightness.setSystemBrightnessMode({ mode: BrightnessMode.AUTOMATIC });

isUsingSystemBrightness

Verificar si la actividad actual está utilizando el valor de brillo del sistema.

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

const result = await CapgoBrightness.isUsingSystemBrightness();
console.log(result);

restoreSystemBrightness

Restablecer la configuración de brillo de la actividad actual para utilizar el valor del sistema.

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

await CapgoBrightness.restoreSystemBrightness();

isAvailable

Verificar si el control de brillo API está disponible en el dispositivo actual.

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

const result = await CapgoBrightness.isAvailable();
console.log(result);

checkPermissions

Verificar permisos del usuario para acceder al brillo del sistema.

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

const result = await CapgoBrightness.checkPermissions();
console.log(result);

requestPermissions

Solicitar permisos para acceder a la luminosidad del sistema. En Android, esto abre la configuración del sistema para conceder permiso WRITE_SETTINGS.

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

const result = await CapgoBrightness.requestPermissions();
console.log(result);

Tipo de referencia

GetBrightnessResult

Resultado de getBrightness o 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

Opciones para setBrightness o 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

Resultado de getSystemBrightnessMode.

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

SetBrightnessModeOptions

Opciones para setSystemBrightnessMode.

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

IsUsingSystemBrightnessResult

Resultado de isUsingSystemBrightness.

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

IsAvailableResult

Resultado de isAvailable.

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

PermissionStatus

Resultado del estado de permiso.

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

GetPluginVersionResult

Resultado de obtener versión del plugin.

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

BrightnessMode

El modo de brillo.

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

Estado de permiso.

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

Fuente de Verdad

Esta página se genera a partir del plugin’s src/definitions.ts. Vuelva a sincronizar cuando los cambios públicos API cambien en la fuente.

Siga adelante desde Inicio

Si está utilizando Getting Started para planificar la consola y API operaciones, conecte con Usando @capgo/capacitor-brillo para la capacidad nativa en Usando @capgo/capacitor-brillo, API Resumen para el detalle de implementación en API Introducción Introducción para el detalle de implementación en Introducción API Claves para el detalle de implementación en API Claves, y Dispositivos Para los detalles de implementación en dispositivos.