Getting Started

Installation

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

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

Importation

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

API Vue d'ensemble

checkAuthorization

Renvoie le statut d'autorisation actuel sans solliciter l'utilisateur.

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

const result = await PhotoLibrary.checkAuthorization();
console.log(result);

requestAuthorization

Demande l'accès à la bibliothèque de photos si nécessaire.

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

const result = await PhotoLibrary.requestAuthorization();
console.log(result);

getAlbums

Récupère les albums disponibles.

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

const result = await PhotoLibrary.getAlbums();
console.log(result);

getLibrary

Récupère les actifs de la bibliothèque ainsi que les URL qui peuvent être affichées dans la vue web.

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

const result = await PhotoLibrary.getLibrary();
console.log(result);

getPhotoUrl

Récupère une URL affichable pour la version haute résolution de l'actif. Si vous avez déjà appelé getLibrary avec includeFullResolutionDatavous n'avez généralement pas besoin de cette méthode.

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

const result = await PhotoLibrary.getPhotoUrl({ id: 'id-123' });
console.log(result);

getThumbnailUrl

Récupère une URL affichable pour une vignette réduite de l'actif.

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

const result = await PhotoLibrary.getThumbnailUrl({ id: 'id-123' });
console.log(result);

pickMedia

Ouvre le sélecteur natif du système pour que l'utilisateur puisse sélectionner des médias sans accéder à la bibliothèque photo complète. Les fichiers sélectionnés sont copiés dans le cache de l'application et renvoyés avec des URL portables.

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

const result = await PhotoLibrary.pickMedia();
console.log(result);

Référence de type

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

Source de vérité

Cette page est générée à partir du plugin’s src/definitions.tsRexécutez la synchronisation lorsque les données publiques API changent en amont.

Continuez de la section « Getting Started »

Si vous utilisez Getting Started pour planifier les opérations de tableau de bord et API , connectez-l’à Utilisez @capgo/capacitor-photo-library pour la capacité native dans Utilisez @capgo/capacitor-photo-library, API Vue d'ensemble pour le détail d'implémentation dans API Vue d'ensemble, Introduction pour les détails d'implémentation dans l'Introduction Clés API pour les détails d'implémentation dans les Clés API et Appareils pour les détails d'implémentation sur les appareils.