Getting Started

Install

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

Import

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

API の概要

checkAuthorization

ユーザーに質問することなく、現在の認証状態を取得します。

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

await PhotoLibrary.checkAuthorization();

requestAuthorization

写真ライブラリへのアクセスが必要な場合に、リクエストします。

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

await PhotoLibrary.requestAuthorization();

getAlbums

利用可能なアルバムを取得します。

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

await PhotoLibrary.getAlbums();

getLibrary

ライブラリのアセットと表示可能なURLを取得します。

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

await PhotoLibrary.getLibrary();

getPhotoUrl

アセットのフル解像度版の表示可能なURLを取得します。 既に「with」メソッドを呼び出した場合は通常、このメソッドを呼び出す必要はありません。 getLibrary コピー includeFullResolutionDataセクション「getThumbnailUrl」

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

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

getThumbnailUrl

セクション「pickMedia」

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

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

pickMedia

nativeシステムのピッカーを開いて、ユーザーが写真ライブラリへの全面的なアクセスを許可せずにメディアを選択できるようにします。 選択されたファイルは、適用可能なURLとともにアプリケーションキャッシュにコピーされます。

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

await PhotoLibrary.pickMedia();

型の参照

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 がアップストリームで変更された場合に再度 Sync を実行してください。

Getting Started から続けてください。

Capacitor を使用している場合 Getting Started ダッシュボードと API の作業を計画するには、Capacitor を接続してください。 Using @capgo/capacitor-photo-library Using @capgo/capacitor-photo-library API の概要 API の実装詳細 導入 Introductionの実装詳細については API キー 実装詳細についてはAPI キー、 デバイス 実装詳細についてはデバイス。