create a skeleton Time object and add references to it

docsforadobe · Aug 18, 2020 · 1f4b43e · 1f4b43e
1 parent cd0a079
commit 1f4b43e
Show file tree

Hide file tree

Showing 7 changed files with 121 additions and 19 deletions.
diff --git a/12 - Marker object/marker.rst b/12 - Marker object/marker.rst
@@ -43,11 +43,11 @@ Marker.end
 
 **Description**
 
-A **Time** object containing the value of the ending of the marker.
+A :ref:`time` containing the value of the ending of the marker.
 
 **Type**
 
-``Time``; read/write.
+:ref:`time`; read/write.
 
 ----
 
@@ -94,11 +94,11 @@ Marker.start
 
 **Description**
 
-A **Time** object containing the value of the beginning of the marker.
+A :ref:`time` containing the value of the beginning of the marker.
 
 **Type**
 
-``Time``; read/write.
+:ref:`time`; read/write.
 
 ----
 

diff --git a/13 - SourceMonitor object/sourcemonitor.rst b/13 - SourceMonitor object/sourcemonitor.rst
@@ -84,7 +84,7 @@ None.
 
 **Returns**
 
-Returns a ``Time`` object containing the position of the Source monitor's current time indicator. 
+Returns a :ref:`time` containing the position of the Source monitor's current time indicator. 
 
 ----
 

diff --git a/17 - Time object/time.rst b/17 - Time object/time.rst
@@ -0,0 +1,96 @@
+.. highlight:: javascript
+
+.. _time:
+
+Time object
+===================
+
+``app.project.rootItem.children[index].getInPoint()``
+
+**Description**
+
+*add description here*
+
+----
+
+==========
+Attributes
+==========
+
+.. _time.seconds:
+
+Time.seconds
+*********************************************
+
+``app.project.rootItem.children[index].getInPoint().seconds``
+
+**Description**
+
+*add description here*
+
+**Type**
+
+Number.
+
+----
+
+.. _time.ticks:
+
+Time.ticks
+*********************************************
+
+``app.project.rootItem.children[index].getInPoint().ticks``
+
+**Description**
+
+*add description here*
+
+**Type**
+
+String.
+
+----
+
+=======
+Methods
+=======
+
+.. _time.getFormatted:
+
+Time.getFormatted()
+*********************************************
+
+``app.project.rootItem.children[index].getInPoint().getFormatted(frameRate, displayFormat)``
+
+**Description**
+
+*add description here*
+
+**Parameters**
+
+*add parameters here*
+
+**Returns**
+
+*add return value/type here*
+
+----
+
+.. _time.setSecondsAsFraction:
+
+Time.setSecondsAsFraction()
+*********************************************
+
+``app.project.rootItem.children[index].getInPoint().setSecondsAsFraction()``
+
+**Description**
+
+*add description here*
+
+**Parameters**
+
+*add parameters here*
+
+**Returns**
+
+*add return value/type here*
diff --git a/4 - ProjectItem object/projectItem.rst b/4 - ProjectItem object/projectItem.rst
@@ -502,7 +502,7 @@ None.
 
 **Returns**
 
-A ``Time`` object, containing the in point.
+A :ref:`time`, containing the in point.
 
 ----
 
@@ -565,7 +565,7 @@ mediaType is an ``int``; pass ``1`` for video only, or ``2`` for audio only. If
 
 **Returns**
 
-Returns a ``Time`` object.
+Returns a :ref:`time`.
 
 ----
 
@@ -876,7 +876,7 @@ Sets the in point to ``timeInTicks``, for specified media types.
 
 **Parameters**
 
-A ``Time`` object, and an ``int`` determining which media type to affect; pass ``1`` for video only, ``2`` for audio only, or ``4`` for all media types.
+A :ref:`time`, and an ``int`` determining which media type to affect; pass ``1`` for video only, ``2`` for audio only, or ``4`` for all media types.
 
 **Returns**
 
@@ -918,7 +918,7 @@ Sets the out point to ``timeInTicks``, for specified media types.
 
 **Parameters**
 
-A ``Time`` object, and an ``int`` determining which media type to affect; pass ``1`` for video only, ``2`` for audio only, or ``4`` for all media types.
+A :ref:`time`, and an ``int`` determining which media type to affect; pass ``1`` for video only, ``2`` for audio only, or ``4`` for all media types.
 
 **Returns**
 
@@ -1061,12 +1061,12 @@ ProjectItem.startTime()
 
 **Description**
 
-Returns a Time object, representing start time.
+Returns a :ref:`time`, representing start time.
 
 **Parameters**
 
 None.
 
 **Returns**
 
-A ``Time`` object.
+:ref:`time`.
diff --git a/5 - Sequence object/sequence.rst b/5 - Sequence object/sequence.rst
@@ -456,7 +456,7 @@ None.
 
 **Returns**
 
-Returns a Time representing the in point, in seconds.
+Returns a :ref:`time` representing the in point, in seconds.
 
 ----
 
@@ -498,7 +498,7 @@ None.
 
 **Returns**
 
-Returns a Time representing the out point, in seconds.
+Returns a :ref:`time` representing the out point, in seconds.
 
 ----
 
@@ -519,7 +519,7 @@ None
 
 **Returns**
 
-Returns a Time object, representing the current player position.
+Returns a :ref:`time`, representing the current player position.
 
 ----
 

diff --git a/7 - TrackItem object/trackitem.rst b/7 - TrackItem object/trackitem.rst
@@ -50,7 +50,7 @@ The duration of the trackItem.
 
 **Type**
 
-Time object, read-only.
+:ref:`time`, read-only.
 
 ----
 
@@ -68,7 +68,7 @@ The ending time of the trackItem. Note: This may differ, from the trackItem's ou
 
 **Type**
 
-Time object, read/write.
+:ref:`time`, read/write.
 
 ----
 
@@ -86,7 +86,7 @@ The in point for media, in this trackItem.
 
 **Type**
 
-Time object, read/write.
+:ref:`time`, read/write.
 
 ----
 
@@ -140,7 +140,7 @@ The out point for media, in this trackItem.
 
 **Type**
 
-Time object, read/write.
+:ref:`time`, read/write.
 
 ----
 
@@ -176,7 +176,7 @@ The starting time of the trackItem. Note: This may differ, from the trackItem's
 
 **Type**
 
-Time object, read/write.
+:ref:`time`, read/write.
 
 ----
 

diff --git a/index.rst b/index.rst
@@ -100,3 +100,9 @@ Welcome to the Premiere Pro Scripting Guide!
     :caption: Productions object
 
     16 - Productions object/productions
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Time object
+
+    17 - Time object/time