Skip to content

Commit

Permalink
add few missing attributes
Browse files Browse the repository at this point in the history
  • Loading branch information
rendertom committed Aug 19, 2020
1 parent 2b03d2a commit 23d3f34
Show file tree
Hide file tree
Showing 8 changed files with 329 additions and 34 deletions.
13 changes: 12 additions & 1 deletion 16 - Productions object/productions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ Production.name

The name of the production.

**Type**

String.

----

.. _production.path:
Expand All @@ -39,7 +43,11 @@ Production.path

**Description**

The path to the Production folder.
The path to the Production folder.

**Type**

String.

----

Expand All @@ -54,6 +62,9 @@ Production.projects

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

**Type**

(ProjectCollection object).
----

=======
Expand Down
148 changes: 145 additions & 3 deletions 2 - App object/application.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,56 @@ Provides access to Adobe Media Encoder (on the same system).

----

.. _app.getAppPrefPath:

app.getAppPrefPath
*********************************************

``app.getAppPrefPath``

**Description**

The path containing the currently active "Adobe Premiere Pro Prefs" file.

**Type**

String; read-only.

**Example**

Get a path to a currently active preference file

.. code:: javascript
app.getAppPrefPath; // /Users/USERNAME/Documents/Adobe/Premiere Pro/14.0/Profile-USERNAME/
----

.. _app.getAppSystemPrefPath:

app.getAppSystemPrefPath
*********************************************

``app.getAppSystemPrefPath``

**Description**

Premiere Pro's active configuration files, not specific to a given user.

**Type**

String; read-only.

**Example**

Get a path to a currently active configuration folder

.. code:: javascript
app.getAppSystemPrefPath; // /Library/Application Support/Adobe/Adobe Premiere Pro 2020/
----

.. _app.getPProPrefPath:

app.getPProPrefPath
Expand Down Expand Up @@ -127,6 +177,98 @@ Get a path to a currently active configuration folder
----

.. _app.learnPanelContentDirPath:

app.learnPanelContentDirPath
*********************************************

``app.learnPanelContentDirPath``

**Description**

Get the Learn panel's contents directory path.

**Type**

String; read-only.

**Example**

Get a path to a Learn panel's directory

.. code:: javascript
app.learnPanelContentDirPath; // /Users/Shared/Adobe/Premiere Pro 2020/Learn Panel/
----

.. _app.learnPanelExampleProjectDirPath:

app.learnPanelExampleProjectDirPath
*********************************************

``app.learnPanelExampleProjectDirPath``

**Description**

Get the Learn panel's example projects directory path.

**Type**

String; read-only.

**Example**

Get a path to a Learn panel's example projects' directory

.. code:: javascript
app.learnPanelExampleProjectDirPath; // /Users/Shared/Adobe/Premiere Pro/14.0/Tutorial/Going Home project/
----

.. _app.metadata:

app.metadata
*********************************************

``app.metadata``

**Description**

Get applications Metadata object.

**Type**

Metadata object; read-only.

----

.. _app.path:

app.path
*********************************************

``app.path``

**Description**

Get a path to applications executable file.

**Type**

String; read-only.

**Example**

Get a path to applications executable file.

.. code:: javascript
app.path; // /Applications/Adobe Premiere Pro 2020/Adobe Premiere Pro 2020.app/
----

.. _app.project:

app.project
Expand Down Expand Up @@ -174,7 +316,7 @@ An array referencing all open projects; `numProjects` contains size.

**Type**

Array of :ref:`Project <project>` objects.
Array of :ref:`Project <project>` objects; (ProjectCollection object).

----

Expand All @@ -191,7 +333,7 @@ The properties object provides methods to access and modify preference values.

**Type**

properties object; read-only.
properties object; read-only; (Properties object).

----

Expand Down Expand Up @@ -263,7 +405,7 @@ Methods
app.enableQE()
*********************************************

| ``app.enableQE()``
``app.enableQE()``

**Description**

Expand Down
36 changes: 35 additions & 1 deletion 3 - Project object/project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,23 @@ a :ref:`sequence`, or ``0`` if no sequence is currently active.

----

.. _project.cloudProjectlocalID:

Project.cloudProjectlocalID
*********************************************

``app.project.cloudProjectlocalID``

**Description**

The ID of cloud project.

**Type**

String; read/only.

----

.. _project.documentID:

Project.documentID
Expand All @@ -51,6 +68,23 @@ String; read-only.

----

.. _project.isCloudProject:

Project.isCloudProject
*********************************************

``app.project.isCloudProject``

**Description**

Check whether the project is cloud project.

**Type**

Boolean; read-only.

----

.. _project.name:

Project.name
Expand Down Expand Up @@ -123,7 +157,7 @@ The sequences within the project.

**Type**

An array of :ref:`Sequence <sequence>` objects.
An array of :ref:`Sequence <sequence>` objects; (SequenceCollection object).

----

Expand Down
76 changes: 57 additions & 19 deletions 4 - ProjectItem object/projectItem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ An array of project items, contained within the specified project item.

**Type**

Array; read-only.
Array; read-only; (ProjectItemCollection object).

----

Expand All @@ -51,6 +51,44 @@ An audioChannelMapping object.

----

.. _projectItem.getOverrideColorSpaceList:

ProjectItem.getOverrideColorSpaceList
*********************************************

``app.project.rootItem.children[index].getOverrideColorSpaceList``

**Description**

*Add a description*

Returns an object, containing similar data

.. code:: javascript
{
value: [
sRGB,
BT.601 (NTSC),
BT.601 (PAL),
BT.709,
BT.709 (Scene),
BT.2020,
BT.2020 (Scene),
BT.2100 PQ,
BT.2100 PQ (Scene),
BT.2100 HLG,
BT.2100 HLG (Scene),
DCDM XYZ,
]
};
**Type**

Javascript Object.

----

.. _projectItem.name:

ProjectItem.name
Expand Down Expand Up @@ -136,24 +174,7 @@ Will be **CLIP**, **BIN**, **ROOT**, or **FILE**.

**Type**

Enumeration; read-only.

----

.. _projectItem.videoComponents:

ProjectItem.videoComponents
*********************************************

``app.project.rootItem.children[index].videoComponents``

**Description**

Video components for the 'Master Clip' of this project item.

**Type**

This array is read-only; the components are not.
Enumerated value; read-only.

----

Expand Down Expand Up @@ -1070,3 +1091,20 @@ None.
**Returns**

:ref:`time`.

----

.. _projectItem.videoComponents:

ProjectItem.videoComponents()
*********************************************

``app.project.rootItem.children[index].videoComponents()``

**Description**

Video components for the 'Master Clip' of this project item.

**Type**

This array is read-only; the components are not.

0 comments on commit 23d3f34

Please sign in to comment.