Client API Overview

Virtual USB Client installs an in-process COM server providing full-featured API to native, .NET or scripting clients. This documentation section describes the provided API in detail.

Any user code that intends to call any API method or use any API interface must have sufficient rights on the local computer. This means that the caller needs to be running elevated.

Using from Native Code

In order to use the API in native code, include the supplied header files:

#include "client.api.tlh"
#include "client.api.tli"

These files are pre-installed in the %INSTALLDIR%\api\native folder.

After that you can use all library classes and interfaces. For example, to create an instance of the library object and then get a list of shared USB devices, use the following code:

if (hhdvusb::IUsbClientPtr api; SUCCEEDED(api.CreateInstance(__uuidof(hhdvusb::UsbClient))))
{
      // get a list of local USB devices
      auto devices = api->${get_devices};
      // ...
      // add shared device
      api->addDevice(L"remote address", L"device key", L"optional secret auth key");
}

Using from C#

In order to use the library from C# project, add a reference to the supplied client.api.interop.dll file to your project in Microsoft Visual Studio. The file is pre-installed in the %INSTALLDIR%\api\interop folder.

Use the API provided by the library:

var api = new hhdvusb.${UsbClient#IUsbClient}();
var devices = api.devices;
api.addDevice("remote address", "device key", "optional secret auth key");
// ...

As an alternative, you can add a reference to client.api.dll in Visual Studio to generate an interop DLL.

Using from JavaScript

To create an instance of the library, use the following code:

var api = new ActiveXObject("hhdvusb.client.1");

Then, use the library object to create and manage shared USB devices:

var devices = api.${devicesJs};
var sharedDevice = api.addDevice("remote address", "device key", "optional secret auth key");

Using from TypeScript

Virtual USB Client contains TypeScript definition file that simplifies library usage in scripting environments. It automatically gives you method parameter type validation and simplifies specifying callback methods.

///<reference path="client.api.d.ts" />
var api = (${IUsbServer}) new ActiveXObject("hhdvusb.client.1");
var devices = api.${devicesJs};
var sharedDevice = api.addDevice("remote address", "device key", "optional secret auth key");

IUsbClient devices devicesJs addDevice