Skip to content

Node-OBSosc App
Compare
Choose a tag to compare
@jshea2 jshea2 released this 27 Jan 11:22
· 69 commits to master since this release
v1.0.0
bfb11c2
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

Node-OBSoscsmall

Using Node-OBSosc

Requires: obs-websocket

Screen Shot 2021-01-26 at 7 59 05 AM

  • Configure the input fields
  • Successfully "Connect"
  • The window will open a "DevTools" window
    • Make sure it's on the "Console" tab, not "Elements"
  • In the "Console" tab it will log IP and Port info, the number of available scenes, and a list of all scenes with numbers (This is what you can use as an argument in your /scene OSC message)

Application OSC -> OBS

This can be used for any application that transmits and/or receives OSC.
(This was designed with Qlab in mind, so the examples show file of all the OSC commands is available below: "Qlab OSC Examples.qlab4" Note: Sending OSC Commands requires a paid version of Qlab)

OSC Command List:

- Triggering Scenes: -

/scene [index number] this message will activate a scene with the index associated from the logged list.
(Ex. "/scene 1" will activate the first scene in OBS, also floats will be rounded down (Ex. /scene 1.9 === /scene 1))

/scene/[scene_name] this message allows you to activate a scene by name in the OSC string. (Ex. "/scene/Wide" will activate a scene named "Wide" in OBS. NOTE: If a scene name contains a SPACE, replace with "_", so if OBS has a scene "Webcam 1" make OSC message "/scene/Webcam_1")

/scene [scene name] this message allows you to activate a scene by name in the OSC argument. (Ex. "/scene Wide" will activate a scene named "Wide" in OBS.) NOTE: SPACES will work ok for this format, so "/scene Webcam 1" is valid syntax

/go this message will go to the next scene in the list, if this is triggered on the last scene it will go to the first scene

/back this message will go to the previous scene in the list, if this is triggered on the first scene it will go to the last scene

- Change Transition Type and Duration: -

/transition [name] [duration] this message sets the desired transition and duration(in milliseconds).
(Ex. "/transition Cut" will change the current Scene Transition to "Cut". "/transition Fade 500" will set the current Scene Transition to "Fade" with a "500" millisecond duration. If you do not set a duration in the 2nd argument it will keep the current duration and log it in node.

- Change Source Visibility On/Off: -

/[scene_name]/[source_name]/visible [0 or 1] this message will turn on or off the source's visibility. (Ex. "/Webcam_1/Audio_Input_Capture/visible 0" will turn OFF "Audio Input Capture" source in OBS from scene "Webcam 1". Where as "/Webcam_1/Text_1/visible 1" will turn it ON). NOTE: If a scene name or source name contains a SPACE, replace with "_", so if OBS has a scene "Webcam 1" and a source name of "Text 1" make OSC message the example from above.)

- Change Filter Visibility On/Off: -

/[scene_name]/[source_name]/filterVisibility [0 or 1] this message will turn on or off the source's filter visibility. (Ex. "/Video_Input/Color_Correction/filterVisibiltity 0" will turn OFF "Color Correction" filter in OBS from source "Video Input". Where as "/Video_Input/Color_Correction/filterVisibility 1" will turn it ON). NOTE: If a filter name or source name contains a SPACE, replace with "_", so if OBS has a filter "Color Correction" and a source name of "Video Input" make OSC message the example from above.)

- Change Opacity: -

/[source_name]/[color_correction_filter_name]/opacity [0 thru 1] this message allows you to adjust the Opacity of a source via the "Color Correction" filter in OBS of the current scene. (Ex. "/Text_1/Color_Correction 0.5" will make "Text 1" half transparent. NOTE: If a source name or filter name contains a SPACE, replace with "_", so if OBS has a source "Text 1" and filter "Color Correction" make OSC message the example from above)

- Translate Source's Position: -

/[scene_name]/[source_name]/position [x] [y] this allows you to change the sources position by x and y values. This also changes the alignment to center the bounding box to the x and y values. (Ex. "/Webcam_1/Text_1/position 0 0" this changes the source to center of the screen. See "Qlab OSC Examples" file for how to automate positions. NOTE: This is only tested for a "Canvas Size" of 1920x1080 in OBS. Also, If a scene name or source name contains a SPACE, replace with "_", so if OBS has a scene "Webcam 1" and a source name of "Text 1" make OSC message the example from above.)

- Translate Source's Scale: -

/[scene_name]/[source_name]/scale [float] this allows you to change the source's scale. "0" is nothing, "1" is original full size. Negative numbers will invert the source. Numbers larger than "1" will be larger than original size. (Ex. /Webcam_1/Text_1/scale 2 this will make the size of the "Text 1" source twice as large. See "Qlab OSC Examples" file for how to automate scale. Also, If a scene name or source name contains a SPACE, replace with "_", so if OBS has a scene "Webcam 1" and a source name of "Text 1" make OSC message the example from above.)

- Translate Source's Rotation: -

/[scene_name]/[source_name]/rotate [float] this allows you to change the source's scale. "0" is nothing, "360" is full 360 rotation clockwise. Negative numbers will rotate counterclockwise. Numbers larger than "360" will be more roations. (Ex. /Webcam_1/Text_1/rotate 90 this will make the rotation of the "Text 1" source 90º clockwise. See "Qlab OSC Examples" file for how to automate rotation. Also, If a scene name or source name contains a SPACE, replace with "_", so if OBS has a scene "Webcam 1" and a source name of "Text 1" make OSC message the example from above.)

- Streaming and Recording: -

/startRecording this message will start recording in OBS

/stopRecording this message will stop recording in OBS

/toggleRecording this message will toggle the start/stop recording button in OBS

/startStreaming this message will start streaming in OBS

/stopStreaming this message will stop streaming in OBS

/toggleStreaming this message will toggle the start/stop streaming button in OBS

/pauseRecording this message will pause the recording in OBS

/resumeRecording this message will resume recording in OBS

- Studio Mode: -

/enableStudioMode this message enables Studio Mode in OBS (WARNING: This Command Has Caused Some Computers to Crash OBS)

/disableStudioMode this message disables Studio Mode in OBS

/toggleStudioMode this message toggles Studio Mode on/off in OBS (WARNING: This Command Has Caused Some Computers to Crash OBS)

OBS -> Application:

This allows OBS to send OSC to other applications when a scene is activated.

To use/enable this function, change the toggle button to ON
Configure the prefix and suffix for how you want your OSC application to receive an OSC string from OBS

(Ex. In OBS when "Wide" scene is activated, Qlab recieves an OSC message "/cue/Wide/start")

Support The Project

If Node-OBSosc helped you, consider helping the project by making a donation via PayPal

Join the Discord Community

chat on Discord
Assets 5
Loading