Skip to content

Commit 644331f

Browse files
justintaylor-devjustintaylor-dev
committed
Revert "added broadcastPrefsChanged"
This reverts commit b50b7df.
1 parent b50b7df commit 644331f

File tree

1 file changed

+44
-72
lines changed

1 file changed

+44
-72
lines changed

‎docs/application/application.md

Lines changed: 44 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ parseInt(app.build); // 45
5858
Provides access to Adobe Media Encoder (on the same system).
5959

6060
!!! warning
61-
`app.encoder` is broken on Premiere Pro 14.3.1 - 15 on Mac only. Fixed in 22 and up. [See this discussion](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).
61+
`app.encoder` is broken on Premiere Pro 14.3.1 - 15 on Mac only. Fixed in 22 and up. [See this discussion](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).
6262

6363
#### Type
6464

@@ -353,7 +353,7 @@ String; read-only.
353353

354354
#### Example
355355

356-
Get a version of a current application _(Adobe Premiere Pro version 14.3.1 (Build 45))_
356+
Get a version of a current application *(Adobe Premiere Pro version 14.3.1 (Build 45))*
357357

358358
```js
359359
app.version; // 14.3.1
@@ -448,7 +448,7 @@ Determines whether the file at path can be opened as a Premiere Pro [project](..
448448

449449
#### Parameters
450450

451-
| Parameter | Type | Description |
451+
| Parameter | Type | Description |
452452
| --------- | ------ | ----------------- |
453453
| `path` | String | A path to a file. |
454454

@@ -461,10 +461,10 @@ Returns `true` if file can be opened as a Premiere Pro [project](../general/proj
461461
Test for valid project files
462462

463463
```js
464-
app.isDocument("~/Desktop/myProject.prproj"); // true
465-
app.isDocument("~/Desktop/textFile.txt"); // false
466-
app.isDocument("~/Desktop/footageFile.mov"); // false
467-
app.isDocument("~/Desktop/imageFile.mov"); // false
464+
app.isDocument('~/Desktop/myProject.prproj'); // true
465+
app.isDocument('~/Desktop/textFile.txt'); // false
466+
app.isDocument('~/Desktop/footageFile.mov'); // false
467+
app.isDocument('~/Desktop/imageFile.mov'); // false
468468
```
469469

470470
---
@@ -497,9 +497,9 @@ Creates a new .prproj [Project object](../general/project.md), at the specified
497497

498498
#### Parameters
499499

500-
| Parameter | Type | Description |
500+
| Parameter | Type | Description |
501501
| --------- | ------ | -------------------------------------------------------------------- |
502-
| `path` | String | A full path to new project; a .prproj extension will _not_ be added. |
502+
| `path` | String | A full path to new project; a .prproj extension will *not* be added. |
503503

504504
#### Returns
505505

@@ -517,7 +517,7 @@ Opens the file at the specified path, as a Premiere Pro [Project object](../gene
517517

518518
#### Parameters
519519

520-
| Parameter | Type | Description |
520+
| Parameter | Type | Description |
521521
| -------------------------- | ------- | --------------------------------------------------------------- |
522522
| `path` | String | Full path to the document to be opened. |
523523
| `suppressConversionDialog` | Boolean | Optional. Suppress project conversion dialog. |
@@ -541,7 +541,7 @@ Opens an FCP XML file as a Premiere Pro [Project object](../general/project.md)
541541

542542
#### Parameters
543543

544-
| Parameter | Type | Description |
544+
| Parameter | Type | Description |
545545
| ---------- | ------ | ----------- |
546546
| `path` | String | |
547547
| `projPath` | String | |
@@ -580,7 +580,7 @@ Determines whether proxy usage is currently enabled.
580580

581581
#### Parameters
582582

583-
| Parameter | Type | Description |
583+
| Parameter | Type | Description |
584584
| --------- | ------- | ----------------------------------------- |
585585
| `enabled` | Integer | `1` turns proxies on, `0` turns them off. |
586586

@@ -600,7 +600,7 @@ Whether extension with the given extensionID persists, within this session.
600600

601601
#### Parameters
602602

603-
| Parameter | Type | Description |
603+
| Parameter | Type | Description |
604604
| ------------- | ------- | ------------------------------------------------------------- |
605605
| `extensionID` | String | Which extension to modify. |
606606
| `persistent` | Integer | Pass `1` to keep extension in memory, `0` to allow unloading. |
@@ -612,7 +612,7 @@ Returns `true` if successful.
612612
#### Example
613613

614614
```js
615-
var extensionID = "com.adobe.PProPanel";
615+
var extensionID = 'com.adobe.PProPanel';
616616
// 0 - while testing (to enable rapid reload);
617617
// 1 - for "Never unload me, even when not visible."
618618
var persistent = 0;
@@ -632,20 +632,21 @@ Specifies the path to be used for one of Premiere Pro's scratch disk paths.
632632

633633
#### Parameters
634634

635+
635636
+-------------------+------------------------+-------------------------------------------------+
636-
| Parameter | Type | Description |
637+
| Parameter | Type | Description |
637638
+===================+========================+=================================================+
638-
| `path` | String | The new path to be used. |
639+
| `path` | String | The new path to be used. |
639640
+-------------------+------------------------+-------------------------------------------------+
640641
| `scratchDiskType` | `ScratchDiskType` enum | Enumerated value, must be one of the following: |
641-
| | | |
642-
| | | - `ScratchDiskType.FirstVideoCaptureFolder` |
643-
| | | - `ScratchDiskType.FirstAudioCaptureFolder` |
644-
| | | - `ScratchDiskType.FirstVideoPreviewFolder` |
645-
| | | - `ScratchDiskType.FirstAudioPreviewFolder` |
646-
| | | - `ScratchDiskType.FirstAutoSaveFolder` |
647-
| | | - `ScratchDiskType.FirstCCLibrariesFolder` |
648-
| | | - `ScratchDiskType.FirstCapsuleMediaFolder` |
642+
| | | |
643+
| | | - `ScratchDiskType.FirstVideoCaptureFolder` |
644+
| | | - `ScratchDiskType.FirstAudioCaptureFolder` |
645+
| | | - `ScratchDiskType.FirstVideoPreviewFolder` |
646+
| | | - `ScratchDiskType.FirstAudioPreviewFolder` |
647+
| | | - `ScratchDiskType.FirstAutoSaveFolder` |
648+
| | | - `ScratchDiskType.FirstCCLibrariesFolder` |
649+
| | | - `ScratchDiskType.FirstCapsuleMediaFolder` |
649650
+-------------------+------------------------+-------------------------------------------------+
650651

651652
#### Returns
@@ -655,12 +656,9 @@ Returns `true` if successful.
655656
#### Example
656657

657658
```js
658-
var scratchPath = Folder.selectDialog("Choose new scratch disk folder");
659+
var scratchPath = Folder.selectDialog('Choose new scratch disk folder');
659660
if (scratchPath && scratchPath.exists) {
660-
app.setScratchDiskPath(
661-
scratchPath.fsName,
662-
ScratchDiskType.FirstAutoSaveFolder
663-
);
661+
app.setScratchDiskPath(scratchPath.fsName, ScratchDiskType.FirstAutoSaveFolder);
664662
}
665663
```
666664

@@ -677,15 +675,15 @@ Writes a string to Premiere Pro's Events panel.
677675
#### Parameters
678676

679677
+-------------+--------+-----------------------+
680-
| Parameter | Type | Description |
678+
| Parameter | Type | Description |
681679
+=============+========+=======================+
682-
| `message` | String | A message to display. |
680+
| `message` | String | A message to display. |
683681
+-------------+--------+-----------------------+
684-
| `decorator` | String | Decorator, one of: |
685-
| | | |
686-
| | | - `info` |
687-
| | | - `warning` |
688-
| | | - `error` |
682+
| `decorator` | String | Decorator, one of: |
683+
| | | |
684+
| | | - `info` |
685+
| | | - `warning` |
686+
| | | - `error` |
689687
+-------------+--------+-----------------------+
690688

691689
#### Returns
@@ -704,7 +702,7 @@ Set workspace as active. Use [app.getWorkspaces()](#appgetworkspaces) to get a l
704702

705703
#### Parameters
706704

707-
| Parameter | Type | Description |
705+
| Parameter | Type | Description |
708706
| ----------- | ------ | -------------------------- |
709707
| `workspace` | String | The name of the workspace. |
710708

@@ -717,11 +715,11 @@ Boolean.
717715
Activate "Editing" workspace.
718716

719717
```js
720-
var workspace = "Editing";
718+
var workspace = 'Editing';
721719
if (app.setWorkspace(workspace)) {
722-
alert('Workspace changed to "' + workspace + '"');
720+
alert('Workspace changed to "' + workspace + '"');
723721
} else {
724-
alert('Could not set "' + workspace + '" workspace');
722+
alert('Could not set "' + workspace + '" workspace');
725723
}
726724
```
727725

@@ -765,10 +763,10 @@ An array of view IDs; can be null.
765763

766764
```js
767765
var allViewIDs = app.getProjectViewIDs();
768-
if (allViewIDs) {
769-
var firstOne = allViewIDs[0];
766+
if (allViewIDs){
767+
var firstOne = allViewIDs[0];
770768
} else {
771-
// No views open.
769+
// No views open.
772770
}
773771
```
774772

@@ -830,35 +828,9 @@ An array of [ProjectItems](../item/projectitem.md); can be null.
830828
831829
```js
832830
var selectedItems = app.getCurrentProjectViewSelection();
833-
if (selectedItems) {
834-
var firstOne = selectedItems[0];
831+
if (selectedItems){
832+
var firstOne = selectedItems[0];
835833
} else {
836-
// No projectItems selected.
834+
// No projectItems selected.
837835
}
838836
```
839-
840-
---
841-
842-
### app.broadcastPrefsChanged()
843-
844-
`app.broadcastPrefsChanged()`
845-
846-
#### Description
847-
848-
Notifies Application that preferences have changed.
849-
850-
#### Parameters
851-
852-
String ID of the preference that changed. (currently only listens to "BE::PreferencesScratchDisksChanged")
853-
854-
#### Returns
855-
856-
Returns `true` if update was successful.
857-
858-
#### Example
859-
860-
```js
861-
app.broadcastPrefsChanged("BE::PreferencesScratchDisksChanged");
862-
```
863-
864-
---

0 commit comments

Comments
 (0)