Panduan Memulai

Instal

Anda bisa menggunakan AI-Assisted Setup untuk menginstal plugin ini. Tambahkan skill Capgo ke tool AI Anda menggunakan perintah berikut:

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

Lalu gunakan prompt berikut:

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

Jika Anda lebih suka Manual Setup, instal plugin dengan menjalankan perintah berikut dan ikuti instruksi khusus platform di bawah ini:

bun add @capgo/capacitor-brightness
npx cap sync

Impor

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

Mulai cepat

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

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

Contoh: setBrightness

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

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

Contoh: getSystemBrightness

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

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

Masalah umum

• Izin: panggil checkPermissions() lalu requestPermissions() saat dibutuhkan.
• Sinkronisasi native: jalankan npx cap sync setelah upgrade plugin.
• Sumber kebenaran: percaya src/definitions.ts pada repo GitHub.

Ikhtisar API

getBrightness

Dapatkan level brightness saat ini pada layar utama perangkat.

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

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

setBrightness

Atur level brightness pada layar utama perangkat.

Di iOS, brightness akan tetap bertahan sampai perangkat terkunci. Di Android, brightness hanya berlaku untuk activity saat ini.

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

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

getSystemBrightness

Dapatkan brightness layar untuk seluruh sistem.

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

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

setSystemBrightness

Atur brightness layar secara sistem. Membutuhkan izin WRITE_SETTINGS di Android. Ini juga akan mengubah brightness mode ke MANUAL.

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

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

getSystemBrightnessMode

Ambil brightness mode sistem saat ini (automatic atau manual). Membutuhkan izin WRITE_SETTINGS di Android.

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

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

setSystemBrightnessMode

Atur mode brightness sistem (otomatis atau manual). Membutuhkan izin WRITE_SETTINGS di Android.

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

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

isUsingSystemBrightness

Cek apakah activity saat ini menggunakan nilai brightness sistem.

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

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

restoreSystemBrightness

Reset pengaturan brightness pada activity saat ini ke nilai sistem.

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

await CapgoBrightness.restoreSystemBrightness();

isAvailable

Cek apakah Brightness API tersedia di perangkat saat ini.

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

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

checkPermissions

Cek izin pengguna untuk mengakses kecerahan sistem.

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

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

requestPermissions

Minta izin untuk mengakses kecerahan sistem. Di Android, ini akan membuka pengaturan sistem untuk memberikan izin WRITE_SETTINGS.

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

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

Referensi Tipe

GetBrightnessResult

Hasil dari getBrightness atau 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

Opsi untuk setBrightness atau 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

Hasil dari getSystemBrightnessMode.

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

SetBrightnessModeOptions

Opsi untuk setSystemBrightnessMode.

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

IsUsingSystemBrightnessResult

Hasil dari isUsingSystemBrightness.

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

IsAvailableResult

Hasil dari isAvailable.

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

PermissionStatus

Hasil status izin.

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

GetPluginVersionResult

Hasil dari getPluginVersion.

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

BrightnessMode

Mode kecerahan.

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

Status izin.

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

Sumber Kebenaran

Halaman ini dibuat dari plugin src/definitions.ts. Jalankan ulang sync saat API publik berubah di upstream.

Lanjutkan dari Getting Started

Jika Anda menggunakan Panduan Memulai untuk merencanakan operasi dashboard dan API, hubungkan dengan Menggunakan @capgo/capacitor-brightness untuk kemampuan native dalam Menggunakan @capgo/capacitor-brightness, Ikhtisar API untuk detail implementasi di Ringkasan API, Pendahuluan untuk detail implementasi di Pendahuluan, Kunci API untuk detail implementasi di API Keys, dan Perangkat untuk detail implementasi di Perangkat.