Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jensstigaard/vmix-js-utils
JavaScript utilities for vMix to read state of vMix instance
https://github.com/jensstigaard/vmix-js-utils
livestreaming vmix
Last synced: 2 months ago
JSON representation
JavaScript utilities for vMix to read state of vMix instance
- Host: GitHub
- URL: https://github.com/jensstigaard/vmix-js-utils
- Owner: jensstigaard
- License: mit
- Created: 2018-03-03T10:04:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-16T10:31:04.000Z (4 months ago)
- Last Synced: 2024-07-27T00:24:53.439Z (2 months ago)
- Topics: livestreaming, vmix
- Language: TypeScript
- Homepage:
- Size: 938 KB
- Stars: 16
- Watchers: 5
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-vmix - vMix JS utils - js-utils?style=social) (Third-party software and development / Libraries)
README
# vMix-js-utils
[](https://github.com/jensstigaard/vmix-js-utils)
[](https://www.npmjs.com/package/vmix-js-utils)
[](https://www.npmjs.com/package/vmix-js-utils)
[](https://npmjs.com/package/vmix-js-utils)
vMix API utility library for Javascript can be used in either frontend or backend applications (NodeJS).
It is recommended to import the package as a NPM package.
Alternatively you can download the source code and included it as a library manually.
## OBS - NodeJS utility for vMix
**Note**: The NodeJS utility for communicating with vMix is branched out in its own repository/package - See [node-vmix](https://github.com/jensstigaard/node-vmix) for more info.
The node-vmix package is only for NodeJS applications, used for easy connection to vMix instances.
This library can be used both in front-end and NodeJS projects.
---
Simple use
```javascript
// Import all XML API functionality
import { XmlApi as vMixXmlApi } from 'vmix-js-utils'
// Import specific XML API functionality from the (sub)module
import { DataParser, Inputs } from 'vmix-js-utils/xml-api'
```
# Purpose
This library is a set of utilities consisting of several modules.
Each can be used on its own, but usually it makes more sense to make it interplay with some of the other modules.
This is demonstrated in [the examples](#examples).
The modules are coded as classes, meaning that they are constructed with specific parameters.
The source code is written in TypeScript, and compiled to javascript to allow it to be used as a npm package.
It includes type declarations for TypeScript support, meaning that you can type defer i.e. the input types.
# Documentation
Please read [the documentation](https://jensstigaard.github.io/vmix-js-utils/).
# Installation and use
## As a dependency using npm (or yarn)
The library is published at npmjs as a package, meaning that you can easily add the utilities as a dependency in your project.
Found here: https://www.npmjs.com/package/vmix-js-utils
```sh
npm install vmix-js-utils --save
# or 'yarn add vmix-js-utils -d'
```
In your code the simplest way to import the modules is the following:
```javascript
// ES6
import { DataParser, GeneralState } from 'vmix-js-utils/xml-api'
// or commonjs
const { DataParser, GeneralState } = require('vmix-js-utils/xml-api')
// ...
```
# Standalone project / Fork
The code can be cloned and tested as needed from the source code.
It is especially useful when deveoping and extending the functionality.
```sh
git clone https://github.com/jensstigaard/vmix-js-utils.git
cd vmix-js-utils
```
To run the project as standalone locally, you may want to first install the dependencies
```sh
npm install # or 'yarn'
```
Compile TypeScript source code to JavaScript code
```sh
npm build # or 'yarn build'
```
Run tests
```sh
npm test # or 'yarn test'
```
# Examples
*Work in progress.*
## XML API
### Inputs
- [Map all attributes](./examples/xml-api/input-mapping.js)
- [Map only selected attributes](./examples/xml-api/input-mapping-selective.js)
# Authors
(Jens Grønhøj Stigaard)[github.com/jensstigaard]
# Contribution
You are more than welcome to contribute to the repository!
# Roadmap
- More examples
- More tests
- Perhaps more functionality