Skip to content

Commit

Permalink
use references to objects
Browse files Browse the repository at this point in the history
  • Loading branch information
rendertom committed Aug 18, 2020
1 parent 1124fab commit 57ec576
Show file tree
Hide file tree
Showing 12 changed files with 66 additions and 65 deletions.
6 changes: 3 additions & 3 deletions 11 - Encoder object/encoder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,12 @@ encodeProjectItem()

**Description**

Makes Adobe Media Encoder render (optionally, a specified range from) the specified projectItem, with the specified settings.
Makes Adobe Media Encoder render (optionally, a specified range from) the specified :ref:`projectItem`, with the specified settings.

**Parameters**

+------------------------------+---------------------------------------------------+
| ``projectItem`` | The **projectItem** to render. |
| ``projectItem`` | projectItem to render. |
+------------------------------+---------------------------------------------------+
| ``fullOutputPath`` | **String**, path to output file. |
+------------------------------+---------------------------------------------------+
Expand Down Expand Up @@ -106,7 +106,7 @@ encodeSequence()

**Description**

Makes Adobe Media Encoder render the specified sequence, with the specified settings.
Makes Adobe Media Encoder render the specified :ref:`sequence`, with the specified settings.

**Parameters**

Expand Down
2 changes: 1 addition & 1 deletion 12 - Marker object/marker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Marker object

**Description**

Both projectItems and sequences have associated **marker** objects, which represent their associated markers.
Both :ref:`Project items <projectItem>` and :ref:`sequences <sequence>` have associated **marker** objects, which represent their associated markers.

----

Expand Down
2 changes: 1 addition & 1 deletion 13 - Source object/source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Open a project item in the Source monitor.

**Parameters**

The ``projectItem`` to open.
The :ref:`projectItem` to open.

**Returns**

Expand Down
6 changes: 3 additions & 3 deletions 14 - ProjectManager object/projectmanager.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ affectedSequences

**Description**

An `Array` of `Sequence` objects, to be exported.
An `Array` of :ref:`Sequence <sequence>` objects, to be exported.

**Type**

Expand Down Expand Up @@ -223,7 +223,7 @@ includeAllSequences

**Description**

If `true`, export all sequences in the exported project.
If `true`, export all :ref:`Sequences <sequence>` in the exported project.

**Type**

Expand Down Expand Up @@ -295,7 +295,7 @@ closeClip()

**Description**

Closes the front-most clip in the Source monitor.
Closes the front-most clip in the :ref:`Source monitor <source>`.

**Parameters**

Expand Down
2 changes: 1 addition & 1 deletion 15 - AudioChannelMapping object/audiochannelmapping.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ AudioChannelMapping

**Description**

The AudioChannelMapping object defines the audio channel mapping applied to a given **projectItem**.
The AudioChannelMapping object defines the audio channel mapping applied to a given :ref:`projectItem`.

----

Expand Down
27 changes: 13 additions & 14 deletions 2 - App object/application.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ anywhere

**Description**

An Anywhere object, providing access to available Anywhere servers. Only available when running in Anywhere configuration (discontinued).
An :ref:`anywhere`, providing access to available Anywhere servers. Only available when running in Anywhere configuration (discontinued).

**Type**

Anywhere object.
:ref:`anywhere`.

----

Expand Down Expand Up @@ -65,7 +65,7 @@ Provides access to Adobe Media Encoder (on the same system).

**Type**

Encoder object.
:ref:`encoder`.

----

Expand Down Expand Up @@ -116,7 +116,7 @@ The currently active project.

**Type**

Project object.
:ref:`project`.

----

Expand All @@ -133,8 +133,7 @@ Provides access to project management functions within Premiere Pro.

**Type**

projectManager object.

:ref:`projectManager`.

----

Expand All @@ -151,7 +150,7 @@ An array referencing all open projects; `numProjects` contains size.

**Type**

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

----

Expand Down Expand Up @@ -299,7 +298,7 @@ isDocument()

**Description**

Determines whether the file at path can be opened as a Premiere Pro project.
Determines whether the file at path can be opened as a Premiere Pro :ref:`project <project>`.

**Parameters**

Expand All @@ -320,7 +319,7 @@ isDocumentOpen()

**Description**

Determines whether there are any projects currently open.
Determines whether there are any :ref:`projects <project>` currently open.

**Parameters**

Expand All @@ -341,7 +340,7 @@ newProject()

**Description**

Creates a new .prproj project, at the specified path.
Creates a new .prproj :ref:`project`, at the specified path.

**Parameters**

Expand All @@ -364,7 +363,7 @@ openDocument()

**Description**

Opens the file at the specified path, as a Premiere Pro project.
Opens the file at the specified path, as a Premiere Pro :ref:`project`.

**Parameters**

Expand Down Expand Up @@ -395,15 +394,15 @@ openFCPXML()

**Description**

Opens an FCP XML file as a Premiere Pro project (specified in projPath).
Opens an FCP XML file as a Premiere Pro :ref:`project` (specified in projPath).

**Parameters**

path, projPath.

**Returns**

Returns **true** if file was successfully opened as a Premiere Pro project.
Returns **true** if file was successfully opened as a Premiere Pro :ref:`project`.

----

Expand All @@ -416,7 +415,7 @@ quit()

**Description**

Quits Premiere Pro; user will be prompted to save any changes to project.
Quits Premiere Pro; user will be prompted to save any changes to :ref:`project`.

**Parameters**

Expand Down
46 changes: 23 additions & 23 deletions 3 - Project object/project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ activeSequence

**Description**

The currently active sequence, within the project.
The currently active :ref:`sequence`, within the project.

**Type**

a ``sequence`` object, or ``0`` if no sequence is currently active.
a :ref:`sequence`, or ``0`` if no sequence is currently active.

----

Expand Down Expand Up @@ -94,11 +94,11 @@ rootItem

**Description**

A ``projectItem`` representing the "root" of the project.
A :ref:`projectItem` representing the "root" of the project.

**Type**

A **projectItem**; this will always be of type ``ProjectItemType_BIN``.
A :ref:`projectItem`; this will always be of type ``ProjectItemType_BIN``.

----

Expand All @@ -115,7 +115,7 @@ The sequences within the project.

**Type**

An array of ``sequence`` objects.
An array of :ref:`Sequence <sequence>` objects.

----

Expand Down Expand Up @@ -205,7 +205,7 @@ createNewSequence()

**Description**

Creates a new sequence with the specified ID.
Creates a new :ref:`sequence` with the specified ID.

**Parameters**

Expand All @@ -215,7 +215,7 @@ Creates a new sequence with the specified ID.

**Returns**

Returns a **Sequence** object if creation was successful, or **0** if unsuccessful.
Returns a :ref:`sequence` if creation was successful, or **0** if unsuccessful.

----

Expand All @@ -228,7 +228,7 @@ createNewSequenceFromClips()

**Description**

Creates a new sequence with the given name, in the specified destination bin, and sequentially inserts project items into it.
Creates a new :ref:`sequence` with the given name, in the specified destination bin, and sequentially inserts project items into it.

**Parameters**

Expand All @@ -242,7 +242,7 @@ Creates a new sequence with the given name, in the specified destination bin, an

**Returns**

Returns the newly-created Sequence object if successful; `0` if unsuccessful.
Returns the newly-created :ref:`sequence` if successful; `0` if unsuccessful.

----

Expand All @@ -255,11 +255,11 @@ deleteSequence()

**Description**

Deletes the specified sequence from the project.
Deletes the specified :ref:`sequence` from the project.

**Parameters**

The **Sequence** to delete.
The :ref:`sequence` to delete.

**Returns**

Expand All @@ -276,7 +276,7 @@ exportAAF()

**Description**

Exports an AAF file of the specified sequence, using the specified settings.
Exports an AAF file of the specified :ref:`sequence`, using the specified settings.

**Parameters**

Expand Down Expand Up @@ -348,7 +348,7 @@ exportOMF()

**Description**

Exports an OMF file of the specified sequence, using the specified settings.
Exports an OMF file of the specified :ref:`sequence`, using the specified settings.

**Parameters**

Expand Down Expand Up @@ -389,7 +389,7 @@ exportTimeline()

**Description**

Exports the currently active sequence, using an Export Controller plug-in with the specified name.
Exports the currently active :ref:`sequence`, using an Export Controller plug-in with the specified name.

**Parameters**

Expand Down Expand Up @@ -431,15 +431,15 @@ getInsertionBin()

**Description**

Returns a **projectItem** referencing the bin into which import will occur.
Returns a :ref:`projectItem` referencing the bin into which import will occur.

**Parameters**

None.

**Returns**

Returns a **projectItem** if successful, **0** if not.
Returns a :ref:`projectItem` if successful, **0** if not.

----

Expand Down Expand Up @@ -567,7 +567,7 @@ Imports media from the specified file paths.

**Parameters**

An ``array`` of full, platform-specific file paths to be imported, a ``boolean`` indicating whether warning dialogs should be suppressed, a ``projectItem`` object for the bin into which the files should be imported, and a ``boolean`` indicating whether the file paths should be interpreted as a sequence of numbered stills.
An ``array`` of full, platform-specific file paths to be imported, a ``boolean`` indicating whether warning dialogs should be suppressed, a :ref:`projectItem` for the bin into which the files should be imported, and a ``boolean`` indicating whether the file paths should be interpreted as a sequence of numbered stills.

**Returns**

Expand All @@ -584,7 +584,7 @@ importSequences()

**Description**

Imports an array of sequences (with specified sequenceIDs), from the specified project, into the current project.
Imports an array of :ref:`sequence <sequence>` objects (with specified sequenceIDs), from the specified project, into the current project.

**Parameters**

Expand Down Expand Up @@ -626,7 +626,7 @@ newBarsAndTone()

**Description**

Creates a new sequence with the given name, based on the specified preset (.sqpreset file).
Creates a new :ref:`sequence` with the given name, based on the specified preset (.sqpreset file).

**Parameters**

Expand All @@ -648,7 +648,7 @@ Creates a new sequence with the given name, based on the specified preset (.sqpr

**Returns**

Returns a **projectItem** for the new bars and tone, or **0** if unsuccessful.
Returns a :ref:`projectItem` for the new bars and tone, or **0** if unsuccessful.

----

Expand All @@ -661,7 +661,7 @@ newSequence()

**Description**

Creates a new sequence with the given name, based on the specified preset (.sqpreset file).
Creates a new :ref:`sequence` with the given name, based on the specified preset (.sqpreset file).

**Parameters**

Expand All @@ -673,7 +673,7 @@ Creates a new sequence with the given name, based on the specified preset (.sqpr

**Returns**

Returns a **Sequence**, or **0** if unsuccessful.
Returns a :ref:`sequence`, or **0** if unsuccessful.

----

Expand All @@ -686,7 +686,7 @@ openSequence()

**Description**

Makes the sequence with the provided sequence ID, active. This will open the sequence in the Timeline panel.
Makes the :ref:`sequence` with the provided sequence ID, active. This will open the sequence in the Timeline panel.

**Parameters**

Expand Down

0 comments on commit 57ec576

Please sign in to comment.