Skip to content

Commit c3800fe

Browse files
zlovattzlovatt
committed
Clean up Application
1 parent fe8a969 commit c3800fe

File tree

6 files changed

+60
-60
lines changed

6 files changed

+60
-60
lines changed

‎docs/application/application.md‎

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,7 @@ None.
406406

407407
#### Returns
408408

409-
`Array` if successful, `null` if unsuccessful.
409+
Array of strings if successful, `null` if unsuccessful.
410410

411411
#### Example
412412

@@ -441,13 +441,13 @@ Determines whether the file at path can be opened as a Premiere Pro [project](..
441441

442442
#### Parameters
443443

444-
| Argument | Type | Description |
445-
|------------|----------|-------------------|
446-
| `path` | String | A path to a file. |
444+
| Parameter | Type | Description |
445+
| --------- | ------ | ----------------- |
446+
| `path` | String | A path to a file. |
447447

448448
#### Returns
449449

450-
Returns **true** if file can be opened as a Premiere Pro [project](../general/project.md).
450+
Returns `true` if file can be opened as a Premiere Pro [project](../general/project.md).
451451

452452
#### Example
453453

@@ -476,7 +476,7 @@ None.
476476

477477
#### Returns
478478

479-
Returns **true** if at least 1 project is open; otherwise **false**.
479+
Returns `true` if at least 1 project is open; otherwise `false`.
480480

481481
---
482482

@@ -490,28 +490,28 @@ Creates a new .prproj [Project object](../general/project.md), at the specified
490490

491491
#### Parameters
492492

493-
| Argument | Type | Description |
494-
|------------|----------|----------------------------------------------------------------------|
495-
| `path` | String | A full path to new project; a .prproj extension will *not* be added. |
493+
| Parameter | Type | Description |
494+
| --------- | ------ | -------------------------------------------------------------------- |
495+
| `path` | String | A full path to new project; a .prproj extension will *not* be added. |
496496

497497
#### Returns
498498

499-
Returns **true** if successful.
499+
Returns `true` if successful.
500500

501501
---
502502

503503
### app.openDocument()
504504

505-
`app.openDocument(path)`
505+
`app.openDocument(path, [suppressConversionDialog], [bypassLocateFileDialog], [bypassWarningDialog], [doNotAddToMRUList])`
506506

507507
#### Description
508508

509509
Opens the file at the specified path, as a Premiere Pro [Project object](../general/project.md).
510510

511511
#### Parameters
512512

513-
| Argument | Type | Description |
514-
|----------------------------|-----------|-----------------------------------------------------------------|
513+
| Parameter | Type | Description |
514+
| -------------------------- | ------- | --------------------------------------------------------------- |
515515
| `path` | String | Full path to the document to be opened. |
516516
| `suppressConversionDialog` | Boolean | Optional. Suppress project conversion dialog. |
517517
| `bypassLocateFileDialog` | Boolean | Optional. Bypass the locate file dialog. |
@@ -520,7 +520,7 @@ Opens the file at the specified path, as a Premiere Pro [Project object](../gene
520520

521521
#### Returns
522522

523-
Returns **true** if file was successfully opened.
523+
Returns `true` if file was successfully opened.
524524

525525
---
526526

@@ -534,14 +534,14 @@ Opens an FCP XML file as a Premiere Pro [Project object](../general/project.md)
534534

535535
#### Parameters
536536

537-
| Argument | Type | Description |
538-
|------------|----------|---------------|
539-
| `path` | String | |
540-
| `projPath` | String | |
537+
| Parameter | Type | Description |
538+
| ---------- | ------ | ----------- |
539+
| `path` | String | |
540+
| `projPath` | String | |
541541

542542
#### Returns
543543

544-
Returns **true** if file was successfully opened as a Premiere Pro [Project object](../general/project.md).
544+
Returns `true` if file was successfully opened as a Premiere Pro [Project object](../general/project.md).
545545

546546
---
547547

@@ -573,13 +573,13 @@ Determines whether proxy usage is currently enabled.
573573

574574
#### Parameters
575575

576-
| Argument | Type | Description |
577-
|------------|-----------|-------------------------------------------|
578-
| `enabled` | Integer | `1` turns proxies on, `0` turns them off. |
576+
| Parameter | Type | Description |
577+
| --------- | ------- | ----------------------------------------- |
578+
| `enabled` | Integer | `1` turns proxies on, `0` turns them off. |
579579

580580
#### Returns
581581

582-
Returns 1 if proxy enablement was changed.
582+
Returns `1` if proxy enablement was changed.
583583

584584
---
585585

@@ -593,14 +593,14 @@ Whether extension with the given extensionID persists, within this session.
593593

594594
#### Parameters
595595

596-
| Argument | Type | Description |
597-
|---------------|-----------|---------------------------------------------------------------|
596+
| Parameter | Type | Description |
597+
| ------------- | ------- | ------------------------------------------------------------- |
598598
| `extensionID` | String | Which extension to modify. |
599599
| `persistent` | Integer | Pass `1` to keep extension in memory, `0` to allow unloading. |
600600

601601
#### Returns
602602

603-
Returns **true** if successful.
603+
Returns `true` if successful.
604604

605605
#### Example
606606

@@ -625,14 +625,14 @@ Specifies the path to be used for one of Premiere Pro's scratch disk paths.
625625

626626
#### Parameters
627627

628-
| Argument | Type | Description |
629-
|-------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
630-
| `path` | String | The new path to be used. |
631-
| `scratchDiskType` | `Enum` | Enumerated value, must be one of the following:<br/><br/>- `ScratchDiskType.FirstVideoCaptureFolder`<br/>- `ScratchDiskType.FirstAudioCaptureFolder`<br/>- `ScratchDiskType.FirstVideoPreviewFolder`<br/>- `ScratchDiskType.FirstAudioPreviewFolder`<br/>- `ScratchDiskType.FirstAutoSaveFolder`<br/>- `ScratchDiskType.FirstCCLibrariesFolder`<br/>- `ScratchDiskType.FirstCapsuleMediaFolder` |
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> |
632632

633633
#### Returns
634634

635-
Returns 'true' if successful.
635+
Returns `true` if successful.
636636

637637
#### Example
638638

@@ -655,14 +655,14 @@ Writes a string to Premiere Pro's Events panel.
655655

656656
#### Parameters
657657

658-
| Argument | Type | Description |
659-
|-------------|----------|--------------------------------------------------------------------------------------------|
660-
| `message` | String | A message to display. |
661-
| `decorator` | String | Decorator, one of:<br/><br/>`info`<br/><br/><br/>`warning`<br/><br/><br/>`error`<br/><br/> |
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> |
662662

663663
#### Returns
664664

665-
Returns 'true' if successful.
665+
Returns `true` if successful.
666666

667667
---
668668

@@ -676,8 +676,8 @@ Set workspace as active. Use [app.getWorkspaces()](#appgetworkspaces) to get a l
676676

677677
#### Parameters
678678

679-
| Argument | Type | Description |
680-
|-------------|----------|----------------------------|
679+
| Parameter | Type | Description |
680+
| ----------- | ------ | -------------------------- |
681681
| `workspace` | String | The name of the workspace. |
682682

683683
#### Returns
@@ -686,7 +686,7 @@ Boolean.
686686

687687
#### Example
688688

689-
Activate `Editing` workspace.
689+
Activate "Editing" workspace.
690690

691691
```js
692692
var workspace = 'Editing';
@@ -713,7 +713,7 @@ None.
713713

714714
#### Returns
715715

716-
Returns **true** if trace was added.
716+
Returns `true` if trace was added.
717717

718718
---
719719

@@ -752,15 +752,15 @@ if (allViewIDs){
752752

753753
#### Description
754754

755-
Returns the Project associated with the provided View ID.
755+
Returns the [Project](../general/project.md) associated with the provided View ID.
756756

757757
#### Parameters
758758

759759
A View ID, obtained from `getProjectViewIDs`.
760760

761761
#### Returns
762762

763-
A Project object, for the project associated with the provided View ID. Can be `null`.
763+
A [Project](../general/project.md) object, for the project associated with the provided View ID. Can be `null`.
764764

765765
#### Example
766766

@@ -788,15 +788,15 @@ if (allViewIDs){
788788
789789
#### Description
790790
791-
Returns an array of projectItems selected, in the current active project view.
791+
Returns an array of [ProjectItems](../item/projectitem.md) selected, in the current active project view.
792792
793793
#### Parameters
794794
795795
None.
796796
797797
#### Returns
798798
799-
An array of projectItems; can be null.
799+
An array of [ProjectItems](../item/projectitem.md); can be null.
800800
801801
#### Example
802802

‎docs/general/production.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Copies a project from some other location, into the Production directory.
7171

7272
#### Returns
7373

74-
Returns **true** if successful.
74+
Returns `true` if successful.
7575

7676
---
7777

@@ -89,7 +89,7 @@ None.
8989

9090
#### Returns
9191

92-
Returns **true** if successful.
92+
Returns `true` if successful.
9393

9494
---
9595

@@ -109,7 +109,7 @@ Returns the lock state of a single project within the Production.
109109

110110
#### Returns
111111

112-
Returns **true** if the Project is locked, **false** if the Project is unlocked.
112+
Returns `true` if the Project is locked, `false` if the Project is unlocked.
113113

114114
---
115115

@@ -131,7 +131,7 @@ Moves the specified path ("bin") or .prproj into the Production's Trash folder.
131131

132132
#### Returns
133133

134-
Returns **true** if successful.
134+
Returns `true` if successful.
135135

136136
---
137137

@@ -152,4 +152,4 @@ Sets the lock state of the specified project within the Production.
152152

153153
#### Returns
154154

155-
Returns **true** if successful.
155+
Returns `true` if successful.

‎docs/general/project.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ Adds a new field of the specified type to Premiere Pro's private project metadat
150150

151151
#### Returns
152152

153-
Returns **true** if successful, **undefined** if unsuccessful.
153+
Returns `true` if successful, **undefined** if unsuccessful.
154154

155155
---
156156

@@ -511,7 +511,7 @@ Imports media from the specified file paths.
511511

512512
#### Returns
513513

514-
Returns **true** if successful, **false** if not.
514+
Returns `true` if successful, `false` if not.
515515

516516
---
517517

@@ -550,7 +550,7 @@ None.
550550

551551
#### Returns
552552

553-
Returns **true** if copying is enabled; **false** if not.
553+
Returns `true` if copying is enabled; `false` if not.
554554

555555
---
556556

@@ -617,7 +617,7 @@ Makes the [Sequence object](../sequence/sequence.md) with the provided sequence
617617

618618
#### Returns
619619

620-
Returns **true** if successful, **false** if not.
620+
Returns `true` if successful, `false` if not.
621621

622622
---
623623

@@ -695,7 +695,7 @@ Controls the enablement of transcode-upon-ingest behavior, for the given project
695695

696696
#### Returns
697697

698-
Returns **true** if successful.
698+
Returns `true` if successful.
699699

700700
---
701701

‎docs/item/projectitem.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -189,15 +189,15 @@ Returns **0** if successful.
189189

190190
#### Description
191191

192-
Returns **true** if Premiere Pro can change the path, associated with this project item; otherwise, returns **false**.
192+
Returns `true` if Premiere Pro can change the path, associated with this project item; otherwise, returns `false`.
193193

194194
#### Parameters
195195

196196
None.
197197

198198
#### Returns
199199

200-
Boolean; **true** if media can be replaced, **false** if not.
200+
Boolean; `true` if media can be replaced, `false` if not.
201201

202202
---
203203

@@ -215,7 +215,7 @@ None.
215215

216216
#### Returns
217217

218-
Returns **true** if the project item permits a proxy to be attached; **false** if not.
218+
Returns `true` if the project item permits a proxy to be attached; `false` if not.
219219

220220
---
221221

@@ -703,7 +703,7 @@ None.
703703

704704
#### Returns
705705

706-
Returns **true** if the project item has a proxy attached; **false** if not.
706+
Returns `true` if the project item has a proxy attached; `false` if not.
707707

708708
---
709709

‎docs/other/audiochannelmapping.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,4 @@ Maps a source channel to the specified channel index.
4949

5050
#### Returns
5151

52-
Returns **true** if successful, **false** if that mapping is unsupported.
52+
Returns `true` if successful, `false` if that mapping is unsupported.

‎docs/sequence/track.md‎

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

144144
#### Returns
145145

146-
Returns **true** if track is currently muted; **false** if not.
146+
Returns `true` if track is currently muted; `false` if not.
147147

148148
---
149149

0 commit comments

Comments
 (0)