getBaseFile method

Future<File?> getBaseFile({
  1. bool isOrigin = true,
  2. PMProgressHandler? progressHandler,
  3. PMDarwinAVFileType? darwinFileType,
  4. PMCancelToken? cancelToken,
})

Obtain the base (unedited) file of the asset, before any adjustments were applied in the Photos app.

When the asset has no adjustments this resolves to the same content as AssetEntity.originFile. Returns null if the base resource cannot be exported.

  • isOrigin requests the original, full-resolution base resource.
  • progressHandler observes the (possibly network-bound) export progress.
  • darwinFileType tries to define the export format, e.g. exporting a MOV file to MP4.
  • cancelToken cancels the export.

See also:

Implementation

Future<File?> getBaseFile({
  bool isOrigin = true,
  PMProgressHandler? progressHandler,
  PMDarwinAVFileType? darwinFileType,
  PMCancelToken? cancelToken,
}) async {
  final String? path = await plugin.getBaseAdjustmentFile(
    _asset.id,
    isOrigin: isOrigin,
    progressHandler: progressHandler,
    darwinFileType: darwinFileType,
    cancelToken: cancelToken,
  );
  if (path == null) {
    return null;
  }
  return File(path);
}