OBS Studio - Revision history

Hey: added disclaimer for missing hardware acceleration options

2025-06-14T07:04:17Z

added disclaimer for missing hardware acceleration options

← Older revision		Revision as of 07:04, 14 June 2025
Line 34:		Line 34:
	or by wrapping the package with <code>wrapOBS</code>:		or by wrapping the package with <code>wrapOBS</code>:

	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">environment.systemPackages = [
	environment.systemPackages = [
	(pkgs.wrapOBS {		(pkgs.wrapOBS {
	plugins = with pkgs.obs-studio-plugins; [		plugins = with pkgs.obs-studio-plugins; [
Line 46:		Line 45:
	];		];
	})		})
	];		];</syntaxhighlight>'''Package collision''': Including both <code>obs-studio</code> and <code>(pkgs.wrapOBS {...</code> in <code>environment.systemPackages</code> will result in a package collision; if plugins are needed, only include the "wrapped" version, which sets the plugins directory to include Nix-managed plugins (see [https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/video/obs-studio/wrapper.nix pkgs/applications/video/obs-studio/wrapper.nix].
	</syntaxhighlight>

	~~Including both <code>obs-studio</code> and <code>(pkgs.wrapOBS {...</code> in <code>environment.systemPackages</code> will result in a package collision; if plugins are needed, only include the~~ "~~wrapped~~" ~~version, which sets the plugins directory~~ to ~~include Nix-managed plugins (~~see ~~[https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/video/obs-studio/wrapper.nix pkgs/applications/video/obs-studio/wrapper.nix]~~.		'''Missing hardware acceleration''': Sometimes you need to set "Output Mode" to Advanced in settings Output tab to see the hardware accelerated Video Encoders options.

	=== Using the Virtual Camera ===		=== Using the Virtual Camera ===

Hey: added nvidia and amd hardware accelerated

2025-06-14T06:17:10Z

added nvidia and amd hardware accelerated

← Older revision		Revision as of 06:17, 14 June 2025
Line 12:		Line 12:
	programs.obs-studio = {		programs.obs-studio = {
	enable = true;		enable = true;

			# optional Nvidia hardware acceleration
			package = (
			pkgs.obs-studio.override {
			cudaSupport = true;
			}
			);

	plugins = with pkgs.obs-studio-plugins; [		plugins = with pkgs.obs-studio-plugins; [
	wlrobs		wlrobs
	obs-backgroundremoval		obs-backgroundremoval
	obs-pipewire-audio-capture		obs-pipewire-audio-capture
			obs-vaapi #optional AMD hardware acceleration
			obs-gstreamer
			obs-vkcapture
	];		];
	};		};
Line 30:		Line 41:
	obs-backgroundremoval		obs-backgroundremoval
	obs-pipewire-audio-capture		obs-pipewire-audio-capture
			obs-vaapi #optional AMD hardware acceleration
			obs-gstreamer
			obs-vkcapture
	];		];
	})		})

NullCube: Added information about the OBS module added to NixOS in 24.11.

2025-02-26T07:41:05Z

Added information about the OBS module added to NixOS in 24.11.

← Older revision		Revision as of 07:41, 26 February 2025
Line 5:		Line 5:
	Plugins are available from the <code>obs-studio-plugins</code> package set.		Plugins are available from the <code>obs-studio-plugins</code> package set.

	They can be installed by either ~~wrapping~~ the ~~package with <code>wrapOBS</code>~~:		They can be installed by using either the [[NixOS]] or [[Home Manager]] module:

	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
	~~environment~~.~~systemPackages = [~~		{ config, pkgs, ... }:
	~~(pkgs~~.~~wrapOBS~~ {		{
			programs.obs-studio = {
			enable = true;
	plugins = with pkgs.obs-studio-plugins; [		plugins = with pkgs.obs-studio-plugins; [
	wlrobs		wlrobs
Line 15:		Line 17:
	obs-pipewire-audio-capture		obs-pipewire-audio-capture
	];		];
	})		};
	];		}
	</syntaxhighlight>		</syntaxhighlight>

	or ~~using [[Home Manager]]~~:		or by wrapping the package with <code>wrapOBS</code>:

	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
	~~{ config, pkgs,~~ .~~.. }:~~		environment.systemPackages = [
	{		(pkgs.wrapOBS {
	~~programs~~.~~obs-studio =~~ {
	~~enable = true;~~
	plugins = with pkgs.obs-studio-plugins; [		plugins = with pkgs.obs-studio-plugins; [
	wlrobs		wlrobs
Line 31:		Line 31:
	obs-pipewire-audio-capture		obs-pipewire-audio-capture
	];		];
	};		})
	}		];
	</syntaxhighlight>		</syntaxhighlight>

Line 39:		Line 39:
	=== Using the Virtual Camera ===		=== Using the Virtual Camera ===

	The virtual camera requires the <code>v4l2loopback</code> [[Linux kernel#Custom kernel modules\|kernel module]] to be installed, a loopback device configured, and polkit enabled so OBS can access the virtual device:		The virtual camera requires the <code>v4l2loopback</code> [[Linux kernel#Custom kernel modules\|kernel module]] to be installed, a loopback device configured, and polkit enabled so OBS can access the virtual device.

	<syntaxhighlight lang="nix">		This can be done in NixOS with:<syntaxhighlight lang="nixos">
			programs.obs-studio.enableVirtualCamera = true;
			</syntaxhighlight>Or by setting the kernel options manually, this is useful if you need to add an additional loopback device as shown below:<syntaxhighlight lang="nix">
	{ config, ... }:		{ config, ... }:
	{		{

RichardJActon: /* Using the Virtual Camera */ Adding a note on how to modify your v4l2loopback module config to have additional virtual devices such as you might use to use a DSLR as a webcam with gphoto2

2024-07-05T10:54:58Z

Using the Virtual Camera: Adding a note on how to modify your v4l2loopback module config to have additional virtual devices such as you might use to use a DSLR as a webcam with gphoto2

← Older revision		Revision as of 10:54, 5 July 2024
Line 57:		Line 57:
	It is possible to use [[Droidcam]] as virtual camera.		It is possible to use [[Droidcam]] as virtual camera.

			If you use a digital camera as a webcam via [http://gphoto.org/ gphoto2] you will need an additional loopback device to use this camera as a virtual camera. For a setup like this you may wish to change the above v4l2loopback module config to something like this:<syntaxhighlight lang="nix">
			boot.extraModprobeConfig = ''
			options v4l2loopback devices=2 video_nr=1,2 card_label="OBS Cam, Virt Cam" exclusive_caps=1
			'';
			</syntaxhighlight>For more the [https://wiki.archlinux.org/title/V4l2loopback#Loading_the_kernel_module arch wiki entry on v4l2loopback] is a good reference.

			In addition to <code>gphoto2</code> you will need the <code>v4l-utils</code> and <code>ffmpeg</code> packages so that you can use gphoto2 to send the raw feed from your camera to the virtual camera via ffmpeg for example using a command like this<ref>https://austingil.com/dslr-webcam-linux/</ref>:<syntaxhighlight lang="bash">
			gphoto2 --stdout autofocusdrive=1 --capture-movie \| ffmpeg -i - -vcodec rawvideo -pix_fmt yuv420p -threads 0 -f v4l2 /dev/video2
			</syntaxhighlight>
	[[Category:Applications]]		[[Category:Applications]]

RichardJActon: add missing line loading the v4l2loopback kernel module without which is does not work.

2024-07-05T10:24:03Z

add missing line loading the v4l2loopback kernel module without which is does not work.

← Older revision		Revision as of 10:24, 5 July 2024
Line 47:		Line 47:
	v4l2loopback		v4l2loopback
	];		];
			boot.kernelModules = [ "v4l2loopback" ];
	boot.extraModprobeConfig = ''		boot.extraModprobeConfig = ''
	options v4l2loopback devices=1 video_nr=1 card_label="OBS Cam" exclusive_caps=1		options v4l2loopback devices=1 video_nr=1 card_label="OBS Cam" exclusive_caps=1

Klinger: link to Droidcamera wiki article added

2024-06-18T18:01:42Z

link to Droidcamera wiki article added

← Older revision		Revision as of 18:01, 18 June 2024
Line 53:		Line 53:
	}		}
	</syntaxhighlight>		</syntaxhighlight>

			It is possible to use [[Droidcam]] as virtual camera.

	[[Category:Applications]]		[[Category:Applications]]

imported>Aaronchall: add in a few more requirements I'm aware of

2023-10-23T05:34:10Z

add in a few more requirements I'm aware of

← Older revision		Revision as of 05:34, 23 October 2023
Line 12:		Line 12:
	plugins = with pkgs.obs-studio-plugins; [		plugins = with pkgs.obs-studio-plugins; [
	wlrobs		wlrobs
			obs-backgroundremoval
			obs-pipewire-audio-capture
	];		];
	})		})
Line 26:		Line 28:
	plugins = with pkgs.obs-studio-plugins; [		plugins = with pkgs.obs-studio-plugins; [
	wlrobs		wlrobs
			obs-backgroundremoval
			obs-pipewire-audio-capture
	];		];
	};		};
Line 35:		Line 39:
	=== Using the Virtual Camera ===		=== Using the Virtual Camera ===

	The virtual camera requires the <code>v4l2loopback</code> [[Linux kernel#Custom kernel modules\|kernel module]] to be installed, ~~like~~ so:		The virtual camera requires the <code>v4l2loopback</code> [[Linux kernel#Custom kernel modules\|kernel module]] to be installed, a loopback device configured, and polkit enabled so OBS can access the virtual device:

	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
Line 43:		Line 47:
	v4l2loopback		v4l2loopback
	];		];
			boot.extraModprobeConfig = ''
			options v4l2loopback devices=1 video_nr=1 card_label="OBS Cam" exclusive_caps=1
			'';
			security.polkit.enable = true;
	}		}
	</syntaxhighlight>		</syntaxhighlight>

	[[Category:Applications]]		[[Category:Applications]]

imported>Steadygaze: Add note about package collision gotcha

2023-10-08T19:14:45Z

Add note about package collision gotcha

← Older revision		Revision as of 19:14, 8 October 2023
Line 30:		Line 30:
	}		}
	</syntaxhighlight>		</syntaxhighlight>

			Including both <code>obs-studio</code> and <code>(pkgs.wrapOBS {...</code> in <code>environment.systemPackages</code> will result in a package collision; if plugins are needed, only include the "wrapped" version, which sets the plugins directory to include Nix-managed plugins (see [https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/video/obs-studio/wrapper.nix pkgs/applications/video/obs-studio/wrapper.nix].

	=== Using the Virtual Camera ===		=== Using the Virtual Camera ===

imported>Flexiondotorg: Correct syntax error

2023-07-06T08:32:08Z

Correct syntax error

← Older revision		Revision as of 08:32, 6 July 2023
Line 13:		Line 13:
	wlrobs		wlrobs
	];		];
	});		})
	];		];
	</syntaxhighlight>		</syntaxhighlight>

imported>Anoadragon453: Provide a clearer example for how to install obs-studio plugins without home-manager

2022-11-28T00:16:58Z

Provide a clearer example for how to install obs-studio plugins without home-manager

← Older revision		Revision as of 00:16, 28 November 2022
Line 8:		Line 8:

	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
	~~pkgs.wrapOBS~~.~~override { obs-studio~~ = pkgs.~~obs-studio; }~~ {		environment.systemPackages = [
	plugins = with pkgs.obs-studio-plugins; [		(pkgs.wrapOBS {
	wlrobs		plugins = with pkgs.obs-studio-plugins; [
	];		wlrobs
	};		];
			});
			];
	</syntaxhighlight>		</syntaxhighlight>