Updated documentation for Premiere Pro 13.0 release

Lots of new stuff. :)

11 - Encoder object/encoder.rst

@@ -85,7 +85,7 @@ Makes Adobe Media Encoder render the specified sequence, with the specified sett
 +------------------------------+---------------------------------------------------+
 | ``presetPath``               | **String**, path to preset (.epr) file.           |
 +------------------------------+---------------------------------------------------+
-| ``workArea``                 | Integer denoting work area to be used:            |
+| ``workArea``                 | **Integer** denoting work area to be used:        |
 |                              |    - 0 ENCODE_ENTIRE                              |
 |                              |    - 1 ENCODE_IN_TO_OUT                           |
 |                              |    - 2 ENCODE_WORK_AREA                           |

13 - Source object/source.rst

@@ -0,0 +1,148 @@
+.. highlight:: javascript
+
+.. _Source:
+
+Source object
+==========================
+
+``Source``
+
+**Description**
+
+The Source object represents Premiere Pro's Source monitor.
+
+
+==========
+Attributes
+==========
+
+None.
+
+=======
+Methods
+=======
+
+.. _source.closeClip:
+
+closeClip
+*********************************************
+
+``source.closeClip()``
+
+**Description**
+
+Closes the front-most clip in the Source monitor.
+
+**Parameters**
+
+None.
+
+**Returns**
+
+Returns **0** if successful.
+
+----
+
+.. _source.closeAllClips:
+
+closeAllClips
+*********************************************
+
+``source.closeAllClips()``
+
+**Description**
+
+Closes all clips in the Source monitor.
+
+**Parameters**
+
+None.
+
+**Returns**
+
+Returns **0** if successful.
+
+----
+
+.. _source.getPosition:
+
+getPosition
+*********************************************
+
+``source.getPosition()``
+
+**Description**
+
+Retrieves the position of the Source monitor's current time indicator.
+
+**Parameters**
+
+None.
+
+**Returns**
+
+Returns a ``Time`` object containing the position of the Source monitor's current time indicator. 
+
+----
+
+.. _source.openFilePath:
+
+openFilePath
+*********************************************
+
+``source.openFilePath(absolutePathToFile)``
+
+**Description**
+
+Open a file in the Source monitor.
+
+**Parameters**
+
+The absolute path to the file to open.
+
+**Returns**
+
+Returns 0 if successful.
+
+----
+
+
+.. _source.openProjectItem:
+
+openProjectItem
+*********************************************
+
+``source.openProjectItem(projectItem)``
+
+**Description**
+
+Open a project item in the Source monitor.
+
+**Parameters**
+
+The ``projectItem`` to open.
+
+**Returns**
+
+Returns 0 if successful.
+
+----
+
+.. _source.play:
+
+play
+*********************************************
+
+``source.play(playbackSpeed)``
+
+**Description**
+
+Begins playing back the Source monitor, at the specified playback speed.
+
+**Parameters**
+
+A ``float`` representing the playback speed.
+
+**Returns**
+
+Returns 0 if successful.

3 - Project object/project.rst

@@ -634,3 +634,23 @@ Changes the specified scratch disk path to a new path.
 
 Returns  **0** if unsuccessful.
 
+----
+
+.. _project.consolidateDuplicates:
+
+consolidateDuplicates()
+*********************************************
+
+``project.consolidateDuplicates()``
+
+**Description**
+
+Invokes Premiere Pro's "Consolidate Duplicate Footage" functionality, as available from the UI.
+
+**Parameters**
+
+None.
+
+**Returns**
+
+Returns  **0** if successful.

4 - Project Item object/projectItem.rst

@@ -851,3 +851,83 @@ New label color; see projectItem.getColorLabel_.
 **Returns**
 
 0 if successful.
+
+
+----
+
+.. _projectItem.getFootageInterpretation:
+
+getFootageInterpretation()
+*********************************************
+
+``projectItem.getFootageInterpretation()``
+
+**Description**
+
+Returns a structure describing the current interpretation of the projectItem.
+
+**Parameters**
+
+None.
+
+**Returns**
+
+A footage interpretation structure, or ``0`` if unsuccessful. 
+
++----------------------------+------------------------------------------------------------+
+| ``alphaUsage``             | Alpha, will be one of the following:                       |
+|                            |    - 0 ALPHACHANNEL_NONE                                   |
+|                            |    - 1 ALPHACHANNEL_STRAIGHT                               |
+|                            |    - 2 ALPHACHANNEL_PREMULTIPLIED                          |
+|                            |    - 3 ALPHACHANNEL_IGNORE                                 |
++----------------------------+------------------------------------------------------------+
+| ``fieldType``              | Field type, one of the following:                          |
+|                            |    - -1 FIELDTYPE_DEFAULT                                  |
+|                            |    - 0 FIELDTYPE_PROGRESSIVE                               |
+|                            |    - 1 ALPHACHANNEL_UPPERFIRST                             |
+|                            |    - 2 ALPHACHANNEL_LOWERFIRST                             |
++----------------------------+------------------------------------------------------------+
+| ``ignoreAlpha``            | ``true`` or ``false``.                                     |
++----------------------------+------------------------------------------------------------+
+| ``invertAlpha``            | ``true`` or ``false``.                                     |
++----------------------------+------------------------------------------------------------+
+| ``frameRate``              | Frame rate as floating point value.                        |
++----------------------------+------------------------------------------------------------+
+| ``pixelAspectRatio``       | Pixel aspect ratio as floating point value.                |
++----------------------------+------------------------------------------------------------+
+| ``removePulldown``         | ``true`` or ``false``.                                     |
++----------------------------+------------------------------------------------------------+
+| ``vrConformProjectionType``| The projection type in use, for VR footage. One of these:  |
+|                            |    - 0 VR_CONFORM_PROJECTION_NONE                          |
+|                            |    - 1 VR_CONFORM_PROJECTION_EQUIRECTANGULAR               |
++----------------------------+------------------------------------------------------------+
+| ``vrLayoutType``           | The layout of footage in use, for VR. One of these:        |
+|                            |    - 0 VR_LAYOUT_MONOSCOPIC                                |
+|                            |    - 1 VR_LAYOUT_STEREO_OVER_UNDER                         |
+|                            |    - 2 VR_LAYOUT_STEREO_SIDE_BY_SIDE                       |
++----------------------------+------------------------------------------------------------+
+| ``vrHorizontalView``       | The horizontal view in use, for VR footage.                |
++----------------------------+------------------------------------------------------------+
+| ``vrVerticalView``         | The vertical view in use, for VR footage.                  |
++----------------------------+------------------------------------------------------------+
+
+----
+
+.. _projectItem.setFootageInterpretation:
+
+setFootageInterpretation()
+*********************************************
+
+``projectItem.setFootageInterpretation(newInterpretation)``
+
+**Description**
+
+Returns a structure describing the current interpretation of the projectItem.
+
+**Parameters**
+
+A footage interpretation structure.
+
+**Returns**
+
+``0`` if successful.