WatchFolderOutput

data-variant=info

data-slots=text

Since: 27.0

A WatchFolderOutput represents a single output of a watch folder, with its own preset and destination folder. A watch folder encodes every new file once for each of its outputs.

A WatchFolderOutput is returned by addOutput and getOutputs on a watch folder object, rather than constructed directly. To remove an output, pass its id to removeOutput.

const app = require("mediaencoder");
const watchFolder = await app.WatchFolder.createWatchFolder(
  "path/to/source",
  "path/to/destination",
  "path/to/preset.epr",
);
const output = await watchFolder.addOutput("path/to/other-preset.epr", "path/to/other-destination");
output.id; // "3f2b6c1e-9d4a-4c8e-a1f7-5b2d8e6c0a94"

Properties

id

The unique identifier for the output. Pass it to removeOutput to remove the output from its watch folder.

Type: string (readonly)

Since: 27.0

presetPath

The preset used for encoding this output.

Type: string (readonly)

Since: 27.0

destinationPath

The destination path where this output's encoded files are saved.

Type: string (readonly)

Since: 27.0