Skip to content

Commit 6ad4cdd

Browse files
committed
Consolidate WatchFolderScript object events
1 parent 763c3da commit 6ad4cdd

File tree

3 files changed

+32
-13
lines changed

3 files changed

+32
-13
lines changed

docs/events/WatchFolderScriptEvent.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/reference/FrontendScript.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -698,6 +698,8 @@ Boolean
698698

699699
`app.getFrontend().addEventListener("onBatchItemCreationFailed")`
700700

701+
#### Description
702+
701703
The event will be sent after batch item creation failed.
702704

703705
Can be used for the following [FrontendScript Object](#frontendscriptobject) APIs:
@@ -741,6 +743,8 @@ if (frontend) {
741743

742744
`app.getFrontend().addEventListener("onItemAddedToBatch")`
743745

746+
#### Description
747+
744748
The event will be sent after a batch item has been created successfully.
745749

746750
Can be used for all [FrontendScript Object](#frontendscriptobject) APIs which creates a batch item.

docs/reference/WatchFolderScript.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,3 +110,31 @@ if (watchFolderObj) {
110110
$.writeln("Watch folder object is not valid");
111111
}
112112
```
113+
114+
---
115+
116+
## Events
117+
118+
### onEncodeComplete
119+
120+
`app.getWatchFolder().addEventListener("onEncodeComplete")`
121+
122+
#### Description
123+
124+
Notify when the watchfolder job item is complete.
125+
126+
#### Properties
127+
128+
| Property | Type | Description |
129+
| ------------- | ------ | -------------------- |
130+
| `elapsedTime` | Float | The encoding elapsed time, in milliseconds |
131+
132+
---
133+
134+
### onEncodeError
135+
136+
`app.getWatchFolder().addEventListener("onEncodeError")`
137+
138+
#### Description
139+
140+
Notify when the watchfolder job encode fails.

0 commit comments

Comments
 (0)