开始使用

安装

您可以使用我们的 AI 助手设置来安装插件。使用以下命令将 Capgo 技能添加到您的 AI 工具中:

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

然后使用以下提示:

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

如果您prefer手动设置，安装插件并运行以下命令，然后遵循以下平台特定的说明:

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

导入

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

API概述

checkAuthorization

返回当前授权状态，不会提示用户。

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

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

requestAuthorization

如果需要，请求访问相册。

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

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

getAlbums

获取可用的相册。

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

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

getLibrary

获取库资源以及可以在web视图中显示的URL。

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

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

getPhotoUrl

获取全尺寸照片资源的显示URL。 如果您已经调用了 getLibrary with includeFullResolutionData您通常不需要这个方法。

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

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

getThumbnailUrl

获取缩略图资源的显示URL

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

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

pickMedia

打开本地系统选择器，用户可以选择媒体而不授予完整的照片库访问权限。 选择的文件复制到应用程序缓存中并返回可移植的URL。

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

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

类型参考

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

真实来源

该页面由插件生成 src/definitions.ts.重新同步公共API时，重新运行上游

继续从开始

如果您正在使用 开始 来规划仪表板和API操作，连接它 使用@capgo/capacitor-photo-library 使用@capgo/capacitor-photo-library API概述 API概述 简介 简介的实现细节 API 键 API 键的实现细节 设备 设备