Huddly / device-api-usb

Huddly SDK device api which uses node-usb wrapper responsible for handling the transport layer of the communication and discovering the physical device/camera

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status npm badge npm dependencies npm devDependencies NPM Downloads MIT badge Commitizen badge

Huddly SDK - Device Api USB

Development

First clone the repo.

Then you need to init and update the submodules

  git submodule init
  git submodule update

Setup dependcies

npm i

Windows

Then you need to make sure you have build tools for windows

Huddly SDK - Device Api USB

Development setup

If you want to local development together with the @huddly/sdk here is the recommend setup

  • Checkout Device Api USB repo and the sdk repo
  • run npm install in both repos, use the same node version recommend v10.12
  • Go into the Device Api USB repo, run npm link this will create a symlink to this repo in the npm cache
  • Then start the typescript compiler watcher npm run watch-ts
  • Open a new tab
  • Go to the SDK repo folder, run npm link @huddly/device-api-usb.
  • Start the typescript watcher npm run watch-ts

Now you can change things in the sdk and the Device Api USB folder and your changes will be reflected in the compiled code in the sdk.

Licence

MIT Note that the compiled Node extension includes Libusb, and is thus subject to the LGPL.

About

Huddly SDK device api which uses node-usb wrapper responsible for handling the transport layer of the communication and discovering the physical device/camera

License:MIT License


Languages

Language:TypeScript 97.2%Language:JavaScript 2.8%