Skip to content

Commit e7178c7

Browse files
zlovattzlovatt
committed
Clean up tables
1 parent 921e790 commit e7178c7

File tree

7 files changed

+379
-127
lines changed

7 files changed

+379
-127
lines changed

‎docs/application/application.md

Lines changed: 41 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@ String; read-only.
8383
Get a path to a currently active preference file
8484

8585
```js
86-
app.getAppPrefPath; // /Users/USERNAME/Documents/Adobe/Premiere Pro/14.0/Profile-USERNAME/
86+
app.getAppPrefPath;
87+
// /Users/USERNAME/Documents/Adobe/Premiere Pro/14.0/Profile-USERNAME/
8788
```
8889

8990
---
@@ -105,7 +106,8 @@ String; read-only.
105106
Get a path to a currently active configuration folder
106107

107108
```js
108-
app.getAppSystemPrefPath; // /Library/Application Support/Adobe/Adobe Premiere Pro 2020/
109+
app.getAppSystemPrefPath;
110+
// /Library/Application Support/Adobe/Adobe Premiere Pro 2020/
109111
```
110112

111113
---
@@ -127,7 +129,8 @@ String; read-only.
127129
Get a path to a currently active preference file
128130

129131
```js
130-
app.getPProPrefPath; // /Users/USERNAME/Documents/Adobe/Premiere Pro/14.0/Profile-USERNAME/
132+
app.getPProPrefPath;
133+
// /Users/USERNAME/Documents/Adobe/Premiere Pro/14.0/Profile-USERNAME/
131134
```
132135

133136
---
@@ -149,7 +152,8 @@ String; read-only.
149152
Get a path to a currently active configuration folder
150153

151154
```js
152-
app.getPProSystemPrefPath; // /Library/Application Support/Adobe/Adobe Premiere Pro 2020/
155+
app.getPProSystemPrefPath;
156+
// /Library/Application Support/Adobe/Adobe Premiere Pro 2020/
153157
```
154158

155159
---
@@ -171,7 +175,8 @@ String; read-only.
171175
Get a path to a Learn panel's directory
172176

173177
```js
174-
app.learnPanelContentDirPath; // /Users/Shared/Adobe/Premiere Pro 2020/Learn Panel/
178+
app.learnPanelContentDirPath;
179+
// /Users/Shared/Adobe/Premiere Pro 2020/Learn Panel/
175180
```
176181

177182
---
@@ -193,7 +198,8 @@ String; read-only.
193198
Get a path to a Learn panel's example projects' directory
194199

195200
```js
196-
app.learnPanelExampleProjectDirPath; // /Users/Shared/Adobe/Premiere Pro/14.0/Tutorial/Going Home project/
201+
app.learnPanelExampleProjectDirPath;
202+
// /Users/Shared/Adobe/Premiere Pro/14.0/Tutorial/Going Home project/
197203
```
198204

199205
---
@@ -229,7 +235,8 @@ String; read-only.
229235
Get a path to applications executable file.
230236

231237
```js
232-
app.path; // /Applications/Adobe Premiere Pro 2020/Adobe Premiere Pro 2020.app/
238+
app.path;
239+
// /Applications/Adobe Premiere Pro 2020/Adobe Premiere Pro 2020.app/
233240
```
234241

235242
---
@@ -625,10 +632,22 @@ Specifies the path to be used for one of Premiere Pro's scratch disk paths.
625632

626633
#### Parameters
627634

628-
| Parameter | Type | Description |
629-
| ----------------- | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
630-
| `path` | String | The new path to be used. |
631-
| `scratchDiskType` | `ScratchDiskType` enum | Enumerated value, must be one of the following:<ul><li>`ScratchDiskType.FirstVideoCaptureFolder`</li><li>`ScratchDiskType.FirstAudioCaptureFolder`</li><li>`ScratchDiskType.FirstVideoPreviewFolder`</li><li>`ScratchDiskType.FirstAudioPreviewFolder`</li><li>`ScratchDiskType.FirstAutoSaveFolder`</li><li>`ScratchDiskType.FirstCCLibrariesFolder`</li><li>`ScratchDiskType.FirstCapsuleMediaFolder`</li></ul> |
635+
636+
+-------------------+------------------------+-------------------------------------------------+
637+
| Parameter | Type | Description |
638+
+===================+========================+=================================================+
639+
| `path` | String | The new path to be used. |
640+
+-------------------+------------------------+-------------------------------------------------+
641+
| `scratchDiskType` | `ScratchDiskType` enum | Enumerated value, must be one of the following: |
642+
| | | |
643+
| | | - `ScratchDiskType.FirstVideoCaptureFolder` |
644+
| | | - `ScratchDiskType.FirstAudioCaptureFolder` |
645+
| | | - `ScratchDiskType.FirstVideoPreviewFolder` |
646+
| | | - `ScratchDiskType.FirstAudioPreviewFolder` |
647+
| | | - `ScratchDiskType.FirstAutoSaveFolder` |
648+
| | | - `ScratchDiskType.FirstCCLibrariesFolder` |
649+
| | | - `ScratchDiskType.FirstCapsuleMediaFolder` |
650+
+-------------------+------------------------+-------------------------------------------------+
632651

633652
#### Returns
634653

@@ -655,10 +674,17 @@ Writes a string to Premiere Pro's Events panel.
655674

656675
#### Parameters
657676

658-
| Parameter | Type | Description |
659-
| ----------- | ------ | ---------------------------------------------------------------------------- |
660-
| `message` | String | A message to display. |
661-
| `decorator` | String | Decorator, one of:<ul><li>`info`</li><li>`warning`</li><li>`error`</li></ul> |
677+
+-------------+--------+-----------------------+
678+
| Parameter | Type | Description |
679+
+=============+========+=======================+
680+
| `message` | String | A message to display. |
681+
+-------------+--------+-----------------------+
682+
| `decorator` | String | Decorator, one of: |
683+
| | | |
684+
| | | - `info` |
685+
| | | - `warning` |
686+
| | | - `error` |
687+
+-------------+--------+-----------------------+
662688

663689
#### Returns
664690

‎docs/general/encoder.md

Lines changed: 55 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,27 @@ Makes Adobe Media Encoder render (optionally, a specified range from) the specif
2929

3030
#### Parameters
3131

32-
| Parameter | Type | Description |
33-
| ---------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
34-
| `filePath` | String | A path to a file to render. |
35-
| `outputPath` | String | A path to an output file. |
36-
| `presetPath` | String | A path to a preset (.epr) file. |
37-
| `workArea` | Integer | Integer denoting work area to be used:<ul><li>`0` - `ENCODE_ENTIRE`</li><li>`1` - `ENCODE_IN_TO_OUT`</li><li>`2` - `ENCODE_WORK_AREA`</li></ul> |
38-
| `removeUponCompletion` | Integer | If `1`, job will be removed once complete. |
39-
| `inPoint` | [Time object](../other/time.md) | A Time object, for the in point of new file. |
40-
| `outPoint` | [Time object](../other/time.md) | A Time object, for the out point of new file. |
32+
+------------------------+---------------------------------+-----------------------------------------------+
33+
| Parameter | Type | Description |
34+
+========================+=================================+===============================================+
35+
| `filePath` | String | A path to a file to render. |
36+
+------------------------+---------------------------------+-----------------------------------------------+
37+
| `outputPath` | String | A path to an output file. |
38+
+------------------------+---------------------------------+-----------------------------------------------+
39+
| `presetPath` | String | A path to a preset (.epr) file. |
40+
+------------------------+---------------------------------+-----------------------------------------------+
41+
| `workArea` | Integer | Integer denoting work area to be used: |
42+
| | | |
43+
| | | - `0` - `ENCODE_ENTIRE` |
44+
| | | - `1` - `ENCODE_IN_TO_OUT` |
45+
| | | - `2` - `ENCODE_WORK_AREA` |
46+
+------------------------+---------------------------------+-----------------------------------------------+
47+
| `removeUponCompletion` | Integer | If `1`, job will be removed once complete. |
48+
+------------------------+---------------------------------+-----------------------------------------------+
49+
| `inPoint` | [Time object](../other/time.md) | A Time object, for the in point of new file. |
50+
+------------------------+---------------------------------+-----------------------------------------------+
51+
| `outPoint` | [Time object](../other/time.md) | A Time object, for the out point of new file. |
52+
+------------------------+---------------------------------+-----------------------------------------------+
4153

4254
#### Returns
4355

@@ -55,13 +67,23 @@ Makes Adobe Media Encoder render (optionally, a specified range from) the specif
5567

5668
#### Parameters
5769

58-
| Parameter | Type | Description |
59-
| ---------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
60-
| `projectItem` | [ProjectItem object](../item/projectitem.md) | A project item to render. |
61-
| `outputPath` | String | A path to an output file. |
62-
| `presetPath` | String | A path to a preset (.epr) file. |
63-
| `workArea` | Integer | Integer denoting work area to be used:<ul><li>`0` - `ENCODE_ENTIRE`</li><li>`1` - `ENCODE_IN_TO_OUT`</li><li>`2` - `ENCODE_WORK_AREA`</li></ul> |
64-
| `removeUponCompletion` | Integer | If `1`, job will be removed once complete. |
70+
+------------------------+----------------------------------------------+--------------------------------------------+
71+
| Parameter | Type | Description |
72+
+========================+==============================================+============================================+
73+
| `projectItem` | [ProjectItem object](../item/projectitem.md) | A project item to render. |
74+
+------------------------+----------------------------------------------+--------------------------------------------+
75+
| `outputPath` | String | A path to an output file. |
76+
+------------------------+----------------------------------------------+--------------------------------------------+
77+
| `presetPath` | String | A path to a preset (.epr) file. |
78+
+------------------------+----------------------------------------------+--------------------------------------------+
79+
| `workArea` | Integer | Integer denoting work area to be used: |
80+
| | | |
81+
| | | - `0` - `ENCODE_ENTIRE` |
82+
| | | - `1` - `ENCODE_IN_TO_OUT` |
83+
| | | - `2` - `ENCODE_WORK_AREA` |
84+
+------------------------+----------------------------------------------+--------------------------------------------+
85+
| `removeUponCompletion` | Integer | If `1`, job will be removed once complete. |
86+
+------------------------+----------------------------------------------+--------------------------------------------+
6587

6688
#### Returns
6789

@@ -79,13 +101,23 @@ Makes Adobe Media Encoder render the specified [Sequence object](../sequence/seq
79101

80102
#### Parameters
81103

82-
| Parameter | Type | Description |
83-
| ---------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
84-
| `sequence` | [Sequence object](../sequence/sequence.md) | A sequence to render. |
85-
| `outputPath` | String | A path to an output file. |
86-
| `presetPath` | String | A path to a preset (.epr) file. |
87-
| `workArea` | Integer | Integer denoting work area to be used:<ul><li>`0` - `ENCODE_ENTIRE`</li><li>`1` - `ENCODE_IN_TO_OUT`</li><li>`2` - `ENCODE_WORK_AREA`</li></ul> |
88-
| `removeUponCompletion` | Integer | If `1`, job will be removed once complete. |
104+
+------------------------+--------------------------------------------+--------------------------------------------+
105+
| Parameter | Type | Description |
106+
+========================+============================================+============================================+
107+
| `sequence` | [Sequence object](../sequence/sequence.md) | A sequence to render. |
108+
+------------------------+--------------------------------------------+--------------------------------------------+
109+
| `outputPath` | String | A path to an output file. |
110+
+------------------------+--------------------------------------------+--------------------------------------------+
111+
| `presetPath` | String | A path to a preset (.epr) file. |
112+
+------------------------+--------------------------------------------+--------------------------------------------+
113+
| `workArea` | Integer | Integer denoting work area to be used: |
114+
| | | |
115+
| | | - `0` - `ENCODE_ENTIRE` |
116+
| | | - `1` - `ENCODE_IN_TO_OUT` |
117+
| | | - `2` - `ENCODE_WORK_AREA` |
118+
+------------------------+--------------------------------------------+--------------------------------------------+
119+
| `removeUponCompletion` | Integer | If `1`, job will be removed once complete. |
120+
+------------------------+--------------------------------------------+--------------------------------------------+
89121

90122
#### Returns
91123

0 commit comments

Comments
 (0)