Introduction [VDT UG]

The information on this page is sourced from: Start Here / Introduction - Page ⋅ Storybook (vidispine.github.io)

Introduction

VidiCore Development Toolkit (VDT) is a collection of packages used to help build (Javascript-based) solutions using VidiCore.

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. In some cases, we consider components to be better demonstrated with more detailed code examples rather than controls. For these we'll direct you to the code example in the Docs view, and the Controls tab are removed from the Canvas view.

Furthermore, there's also information of packages and categories found under Overview at their root.

Published Packages

Package	Version	Description
@vidispine/vdt-api		Javascript API for VidiCore
@vidispine/vdt-js		Javascript SDK for VidiCore
@vidispine/vdt-react		React SDK for VidiCore
@vidispine/vdt-react-timeline		React timeline based on react-konva
@vidispine/vdt-materialui		Materialui (v4) library for VidiCore
@vidispine/vdt-mui		Mui (v5) library for VidiCore
@vidispine/vdt-videojs		Javascript player based on videojs
@vidispine/vdt-videojs-react		React player based on vdt-videojs

Developer Packages

Package	Version	Description
@vidispine/cra-template-vdt		CRA template using vdt packages
@vidispine/proptypes		PropTypes for VidiCore
@vidispine/types		TypeScript definitions for VidiCore
@vidispine/eslint-config		Eslint config for React apps
@vidispine/eslint-config-react		Eslint config for React libs
@vidispine/eslint-config-base		Eslint config for Javascript
@vidispine/prettier-config		Prettier config