Skip to content

Docs: fix 404 links, document LOM-unsupported tools; rename $Host #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Ziforge merged 1 commit into from
Sep 9, 2026
Merged

Docs: fix 404 links, document LOM-unsupported tools; rename $Host #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ This implementation provides **220 tools across 44 categories** based on:
| **Display Values** | 2 | Get parameter values as shown in UI |
| **Additional Properties** | 10 | Clip start time, track/scene states, signatures |

**Total: 220 Tools**
**Total: ~220 Tools** (a handful are GUI-only in Live and return an honest "not exposed by the Live Object Model" error — see [Not supported by the Live API](#not-supported-by-the-live-api)).

## Quick Start

Expand Down Expand Up @@ -170,8 +170,19 @@ send_command('launch_clip', track_index=track_index, scene_index=0)
## Documentation

- **[Installation Guide](docs/INSTALLATION.md)** - Detailed installation instructions
- **[API Reference](docs/API_REFERENCE.md)** - Complete list of all 220 tools
- **[Troubleshooting](docs/TROUBLESHOOTING.md)** - Common issues and solutions
- **[Architecture](docs/ARCHITECTURE.md)** - How the socket server / queue works
- **[Windows install notes](docs/install-notes-windows.md)** and **[smoke-test runbook](docs/smoke-test-runbook.md)** - Windows deploy + validation
- The live, authoritative tool list is always available via the `get_available_tools` action.

### Not supported by the Live API

A few advertised actions reference Live Object Model members that don't exist in
current Live (verified on 12.4), so they return an honest
`{"ok": false, "error": "... not exposed by the Live Object Model"}` rather than
silently doing nothing: track **grouping / ungroup**, track **freeze / flatten**,
**track delay**, **track & clip annotations**, **clip follow-actions**, track
**groove amount**, **take-lane delete**, and **metronome volume**. These are
GUI-only in Live. (See issue #3.)

## Examples

Expand Down
4 changes: 2 additions & 2 deletions scripts/windows/run_smoke_test.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
param(
[string]$RepoRoot = (Resolve-Path (Join-Path $PSScriptRoot "..\..")).Path,
[string]$Host = "127.0.0.1",
[string]$TargetHost = "127.0.0.1",
[int]$Port = 9004,
[string]$PythonLauncher = "py",
[string]$LogFile = ""
Expand Down Expand Up @@ -30,7 +30,7 @@ Get-NetTCPConnection -LocalPort $Port -ErrorAction SilentlyContinue |

Write-Host ""
Write-Host "Running smoke test client..."
& $PythonLauncher -3 $clientPath --host $Host --port $Port --log-file $LogFile
& $PythonLauncher -3 $clientPath --host $TargetHost --port $Port --log-file $LogFile

Write-Host ""
Write-Host "Raw request/response capture saved to $LogFile"
Loading