win/C#/HandBrake.ApplicationServices/Services/Interfaces/IScan.cs

   1 /*  IScan.cs $\r
   2     This file is part of the HandBrake source code.\r
   3     Homepage: <http://handbrake.fr/>.\r
   4     It may be used under the terms of the GNU General Public License. */\r
   5 \r
   6 namespace HandBrake.ApplicationServices.Services.Interfaces\r
   7 {\r
   8     using System;\r
   9 \r
  10     using HandBrake.ApplicationServices.Parsing;\r
  11 \r
  12     /// <summary>\r
  13     /// The IScan Interface\r
  14     /// </summary>\r
  15     public interface IScan\r
  16     {\r
  17         /// <summary>\r
  18         /// Scan has Started\r
  19         /// </summary>\r
  20         event EventHandler ScanStared;\r
  21 \r
  22         /// <summary>\r
  23         /// Scan has completed\r
  24         /// </summary>\r
  25         event EventHandler ScanCompleted;\r
  26 \r
  27         /// <summary>\r
  28         /// Scan process has changed to a new title\r
  29         /// </summary>\r
  30         event EventHandler ScanStatusChanged;\r
  31 \r
  32         /// <summary>\r
  33         /// Gets a value indicating whether IsScanning.\r
  34         /// </summary>\r
  35         bool IsScanning { get; }\r
  36 \r
  37         /// <summary>\r
  38         /// Gets the Scan Status.\r
  39         /// </summary>\r
  40         string ScanStatus { get; }\r
  41 \r
  42         /// <summary>\r
  43         /// Gets the Souce Data.\r
  44         /// </summary>\r
  45         DVD SouceData { get; }\r
  46 \r
  47         /// <summary>\r
  48         /// Gets ActivityLog.\r
  49         /// </summary>\r
  50         string ActivityLog { get; }\r
  51 \r
  52         /// <summary>\r
  53         /// Scan a Source Path.\r
  54         /// Title 0: scan all\r
  55         /// </summary>\r
  56         /// <param name="sourcePath">Path to the file to scan</param>\r
  57         /// <param name="title">int title number. 0 for scan all</param>\r
  58         void Scan(string sourcePath, int title);\r
  59 \r
  60         /// <summary>\r
  61         /// Kill the scan\r
  62         /// </summary>\r
  63         void Stop();\r
  64     }\r
  65 }