# aerender-core-glia

> In case you are building your own application and just need to use a rendering part, or you wanna manually trigger jobs from your code, there is a way to use nexrender programmatically:

Latest version **1.0.1** (published 2019-12-05) · 0 weekly downloads

## Install

```sh
npm install aerender-core-glia
pnpm add aerender-core-glia
yarn add aerender-core-glia
bun add aerender-core-glia
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-12-05 |
| First published | 2019-12-05 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 86 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | yulo |
| Maintainers | sarsky123 |

## Links

- npm: https://www.npmjs.com/package/aerender-core-glia
- npm.io page: https://npm.io/package/aerender-core-glia

## Dependencies (6)

- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [requireg](https://npm.io/package/requireg.md) ^0.2.1
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.3.0
- [@nexrender/types](https://npm.io/package/@nexrender/types.md) ^1.5.7
- [file-uri-to-path](https://npm.io/package/file-uri-to-path.md) ^1.0.0
- [data-uri-to-buffer](https://npm.io/package/data-uri-to-buffer.md) ^2.0.0

## Recent versions

- 1.0.1 (latest) — 2019-12-05
- 1.0.0 — 2019-12-05

## README

# Core

In case you are building your own application and just need to use a rendering part, or you wanna manually trigger jobs from your code,
there is a way to use nexrender programmatically:

## Installation
Install the [@nexrender/core](https://github.com/inlife/nexrender/tree/master/packages/nexrender-core)

```sh
$ npm install @nexrender/core --save
```

## Usage

And then load it, and run it

```js
const { init, render } = require('@nexrender/core')

const settings = init({
    logger: console,
})

const main = async () => {
    const result = await render(/*myJobJson*/, settings)
}

main().catch(console.error);
```

## Information

The module reuturns 2 methods, `init` and `render`.

First one is responsible for setting up the env, checking if all needed patches for AE are in place,
automatically adding render-only license file for a free usage of Adobe's product (unless disabled), and a few other minor things.

Second one is responsible for mainly job-related operations of the full cycle: downloading, rendering, processing, and uploading.

`init` accepts an object, containing additional options:

* `workpath` - string, manually set path to working directory where project folder will be created, overrides default one in system temp folder
* `binary` - string, manually set path pointing to the aerender(.exe) binary, overrides auto found one
* `debug` - boolean, enables or disables debug mode, false by default
* `skipCleanup` - boolean, providing true will prevent nexrender from removing the temp folder with project (false by default)
* `multiFrames` - boolean, providing true will attmpt to use aerender's built-in feature of multi frame rendering (false by default)
* `maxMemoryPercent` - integer, undefined by default, check [original documentation](https://helpx.adobe.com/after-effects/using/automated-rendering-network-rendering.html) for more info
* `imageCachePercent` - integer, undefined by default, check [original documentation](https://helpx.adobe.com/after-effects/using/automated-rendering-network-rendering.html) for more info
* `addLicense` - boolean, providing false will disable ae_render_only_node.txt license file auto-creation (true by default)
* `forceCommandLinePatch` - boolean, providing true will force patch re-installation

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