-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add Collection objects and references to them
- Loading branch information
Showing
16 changed files
with
309 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
.. highlight:: javascript | ||
|
||
.. _collection: | ||
|
||
Collection object | ||
################################################ | ||
|
||
Like an array, a collection associates a set of objects or values as a logical group and provides access to them by index. However, most collection objects are read-only. You do not assign objects to them yourself — their contents update automatically as objects are created or deleted. | ||
|
||
======= | ||
Objects | ||
======= | ||
|
||
- :ref:`componentCollection` - *todo*. | ||
- :ref:`markerCollection` - a collection of the :ref:`Marker objects <marker>` in a :ref:`projectItem` and :ref:`sequence`. | ||
- :ref:`projectCollection` - a collection of :ref:`Project objects <project>`. | ||
- :ref:`projectItemCollection` - a collection of :ref:`ProjectItem objects <projectItem>`. | ||
- :ref:`sequenceCollection` - a collection of :ref:`Sequence objects <sequence>`. | ||
- :ref:`trackCollection` - a collection of :ref:`Track objects <track>`. | ||
- :ref:`trackItemCollection` - a collection of :ref:`TrackItem objects <trackItem>`. | ||
|
||
---- | ||
|
||
========== | ||
Attributes | ||
========== | ||
|
||
========== ======================================== | ||
``length`` The number of objects in the collection. | ||
========== ======================================== | ||
|
||
----- | ||
|
||
======= | ||
Methods | ||
======= | ||
|
||
========== ============================================================== | ||
``[]`` Retrieves an object in the collection by its index number. The | ||
first object is at index 0. | ||
========== ============================================================== |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
.. highlight:: javascript | ||
|
||
.. _componentCollection: | ||
|
||
ComponentCollection object | ||
################################################ | ||
|
||
| ``app.project.rootItem.children[index].videoComponents()`` | ||
| ``app.project.sequences[index].audioTracks[index].clips[index].components`` | ||
| ``app.project.sequences[index].videoTracks[index].clips[index].components`` | ||
|
||
*add a description* | ||
|
||
ComponentCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with ComponentCollection. | ||
|
||
---- | ||
|
||
========== | ||
Attributes | ||
========== | ||
|
||
.. _componentCollection.numItems: | ||
|
||
ComponentCollection.numItems | ||
********************************************* | ||
|
||
| ``app.project.rootItem.children[index].videoComponents().numItems`` | ||
| ``app.project.sequences[index].audioTracks[index].clips[index].components.numItems`` | ||
| ``app.project.sequences[index].videoTracks[index].clips[index].components.numItems`` | ||
**Description** | ||
|
||
*add a description* | ||
|
||
**Type** | ||
|
||
Integer, read-only. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
.. highlight:: javascript | ||
|
||
.. _markerCollection: | ||
|
||
MarkerCollection object | ||
################################################ | ||
|
||
``app.project.sequences[index].markers`` | ||
|
||
The MarkerCollection object represents a collection of :ref:`Marker objects <marker>` in a :ref:`projectItem` and :ref:`sequence`. | ||
|
||
MarkerCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with MarkerCollection. | ||
|
||
---- | ||
|
||
========== | ||
Attributes | ||
========== | ||
|
||
.. _markerCollection.numMarkers: | ||
|
||
MarkerCollection.numMarkers | ||
********************************************* | ||
|
||
``app.project.sequences[index].markers.numMarkers`` | ||
|
||
**Description** | ||
|
||
The total number of marker objects in the sequence. | ||
|
||
**Type** | ||
|
||
Integer, read-only. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
.. highlight:: javascript | ||
|
||
.. _projectCollection: | ||
|
||
ProjectCollection object | ||
################################################ | ||
|
||
| ``app.projects`` | ||
| ``app.production.projects`` | ||
The ProjectCollection object represents a collection of :ref:`Project objects <project>`. | ||
|
||
ProjectCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with ProjectCollection. | ||
|
||
---- | ||
|
||
========== | ||
Attributes | ||
========== | ||
|
||
.. _projectCollection.numProjects: | ||
|
||
ProjectCollection.numProjects | ||
********************************************* | ||
|
||
| ``app.projects.numProjects`` | ||
| ``app.production.projects.numProjects`` | ||
**Description** | ||
|
||
The total number of projects and productions found in the Project panel. | ||
|
||
**Type** | ||
|
||
Integer, read-only. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
.. highlight:: javascript | ||
|
||
.. _projectItemCollection: | ||
|
||
ProjectItemCollection object | ||
################################################ | ||
|
||
``app.project.rootItem.children`` | ||
|
||
The ProjectItemCollection object represents a collection of :ref:`ProjectItem objects <projectItem>` in an active project. | ||
|
||
ProjectItemCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with ProjectItemCollection. | ||
|
||
---- | ||
|
||
========== | ||
Attributes | ||
========== | ||
|
||
.. _projectItemCollection.numItems: | ||
|
||
ProjectItemCollection.numItems | ||
********************************************* | ||
|
||
``app.project.rootItem.children.numItems`` | ||
|
||
**Description** | ||
|
||
The total number of items in the active project. | ||
|
||
**Type** | ||
|
||
Integer, read-only. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
.. highlight:: javascript | ||
|
||
.. _sequenceCollection: | ||
|
||
SequenceCollection object | ||
################################################ | ||
|
||
``app.project.sequences`` | ||
|
||
The SequenceCollection object represents a collection of all the :ref:`Sequence objects <sequence>` in the active project. | ||
|
||
SequenceCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with SequenceCollection. | ||
|
||
---- | ||
|
||
========== | ||
Attributes | ||
========== | ||
|
||
.. _projectCollection.numSequences: | ||
|
||
SequenceCollection.numSequences | ||
********************************************* | ||
|
||
``app.project.sequences.numSequences`` | ||
|
||
**Description** | ||
|
||
The total number of sequences in the active project. | ||
|
||
**Type** | ||
|
||
Integer, read-only. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
.. highlight:: javascript | ||
|
||
.. _trackCollection: | ||
|
||
TrackCollection object | ||
################################################ | ||
|
||
| ``app.project.sequences[index].audioTracks`` | ||
| ``app.project.sequences[index].videoTracks`` | ||
The TrackCollection object represents a collection of :ref:`Track objects <track>` in a sequence. | ||
|
||
TrackCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with TrackCollection. | ||
|
||
---- | ||
|
||
========== | ||
Attributes | ||
========== | ||
|
||
.. _trackCollection.numTracks: | ||
|
||
TrackCollection.numTracks | ||
********************************************* | ||
|
||
| ``app.project.sequences[index].audioTracks.numTracks`` | ||
| ``app.project.sequences[index].videoTracks.numTracks`` | ||
**Description** | ||
|
||
The total number of tracks in the sequence. | ||
|
||
**Type** | ||
|
||
Integer, read-only. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
.. highlight:: javascript | ||
|
||
.. _trackItemCollection: | ||
|
||
TrackItemCollection object | ||
################################################ | ||
|
||
| ``app.project.sequences[index].audioTracks[index].clips`` | ||
| ``app.project.sequences[index].videoTracks[index].clips`` | ||
The TrackItemCollection object represents a collection of :ref:`TrackItem objects <trackItem>` on a track. | ||
|
||
TrackItemCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with TrackItemCollection. | ||
|
||
---- | ||
|
||
========== | ||
Attributes | ||
========== | ||
|
||
.. _trackItemCollection.numItems: | ||
|
||
TrackItemCollection.numItems | ||
********************************************* | ||
|
||
| ``app.project.sequences[index].audioTracks[index].clips.numItems`` | ||
| ``app.project.sequences[index].videoTracks[index].clips.numItems`` | ||
**Description** | ||
|
||
The total number of clips on a track. | ||
|
||
**Type** | ||
|
||
Integer, read-only. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.