-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Same marker object, sequences and projectItems.
- Loading branch information
bbb
committed
Feb 27, 2018
1 parent
b4f1d2d
commit 2f2367b
Showing
3 changed files
with
260 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters