Skip to content

Commit

Permalink
Update readme and version number for v2.1.0 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
sebinside committed Feb 2, 2025
1 parent 80a4907 commit 7043e8c
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 4 deletions.
2 changes: 1 addition & 1 deletion CSXS/manifest.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version='1.0' encoding='UTF-8'?>
<ExtensionManifest ExtensionBundleId="de.sebinside.premiereremote" ExtensionBundleVersion="1.0.0" Version="7.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ExtensionList>
<Extension Id="de.sebinside.premiereremote.panel" Version="2.0.0" />
<Extension Id="de.sebinside.premiereremote.panel" Version="2.1.0" />
</ExtensionList>
<ExecutionEnvironment>
<HostList>
Expand Down
2 changes: 1 addition & 1 deletion client/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

<!-- Change this port, if there are conflicts with other software -->
<script type="text/javascript">
const PREMIERE_REMOTE_VERSION = "2.0.0";
const PREMIERE_REMOTE_VERSION = "2.1.0";
const SERVER_PORT = 8081;
const WS_SERVER_PORT = 8082;
const ENABLE_QE = true;
Expand Down
25 changes: 23 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
![Premiere Version](https://img.shields.io/badge/Premiere%20Version-2021-orange)
[![Custom](https://img.shields.io/badge/Custom%20Functionality-Available-green)](/~https://github.com/sebinside/PremiereRemote/tree/custom/host/src)

Using the [Adobe Premiere Extension mechanism](/~https://github.com/Adobe-CEP), **PremiereRemote** provides a framework to trigger your own Premiere CEP-based functionality from outside of Premiere, e.g., by using [AutoHotkey](https://autohotkey.com/). This is achieved with a server that is started inside of Premiere on your local machine. Any custom functionality can then be triggerd using a local http request.
Using the [Adobe Premiere Extension mechanism](/~https://github.com/Adobe-CEP), **PremiereRemote** provides a framework to trigger your own Premiere CEP-based functionality from outside of Premiere, e.g., by using [AutoHotkey](https://autohotkey.com/). This is achieved with a server that is started inside of Premiere on your local machine. Any custom functionality can then be triggerd using a local http request or using websockets.

Let's take a custom function like locking a video track inside of Premiere Pro. Unfortunately, there are no shortcuts available without modification. With CEP, you can define your own javascript function using extendscript:

Expand Down Expand Up @@ -69,7 +69,12 @@ This short guide will show how to install and use the **PremiereRemote** framewo

## Usage

Now, you are ready to call your own Premiere CEP functions, defined in the `host` variable of the `index.tsx`-file remotely. Test the endpoints in the browser of your choice, as shown above. For example, use Chrome and the url:
Now, you are ready to call your own Premiere CEP functions, defined in the `host` variable of the `index.tsx`-file remotely.
There are two ways to trigger PremiereRemote functionality from outside: Using HTTP requests or using WebSocket calls.

### HTTP Requests

Test the endpoints in the browser of your choice, as shown above. For example, use Chrome and the url:

```
http://localhost:8081/yourNewFunction?param1=Hello&param2=World
Expand All @@ -93,6 +98,22 @@ Additionally, it is possible to return values from inside of Premiere Pro, by re
{"message":"ok.","result":"5"}
```

### WebSocket

Since the release of `v2.1.0`, a WebSocket server was added to PremiereRemote.
This enables you to trigger CEP code with minimal delay, e.g., when integrating PremiereRemote with Controller Hardware like the Elgato Stream Deck +.
Any function that can be called via HTTP (see above) can also be called via WebSocket using port `8082` by default.
See this simple example:

```javascript
import WebSocket from 'ws';
const websocketAddress = 'ws://localhost:8082';
const ws = new WebSocket(websocketAddress);
ws.send(`yourNewFunction,Hello,World`);
```

This code snippet would connect to the WebSocket server and call a CEP function named `yourNewFunction` with the parameters `Hello` and `World`. Any number of parameters (including zero) are allowed.

## Development

Here is my workflow for easy development and debugging of your own [CEP](/~https://github.com/Adobe-CEP)-based functionality:
Expand Down

0 comments on commit 7043e8c

Please sign in to comment.