4d10db4f17
PHP 8.4 library and CLI tools to read, modify, and generate ProPresenter 7 files: songs (.pro), playlists (.proplaylist), bundles (.probundle), themes, and the global library files (Macros, Labels, Groups, ClearGroups, CCLI, Messages, Timers, Stage, Workspace, Props, TestPatterns, Calendar, KeyMappings, CommunicationDevices). Built on the MIT-licensed ProPresenter7-Proto schema by greyshirtguy (v7.16.2). Includes 18 CLI parsers, comprehensive API docs in doc/, binary-format specs, and a synthetic 369-test PHPUnit suite covering RTF extraction, translation slides, ZIP64 repair, round-trip fidelity, and end-to-end generation.
84 lines
1.8 KiB
Markdown
84 lines
1.8 KiB
Markdown
# Workspace Library API
|
|
|
|
> PHP module for reading, modifying, and writing the ProPresenter `Workspace` file.
|
|
|
|
## Quick Reference
|
|
|
|
```php
|
|
use ProPresenter\Parser\WorkspaceFileReader;
|
|
use ProPresenter\Parser\WorkspaceFileWriter;
|
|
|
|
$library = WorkspaceFileReader::read('/path/to/Workspace');
|
|
|
|
foreach ($library->getScreens() as $screen) {
|
|
$screen->getName();
|
|
$screen->getUuid();
|
|
$screen->getScreenType();
|
|
}
|
|
|
|
WorkspaceFileWriter::write($library, '/path/to/Workspace');
|
|
```
|
|
|
|
---
|
|
|
|
## File Layout
|
|
|
|
The `Workspace` file is `Rv\Data\ProPresenterWorkspace` from `proworkspace.proto`.
|
|
Its `pro_screens` entries are `Rv\Data\ProPresenterScreen` messages from
|
|
`proscreen.proto`.
|
|
|
|
---
|
|
|
|
## WorkspaceLibrary
|
|
|
|
```php
|
|
$library->getDocument();
|
|
$library->getScreens();
|
|
$library->getScreenByName('StageDisplay');
|
|
$library->getScreenByUuid('C86D...'); // case-insensitive
|
|
$library->addScreen($screen);
|
|
$library->removeScreen($uuid);
|
|
$library->count();
|
|
$library->getAudienceLooks();
|
|
$library->getMasks();
|
|
$library->getVideoInputs();
|
|
$library->getSelectedLibraryName();
|
|
$library->setSelectedLibraryName('Library');
|
|
```
|
|
|
|
---
|
|
|
|
## Screen
|
|
|
|
```php
|
|
$screen->getName();
|
|
$screen->setName('New name');
|
|
$screen->getUuid();
|
|
$screen->setUuid('...');
|
|
$screen->getScreenType();
|
|
$screen->getIndex();
|
|
$screen->getProto();
|
|
```
|
|
|
|
Use `getProto()` for detailed arrangement, background, and screen geometry data.
|
|
|
|
---
|
|
|
|
## CLI Tool
|
|
|
|
```bash
|
|
php bin/parse-workspace.php /path/to/Workspace
|
|
```
|
|
|
|
---
|
|
|
|
## Key Files
|
|
|
|
| File | Purpose |
|
|
|------|---------|
|
|
| `src/WorkspaceFileReader.php` | Reads the `Workspace` file |
|
|
| `src/WorkspaceFileWriter.php` | Writes the `Workspace` file |
|
|
| `src/WorkspaceLibrary.php` | Document wrapper and indexes |
|
|
| `src/Screen.php` | Single screen wrapper |
|
|
| `bin/parse-workspace.php` | CLI summary tool |
|