LargeFileDownloader文档

版本：V1.0
描述：大文件传输(Large File Downloader使用手册)

1.说明

1. 大文件下载器是untiy3d的一个插件，可以下载任何大文件并保存到磁盘。这个插件使用WebClient类来下载文件。

2. 只要在你的项目中导入该插件，并通过简单地调用一个函数开始使用它。

3. 安卓：你需要在播放器设置中授予互联网访问权限，否则会出现NameResolutionFailure错误。

4. NameResolutionFailure：在没有互联网接入或由于网络安全问题的情况下，会出现这个错误。

2.使用

2.1 使用命名空间（在你想使用LargeFileDownloader的脚本中使用它。）

using LargeFileDownloader;

2.2 创建FileDownloader类的对象

FileDownloader downloader = new FileDownloader ();

2.3 添加回调

FileDownloader.onComplete += OnDownloadComplete;
FileDownloader.onProgress += OnProgress;

• 这将在任何文件的下载完成后调用

  void OnDownloadComplete(DownloadEvent e)
  {
      if(e.status == DownloadStatus.COMPLETED)
      {
          // File downloaded successfully
          //文件下载成功
      }
      else if(e.status == DownloadStatus.CANCELLED)
      {
          // File cancelled
          //文件取消下载
      }
      else if(e.status == DownloadStatus.FAILED)
      {
          // Downloading failed or there is any error
          //下载失败或出现什么错误
          if(e.error != null)
              Debug.Log(“ERROR : “+e.error);
      }
  }

• 这将在文件下载时调用

  void OnProgress(DownloadEvent e)
  {
      if(e.status == DownloadStatus.PROGRESS)
      {
          // Progress of downloading下载的进展
          // e.downloadedBytes : total bytes downloaded. 
          //e.downloadBytes : 下载的总字节数。
          // e.totalBytes : total bytes to be downloaded.
          // e.totalBytes : 要下载的总字节数。
  
          // e.progress : progress in percentage (%).
          // e.progress：进度的百分比（%）。
  
          // e.fileURL : downloading file URL.
          // e.fileURL : 下载文件的网址。
      }
  }

2.4 下载文件

• downloader.Download (<< FILE_URL >>);

  //它将下载Application.persistantDatapath(应用程序的持久化数据路径。)中的文件。

• downloader.Download (<< FILE_URL >>, << PATH_TO_SAVE >>);

  FILE_URL : // 要下载的文件的URL
  PATH_TO_SAVE : // 下载的文件将被保存的路径。

2.5 添加文件到下载队列

• downloader.DownloadInQueue (<< FILE_URL >>);

  //它将下载Application.persistantDatapath(应用程序的持久化数据路径。)中的文件。

• downloader.DownloadInQueue (<< FILE_URL >>, << PATH_TO_SAVE >>);

  FILE_URL : // 要下载的文件的URL
  PATH_TO_SAVE : // 下载的文件将被保存的路径。

2.6 检查下载器是否下载文件

bool isBusy = downloader.IsBusy;

2.7 检查下载队列中多少文件在排队

int count = downloader.ItemsInQueue;

2.8 检查某个文件是否在下载队列

bool isInQueue = downloader.IsInQueue(<<FILE_URL>>);

2.9 取消当前文件下载

downloader.Cancel();

2.10 取消在队列中的某个文件下载

downloader.CancelInQueue(<<FILE_URL>>);

2.11 取消所有文件下载

downloader.CancelAll();

2.12 初始化（如果你通过调用下面提到的Dispose函数处置了下载器，则再次启动它。）

downloader.Init();

2.13 处置下载器实例。调用这个函数后，如果你想使用下载器，你必须通过调用上面提到的Init()函数再次初始化它。

downloader.Dispose();