1
0
mirror of https://github.com/mifi/lossless-cut.git synced 2024-11-22 18:32:34 +01:00
lossless-cut/api.md
Mikael Finstad a3cbce6190
implement http api #980 #868
- add closeCurrentFile action
- allow export confirm also via action
- upgrade electron
2023-10-15 23:36:54 +08:00

49 lines
1.2 KiB
Markdown

# HTTP API
LosslessCut can be controlled via a HTTP API, if it is being run with the command line option `--http-api`. See also [CLI](./cli.md). **Note that the HTTP API is experimental and may change at any time.**
## Programmatically opening a file
This must be done with [the CLI](./cli.md).
## Enabling the API
```bash
LosslessCut --http-api
```
## API endpoints
### `POST /api/shortcuts/action`
Execute a keyboard shortcut `action`, similar to the `--keyboard-action` CLI option. This is different from the CLI in that most of the actions will wait for the action to finish before responding to the HTTP request (but not all).
#### [Available keyboard actions](./cli.md#available-keyboard-actions)
#### Example
Export the currently opened file:
```bash
curl -X POST http://localhost:8080/api/shortcuts/export
```
### Batch example
Start the main LosslessCut in one terminal with the HTTP API enabled:
```bash
LosslessCut --http-api
```
Then run the script in a different terminal:
```bash
for PROJECT in /path/to/folder/with/projects/*.llc
LosslessCut $PROJECT
sleep 5 # wait for the file to open
curl -X POST http://localhost:8080/api/shortcuts/export
curl -X POST http://localhost:8080/api/shortcuts/closeCurrentFile
done
```