Skip to content

Commit 1c7de50

Browse files
committed
Minor documentation updates
Squelched some .rst warnings about titles, added optional params to track.insertClip().
1 parent 2f72dc3 commit 1c7de50

File tree

3 files changed

+15
-9
lines changed

3 files changed

+15
-9
lines changed

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969
#
7070
# This is also used if you do content translation via gettext catalogs.
7171
# Usually you set "language" from the command line for these cases.
72-
language = None
72+
language = "en"
7373

7474

7575
highlight_language = "javascript"

docs/item/projectitem.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -508,7 +508,8 @@ Returns an item's colorspace properties.
508508

509509
this will write the above info to the Events panel.
510510

511-
.. code:: javascript
511+
.. code-block:: javascript
512+
512513
{
513514
var colorSpace = app.project.rootItem.children[0].getColorSpace()
514515
app.setSDKEventMessage("Color Space " + " = " + colorSpace.name, 'info');
@@ -547,9 +548,9 @@ Returns an item's colorspace properties if the properties have been overwritten.
547548

548549
See ProjectItem.getColorSpace()
549550

550-
----
551-
551+
---------------------------------
552552
.. _projectItem.getEmbeddedLUTID:
553+
---------------------------------
553554

554555
ProjectItem.getEmbeddedLUTID()
555556
*********************************************
@@ -571,14 +572,16 @@ Returns an item's LUTID
571572

572573
Writes LUTID to Events panel.
573574

574-
.. code:: javascript
575+
.. code-block:: javascript
576+
575577
{
576578
var lutID = app.project.rootItem.children[0].getEmbeddedLUTID()
577579
app.setSDKEventMessage("LutID " + " = " + lutID, 'info');
578580
}
579581

580-
----
582+
------------------------------
581583
.. _projectItem.getInputLUTID:
584+
------------------------------
582585

583586
ProjectItem.getInputLUTID()
584587
*********************************************
@@ -600,7 +603,8 @@ Returns an item's Input LUTID
600603

601604
Writes Input LUTID to Events panel.
602605

603-
.. code:: javascript
606+
.. code-block:: javascript
607+
604608
{
605609
var lutID = app.project.rootItem.children[0].getInputLUTID()
606610

docs/sequence/track.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,8 @@ Methods
117117
Track.insertClip()
118118
*********************************************
119119

120-
| ``app.project.sequences[index].audioTracks[index].insertClip(projectItem, time)``
121-
| ``app.project.sequences[index].videoTracks[index].insertClip(projectItem, time)``
120+
| ``app.project.sequences[index].audioTracks[index].insertClip(projectItem, time, vTrackIndex, aTrackIndex)``
121+
| ``app.project.sequences[index].videoTracks[index].insertClip(projectItem, time, vTrackIndex, aTrackIndex)``
122122
123123
**Description**
124124

@@ -131,6 +131,8 @@ Argument Type Description
131131
================ =================== =======================
132132
``projectItem`` :ref:`projectItem` A project item from which to get media.
133133
``time`` ``String`` The time at which to add project item, in **Ticks**.
134+
``vTrackIndex`` ``int`` The (zero-based) track index, into which to insert video.
135+
``aTrackIndex`` ``int`` The (zero-based) track index, into which to insert audio.
134136
================ =================== =======================
135137

136138
**Returns**

0 commit comments

Comments
 (0)