Skip to content

Commit 66393da

Browse files
committed
Several minor updates
Closing out issues reported on Github.
1 parent 55f3a7c commit 66393da

File tree

2 files changed

+25
-6
lines changed

2 files changed

+25
-6
lines changed

docs/general/marker.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ String; read/write.
4141

4242
A [Time object](../other/time.md) containing the value of the ending of the marker.
4343

44+
NOTE: To set the time value for the end of a marker, pass a Seconds value, not a complete replacement ```Time```.
45+
4446
#### Type
4547

4648
[Time object](../other/time.md); read/write.

docs/item/projectitem.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,23 @@ Returns `0` if replacement was successful.
246246

247247
---
248248

249+
### ProjectItem.clearInPoint()
250+
251+
`app.project.rootItem.children[index].clearInPoint()`
252+
253+
#### Description
254+
255+
Clears any assigned in point; the project item will then start at `startTime`.
256+
257+
#### Parameters
258+
259+
None
260+
261+
#### Returns
262+
263+
Returns `0` if successful.
264+
265+
---
249266
### ProjectItem.clearOutPoint()
250267

251268
`app.project.rootItem.children[index].clearOutPoint()`
@@ -953,17 +970,17 @@ Returns a structure describing the current interpretation of the projectItem.
953970

954971
### ProjectItem.setInPoint()
955972

956-
`app.project.rootItem.children[index].setInPoint(time, mediaType)`
973+
`app.project.rootItem.children[index].setInPoint(seconds, mediaType)`
957974

958975
#### Description
959976

960-
Sets the in point to `timeInTicks`, for specified media types.
977+
Sets the in point to `seconds`, for specified media types.
961978

962979
#### Parameters
963980

964981
| Parameter | Type | Description |
965982
| ----------- | ------- | ---------------------------------------------------------------------------------------------------------------- |
966-
| `time` | String | A time in ticks. |
983+
| `seconds` | Integer | A time in ticks. |
967984
| `mediaType` | Integer | Determining which media type to affect; pass `1` for video only, `2` for audio only, or `4` for all media types. |
968985

969986
#### Returns
@@ -992,17 +1009,17 @@ None.
9921009

9931010
### ProjectItem.setOutPoint()
9941011

995-
`app.project.rootItem.children[index].setOutPoint(time, mediaType)`
1012+
`app.project.rootItem.children[index].setOutPoint(seconds, mediaType)`
9961013

9971014
#### Description
9981015

999-
Sets the out point to `timeInTicks`, for specified media types.
1016+
Sets the out point to `seconds`, for specified media types.
10001017

10011018
#### Parameters
10021019

10031020
| Parameter | Type | Description |
10041021
| ----------- | ------- | ---------------------------------------------------------------------------------------------------------------- |
1005-
| `time` | String | A time in ticks. |
1022+
| `seconds` | Integer | A time in seconds. |
10061023
| `mediaType` | Integer | Determining which media type to affect; pass `1` for video only, `2` for audio only, or `4` for all media types. |
10071024

10081025
#### Returns

0 commit comments

Comments
 (0)