Skip to content
This repository has been archived by the owner on Dec 15, 2020. It is now read-only.

Latest commit

 

History

History
73 lines (44 loc) · 7.22 KB

README.md

File metadata and controls

73 lines (44 loc) · 7.22 KB
Raw

OBS (macOS) Virtual Camera (ARCHIVED) 🎥

Build

ATTENTION: STARTING WITH OBS Studio 26.1, THIS PLUGIN IS NOW A PART OF THE OFFICIAL OBS PACKAGE 🎉. Development will now happen on the OBS Studio GitHub. Running this plugin along-side the built-in distribution does not work. If you can, update to OBS 26.1!

ATTENTION: Before updating to OBS Studio 26.1, make sure to remove this plugin using the uninstall instructions. While it worked for most, some users have reported problems when updating to OBS Studio 26.1 with the plugin installed. You will likely also need to restart any host software (e.g. Chrome, Zoom, etc) after installing OBS Studio 26.1 and starting the virtual camera before the new plugin will work.

Creates a virtual webcam device from the output of OBS Studio. Especially useful for streaming smooth, composited video into Zoom, Hangouts, Jitsi etc. Like CatxFish/obs-virtual-cam but for macOS.

Mar-28-2020 01-55-07

This code was spun out of this OBS Project RFC which was itself spun out of this issue from @tobi. The goal for this, being merged into the core OBS codebase, has been reached 🤞.

Donating 💸

Consider sending some money in the direction of the OBS Project via Open Collective, Patreon, or PayPal. Obviously, without OBS, this plugin would not be very useful! Hugh "Jim" Bailey is OBS Project's full-time lead developer and project maintainer. This money helps him continue to work on OBS!

If, after you donate to the OBS Project, you also want to send some cash my way that's appreciated too! Feel free to Buy Me a Coffee or PayPal me.

Buy Me A Coffee

Known Issues

  • Zoom prior to version 5.1.1 disabled virtual cameras by default. Please update to the latest (5.2.1 at time of writing) to re-enable virtual camera. Start the virtual camera before starting the Zoom application.
  • Slack, Webex, Skype and probably some other applications have disabled virtual cameras by default via application restrictions. Check out the wiki to see if your app is supported. Please edit the wiki if you try other software that we should include in that list. In most cases you can work around these restrictions by re-codesigning those applications.
  • Photo Booth and FaceTime do not support virtual cameras as of macOS 10.14 Mojave since they disallow loading any plugin that's not provided by Apple. Photo Booth can simply be duplicated and renamed (e.g. Photo Booth copy) and it will work. There is no known workaroud for FaceTime.
  • You may need to restart your computer after installing new versions of this plugin (not sure why 🤷‍♂️).

See also the open issues for other reported issues. In case you need help or think you found a bug, see this.

Installing

If you are using OBS Studio 26.1 or newer, the virtual camera is already part of OBS Studio. In that case, DO NOT install this plugin!

  • Download and install the latest version of OBS from the official website.
  • Download the latest .pkg installer on the Releases page
  • Run the .pkg installer (entering your password when required)
  • If you're already running OBS, make sure to restart it.
  • Restart any app that was running during the installation process that is supposed to pick up the camera.
  • To start the virtual camera, go (in OBS) to Tools→Start Virtual Camera.

Your OBS video should now show up in the target app!

Uninstalling

You can easily uninstall this plugin by deleting the OBS plugin (in /Library/Application\ Support/obs-studio/plugins/) and the DAL plugin (in /Library/CoreMediaIO/Plug-Ins/DAL/).

sudo rm -rf /Library/CoreMediaIO/Plug-Ins/DAL/obs-mac-virtualcam.plugin
sudo rm -rf /Library/Application\ Support/obs-studio/plugins/obs-mac-virtualcam

Discussion / Support

If you are using the version the virtual camera that comes shipped with OBS Studio 26.1, the official place for questions is the #macos-support channel in the OBS Studio Discord. If you are still using this plugin, the official place for discussion and chat is in the #plugins-and-tools channel in the OBS Studio Discord. For questions or troubleshooting, ping @gxalpha#3486 and attach the OBS log, screenshots, and/or crash logs (from Console.app).

Reporting Issues / Bugs / Improvements

🚀 Wonder How to contribute? Have look at our notes for contributors. There are ways non-technical or minimally-technical folks can contribute too!

This plugin is now archived. If you are having an issue there's a good chance someone has already run into the same thing. Please search through the issues before reporting a new one. If you are using the version the virtual camera that comes shipped with OBS Studio 26.1, also see the issues on the OBS Studio GitHub and create new issues there.

If you still believe you have found an unreported issue related to this plugin, please open an issue! When you do, include any relevant terminal log, Console.app log, crash log, screen recording and/or screenshots. The more information you can provide, the better!

Development

Please help me make this thing not janky! See the this wiki page for build instructions and tips & tricks for developing.

License

As the goal of this repo was to get merged into obsproject/obs-studio, the license for this code mirrors the GPLv2 license for that project.