Saltar al contenido

Primeros pasos

GitHub

Puedes usar nuestro setup asistido por IA para instalar el plugin. Añade las skills de Capgo a tu herramienta de IA con el siguiente comando:

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

Luego usa el siguiente prompt:

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

Si prefieres la configuración manual, instala el plugin ejecutando estos comandos y sigue las instrucciones de cada plataforma:

Ventana de terminal
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);
  • Permisos: llama a checkPermissions() luego requestPermissions() cuando sea necesario.
  • Sync nativo: ejecuta npx cap sync tras actualizar los plugins.
  • Fuente de verdad: confianza src/definitions.ts en el repo de GitHub.

Obtén 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);

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

En iOS, el brillo se mantendrá hasta que se bloquee el dispositivo. En Android, el brillo solo se aplica a la actividad actual.

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

Obtén el brillo de pantalla de todo el sistema.

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

Establece el brillo de la pantalla a nivel de sistema. Requiere el permiso WRITE_SETTINGS en Android. También cambia el modo de brillo a MANUAL.

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

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

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

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

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

Comprueba si la actividad actual usa el valor de brillo del sistema.

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

Restablece el ajuste de brillo de la actividad actual al valor del sistema.

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

Comprueba si el API de Brightness está disponible en el dispositivo actual.

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

Comprueba los permisos del usuario para acceder al brillo del sistema.

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

Solicita permisos para acceder al brillo del sistema. En Android, esto abre la configuración del sistema para otorgar el permiso WRITE_SETTINGS.

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

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

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

Resultado de getSystemBrightnessMode.

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

Opciones para setSystemBrightnessMode.

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

Resultado de isUsingSystemBrightness.

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

Resultado de isAvailable.

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

Resultado del estado del permiso.

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

Resultado de getPluginVersion.

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

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

Estado del permiso.

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

Esta página se genera a partir del plugin src/definitions.ts. Vuelve a ejecutar el sync cuando el API público cambie en upstream.

Si estás usando Primeros pasos para planificar las operaciones del dashboard y de API, conéctalo con Uso de @capgo/capacitor-brightness para la capacidad nativa en Uso de @capgo/capacitor-brightness, Resumen de API para los detalles de implementación en API Overview, Introducción para los detalles de implementación en la Introducción, Claves de API para los detalles de implementación en las claves de API, y Dispositivos para el detalle de implementación en Devices.