|
| 1 | +# Cap Desktop Deeplinks |
| 2 | + |
| 3 | +Cap Desktop registers the `cap-desktop://` URL scheme. |
| 4 | + |
| 5 | +## Recording controls |
| 6 | + |
| 7 | +### Start recording |
| 8 | + |
| 9 | +```bash |
| 10 | +open 'cap-desktop://record/start?mode=studio&capture_type=screen&target=Built-in%20Display&capture_system_audio=true&mic_label=External%20Microphone' |
| 11 | +``` |
| 12 | + |
| 13 | +Query params: |
| 14 | +- `mode`: `studio` or `instant` (default: `studio`) |
| 15 | +- `capture_type`: `screen` or `window` (required) |
| 16 | +- `target`: screen/window name exactly as shown in Cap (required) |
| 17 | +- `capture_system_audio`: `true` / `false` (optional) |
| 18 | +- `mic_label`: microphone label exactly as shown in Cap (optional) |
| 19 | +- omitting `mic_label`, `device_id`, `model_id`, and `off` keeps the current Cap inputs unchanged |
| 20 | +- camera: |
| 21 | + - `device_id=<id>` or `model_id=<VID:PID>` |
| 22 | + - `off=true` to disable camera |
| 23 | + |
| 24 | +### Stop / pause / resume / toggle / restart |
| 25 | + |
| 26 | +```bash |
| 27 | +open 'cap-desktop://record/stop' |
| 28 | +open 'cap-desktop://record/pause' |
| 29 | +open 'cap-desktop://record/resume' |
| 30 | +open 'cap-desktop://record/toggle-pause' |
| 31 | +open 'cap-desktop://record/restart' |
| 32 | +``` |
| 33 | + |
| 34 | +## Device switching |
| 35 | + |
| 36 | +### Switch microphone |
| 37 | + |
| 38 | +```bash |
| 39 | +open 'cap-desktop://device/microphone?label=External%20Microphone' |
| 40 | +``` |
| 41 | + |
| 42 | +To disable microphone input: |
| 43 | + |
| 44 | +```bash |
| 45 | +open 'cap-desktop://device/microphone?off=true' |
| 46 | +``` |
| 47 | + |
| 48 | +### Switch camera |
| 49 | + |
| 50 | +```bash |
| 51 | +open 'cap-desktop://device/camera?device_id=YOUR_DEVICE_ID' |
| 52 | +open 'cap-desktop://device/camera?model_id=VID:PID' |
| 53 | +open 'cap-desktop://device/camera?off=true' |
| 54 | +``` |
| 55 | + |
| 56 | +`off=true` cannot be combined with `device_id` or `model_id`. |
| 57 | + |
| 58 | +## Settings |
| 59 | + |
| 60 | +```bash |
| 61 | +open 'cap-desktop://settings/open?page=hotkeys' |
| 62 | +``` |
| 63 | + |
| 64 | +## Backward compatibility |
| 65 | + |
| 66 | +Legacy JSON payload links remain supported: |
| 67 | + |
| 68 | +```bash |
| 69 | +open 'cap-desktop://action?value={...json...}' |
| 70 | +``` |
0 commit comments