Skip to content

Commit

Permalink
Minor updates
Browse files Browse the repository at this point in the history
Filled in some info on Time objects. Also, began actually updating the changelog <gasp>; more to come.
  • Loading branch information
bbb999 committed Oct 14, 2020
1 parent 51023e7 commit a5a2cf5
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 12 deletions.
1 change: 1 addition & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{
"restructuredtext.workspaceRoot": "${workspaceFolder}",
"restructuredtext.confPath": "${workspaceFolder}/docs",
}
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@
# built documents.
#
# The short X.Y version.
version = u'1.0'
version = u'14.5'
# The full version, including alpha/beta/rc tags.
release = u'1.0'
release = u'14.5'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
9 changes: 9 additions & 0 deletions docs/introduction/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@ What's new and changed for scripting?

----

.. _Changelog.14.x:

`Adobe Premiere Pro 14.x`_
************************************************************************************************************************************

- Scripting access to Auto-Reframe:
- Added: :ref:`sequence.autoReframeSequence`


.. _Changelog.13.x:

`Adobe Premiere Pro 13.x`_
Expand Down
57 changes: 47 additions & 10 deletions docs/other/time.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Time object

**Description**

*add description here*
An object representing a time. Internally, the time is computed in ``ticks``; there are 254016000000 ticks per second. That time can be accessed in different representations, including as a timecode string.

----

Expand All @@ -26,7 +26,7 @@ Time.seconds

**Description**

*add description here*
The time value, expressed in seconds.

**Type**

Expand All @@ -43,7 +43,7 @@ Time.ticks

**Description**

*add description here*
The time value, expressed in ticks.

**Type**

Expand All @@ -64,15 +64,52 @@ Time.getFormatted()

**Description**

*add description here*
Returns the value of the ``Time`` passed, as a string, formatted in the specified display format.

**Parameters**

*add parameters here*
=================== =========== =======================
Argument Type Description
=================== =========== =======================
``frameRate`` ``String`` The frame rate to be used, for the String-based time value.
``displayFormat`` ``int`` The display format to use. Will be one of the following:

TIMEDISPLAY_24Timecode = 100;

TIMEDISPLAY_25Timecode = 101;

TIMEDISPLAY_2997DropTimecode = 102;

TIMEDISPLAY_2997NonDropTimecode = 103;

TIMEDISPLAY_30Timecode = 104;

TIMEDISPLAY_50Timecode = 105;

TIMEDISPLAY_5994DropTimecode = 106;

TIMEDISPLAY_5994NonDropTimecode = 107;

TIMEDISPLAY_60Timecode = 108;

TIMEDISPLAY_Frames = 109;

TIMEDISPLAY_23976Timecode = 110;

TIMEDISPLAY_16mmFeetFrames = 111;

TIMEDISPLAY_35mmFeetFrames = 112;

TIMEDISPLAY_48Timecode = 113;

TIMEDISPLAY_AudioSamplesTimecode = 200;

TIMEDISPLAY_AudioMsTimecode = 201;
=================== =========== =======================

**Returns**

*add return value/type here*
A ``String``.

----

Expand All @@ -81,16 +118,16 @@ Time.getFormatted()
Time.setSecondsAsFraction()
*********************************************

``myTime.setSecondsAsFraction()``
``myTime.setSecondsAsFraction(numerator, denominator)``

**Description**

*add description here*
Sets the Time object to the result of dividing the numerator by the denominator.

**Parameters**

*add parameters here*
Both the numerator and the denominator are ``ints``.

**Returns**

*add return value/type here*
Boolean; ``true`` if successful.

0 comments on commit a5a2cf5

Please sign in to comment.