Skip to content

Commit

Permalink
Added Marker object
Browse files Browse the repository at this point in the history
Same marker object, sequences and projectItems.
  • Loading branch information
bbb committed Feb 27, 2018
1 parent b4f1d2d commit 2f2367b
Show file tree
Hide file tree
Showing 3 changed files with 260 additions and 2 deletions.
254 changes: 254 additions & 0 deletions 12 - Marker object/marker.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,254 @@
.. highlight:: javascript

.. _marker:

Marker object
==========================

``Marker``

**Description**

Both projectItems and sequences have associated **marker** objects, which represent their associated markers.


==========
Attributes
==========

.. _marker.name:

name
*********************************************

``marker.name``

**Description**

The name of the marker.

**Type**

String; read/write.

----

.. _marker.comments:

comments
*********************************************

``marker.comments``

**Description**

The comments within the marker.

**Type**

String; read/write.


----

.. _marker.type:

type
*********************************************

``marker.type``

**Description**

The type of marker; either "Comment", "Chapter", "Segmentation", or "WebLink". Note: Premiere Pro can import some marker types, which cannot be created from within Premiere Pro.

**Type**

String; read-only.


----

.. _marker.guid:

guid
*********************************************

``marker.guid``

**Description**

The unique identifier of the marker, created at time of instantiation.

**Type**

String; read-only.

----

.. _marker.start:

start
*********************************************

``marker.start``

**Description**

A **Time** object containing the value of the beginning of the marker.

**Type**

``Time``; read/write.


----

.. _marker.end:

end
*********************************************

``marker.end``

**Description**

A **Time** object containing the value of the ending of the marker.

**Type**

``Time``; read/write.



=======
Methods
=======


.. _marker.setTypeAsComment:

setTypeAsComment
*********************************************

``marker.setTypeAsComment()``

**Description**

Sets the type of the marker to "Comment".

**Parameters**

None.

**Returns**

Returns **0** if successful.

----

.. _marker.setTypeAsChapter:

setTypeAsChapter
*********************************************

``marker.setTypeAsChapter()``

**Description**

Sets the type of the marker to "Chapter".

**Parameters**

None.

**Returns**

Returns **0** if successful.

----

.. _marker.setTypeAsSegmentation:

setTypeAsSegmentation
*********************************************

``marker.setTypeAsSegmentation()``

**Description**

Sets the type of the marker to "Segmentation".

**Parameters**

None.

**Returns**

Returns **0** if successful.

----

.. _marker.setTypeAsWebLink:

setTypeAsWebLink
*********************************************

``marker.setTypeAsWebLink()``

**Description**

Sets the type of the marker to "WebLink".

**Parameters**

None.

**Returns**

Returns **0** if successful.



----

.. _marker.getWebLinkURL:

getWebLinkURL
*********************************************

``marker.getWebLinkURL()``

**Description**

Retrieves the URL, from the marker's URL field.

**Parameters**

None.

**Returns**

Returns a ``String`` containing the URL, or **0** if unsuccessful.


----

.. _marker.getWebLinkFrameTarget:

getWebLinkFrameTarget
*********************************************

``marker.getWebLinkFrameTarget()``

**Description**

Retrieves the frame target, from the marker's FrameTarget field.

**Parameters**

None.

**Returns**

Returns a ``String`` containing the frame target, or **0** if unsuccessful.
2 changes: 0 additions & 2 deletions 7 - Track Item object/trackitem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ Track Item object

The **trackItem** object represents an item on a video or audio track, within a sequence.

----

==========
Attributes
==========
Expand Down
6 changes: 6 additions & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,9 @@ Welcome to the Premiere Scripting Guide!
:caption: Chapter 11 - Encoder object

11 - Encoder object/encoder

.. toctree::
:maxdepth: 2
:caption: Chapter 12 - Marker object

12 - Marker object/marker

0 comments on commit 2f2367b

Please sign in to comment.