User:Seanlin/USB Manager API: Difference between revisions

User:Seanlin/USB Manager API (view source)

Revision as of 06:30, 9 December 2014

582 bytes removed , 9 December 2014

Removing 'storage' type but adding 'keyboard', 'mouse', and 'camera' types.

Seanlin

Confirmed users

16

edits

@@ Line 8: / Line 8: @@
 == Features ==
-* Enumerate available USB ports on the current device. So far supported types of USB ports include Storage.
+* Enumerate available USB ports on the current device. So far supported types of USB ports include Keyboard, Mouse, Camera.
 * Support hot-plug detection on each USB port.
@@ Line 36: / Line 36: @@
 === USB Port Interface ===
 ==== Basic ====
-   enum USBPortType { "storage" };
+   enum USBPortType { "keyboard", "mouse", "camera" };
    interface USBPort : EventTarget {
@@ Line 50: / Line 50: @@
 '''type''' of type USBPortType, readonly <br/>
-The type of this USB port, value must be defined in the enum of USBPortType. So far only "storage" is supported. (This might be extended in the future.)
+The type of this USB port, value must be defined in the enum of USBPortType.
 '''connected''' of type boolean, readonly <br/>
@@ Line 59: / Line 59: @@
 Whenever the hardware detects connection/disconnection, a USBConnectEvent or USBDisconnectEvent against this USB port should be fired.
-==== Storage ====
+==== Keyboard ====
 ''In reality, a specific USB port may have its specific attributes and methods. And our goal is to collect the "common" ones as many as possible. However, with limited information, we will not focus on implementing hardware dependent members in this draft.''
-   interface StorageUSBPort : USBPort {
+   interface KeyboardUSBPort : USBPort {
-    readonly attribute unsigned long long totalVolume;
+     // Possible hardware-dependent attributes.
-    readonly attribute unsigned long long availableVolume;
-    readonly attribute DOMString fileSystem;
-             attribute EventHandler onAvailableVolumeChange;
-     // Other possible hardware-dependent attributes.
    };
-'''totalVolume''' of type unsigned long long, readonly <br/>
+==== Mouse ====
-The total volume of the USB storage device.
-'''availableVolume''' of type unsigned long long, readonly <br/>
+  interface MouseUSBPort : USBPort {
-The available volume of the USB storage device.
+    // Possible hardware-dependent attributes.
+  };
-'''fileSystem''' of type DOMString, readonly <br/>
+==== Camera ====
-The type of the file system, e.g. FAT32, NTFS, etc.
-'''onAvailableVolumeChange''' of type EventHandler <br/>
+  interface CameraUSBPort : USBPort {
-Whenever the hardware detects a change on the available volume, an simple event with the updated available volume against the USB port should be fired.
+    // Possible hardware-dependent attributes.
+  };
 === USB Port Connect/Disconnect Event Interface ===