Skip to content

Commit

Permalink
Updated for 14.1
Browse files Browse the repository at this point in the history
Added Productions object documentation
  • Loading branch information
bbb999 committed Apr 14, 2020
1 parent 72ca553 commit b422479
Show file tree
Hide file tree
Showing 2 changed files with 155 additions and 0 deletions.
149 changes: 149 additions & 0 deletions 16 - Productions object/productions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
.. highlight:: javascript

.. Productions:
Production
==========

``Production``

**Description**

The Production object lets ExtendScript access and manipulate productions, insert projects, create new projects and bins, and move existing Production projects to Trash.

==========
Attributes
==========

.. production.name:
name
*********************************************

``Production.name``

**Description**

The name of the production.

.. _Production.path:

path
****

``Production.path``

**Description**

The path to the Production folder.

.. _Production.projects:

projects
********

``Production.projects``

**Description**

An array of the projects containined within the Production, which are currently open. Does not include non-open projects.

=======
Methods
=======

.. _Production.addProject:

addProject
*********************************************

``app.production.addProject(srcProjectPath, destProjectPath);``

**Description**

Copies a project from some other location, into the Production directory.

**Parameters**

Path to the source project, specified destination path for added project.

**Returns**

Returns **true** if successful.

.. _Production.moveToTrash:

moveToTrash
*********************************************

``app.production.moveToTrash(projectOrFolderPath, suppressUI, saveProject);``

**Description**

Moves the specified path ("bin") or .prproj into the Production's Trash folder.

**Parameters**

Path to the source project or path, and booleans specifying whether or not to suppress any resultant Premiere Pro UI, and whether to save the project(s) first.

**Returns**

Returns **true** if successful.

.. _Production.close:

close
*********************************************

``app.production.close();``

**Description**

Closes the Production, and all open projects from within that Production.

**Parameters**

None.

**Returns**

Returns **true** if successful.

.. _Production.getLocked:

getLocked
*********

``app.production.getLocked();``

**Description**

Returns the current lock state of the Production.

**Parameters**

None.

**Returns**

Returns **true** if the Production is locked, **false** if it is unlocked.


.. _Production.setLocked:

setLocked
*********************************************

``app.production.setLocked(newLockState);``

**Description**

Sets the lock state of the Production

**Parameters**

Boolean corresponding to desired new lock state.

**Returns**

Returns **true** if successful.
6 changes: 6 additions & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,3 +93,9 @@ Welcome to the Premiere Pro Scripting Guide!
:caption: AudioChannelMapping object

15 - AudioChannelMapping object/audiochannelmapping

.. toctree::
:maxdepth: 2
:caption: Productions object

16 - Productions object/productions

0 comments on commit b422479

Please sign in to comment.