Skip to content

Commit 0e7cde6

Browse files
committed
Update some tables to swap <br> for better formatting
1 parent 8304957 commit 0e7cde6

File tree

2 files changed

+59
-30
lines changed

2 files changed

+59
-30
lines changed

docs/reference/EncoderWrapper.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# EncoderWrapper Object
22

33
`app.getFrontend().addDLToBatch(...)`
4-
<br/>
4+
55
`app.getFrontend().addFileToBatch(...)`
6-
<br/>
6+
77
`app.getFrontend().addTeamProjectsItemToBatch(...)`
8-
<br/>
8+
99
`app.getFrontend().exportItem(...)`
10-
<br/>
10+
1111
`app.getFrontend().stitchFiles(...)`
1212

1313
Queue item object to set encode properties

docs/reference/ExporterScript.md

+55-26
Original file line numberDiff line numberDiff line change
@@ -228,13 +228,21 @@ Export the source with the provided preset.
228228

229229
#### Parameters
230230

231-
| Parameter | Type | Description |
232-
| ------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
233-
| `sourcePath` | String | Media path or Premiere Pro project path (In case of a Premiere Pro project, the last sequence will be used). |
234-
| `outputPath` | String | If `outputPath` is empty, then the output file location will be generated based on the source location. |
235-
| `presetsPath` | String | Multiple preset paths can be provided separated via a <code>&#124;</code> (e.g. <code>"path1&#124;path2&#124;path3"</code>) |
236-
| `matchSource` | Boolean | Optional. Default value is `false`. |
237-
| `writeFramesToDisk` | Boolean | Optional. Default value is `false`. `true` writes five frames at 0%, 25%, 50%, 75% and 100% of the full duration.<br />Known issue: Currently it only works with parallel encoding disabled. |
231+
+---------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
232+
| Parameter | Type | Description |
233+
+=====================+=========+=============================================================================================================================+
234+
| `sourcePath` | String | Media path or Premiere Pro project path (In case of a Premiere Pro project, the last sequence will be used). |
235+
+---------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
236+
| `outputPath` | String | If `outputPath` is empty, then the output file location will be generated based on the source location. |
237+
+---------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
238+
| `presetsPath` | String | Multiple preset paths can be provided separated via a <code>&#124;</code> (e.g. <code>"path1&#124;path2&#124;path3"</code>) |
239+
+---------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
240+
| `matchSource` | Boolean | Optional. Default value is `false`. |
241+
+---------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
242+
| `writeFramesToDisk` | Boolean | Optional. Default value is `false`. `true` writes five frames at 0%, 25%, 50%, 75% and 100% of the full duration. |
243+
| | | |
244+
| | | Known issue: Currently it only works with parallel encoding disabled. |
245+
+---------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
238246

239247
#### Returns
240248

@@ -387,16 +395,27 @@ Export the Premiere Pro sequence with the provided preset.
387395

388396
#### Parameters
389397

390-
| Parameter | Type | Description |
391-
| ---------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
392-
| `projectPath` | String | Premiere Pro project path. |
393-
| `outputPath` | String | If `outputPath` is empty, then the output file location will be generated based on the source location. |
394-
| `presetsPath` | String | Multiple preset paths can be provided separated via a <code>&#124;</code> (e.g. <code>"path1&#124;path2&#124;path3"</code>) |
395-
| `matchSource` | Boolean | Optional. Default value is `false`. |
396-
| `writeFramesToDisk` | Boolean | Optional. Default value is `false`. `true` writes five frames at 0%, 25%, 50%, 75% and 100% of the full duration.<br />Known issue: Currently it only works with parallel encoding disabled. |
397-
| `leadingFramesToTrim` | Integer | Optional. Default value is `0`. |
398-
| `trailingFramesToTrim` | Integer | Optional. Default value is `0`. |
399-
| `sequenceName` | String | Optional. If sequence name is empty, then we use the last sequence of the project. |
398+
+------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
399+
| Parameter | Type | Description |
400+
+========================+=========+=============================================================================================================================+
401+
| `projectPath` | String | Premiere Pro project path. |
402+
+------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
403+
| `outputPath` | String | If `outputPath` is empty, then the output file location will be generated based on the source location. |
404+
+------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
405+
| `presetsPath` | String | Multiple preset paths can be provided separated via a <code>&#124;</code> (e.g. <code>"path1&#124;path2&#124;path3"</code>) |
406+
+------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
407+
| `matchSource` | Boolean | Optional. Default value is `false`. |
408+
+------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
409+
| `writeFramesToDisk` | Boolean | Optional. Default value is `false`. `true` writes five frames at 0%, 25%, 50%, 75% and 100% of the full duration. |
410+
| | | |
411+
| | | Known issue: Currently it only works with parallel encoding disabled. |
412+
+------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
413+
| `leadingFramesToTrim` | Integer | Optional. Default value is `0`. |
414+
+------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
415+
| `trailingFramesToTrim` | Integer | Optional. Default value is `0`. |
416+
+------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
417+
| `sequenceName` | String | Optional. If sequence name is empty, then we use the last sequence of the project. |
418+
+------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
400419

401420
#### Returns
402421

@@ -517,15 +536,25 @@ Smart render the source with the provided preset.
517536

518537
#### Parameters
519538

520-
| Parameter | Type | Description |
521-
| ---------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
522-
| `sourcePath` | String | Media path or Premiere Pro project path (In case of a Premiere Pro project the last sequence will be used). |
523-
| `outputPath` | String | If outputPath is empty, then the output file location will be generated based on the source location. |
524-
| `presetsPath` | String | Multiple preset paths can be provided separated via a <code>&#124;</code> (e.g. <code>"path1&#124;path2&#124;path3"</code>) |
525-
| `matchSource` | Boolean | Optional. Default value is `false`. |
526-
| `writeFramesToDisk` | Boolean | Optional. Default value is `false`. `true` writes five frames at 0%, 25%, 50%, 75% and 100% of the full duration.<br />Known issue: Currently it only works with parallel encoding disabled. |
527-
| `leadingFramesToTrim` | Integer | Optional. Default value is `0`. |
528-
| `trailingFramesToTrim` | Integer | Optional. Default value is `0`. |
539+
+------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
540+
| Parameter | Type | Description |
541+
+========================+=========+=============================================================================================================================+
542+
| `sourcePath` | String | Media path or Premiere Pro project path (In case of a Premiere Pro project the last sequence will be used). |
543+
+------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
544+
| `outputPath` | String | If outputPath is empty, then the output file location will be generated based on the source location. |
545+
+------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
546+
| `presetsPath` | String | Multiple preset paths can be provided separated via a <code>&#124;</code> (e.g. <code>"path1&#124;path2&#124;path3"</code>) |
547+
+------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
548+
| `matchSource` | Boolean | Optional. Default value is `false`. |
549+
+------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
550+
| `writeFramesToDisk` | Boolean | Optional. Default value is `false`. `true` writes five frames at 0%, 25%, 50%, 75% and 100% of the full duration. |
551+
| | | |
552+
| | | Known issue: Currently it only works with parallel encoding disabled. |
553+
+------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
554+
| `leadingFramesToTrim` | Integer | Optional. Default value is `0`. |
555+
+------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
556+
| `trailingFramesToTrim` | Integer | Optional. Default value is `0`. |
557+
+------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
529558

530559
#### Returns
531560

0 commit comments

Comments
 (0)