# proInterface

> A Javascript interface to interact with ProPresenter

Latest version **0.1.0** (published 2016-05-20) · 0 weekly downloads

## Install

```sh
npm install proInterface
pnpm add proInterface
yarn add proInterface
bun add proInterface
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2016-05-20 |
| First published | 2016-05-20 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Nathan MacInnes |
| Maintainers | nathanmacinnes |

## Links

- npm: https://www.npmjs.com/package/proInterface
- npm.io page: https://npm.io/package/proInterface

## Dependencies (1)

- [websocket](https://npm.io/package/websocket.md) ^1.0.23

## Recent versions

- 0.1.0 (latest) — 2016-05-20

## README

ProInterface
------------

Use Javascript to interact with ProPresenter.

Tested with ProPresenter 6.

To initialise:

````javascript
var pro = proInterface('127.0.0.1', 50001, 'control');
````

proInterface needs a network address (use 127.0.0.1 for the current machine), a
port number (ProPresenter's default is 50001) and a password. It'll then handle
opening and authorising the connection.

````javascript
pro.on('authReceived', function (error, controlStatus) {
  pro.on('newSlide', function (slideDetails) {
    ...
  });
  proInterface.getStageDisplayLayouts(function (layouts, current) {
    ...
  });
  pro.setStageDisplayLayout('Default');
});
````

---
_Source: https://npm.io/package/proInterface · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._