Skip to content

Commit 57deb2c

Browse files
zlovattzlovatt
committed
More cleanup; convert General sectionD
1 parent e27233a commit 57deb2c

File tree

15 files changed

+269
-263
lines changed

15 files changed

+269
-263
lines changed

‎docs/application/application.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ None.
388388

389389
#### Returns
390390

391-
Returns 1 if proxies are enabled, 0 of they are not.
391+
Returns `1` if proxies are enabled, `0` if they are not.
392392

393393
---
394394

‎docs/general/anywhere.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
#### Description
66

7-
The **anywhere** object represents any Adobe Anywhere or Team Projects servers available.
7+
The `Anywhere` object represents any Adobe Anywhere or Team Projects servers available.
88

99
---
1010

@@ -30,7 +30,7 @@ None.
3030

3131
#### Returns
3232

33-
A **String** containing the login token, or **0** if unsuccessful.
33+
A String containing the login token, or `0` if unsuccessful.
3434

3535
---
3636

@@ -48,7 +48,7 @@ None.
4848

4949
#### Returns
5050

51-
Returns a **String** containing the asset's URL, or **0** if unsuccessful (including if there is no active sequence, or if no editing session is opened).
51+
Returns a String containing the asset's URL, or `0` if unsuccessful (including if there is no active sequence, or if no editing session is opened).
5252

5353
---
5454

@@ -66,7 +66,7 @@ None.
6666

6767
#### Returns
6868

69-
Returns a **String** containing the asset's URL, or **0** if unsuccessful (including if more or fewre than one item is selected).
69+
Returns a String containing the asset's URL, or `0` if unsuccessful (including if more or fewre than one item is selected).
7070

7171
---
7272

@@ -84,7 +84,7 @@ None.
8484

8585
#### Returns
8686

87-
Returns a **String** containing the production's URL, or **0** if unsuccessful.
87+
Returns a String containing the production's URL, or `0` if unsuccessful.
8888

8989
---
9090

@@ -120,7 +120,7 @@ None.
120120

121121
#### Returns
122122

123-
Returns an Array of **Strings** containing the names of avialable productions, or 0 if unsuccessful.
123+
Returns an Array of Strings containing the names of avialable productions, or `0` if unsuccessful.
124124

125125
---
126126

@@ -134,13 +134,13 @@ Opens the production at the specified URL.
134134

135135
#### Parameters
136136

137-
| Argument | Type | Description |
138-
|-----------------|----------|------------------------------------|
137+
| Argument | Type | Description |
138+
| --------------- | ------ | ---------------------------------- |
139139
| `productionURL` | String | The url of the production to open. |
140140

141141
#### Returns
142142

143-
Returns **0** if successful.
143+
Returns `0` if successful.
144144

145145
---
146146

@@ -154,11 +154,11 @@ Logs the specified email address into the server, using the provided token.
154154

155155
#### Parameters
156156

157-
| Argument | Type | Description |
158-
|----------------|----------|-------------------------------|
157+
| Argument | Type | Description |
158+
| -------------- | ------ | ----------------------------- |
159159
| `token` | String | An authorization token. |
160160
| `emailAddress` | String | The associated email address. |
161161

162162
#### Returns
163163

164-
Returns **0** if successful.
164+
Returns `0` if successful.

‎docs/general/encoder.md

Lines changed: 43 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
#### Description
66

7-
The **encoder** object represents Adobe Media Encoder, and is used for local rendering, outside of Premiere Pro.
7+
The `encoder` object represents Adobe Media Encoder, and is used for local rendering, outside of Premiere Pro.
88

9-
Warning: app.encoder is broken on Premiere Pro 14.3.1 - 15 on Mac only. Fixed in 22 and up.
10-
[https://community.adobe.com/t5/premiere-pro-discussions/missing-the-object-app-encoder-14-3-1-15-0-15-1-15-2/m-p/12544488](https://community.adobe.com/t5/premiere-pro-discussions/missing-the-object-app-encoder-14-3-1-15-0-15-1-15-2/m-p/12544488)
9+
!!! warning
10+
`app.encoder` is broken on Premiere Pro 14.3.1 - 15 on Mac only. Fixed in 22 and up. [See here.](https://community.adobe.com/t5/premiere-pro-discussions/missing-the-object-app-encoder-14-3-1-15-0-15-1-15-2/m-p/12544488)
1111

1212
---
1313

@@ -21,27 +21,27 @@ None.
2121

2222
### Encoder.encodeFile()
2323

24-
`app.encoder.encodeFile(filePath, outputPath, presetPath, workArea, removeUponCompletion)`
24+
`app.encoder.encodeFile(filePath, outputPath, presetPath, workArea, removeUponCompletion, inPoint, outPoint)`
2525

2626
#### Description
2727

2828
Makes Adobe Media Encoder render (optionally, a specified range from) the specified file, with the specified settings.
2929

3030
#### Parameters
3131

32-
| Argument | 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:<br/><br/>- 0 - `ENCODE_ENTIRE`<br/>- 1 - `ENCODE_IN_TO_OUT`<br/>- 2 - `ENCODE_WORK_AREA` |
38-
| `removeUponCompletion` | Integer | If `1`, job will be removed once complete. |
39-
| `inPoint` | Time | A **Time**, for the in point of new file. |
40-
| `outPoint` | Time | A **Time**, for the out point of new file. |
32+
| Argument | 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. |
4141

4242
#### Returns
4343

44-
Returns a job ID as a **String**, for the render job added to the AME queue, or **0** if unsuccessful.
44+
Returns a job ID as a String, for the render job added to the AME queue, or `0` if unsuccessful.
4545

4646
---
4747

@@ -55,17 +55,17 @@ Makes Adobe Media Encoder render (optionally, a specified range from) the specif
5555

5656
#### Parameters
5757

58-
| Argument | 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:<br/><br/>- 0 - `ENCODE_ENTIRE`<br/>- 1 - `ENCODE_IN_TO_OUT`<br/>- 2 - `ENCODE_WORK_AREA` |
64-
| `removeUponCompletion` | Integer | If `1`, job will be removed once complete. |
58+
| Argument | 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. |
6565

6666
#### Returns
6767

68-
Returns a job ID as a **String**, for the render job added to the AME queue, or **0** if unsuccessful.
68+
Returns a job ID as a String, for the render job added to the AME queue, or `0` if unsuccessful.
6969

7070
---
7171

@@ -79,17 +79,17 @@ Makes Adobe Media Encoder render the specified [Sequence object](../sequence/seq
7979

8080
#### Parameters
8181

82-
| Argument | Type | Description |
83-
|------------------------|-----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
82+
| Argument | Type | Description |
83+
| ---------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
8484
| `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:<br/><br/>- 0 - `ENCODE_ENTIRE`<br/>- 1 - `ENCODE_IN_TO_OUT`<br/>- 2 - `ENCODE_WORK_AREA` |
88-
| `removeUponCompletion` | Integer | If `1`, job will be removed once complete. |
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. |
8989

9090
#### Returns
9191

92-
Returns a job ID as a **String**, for the render job added to the AME queue, or **0** if unsuccessful.
92+
Returns a job ID as a String, for the render job added to the AME queue, or `0` if unsuccessful.
9393

9494
---
9595

@@ -107,7 +107,7 @@ None.
107107

108108
#### Returns
109109

110-
Returns **0** if successful.
110+
Returns `0` if successful.
111111

112112
---
113113

@@ -121,15 +121,18 @@ Determines whether embedded XMP metadata, will be output.
121121

122122
#### Parameters
123123

124-
| Argument | Type | Description |
125-
|------------|-----------|----------------------------------------------------|
126-
| `enabled` | Integer | Pass `1` to enable sidecar output, `0` to disable. |
124+
| Argument | Type | Description |
125+
| --------- | ------- | -------------------------------------------------- |
126+
| `enabled` | Integer | Pass `1` to enable sidecar output, `0` to disable. |
127127

128128
#### Returns
129129

130-
Returns **0** if successful.
130+
Returns `0` if successful.
131131

132-
Note: Premiere Pro and Adobe Media Encoder will output sidecar XMP for some file formats, and embed XMP for most. The applications make this determination based on numerous factors, and there is no API control to "force" sidecar or embedded output, for formats which normally use "the other approach".
132+
!!! note
133+
Premiere Pro and Adobe Media Encoder will output sidecar XMP for some file formats, and embed XMP for most.
134+
135+
The applications make this determination based on numerous factors, and there is no API control to "force" sidecar or embedded output, for formats which normally use "the other approach".
133136

134137
---
135138

@@ -143,13 +146,13 @@ Determines whether a sidecar file containing XMP metadata, will be output.
143146

144147
#### Parameters
145148

146-
| Argument | Type | Description |
147-
|------------|-----------|----------------------------------------------------|
148-
| `enabled` | Integer | Pass `1` to enable sidecar output, `0` to disable. |
149+
| Argument | Type | Description |
150+
| --------- | ------- | -------------------------------------------------- |
151+
| `enabled` | Integer | Pass `1` to enable sidecar output, `0` to disable. |
149152

150153
#### Returns
151154

152-
Returns **0** if successful.
155+
Returns `0` if successful.
153156

154157
---
155158

@@ -167,4 +170,4 @@ None.
167170

168171
#### Returns
169172

170-
Returns **0** if successful.
173+
Returns `0` if successful.

‎docs/general/marker.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
#### Description
99

10-
Both [Project items](../item/projectitem.md) and [sequences](../sequence/sequence.md) have associated **marker** objects, which represent their associated markers.
10+
Both [Project items](../item/projectitem.md) and [sequences](../sequence/sequence.md) have associated Marker objects, which represent their associated markers.
1111

1212
---
1313

@@ -107,7 +107,15 @@ A [Time object](../other/time.md) containing the value of the beginning of the m
107107

108108
#### Description
109109

110-
The type of marker; either "Comment", "Chapter", "Segmentation", or "WebLink". Note: Premiere Pro can import some marker types, which cannot be created from within Premiere Pro.
110+
The type of marker, one of:
111+
112+
- `"Comment"`
113+
- `"Chapter"`
114+
- `"Segmentation"`
115+
- `"WebLink"`
116+
117+
!!! note
118+
Premiere Pro can import some marker types which cannot be created from within Premiere Pro.
111119

112120
#### Type
113121

@@ -160,7 +168,7 @@ None.
160168

161169
#### Returns
162170

163-
Returns a String containing the frame target, or **0** if unsuccessful.
171+
Returns a String containing the frame target, or `0` if unsuccessful.
164172

165173
---
166174

@@ -181,7 +189,7 @@ None.
181189

182190
#### Returns
183191

184-
Returns a String containing the URL, or **0** if unsuccessful.
192+
Returns a String containing the URL, or `0` if unsuccessful.
185193

186194
---
187195

@@ -197,16 +205,16 @@ Returns a String containing the URL, or **0** if unsuccessful.
197205

198206
#### Description
199207

200-
Sets the marker color by index. Color indexies listed below.
208+
Sets the marker color by index. Color indices listed below.
201209

202-
* 0 = Green
203-
* 1 = Red
204-
* 2 = Purple
205-
* 3 = Orange
206-
* 4 = Yellow
207-
* 5 = White
208-
* 6 = Blue
209-
* 7 = Cyan
210+
- `0` = Green
211+
- `1` = Red
212+
- `2` = Purple
213+
- `3` = Orange
214+
- `4` = Yellow
215+
- `5` = White
216+
- `6` = Blue
217+
- `7` = Cyan
210218

211219
#### Parameters
212220

@@ -238,7 +246,7 @@ None.
238246

239247
#### Returns
240248

241-
Returns **0** if successful.
249+
Returns `0` if successful.
242250

243251
---
244252

@@ -259,7 +267,7 @@ None.
259267

260268
#### Returns
261269

262-
Returns **0** if successful.
270+
Returns `0` if successful.
263271

264272
---
265273

@@ -280,7 +288,7 @@ None.
280288

281289
#### Returns
282290

283-
Returns **0** if successful.
291+
Returns `0` if successful.
284292

285293
---
286294

@@ -301,4 +309,4 @@ None.
301309

302310
#### Returns
303311

304-
Returns **0** if successful.
312+
Returns `0` if successful.

0 commit comments

Comments
 (0)