You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

History

Dominik Nakamura a8ad9db37f feat: add features from obs-websocket v5.4		3 days ago
..
README.md	Initial commit	3 years ago
events.rs	Use format shorthand in more places	1 year ago
iter_scenes.rs	feat: add features from obs-websocket v5.4	3 days ago
screenshot.rs	feat: add features from obs-websocket v5.4	3 days ago
simple.rs	Use format shorthand in more places	1 year ago

README.md

Examples

These are several examples that show how to use obws. If you require authentication for your OBS instance, create a .env file in the project root and add a OBS_PASSWORD entry in it. The examples will pick up the password and authenticate automatically.

simple A very basic example showing how to connect, login and print out current version information and the list of scenes.
iter_scenes Get a list of all scenes and endlessly iterate through them with a small pause between each change.
screenshot Take a screenshot of the currently visible scene and save it as screenshot.png.
events Shows how to get a stream of user events and simply print them out to the terminal.