MCPcopy Index your code
hub / github.com/bitfocus/companion-module-obs-studio

github.com/bitfocus/companion-module-obs-studio @v3.15.3

Chat with this repo
repository ↗ · DeepWiki ↗ · release v3.15.3 ↗ · + Follow
65 symbols 188 edges 8 files 0 documented · 0% updated 2d agov3.15.3 · 2026-01-12★ 5223 open issues
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

companion-module-obs-studio

This module will allow you to control OBS Studio using the built-in WebSocket Server.

Getting Started

See HELP.md

Changelog

v3.15.3

  • Fix
  • Set Source Visibility action not working when a source is in a group

v3.15.2

  • Fix
  • Recording timecode variables not updating properly

v3.15.1

  • Fix
  • Possible timeouts when using a scene collection that creates a large number of variables
  • Set Source Visibility action and feedback not working when a source is in multiple scenes

v3.15.0

  • New
  • Add WHIP options to Set Stream Settings action

v3.14.0

  • New
  • Action: Set Text Properties
  • Aciton: Adjust Transition Type
  • Action: Update Media Source Local File Path
  • Action: Reset Video Capture Device (Deactivates and Reactivates a souece to reset it, helpful for resolving issues with capture devices on Windows )
  • Variable: transition_list (List of available transition types)

v3.13.2

  • Fix
  • Fixed vendor events not handling

v3.13.1

  • Fix
  • Set Source Text action not handling newline character

v3.13.0

  • New
  • Action: Adjust Audio Sync Offset
  • Action: Adjust Audio Balance

v3.12.0

  • New
  • Added separate hours, minutes, and seconds variants to recording_timecode and stream_timecode variables
  • Ability to use Custom File Name in Take Screenshot action
  • Ability to use variables for Custom File Path in Take Screenshot action
  • Fix
  • Scene filters not appearing in filters dropdown

v3.11.0

  • New
  • Fade Source Volume action, allows fading a source's volume to a specific value over a specific duration
  • Ability to set a threshold in the Audio Meter feedback, so that sources with no signal or a high noise floor do not always show the green color feedback
  • All actions now support sequential execution (requires Companion 3.5)
  • Fix
  • Current Media variables showing info from media that is playing, but not in program
  • Current Media variables disappearing when media is paused, but still in program
  • Previous Scene feedback and scene_previous variable showing incorrect scene after disconnecting and reconnecting to OBS
  • Quick Transition not working after being used once in some instances

v3.10.1

  • Fix
  • Allow hyphens in source variable names

v3.10.0

  • New
  • Ability to use variables in Set Filter Settings action
  • Ability to use variables in Set Stream Settings action

v3.9.1

  • Fix
  • Adding new text sources would not populate in action dropdowns if Companion was already open
  • Text and Media sources would occasionally be duplicated in the dropdown list
  • Invalid preset steps would cause issues with Bitfocus Buttons

v3.9.0

  • New
  • Added custom_command_response variable, which will show a JSON string of the response data from obs-websocket when using the Custom Command action so the data can be used in Companion
  • Added custom_command_type and custom_command_request variables which show the last Custom Command sent from Companion to obs-websocket to help with data parsing
  • Added custom vendor_event_name, vendor_event_type, and vendor_event_data variables to allow data processing from custom Vendor Event messages

v3.8.0

  • New
  • Allow custom variables or strings to be used in Trigger Hotkey by ID action, and Scene in Preview / Program feedbacks

v3.7.1

  • Fix
  • Certain text sources (gdiplus_v3) not populating in action dropdowns or variables

v3.7.0

  • New
  • Added Previous Scene Active feedback
  • Added scene_previous variable
  • Added Adjust Transition Duration action
  • Allow custom variable in Set Transition Duration action

v3.6.0

  • New
  • Added Split Record action (requires OBS 30.2)
  • Added Record Chapter action (requires OBS 30.2)
  • Fix
  • Ensure feedbacks that use custom variables are re-checked if the variable changes
  • Properly throw error if unable to get initial info from obs-websocket

v3.5.0

  • New
  • Added transition_active variable
  • Set Filter Settings action
  • Improved
  • Allow customization of Stream Congestion feedback colors, including a color for when streaming is not active
  • Allow custom variables in additional actions and feedbacks
  • Fix
  • Grouped text sources not appearing in dropdown of text sources

v3.4.3

  • Fix
  • Module not reconnecting when OBS was reopened under specific situations on Windows

v3.4.2

  • Fix
  • "Set Source Transform" action not working
  • Error when updating input settings variables

v3.4.1

  • Fix
  • Performance improvements for Scene Collections with a large number of sources
  • More accurately update action/feedback dropdowns when scenes/sources are removed
  • Properly update scene_preview variable and Scene in Preview feedback when switching into Studio Mode
  • Properly update scene_preview and scene_active variables when switching Scene Collections

v3.4.0

  • New
  • Disk Space Remaining feedback to alert when available disk space is below specified threshold
  • free_disk_space_mb variable that returns a raw number value (no units) of MB free on disk, for use in expressions
  • Improved
  • Rename 'Set Source Filter Visibility' to 'Set Filter Visibility' since it can also be used for scenes
  • Use newly available InputSettingsChanged event (requires OBS v30.1) to more accurately update changes to current_text, image_file_name, and media_file_name variables

v3.3.0

  • New
  • Preview next/previous scene actions
  • Adjust source volume by percentage action
  • VendorEvent feedback
  • Improved
  • Control all filters on a source with the "Set Source Filter Visibility" action
  • Fix
  • More reliable behavior when controlling Source Visibility for all sources

v3.2.0

  • New
  • New Custom Vendor Request action for sending commands to third party plugins
  • Fix
  • Custom Command failing to run
  • Crash when the file name for an image source was invalid

v3.1.1

  • Fix
  • Upgrade script error crashing module
  • Additional fixes for Quick Transition causing transition state to get stuck

v3.1.0

  • New
  • Feedback for Studio Mode Enabled
  • Feedback for stream congestion (similar to the green/yellow/red square in the OBS UI)
  • Feedback for audio meters (similar to the audio meters in the OBS UI)
  • Feedback for audio peaking if above a certain value
  • Fix
  • Quick Transition actions causing transition state to get stuck
  • Kbps variable has been restored
  • Certain variable updates (mute, media_status, and others) were not working when the source has an invalid variable name

v3.0.1

  • Fix
  • Set Preview Scene action now properly sends scene to preview instead of program
  • Possible error when executing upgrade scripts resolved

v3.0.0

  • New
  • Rewrite to support Companion v3
  • Variables for scene names based on the scene order within OBS
  • Fix
  • Filter Enabled feedback now properly lists all filters

v2.0.5

  • Improved
  • Allow hostnames to be used in the module configuration
  • Fix
  • All text source now appear as choices in the Set Text action dropdown on startup

v2.0.4

  • Improved
  • Update obs-websocket-js to latest version
  • Use obs-websocket's Batch command for certain actions
  • Fix
  • When using Set Scene Visibility on a group source, the sources within groups are now not affected
  • Toggle/Start/Stop Output now works properly with Virtual Camera

v2.0.3

  • Fix
  • Properly detect more types of disconnections and properly update module status
  • Grouped sources can now be enabled / disabled via "Set Source Visibility" action
  • Grouped sources feedback is now accurate

v2.0.2

  • New
  • Allow Global Audio Devices to be choices for actions, feedback, and variables
  • Fix
  • Show Scenes in the Open Projector action choices

v2.0.1

  • Fixes
  • Prevent issue when using more than one instance of the OBS module
  • Add filters from scenes, not just sources

v2.0.0

  • New
  • Support for obs-websocket version 5.0.0
  • New "Current Media" option on all media control actions
  • Custom variables for "Set Program Scene", "Set Preview Scene", and "Custom Command" actions
  • Ability to specify a specific scene for a source in the the "Source Visible in Program" feedback

  • New Actions:

    • Toggle Recording Pause
    • Open Source Properties Window
    • Open Source Filters Window
    • Open Source Interact Window
  • New Feedback:
    • Replay Buffer Active
  • New Variables:

    • recording_path
    • stream_service
    • base_resolution
    • output_resolution
    • target_framerate
    • replay_buffer_path
  • Fixes

  • Take Screenshot action now works again
  • Recording feedback should properly reflect recording state

Core symbols most depended-on inside this repo

Shape

Method 58
Function 5
Class 2

Languages

TypeScript100%

Modules by API surface

index.js60 symbols
variables.js2 symbols
presets.js1 symbols
feedbacks.js1 symbols
actions.js1 symbols

For agents

$ claude mcp add companion-module-obs-studio \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page