-
Notifications
You must be signed in to change notification settings - Fork 0
Actions Reference
Choose an action in the Button Editor, fill in its fields, then use Test Action before relying on the physical pad.
| Action | Use it for |
|---|---|
| No Action | Leave a pad intentionally empty |
| Switch Page | Move to another page in the current profile |
| Open URL | Open a website normally or in a private window |
| Open Path/App | Open a local file, folder, or application |
| Run Command | Start a Windows command |
| PowerShell Command | Run PowerShell without loading a user profile |
| Hotkey | Send a keyboard combination |
| Type Text | Type configured text into the focused application |
| Media Control | Play, pause, skip, stop, or change media volume |
| Volume Control | Change the default Windows playback endpoint |
| HTTP Request | Call a local service, webhook, or web API |
| Play Sound | Play a local soundboard file |
| Stop Sound | Stop one button, one page, or all sounds |
| Delay | Pause inside a multi-action sequence |
| Multi-Action | Run multiple actions in order |
| SSH Command | Run a remote command with key-based authentication |
| OBS WebSocket | Control OBS directly |
Does nothing and returns a successful result. Use it for blank or decorative pads.
Field: Page ID
Switches to another page in the active profile and refreshes the on-screen grid and Launchpad lighting. The ID must match the destination page ID, not only its display name.
Use one or more grid pads as page navigation because Launchpad side buttons are not mapped to OpenLaunchDeck pages by default.
Fields: URL, Open In Private Window
Opens an HTTP or HTTPS address. Plain website addresses receive https:// automatically. Other URL schemes are rejected.
Private-window mode supports the registered Windows default browser when it is Brave, Chrome, Chromium, Vivaldi, Edge, or Firefox. If the browser cannot be identified, the action fails instead of quietly opening a normal window.
Field: Path
Opens an existing file, folder, or executable with Windows. Environment variables such as %USERPROFILE% are supported.
The action fails clearly when the path does not exist.
Fields: Command, Working Directory, Run Hidden, Wait For Completion
Runs a local command through the Windows shell.
- Leave Wait For Completion off for long-running programs or scripts.
- Turn it on when a later multi-action step depends on the command finishing.
- Run Hidden avoids opening a console window when Windows supports it.
- Mark destructive or system-changing commands as Dangerous in the button settings.
Waited commands have a bounded execution time and return captured output. Non-waited commands return after the process starts.
Uses the same fields as Run Command. The command is passed to powershell.exe with -NoProfile and -NonInteractive.
Mark commands that stop services, change files, restart systems, or remove data as Dangerous.
Controls: Ctrl, Alt, Shift, Win, Key
Select any needed modifiers, then choose the main key from the searchable drop-down. The list includes letters, numbers, navigation and editing keys, punctuation, media keys, and F1 through F24. Typing into the key list filters it; you do not need to type the complete shortcut syntax.
Examples of the resulting shortcuts:
ctrl+c
win+shift+s
shift+left
ctrl+alt+k
f15
Some elevated applications and games reject input from a non-elevated app. Run both applications at the same privilege level when that happens.
Fields: Text, Interval
Types text into the currently focused application. Interval controls the pause between characters; use 0 for normal fast entry.
This action sends text wherever keyboard focus currently is. Do not assign secrets or destructive console commands to unattended buttons.
Field: Control
Available controls:
play_pausenextpreviousstopvolume_upvolume_downmute
On Windows, the action uses an application media command first and a keyboard media-key fallback second. The active browser or media application still decides whether it accepts the command.
Fields: Mode, Target Volume
Available modes:
volume_upvolume_downset_volumemuteunmutetoggle_mute
This controls the default Windows playback endpoint. It does not replace per-application mixer sliders. Target Volume is only used by set_volume.
Fields: Method, URL, Headers JSON, Body, Timeout
Supported methods are GET, POST, PUT, PATCH, and DELETE.
Headers must be a JSON object:
{
"Content-Type": "application/json"
}Timeout must be between 1 and 60 seconds. HTTP status codes 400 and higher return a failed action result.
Do not put private API keys or webhook credentials into profiles you plan to export or share.
Fields: Sound File, Volume, Route To Voice Chat, Loop, Already Playing, Active Color, Stop On Page Change
Supported baseline formats are .wav and .mp3. .ogg depends on the codecs available to QtMultimedia on the computer.
Already Playing choices:
-
restartrestarts the current button sound. -
overlapstarts another copy. -
ignorekeeps the existing copy playing. -
toggle_stopstops the sound on the next press.
See Soundboard and Voice Chat for output routing and quality setup.
Fields: Scope, Fade Out
Scopes:
-
this_buttonstops sounds associated with the pressed button. -
current_pagestops sounds started from the active page. -
allstops every sound.
Keep a Stop All Sounds button near loops and overlap-enabled clips.
Field: Milliseconds
Waits from 0 through 60,000 milliseconds. Delay is primarily intended for Multi-Action sequences and runs away from the GUI thread.
Fields: Steps, Continue On Error
Runs action objects in order. Example:
[
{
"type": "hotkey",
"config": {
"hotkey": "ctrl+shift+s"
}
},
{
"type": "delay",
"config": {
"milliseconds": 500
}
},
{
"type": "play_sound",
"config": {
"file_path": "C:\\Sounds\\done.wav",
"volume": 60
}
}
]When Continue On Error is off, the sequence stops at the first failed step. Nested multi-actions are limited to prevent runaway recursion.
Fields: Host, Port, Username, Private Key, Command
Uses Paramiko and key-based authentication. The action loads known host keys and rejects unknown hosts instead of automatically trusting them.
Passwords are not stored by this action. Test SSH access from a terminal first, and never bundle a private key with an exported profile.
Common fields: Operation, Host, Port, Password, Timeout Ms
Default connection:
Host: 127.0.0.1
Port: 4455
Available operations:
| Operation | Additional fields |
|---|---|
save_replay_buffer |
Start Replay Buffer If Needed, Replay Verify Timeout Ms |
start_replay_buffer |
None |
stop_replay_buffer |
None |
save_screenshot |
Screenshot Source, Screenshot Folder, Screenshot Format |
start_recording |
None |
stop_recording |
None |
start_streaming |
None; always mark the button Dangerous |
stop_streaming |
None |
switch_scene |
Scene Name |
show_source |
Scene Name, Source Name |
hide_source |
Scene Name, Source Name |
toggle_source |
Scene Name, Source Name |
mute_input |
Input Name |
unmute_input |
Input Name |
toggle_input_mute |
Input Name |
Scene, source, and input names must match OBS exactly. See OBS WebSocket Setup for complete setup and testing.
Dangerous is a button setting, not a separate action.
- First press arms the button for five seconds.
- The GUI and Launchpad show a warning state.
- A second press inside the window executes the action.
- Timeout, page change, or device disconnect cancels the armed state.
Use it for start streaming, stop/restart server commands, shutdown operations, destructive scripts, and anything expensive to trigger accidentally.
Start
Build Your Deck
Streaming And Audio
Help And Reference