Inizia a utilizzare

Installa

Puoi utilizzare la nostra configurazione assistita dall'IA per installare il plugin. Aggiungi le Capgo competenze al tuo strumento di AI utilizzando il seguente comando:

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

Poi utilizza il seguente prompt:

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

Se preferisci l'installazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche per la piattaforma riportate di seguito:

bun add @capgo/capacitor-photo-library
bunx cap sync

Importa

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

API Panoramica

checkAuthorization

Restituisce lo stato di autorizzazione corrente senza sollecitare l'utente.

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

await PhotoLibrary.checkAuthorization();

requestAuthorization

Richiede l'accesso alla libreria delle foto se necessario.

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

await PhotoLibrary.requestAuthorization();

getAlbums

Recupera gli album disponibili.

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

await PhotoLibrary.getAlbums();

getLibrary

Recupera gli asset della libreria insieme alle URL che possono essere visualizzate nella vista web.

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

await PhotoLibrary.getLibrary();

getPhotoUrl

Recupera una URL visualizzabile per la versione a risoluzione completa dell'asset. Se hai già chiamato getLibrary con includeFullResolutionData, non è necessario utilizzare questo metodo normalmente.

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

await PhotoLibrary.getPhotoUrl({} as { id: string });

getThumbnailUrl

Recupera un URL visualizzabile per una miniatura ridimensionata dell'asset.

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

await PhotoLibrary.getThumbnailUrl({} as {
    id: string;
    width?: number;
    height?: number;
    quality?: number;
  });

pickMedia

Apre il picker nativo del sistema per consentire all'utente di selezionare i media senza concedere l'accesso completo alla libreria delle foto. I file selezionati vengono copiati nella cache dell'applicazione e restituiti con URL portatili.

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

await PhotoLibrary.pickMedia();

Riferimento di tipo

PhotoLibraryAuthorizationState

export type PhotoLibraryAuthorizationState = 'authorized' | 'limited' | 'denied' | 'notDetermined';

PhotoLibraryAlbum

export interface PhotoLibraryAlbum {
  id: string;
  title: string;
  assetCount: number;
}

GetLibraryOptions

export interface GetLibraryOptions {
  /**
   * Number of assets to skip from the beginning of the query.
   */
  offset?: number;
  /**
   * Maximum number of assets to return. Omit to return everything that matches.
   */
  limit?: number;
  /**
   * Include images in the result. Defaults to `true`.
   */
  includeImages?: boolean;
  /**
   * Include videos in the result. Defaults to `false`.
   */
  includeVideos?: boolean;
  /**
   * Include information about the albums each asset belongs to. Defaults to `false`.
   */
  includeAlbumData?: boolean;
  /**
   * Include assets stored in the cloud (iCloud / Google Photos). Defaults to `true`.
   */
  includeCloudData?: boolean;
  /**
   * If `true`, use the original filenames reported by the OS when available.
   */
  useOriginalFileNames?: boolean;
  /**
   * Width of the generated thumbnails. Defaults to `512`.
   */
  thumbnailWidth?: number;
  /**
   * Height of the generated thumbnails. Defaults to `384`.
   */
  thumbnailHeight?: number;
  /**
   * JPEG quality for generated thumbnails (0-1). Defaults to `0.5`.
   */
  thumbnailQuality?: number;
  /**
   * When `true`, copies the full sized asset into the app cache and returns its URL.
   * Defaults to `false`.
   */
  includeFullResolutionData?: boolean;
}

GetLibraryResult

export interface GetLibraryResult {
  assets: PhotoLibraryAsset[];
  /**
   * Total number of assets matching the query in the library. `assets.length` can be less
   * than this value when pagination is used.
   */
  totalCount: number;
  /** Whether more assets are available when using pagination. */
  hasMore: boolean;
}

PhotoLibraryFile

export interface PhotoLibraryFile {
  /** Absolute path on the native file system. */
  path: string;
  /**
   * URL that can be used inside a web view. Usually produced by `Capacitor.convertFileSrc(path)`.
   */
  webPath: string;
  mimeType: string;
  /** Size in bytes if known, otherwise `-1`. */
  size: number;
}

PickMediaOptions

export interface PickMediaOptions {
  /**
   * Maximum number of items the user can select. Use `0` to allow unlimited selection.
   * Defaults to `1`.
   */
  selectionLimit?: number;
  /** Allow the user to select images. Defaults to `true`. */
  includeImages?: boolean;
  /** Allow the user to select videos. Defaults to `false`. */
  includeVideos?: boolean;
  /** Width of the generated thumbnails for picked items. Defaults to `256`. */
  thumbnailWidth?: number;
  /** Height of the generated thumbnails for picked items. Defaults to `256`. */
  thumbnailHeight?: number;
  /** JPEG quality for generated thumbnails (0-1). Defaults to `0.7`. */
  thumbnailQuality?: number;
}

PickMediaResult

export interface PickMediaResult {
  assets: PhotoLibraryAsset[];
}

PhotoLibraryAsset

export interface PhotoLibraryAsset {
  id: string;
  fileName: string;
  type: PhotoAssetType;
  width: number;
  height: number;
  duration?: number;
  creationDate?: string;
  modificationDate?: string;
  latitude?: number;
  longitude?: number;
  mimeType: string;
  /** Size in bytes reported by the OS for the underlying asset, if available. */
  size?: number;
  albumIds?: string[];
  thumbnail?: PhotoLibraryFile;
  file?: PhotoLibraryFile;
}

PhotoAssetType

export type PhotoAssetType = 'image' | 'video';

Fonte di verità

Questa pagina è generata dal plugin’s src/definitions.ts. Riavvia la sincronizzazione quando il pubblico API cambia in modo upstream.

Continua da qui: Iniziare

Se stai utilizzando Iniziare per pianificare il dashboard e le API operazioni, connettilo con Utilizza @capgo/capacitor-photo-library per la capacità nativa in Utilizza @capgo/capacitor-photo-library Panoramica di API per il dettaglio di implementazione in Panoramica di API Introduzione per il dettaglio di implementazione in Introduzione Chiavi di API per il dettaglio di implementazione in Chiavi di API, e Dispositivi per il dettaglio di implementazione in Dispositivi.