OSC for OBS v2.7.1
Setup and OSC Commands
v2.7.2 Bug Fix:
- (Mac Only) Fixes Error
"Cannot find 'node-key-sender' module"
when opening application
v2.7.1 New Features:
Open Applications, Files, and/or Websites with file or url path via OSC
/openExternal [string]
- ex.
/openExternal "https://google.com"
- opens google in default browser
- ex. Mac
/openExternal "file:/System/Applications/Stocks.app"
- ex. PC
/openExternal "file://c:/windows/system32/calc.exe"
- opens 'Calculator' app
- ex. Mac
/openExternal "file:/Users/joeshea/Documents/texttest1.png"
- opens 'texttest1.png' in default viewer (like Preview)
- ex.
Simulate Keypress on Front/Active Window via OSC
Java Run Time is required for this feature
/keypress [string]
- this command simulates a keypress on front window. Use this syntax for keys
- ex.
/keypress "space"
- this simulates a space keypress on the active window
- ex. `/keypress "h,i"
- this simulates a
h
and then ani
key press to active window - ex.
keypress "control,s"
- ex. this simulates a keycombo of
Control + S
to active window
- Note: This feature can send multiple keypresses by using a comma
,
, but using combinations of shift, control, and alt have been buggy. Please refer to this repository for issues
v2.7 New Features:
OSC for OBS now automatically reconnects if OBS closes and reopens!
- New colored indicator UI when connected and disconnected from OBS
VirtualCam
/startVirtualCam
/stopVirtualCam
/toggleVirtualCam
/setVirtualCam [0 or 1]
Streaming
/setStreaming [0 or 1]
Recording
/setRecording [0 or 1
]
Studio Mode
/setStudioMode [0 or 1]
Set Recording File Name
/recFileName [string]
Set Active Scene Item Visibility by Index
/[index(int)]/activeSceneItemVisibility [0 or 1]
Set Specific Scene Item Visibility by Index
/[scene name]/[index]/activeSceneItemVisibility [0 or 1]
Get Source Text FreeType2 String Repeatedly
/[text source]/getTextFreetype [1]
- Returns to OSC client:
/[text source]text [string]
- Returns to OSC client:
Get Source Text GDI String Repeatedly
/[text source]/getTextGDI [1]
- Returns to OSC client:
-/[text source]text [string]
- Returns to OSC client:
- NOTE: Disabling the loop is not yet implemented. Quit and reopen app to stop
- The loop is every 500ms (half second)
NDI and Other Outputs
List Outputs Names
/listOutputs
- Logs a list of all outputs
Start Output
/startOutput [name]
- Ex.
/startOutput “NDI Main Output”
- This will enable this output
- Ex.
Stop Output
/stopOutput [name]
- Ex.
/stopOutput “NDI Main Output”
- This will disable this output
- Ex.
Take Screenshot
/takeScreenshot
- This saves a .png of your current active scene and saves it to your Documents folder
Other Changes
- Stream status for recording an OSC message is now:
- /recording [ 0 or 1]