@capacitor/file-viewer

FileViewer API 提供打开文件和预览媒体的机制。不适用于 Web。

媒体预览方法目前仅在 iOS 上支持。它使用内置播放器。

安装

npm install @capacitor/file-viewer
npx cap sync

示例

import { FileViewer } from "@capacitor/file-viewer";

// 可以使用 @capacitor/filesystem 等插件获取文件的完整路径
const openDocument = async () => {
  await FileViewer.openDocumentFromLocalPath({
    path: "path/to/file.pdf"
  });
};

// ios 特定
const previewMedia = async () => {
  await FileViewer.previewMediaContentFromUrl({
    path: "https://url_hosting_media/file.mp4"
  });
}

API

• openDocumentFromLocalPath(...)
• openDocumentFromResources(...)
• openDocumentFromUrl(...)
• previewMediaContentFromLocalPath(...)
• previewMediaContentFromResources(...)
• previewMediaContentFromUrl(...)
• Interfaces
• Type Aliases

有关现有错误代码的列表,请参见错误。

文件查看器 API

仅适用于原生 Android 和 iOS;不适用于 Web / PWAs。

openDocumentFromLocalPath(...)

openDocumentFromLocalPath(options: OpenFromLocalPathOptions) => Promise<void>

打开存储在本地文件系统中的文件

参数	类型
options	OpenFromLocalPathOptions

自: 1.0.0

---

openDocumentFromResources(...)

openDocumentFromResources(options: OpenFromResourcesOptions) => Promise<void>

打开应用程序资源文件

参数	类型
options	OpenFromResourcesOptions

自: 1.0.0

---

openDocumentFromUrl(...)

openDocumentFromUrl(options: OpenFromUrlOptions) => Promise<void>

从远程 URL 打开文件

参数	类型
options	OpenFromUrlOptions

自: 1.0.0

---

previewMediaContentFromLocalPath(...)

previewMediaContentFromLocalPath(options: PreviewMediaFromLocalPathOptions) => Promise<void>

预览存储在本地文件系统中的媒体文件(即视频)。 仅在 iOS 中实现。Android 默认为 openDocumentFromLocalPath。

参数	类型
options	OpenFromLocalPathOptions

自: 1.0.0

---

previewMediaContentFromResources(...)

previewMediaContentFromResources(options: PreviewMediaFromResourcesOptions) => Promise<void>

预览应用程序资源中的媒体文件(即视频)。 仅在 iOS 中实现。Android 默认为 openDocumentFromResources。

参数	类型
options	OpenFromResourcesOptions

自: 1.0.0

---

previewMediaContentFromUrl(...)

previewMediaContentFromUrl(options: PreviewMediaFromUrlOptions) => Promise<void>

预览来自远程 URL 的媒体文件(即视频)。 仅在 iOS 中实现。Android 默认为 openDocumentFromUrl。

参数	类型
options	OpenFromUrlOptions

自: 1.0.0

---

Interfaces

OpenFromLocalPathOptions

属性	类型	描述	自
path	string	要打开的文件的完整绝对路径	1.0.0

OpenFromResourcesOptions

属性	类型	描述	自
path	string	要打开的资源文件的相对路径	1.0.0

OpenFromUrlOptions

属性	类型	描述	自
url	string	指向要打开的文件的远程 URL	1.0.0

Type Aliases

PreviewMediaFromLocalPathOptions

OpenFromLocalPathOptions

PreviewMediaFromResourcesOptions

OpenFromResourcesOptions

PreviewMediaFromUrlOptions

OpenFromUrlOptions

错误

插件在原生 Android 和 iOS 上返回以下具有特定代码的错误:

错误代码	平台	消息
OS-PLUG-FLVW-0004	Android, iOS	您尝试打开的文件不存在。
OS-PLUG-FLVW-0005	Android, iOS	您尝试打开的 URL 格式错误。
OS-PLUG-FLVW-0006	Android, iOS	要打开的文件路径为 null 或空。
OS-PLUG-FLVW-0007	Android, iOS	要打开的 URL 为 null 或空。
OS-PLUG-FLVW-0008	Android, iOS	无法打开文件。
OS-PLUG-FLVW-0009	Android, iOS	无效参数。
OS-PLUG-FLVW-0010	Android	没有应用程序可以打开此文件。
OS-PLUG-FLVW-0011	iOS	Cordova / Capacitor 桥接未初始化。
OS-PLUG-FLVW-0012	iOS	下载失败。
OS-PLUG-FLVW-0013	iOS	文件没有扩展名。