{"id":13687137,"url":"https://github.com/jensstigaard/vmix-function-list","last_synced_at":"2025-05-01T12:32:41.973Z","repository":{"id":43893594,"uuid":"261015620","full_name":"jensstigaard/vmix-function-list","owner":"jensstigaard","description":"Complete function list for vMix. All available functions to call to the vMix API.","archived":false,"fork":false,"pushed_at":"2024-06-16T11:36:27.000Z","size":283,"stargazers_count":21,"open_issues_count":1,"forks_count":0,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-09-21T12:08:41.540Z","etag":null,"topics":["livestreaming","vmix"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jensstigaard.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-05-03T20:32:13.000Z","updated_at":"2024-05-01T20:25:01.000Z","dependencies_parsed_at":"2023-10-13T12:22:27.629Z","dependency_job_id":"b2476407-3290-49b2-a374-57b78fb62746","html_url":"https://github.com/jensstigaard/vmix-function-list","commit_stats":{"total_commits":82,"total_committers":4,"mean_commits":20.5,"dds":0.5121951219512195,"last_synced_commit":"3645aac42542d1b59ab661e5387b26c10860b854"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jensstigaard%2Fvmix-function-list","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jensstigaard%2Fvmix-function-list/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jensstigaard%2Fvmix-function-list/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jensstigaard%2Fvmix-function-list/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jensstigaard","download_url":"https://codeload.github.com/jensstigaard/vmix-function-list/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224257461,"owners_count":17281713,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["livestreaming","vmix"],"created_at":"2024-08-02T15:00:49.416Z","updated_at":"2024-11-12T10:30:44.570Z","avatar_url":"https://github.com/jensstigaard.png","language":"HTML","funding_links":[],"categories":["Third-party software and development"],"sub_categories":["Libraries"],"readme":"# vmix-function-list\nComplete list of available functions in vMix. Structured list read out from https://www.vmix.com/help25/ShortcutFunctionReference.html and from inside vMix \u003e Settings \u003e Shortcuts.\n\n[![package json version](https://img.shields.io/github/package-json/v/jensstigaard/vmix-function-list.svg)](https://www.github/jensstigaard/vmix-function-list)\n[![npm version](https://badge.fury.io/js/vmix-function-list.svg)](https://www.npmjs.com/package/vmix-function-list)\n\nThe version number of this repository reflects which version number of vMix the repository is updated for.\n\nWhen a new patch or version is released to vMix, it is the plan that I check through the help files (and/or vMix itself) for whether new functions has been added to the vMix API, and this function list will be updated accordingly.\n\n## Methods\n`.all()` - Returns a complete list of available functions in the vMix API.\n\n`.category(category: string)` - Returns a list of available functions in a given category from the vMix API.\n\n`.get(function: string)` - Returns a single function with a given name from the vMix API.\n\nSee examples or tests for more info.\n\n\n## Rendered list\nIn the `rendered/` directory you can find .json files of rendered complete list of function, either as minified or in regular format with indentation. \n\n\n# Installation and use\n\n## As a dependency using npm\nThe repo is published at npmjs, meaning that you can easily add the utilities as a dependency in your frontend project.\nFound here: https://www.npmjs.com/package/vmix-function-list\n```sh\nnpm install vmix-function-list --save # or 'yarn add vmix-function-list -d'\n```\n\nIn your code the simplest way to import the module is the following:\n\n```javascript\nconst VmixFunctionList = require('vmix-function-list')\n\n// List of all functions\nconsole.log('All functions', VmixFunctionList.all())\n\n// Get specific function (case-insensitive)\nconsole.log('Get specific function: Cut', VmixFunctionList.get('cut'))\nconsole.log('Get specific function: SetText', VmixFunctionList.get('SetText'))\n```\n\n\n### Examples\n- [All](./examples/all.js)\n- [Get category](./examples/category.js)\n- [Get single function](./examples/get.js)\n\n---\n\n\n# Authors\n[Jens Stigaard](https://github.com/jensstigaard)\n\n\n# Contribution\nYou are more than welcome to contribute to the repository!\nIf you find any inconsistencies or missing functions, you are welcome to tell about it in an issue or make a pull request with the desired changes.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjensstigaard%2Fvmix-function-list","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjensstigaard%2Fvmix-function-list","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjensstigaard%2Fvmix-function-list/lists"}