Introducing VDT
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.
Usage
Vdt packages are published and can be installed from the npm public registry. All packages are bundled as ECMAScript modules (ESM) which has best tree shake, code/module splitting and hmr support. ESM is also supported in modern versions of node However, we also export bundles with Universal Module Definition (UMD) or CommonJs (CJS). Use you're favorite package manager to retrieve packages (e.g. yarn, npm, pnpm). In general, all modules can be imported from the root level.
Published Packages
Package | Description | Version | Latest Release |
|---|---|---|---|
Typescript API for VidiCore | 24.1.0 |  | |
Javascript SDK for VidiCore | 24.1.0 |  | |
React SDK for VidiCore | 24.1.0 |  | |
React timeline based on react-konva | 24.1.0 |  | |
Mui (v5) library for VidiCore | 24.1.0 |  | |
Javascript API for VidiCore | 24.1.0 |  | |
Materialui (v4) library for VidiCore | 24.1.0 |  | |
Javascript player based on videojs | 24.1.0 |  | |
React player based on vdt-videojs | 24.1.0 |  |
Developer Packages
Package | Description | Version | Latest Release |
|---|---|---|---|
CRA template using vdt packages | 24.1.0 |  | |
TypeScript definitions for VidiCore | 24.1.0 |  | |
Prettier config | 24.1.0 |  | |
Eslint config for React apps | 24.1.0 |  | |
Eslint config for React libs | 24.1.0 |  | |
Eslint config for Javascript | 24.1.0 |  | |
Eslint config for Typescript | 24.1.0 |  | |
Eslint config for Typescript | 24.1.0 | | |
Eslint config for Storybook | 24.1.0 |  | |
Eslint config for markdown and mdx | 24.1.0 |  | |
PropTypes for VidiCore | 24.1.0 |  |