media

Last updated last month

Final Cut Pro Media Watch Folder Plugin.

API Overview

API Documentation

Variables

Signature

plugins.compressor.watchfolders.panels.media.automaticallyImport

Type

Variable

Description

Boolean that sets whether or not new generated voice file are automatically added to the timeline or not.

Signature

plugins.compressor.watchfolders.panels.media.deleteAfterImport

Type

Variable

Description

Boolean that sets whether or not you want to delete file after they've been imported.

Signature

plugins.compressor.watchfolders.panels.media.disableImport

Type

Variable

Description

When true Notifications will no longer be triggered.

Signature

plugins.compressor.watchfolders.panels.media.filesInTransit

Type

Variable

Description

Files currently being copied

Signature

plugins.compressor.watchfolders.panels.media.notifications

Type

Variable

Description

Table of Notifications

Signature

plugins.compressor.watchfolders.panels.media.savedNotifications

Type

Variable

Description

Table of Notifications that are saved between restarts

Signature

plugins.compressor.watchfolders.panels.media.watchFolders

Type

Variable

Description

Table of the users watch folders.

Signature

plugins.compressor.watchfolders.panels.media.watchFolderTableID

Type

Variable

Description

Watch Folder Table ID

Functions

Signature

plugins.compressor.watchfolders.panels.media.addFilesToCompressor(files) -> none

Type

Function

Description

Imports a file into Final Cut Pro

Parameters

Returns

Signature

plugins.compressor.watchfolders.panels.media.addWatchFolder() -> none

Type

Function

Description

Opens the "Add Watch Folder" Dialog.

Parameters

Returns

Signature

plugins.compressor.watchfolders.panels.media.controllerCallback(id, params) -> none

Type

Function

Description

Callback Controller

Parameters

Returns

Signature

plugins.compressor.watchfolders.panels.media.generateTable() -> string

Type

Function

Description

Generate HTML Table

Parameters

Returns

init

Signature

plugins.compressor.watchfolders.panels.media.init(deps, env) -> table

Type

Function

Description

Initialises the module.

Parameters

Returns

Signature

plugins.compressor.watchfolders.panels.media.newWatcher(path) -> none

Type

Function

Description

New Folder Watcher

Parameters

Returns

Signature

plugins.compressor.watchfolders.panels.media.refreshTable() -> string

Type

Function

Description

Refreshes the Final Cut Pro Watch Folder Panel via JavaScript Injection

Parameters

Returns

Signature

plugins.compressor.watchfolders.panels.media.removeWatcher(path) -> none

Type

Function

Description

Remove Folder Watcher

Parameters

Returns

Signature

plugins.compressor.watchfolders.panels.media.setupWatchers(path) -> none

Type

Function

Description

Setup Folder Watchers

Parameters

Returns

Signature

plugins.compressor.watchfolders.panels.media.styleSheet() -> cp.web.html

Type

Function

Description

Generates Style Sheet

Parameters

Returns

Signature

plugins.compressor.watchfolders.panels.media.watchCompressorStatus(jobID) -> none

Type

Function

Description

Checks the Status of a Job in Compressor

Parameters

Returns

Signature

plugins.compressor.watchfolders.panels.media.watchFolderTriggered(files) -> none

Type

Function

Description

Watch Folder Triggered

Parameters

Returns