Skip to content

Several minor updates #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 5, 2025
+25 −6
Merged

Several minor updates #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/general/marker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ String; read/write.

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

NOTE: To set the time value for the end of a marker, pass a Seconds value, not a complete replacement ```Time```.

#### Type

[Time object](../other/time.md); read/write.
Expand Down
29 changes: 23 additions & 6 deletions docs/item/projectitem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,23 @@ Returns `0` if replacement was successful.

---

### ProjectItem.clearInPoint()

`app.project.rootItem.children[index].clearInPoint()`

#### Description

Clears any assigned in point; the project item will then start at `startTime`.

#### Parameters

None

#### Returns

Returns `0` if successful.

---
### ProjectItem.clearOutPoint()

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

### ProjectItem.setInPoint()

`app.project.rootItem.children[index].setInPoint(time, mediaType)`
`app.project.rootItem.children[index].setInPoint(seconds, mediaType)`

#### Description

Sets the in point to `timeInTicks`, for specified media types.
Sets the in point to `seconds`, for specified media types.

#### Parameters

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

#### Returns
Expand Down Expand Up @@ -992,17 +1009,17 @@ None.

### ProjectItem.setOutPoint()

`app.project.rootItem.children[index].setOutPoint(time, mediaType)`
`app.project.rootItem.children[index].setOutPoint(seconds, mediaType)`

#### Description

Sets the out point to `timeInTicks`, for specified media types.
Sets the out point to `seconds`, for specified media types.

#### Parameters

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

#### Returns
Expand Down