Introduction [VDT UG]
The information on this page is sourced from: Start Here / Introduction - Page ⋅ Storybook (vidispine.github.io)
Introduction
Vidispine Development Toolkit (VDT) is a collection of packages used to help build (JavaScript-based) solutions with Vidispine.
The documentation in here show examples on how to use the toolkit. In the Canvas view you can try these out using controls and actions, while in the Docs view you'll see APIs and code examples. Furthermore, there's additional information of packages and categories found inside the Overview links.
Installation
Vdt packages are published and can be installed from the npm public registry. Typically you'd use the package managers (and cli tools) from npm or yarn to add them. All packages are bundled as ECMAScript modules (ESM) (enables tree-shaking our libraries). Some libraries (e.g. @vidispine/vdt-js and @vidispine/vdt-api) are also bundled as CommonJs (CJS) and some (e.g. @vidispine/vdt-videojs) as Universal Module Definition (UMD). In general, import are available from the root import.
Peer Dependencies
To avoid installing dependencies for modules you aren't using we add some as peer dependencies; hence you have to add these as dependencies yourselves. At the Installation documentation for each package you'll find a list of the peer dependencies certain modules need to work (other modules might also use them internally). You can also find more information about the peer dependencies (e.g. compliant versions) from the package manager during install or by viewing the vdt packages at npmjs.com
Note: peerDependencies are automatically installed with npm 7+, but not with yarn
Published Packages
Package | Description | Version | Latest Release |
|---|---|---|---|
Javascript API for VidiCore | 23.1.0 |  | |
Javascript SDK for VidiCore | 23.1.0 |  | |
React SDK for VidiCore | 23.1.0 |  | |
React timeline based on react-konva | 23.1.0 |  | |
Materialui (v4) library for VidiCore | 23.1.0 |  | |
Mui (v5) library for VidiCore | 23.1.0 |  | |
Javascript player based on videojs | 23.1.0 |  | |
React player based on vdt-videojs | 23.1.0 |  |
Developer Packages
Package | Description | Version | Latest Release |
|---|---|---|---|
CRA template using vdt packages | 23.1.0 |  | |
PropTypes for VidiCore | 23.1.0 |  | |
TypeScript definitions for VidiCore | 23.1.0 |  | |
Eslint config for React apps | 23.1.0 |  | |
Eslint config for React libs | 23.1.0 |  | |
Eslint config for Javascript | 23.1.0 |  | |
Prettier config | 23.1.0 |  |