Skip to content

Commit

Permalink
Prepend class name to attributes and methods
Browse files Browse the repository at this point in the history
  • Loading branch information
rendertom committed Aug 18, 2020
1 parent 3fdaecf commit d63efc1
Show file tree
Hide file tree
Showing 15 changed files with 256 additions and 256 deletions.
20 changes: 10 additions & 10 deletions 10 - Anywhere object/anywhere.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Methods

.. _anywhere.getAuthenticationToken:

getAuthenticationToken()
Anywhere.getAuthenticationToken()
*********************************************

``anywhere.getAuthenticationToken()``
Expand All @@ -48,8 +48,8 @@ A **String** containing the login token, or **0** if unsuccessful.

.. _anywhere.getCurrentEditingSessionActiveSequenceURL:

getCurrentEditingSessionActiveSequenceURL()
*********************************************
Anywhere.getCurrentEditingSessionActiveSequenceURL()
******************************************************

``anywhere.getCurrentEditingSessionActiveSequenceURL()``

Expand All @@ -69,8 +69,8 @@ Returns a **String** containing the asset's URL, or **0** if unsuccessful (inclu

.. _anywhere.getCurrentEditingSessionSelectionURL:

getCurrentEditingSessionSelectionURL()
*********************************************
Anywhere.getCurrentEditingSessionSelectionURL()
******************************************************

``anywhere.getCurrentEditingSessionSelectionURL()``

Expand All @@ -90,7 +90,7 @@ Returns a **String** containing the asset's URL, or **0** if unsuccessful (inclu

.. _anywhere.getCurrentEditingSessionURL:

getCurrentEditingSessionURL()
Anywhere.getCurrentEditingSessionURL()
*********************************************

``anywhere.getCurrentEditingSessionURL()``
Expand All @@ -111,7 +111,7 @@ Returns a **String** containing the production's URL, or **0** if unsuccessful.

.. _anywhere.isProductionOpen:

isProductionOpen()
Anywhere.isProductionOpen()
*********************************************

``anywhere.isProductionOpen()``
Expand All @@ -132,7 +132,7 @@ Returns ``true`` if a production is open; ``false`` if not.

.. _anywhere.listProductions:

listProductions()
Anywhere.listProductions()
*********************************************

``anywhere.listProductions()``
Expand All @@ -151,7 +151,7 @@ Returns an Array of **Strings** containing the names of avialable productions, o

.. _anywhere.openProduction:

openProduction()
Anywhere.openProduction()
*********************************************

``anywhere.openProduction(productionURL)``
Expand All @@ -172,7 +172,7 @@ Returns **0** if successful.

.. _anywhere.setAuthenticationToken:

setAuthenticationToken()
Anywhere.setAuthenticationToken()
*********************************************

``anywhere.setAuthenticationToken(token, emailAddress)``
Expand Down
14 changes: 7 additions & 7 deletions 11 - Encoder object/encoder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Methods

.. _encoder.encodeFile:

encodeFile()
Encoder.encodeFile()
*********************************************

``encoder.encodeFile(fileToRender, fullOutputPath, presetPath, workArea, boolRemoveUponCompletion)``
Expand Down Expand Up @@ -65,7 +65,7 @@ Returns a job ID as a **String**, for the render job added to the AME queue, or

.. _encoder.encodeProjectItem:

encodeProjectItem()
Encoder.encodeProjectItem()
*********************************************

``encoder.encodeProjectItem(projectItem, fullOutputPath, presetPath, workArea, boolRemoveUponCompletion)``
Expand Down Expand Up @@ -99,7 +99,7 @@ Returns a job ID as a **String**, for the render job added to the AME queue, or

.. _encoder.encodeSequence:

encodeSequence()
Encoder.encodeSequence()
*********************************************

``encoder.encodeSequence(sequenceToRender, fullOutputPath, presetPath, workArea, boolRemoveUponCompletion)``
Expand Down Expand Up @@ -133,7 +133,7 @@ Returns a job ID as a **String**, for the render job added to the AME queue, or

.. _encoder.launchEncoder:

launchEncoder()
Encoder.launchEncoder()
*********************************************

``encoder.launchEncoder()``
Expand All @@ -154,7 +154,7 @@ Returns **0** if successful.

.. _encoder.setEmbeddedXMPEnabled:

setEmbeddedXMPEnabled()
Encoder.setEmbeddedXMPEnabled()
*********************************************

``encoder.setEmbeddedXMPEnabled(enabledOrNot)``
Expand All @@ -177,7 +177,7 @@ Note: Premiere Pro and Adobe Media Encoder will output sidecar XMP for some file

.. _encoder.setSidecarXMPEnabled:

setSidecarXMPEnabled()
Encoder.setSidecarXMPEnabled()
*********************************************

``encoder.setSidecarXMPEnabled(enabledOrNot)``
Expand All @@ -198,7 +198,7 @@ Returns **0** if successful.

.. _encoder.startBatch:

startBatch()
Encoder.startBatch()
*********************************************

``encoder.startBatch()``
Expand Down
28 changes: 14 additions & 14 deletions 12 - Marker object/marker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Attributes

.. _marker.comments:

comments
Marker.comments
*********************************************

``marker.comments``
Expand All @@ -36,7 +36,7 @@ String; read/write.

.. _marker.end:

end
Marker.end
*********************************************

``marker.end``
Expand All @@ -53,7 +53,7 @@ A **Time** object containing the value of the ending of the marker.

.. _marker.guid:

guid
Marker.guid
*********************************************

``marker.guid``
Expand All @@ -70,7 +70,7 @@ String; read-only.

.. _marker.name:

name
Marker.name
*********************************************

``marker.name``
Expand All @@ -87,7 +87,7 @@ String; read/write.

.. _marker.start:

start
Marker.start
*********************************************

``marker.start``
Expand All @@ -104,7 +104,7 @@ A **Time** object containing the value of the beginning of the marker.

.. _marker.type:

type
Marker.type
*********************************************

``marker.type``
Expand All @@ -125,7 +125,7 @@ Methods

.. _marker.getColorByIndex:

getColorByIndex()
Marker.getColorByIndex()
*********************************************

``marker.getColorByIndex(markerIndex)``
Expand All @@ -150,7 +150,7 @@ Returns the color index as an ``Integer``.

.. _marker.getWebLinkFrameTarget:

getWebLinkFrameTarget()
Marker.getWebLinkFrameTarget()
*********************************************

``marker.getWebLinkFrameTarget()``
Expand All @@ -171,7 +171,7 @@ Returns a ``String`` containing the frame target, or **0** if unsuccessful.

.. _marker.getWebLinkURL:

getWebLinkURL()
Marker.getWebLinkURL()
*********************************************

``marker.getWebLinkURL()``
Expand All @@ -192,7 +192,7 @@ Returns a ``String`` containing the URL, or **0** if unsuccessful.

.. _marker.setColorByIndex:

setColorByIndex()
Marker.setColorByIndex()
*********************************************

``marker.setColorByIndex(colorIndex, markerIndex)``
Expand Down Expand Up @@ -228,7 +228,7 @@ Returns ``undefined``.

.. _marker.setTypeAsChapter:

setTypeAsChapter()
Marker.setTypeAsChapter()
*********************************************

``marker.setTypeAsChapter()``
Expand All @@ -249,7 +249,7 @@ Returns **0** if successful.

.. _marker.setTypeAsComment:

setTypeAsComment()
Marker.setTypeAsComment()
*********************************************

``marker.setTypeAsComment()``
Expand All @@ -270,7 +270,7 @@ Returns **0** if successful.

.. _marker.setTypeAsSegmentation:

setTypeAsSegmentation()
Marker.setTypeAsSegmentation()
*********************************************

``marker.setTypeAsSegmentation()``
Expand All @@ -291,7 +291,7 @@ Returns **0** if successful.

.. _marker.setTypeAsWebLink:

setTypeAsWebLink()
Marker.setTypeAsWebLink()
*********************************************

``marker.setTypeAsWebLink()``
Expand Down
12 changes: 6 additions & 6 deletions 13 - Source object/source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Methods

.. _source.closeAllClips:

closeAllClips()
Source.closeAllClips()
*********************************************

``source.closeAllClips()``
Expand All @@ -48,7 +48,7 @@ Returns **0** if successful.

.. _source.closeClip:

closeClip()
Source.closeClip()
*********************************************

``source.closeClip()``
Expand All @@ -69,7 +69,7 @@ Returns **0** if successful.

.. _source.getPosition:

getPosition()
Source.getPosition()
*********************************************

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

.. _source.openFilePath:

openFilePath()
Source.openFilePath()
*********************************************

``source.openFilePath(absolutePathToFile)``
Expand All @@ -111,7 +111,7 @@ Returns 0 if successful.

.. _source.openProjectItem:

openProjectItem()
Source.openProjectItem()
*********************************************

``source.openProjectItem(projectItem)``
Expand All @@ -132,7 +132,7 @@ Returns 0 if successful.

.. _source.play:

play()
Source.play()
*********************************************

``source.play(playbackSpeed)``
Expand Down

0 comments on commit d63efc1

Please sign in to comment.