Skip to content

Commit

Permalink
Add a full path to access the attribute or a method
Browse files Browse the repository at this point in the history
  • Loading branch information
rendertom committed Aug 18, 2020
1 parent 7f95e50 commit d672261
Show file tree
Hide file tree
Showing 14 changed files with 289 additions and 264 deletions.
18 changes: 9 additions & 9 deletions 10 - Anywhere object/anywhere.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Anywhere object
==========================

``anywhere``
``app.anywhere``

**Description**

Expand All @@ -30,7 +30,7 @@ Methods
Anywhere.getAuthenticationToken()
*********************************************

``anywhere.getAuthenticationToken()``
``app.anywhere.getAuthenticationToken()``

**Description**

Expand All @@ -51,7 +51,7 @@ A **String** containing the login token, or **0** if unsuccessful.
Anywhere.getCurrentEditingSessionActiveSequenceURL()
******************************************************

``anywhere.getCurrentEditingSessionActiveSequenceURL()``
``app.anywhere.getCurrentEditingSessionActiveSequenceURL()``

**Description**

Expand All @@ -72,7 +72,7 @@ Returns a **String** containing the asset's URL, or **0** if unsuccessful (inclu
Anywhere.getCurrentEditingSessionSelectionURL()
******************************************************

``anywhere.getCurrentEditingSessionSelectionURL()``
``app.anywhere.getCurrentEditingSessionSelectionURL()``

**Description**

Expand All @@ -93,7 +93,7 @@ Returns a **String** containing the asset's URL, or **0** if unsuccessful (inclu
Anywhere.getCurrentEditingSessionURL()
*********************************************

``anywhere.getCurrentEditingSessionURL()``
``app.anywhere.getCurrentEditingSessionURL()``

**Description**

Expand All @@ -114,7 +114,7 @@ Returns a **String** containing the production's URL, or **0** if unsuccessful.
Anywhere.isProductionOpen()
*********************************************

``anywhere.isProductionOpen()``
``app.anywhere.isProductionOpen()``

**Description**

Expand All @@ -135,7 +135,7 @@ Returns ``true`` if a production is open; ``false`` if not.
Anywhere.listProductions()
*********************************************

``anywhere.listProductions()``
``app.anywhere.listProductions()``

**Description**

Expand All @@ -154,7 +154,7 @@ Returns an Array of **Strings** containing the names of avialable productions, o
Anywhere.openProduction()
*********************************************

``anywhere.openProduction(productionURL)``
``app.anywhere.openProduction(productionURL)``

**Description**

Expand All @@ -175,7 +175,7 @@ Returns **0** if successful.
Anywhere.setAuthenticationToken()
*********************************************

``anywhere.setAuthenticationToken(token, emailAddress)``
``app.anywhere.setAuthenticationToken(token, emailAddress)``

**Description**

Expand Down
16 changes: 8 additions & 8 deletions 11 - Encoder object/encoder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Encoder object
==========================

``encoder``
``app.encoder``

**Description**

Expand All @@ -30,7 +30,7 @@ Methods
Encoder.encodeFile()
*********************************************

``encoder.encodeFile(fileToRender, fullOutputPath, presetPath, workArea, boolRemoveUponCompletion)``
``app.encoder.encodeFile(fileToRender, fullOutputPath, presetPath, workArea, boolRemoveUponCompletion)``

**Description**

Expand Down Expand Up @@ -68,7 +68,7 @@ Returns a job ID as a **String**, for the render job added to the AME queue, or
Encoder.encodeProjectItem()
*********************************************

``encoder.encodeProjectItem(projectItem, fullOutputPath, presetPath, workArea, boolRemoveUponCompletion)``
``app.encoder.encodeProjectItem(projectItem, fullOutputPath, presetPath, workArea, boolRemoveUponCompletion)``

**Description**

Expand Down Expand Up @@ -102,7 +102,7 @@ Returns a job ID as a **String**, for the render job added to the AME queue, or
Encoder.encodeSequence()
*********************************************

``encoder.encodeSequence(sequenceToRender, fullOutputPath, presetPath, workArea, boolRemoveUponCompletion)``
``app.encoder.encodeSequence(sequenceToRender, fullOutputPath, presetPath, workArea, boolRemoveUponCompletion)``

**Description**

Expand Down Expand Up @@ -136,7 +136,7 @@ Returns a job ID as a **String**, for the render job added to the AME queue, or
Encoder.launchEncoder()
*********************************************

``encoder.launchEncoder()``
``app.encoder.launchEncoder()``

**Description**

Expand All @@ -157,7 +157,7 @@ Returns **0** if successful.
Encoder.setEmbeddedXMPEnabled()
*********************************************

``encoder.setEmbeddedXMPEnabled(enabledOrNot)``
``app.encoder.setEmbeddedXMPEnabled(enabledOrNot)``

**Description**

Expand All @@ -180,7 +180,7 @@ Note: Premiere Pro and Adobe Media Encoder will output sidecar XMP for some file
Encoder.setSidecarXMPEnabled()
*********************************************

``encoder.setSidecarXMPEnabled(enabledOrNot)``
``app.encoder.setSidecarXMPEnabled(enabledOrNot)``

**Description**

Expand All @@ -201,7 +201,7 @@ Returns **0** if successful.
Encoder.startBatch()
*********************************************

``encoder.startBatch()``
``app.encoder.startBatch()``

**Description**

Expand Down
30 changes: 15 additions & 15 deletions 12 - Marker object/marker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Marker object
==========================

``Marker``
``app.project.activeSequence.getFirstMarker()``

**Description**

Expand All @@ -22,7 +22,7 @@ Attributes
Marker.comments
*********************************************

``marker.comments``
``app.project.activeSequence.getFirstMarker().comments``

**Description**

Expand All @@ -39,7 +39,7 @@ String; read/write.
Marker.end
*********************************************

``marker.end``
``app.project.activeSequence.getFirstMarker().end``

**Description**

Expand All @@ -56,7 +56,7 @@ A **Time** object containing the value of the ending of the marker.
Marker.guid
*********************************************

``marker.guid``
``app.project.activeSequence.getFirstMarker().guid``

**Description**

Expand All @@ -73,7 +73,7 @@ String; read-only.
Marker.name
*********************************************

``marker.name``
``app.project.activeSequence.getFirstMarker().name``

**Description**

Expand All @@ -90,7 +90,7 @@ String; read/write.
Marker.start
*********************************************

``marker.start``
``app.project.activeSequence.getFirstMarker().start``

**Description**

Expand All @@ -107,7 +107,7 @@ A **Time** object containing the value of the beginning of the marker.
Marker.type
*********************************************

``marker.type``
``app.project.activeSequence.getFirstMarker().type``

**Description**

Expand All @@ -128,7 +128,7 @@ Methods
Marker.getColorByIndex()
*********************************************

``marker.getColorByIndex(markerIndex)``
``app.project.activeSequence.getFirstMarker().getColorByIndex(markerIndex)``

**Description**

Expand All @@ -153,7 +153,7 @@ Returns the color index as an ``Integer``.
Marker.getWebLinkFrameTarget()
*********************************************

``marker.getWebLinkFrameTarget()``
``app.project.activeSequence.getFirstMarker().getWebLinkFrameTarget()``

**Description**

Expand All @@ -174,7 +174,7 @@ Returns a ``String`` containing the frame target, or **0** if unsuccessful.
Marker.getWebLinkURL()
*********************************************

``marker.getWebLinkURL()``
``app.project.activeSequence.getFirstMarker().getWebLinkURL()``

**Description**

Expand All @@ -195,7 +195,7 @@ Returns a ``String`` containing the URL, or **0** if unsuccessful.
Marker.setColorByIndex()
*********************************************

``marker.setColorByIndex(colorIndex, markerIndex)``
``app.project.activeSequence.getFirstMarker().setColorByIndex(colorIndex, markerIndex)``

**Description**

Expand Down Expand Up @@ -231,7 +231,7 @@ Returns ``undefined``.
Marker.setTypeAsChapter()
*********************************************

``marker.setTypeAsChapter()``
``app.project.activeSequence.getFirstMarker().setTypeAsChapter()``

**Description**

Expand All @@ -252,7 +252,7 @@ Returns **0** if successful.
Marker.setTypeAsComment()
*********************************************

``marker.setTypeAsComment()``
``app.project.activeSequence.getFirstMarker().setTypeAsComment()``

**Description**

Expand All @@ -273,7 +273,7 @@ Returns **0** if successful.
Marker.setTypeAsSegmentation()
*********************************************

``marker.setTypeAsSegmentation()``
``app.project.activeSequence.getFirstMarker().setTypeAsSegmentation()``

**Description**

Expand All @@ -294,7 +294,7 @@ Returns **0** if successful.
Marker.setTypeAsWebLink()
*********************************************

``marker.setTypeAsWebLink()``
``app.project.activeSequence.getFirstMarker().setTypeAsWebLink()``

**Description**

Expand Down
14 changes: 7 additions & 7 deletions 13 - Source object/source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Source object
==========================

``Source``
``app.sourceMonitor``

**Description**

Expand All @@ -30,7 +30,7 @@ Methods
Source.closeAllClips()
*********************************************

``source.closeAllClips()``
``app.sourceMonitor.closeAllClips()``

**Description**

Expand All @@ -51,7 +51,7 @@ Returns **0** if successful.
Source.closeClip()
*********************************************

``source.closeClip()``
``app.sourceMonitor.closeClip()``

**Description**

Expand All @@ -72,7 +72,7 @@ Returns **0** if successful.
Source.getPosition()
*********************************************

``source.getPosition()``
``app.sourceMonitor.getPosition()``

**Description**

Expand All @@ -93,7 +93,7 @@ Returns a ``Time`` object containing the position of the Source monitor's curren
Source.openFilePath()
*********************************************

``source.openFilePath(absolutePathToFile)``
``app.sourceMonitor.openFilePath(absolutePathToFile)``

**Description**

Expand All @@ -114,7 +114,7 @@ Returns 0 if successful.
Source.openProjectItem()
*********************************************

``source.openProjectItem(projectItem)``
``app.sourceMonitor.openProjectItem(projectItem)``

**Description**

Expand All @@ -135,7 +135,7 @@ Returns 0 if successful.
Source.play()
*********************************************

``source.play(playbackSpeed)``
``app.sourceMonitor.play(playbackSpeed)``

**Description**

Expand Down

0 comments on commit d672261

Please sign in to comment.