Skip to main content

OBS Web Socket Commands

A list of commands that can be sent to OBS via the Web Socket plugin. This project contains only a subset of all available commands, and is mostly focused on the commands that are useful for recording. The main point of the implemented commands is to be chainable, i.e.: the control only returns once a command is executed and the OBS reports the new state. Or in more practical terms: the switch-profile-and-scene-collection command is the only reason for this package to exist.

Usage

You can execute a single command from the command line:

obws-command pause-record

This assumes the config.toml file is in the current directory.


Or you can call a command from inside a script:

from obwsc.commands.pause_record import PauseRecord

config = {'host': 'localhost', 'port': 4455, 'password': 'secret'}
PauseRecord(config).execute()

Metadata

Release files for obws-commands 0.0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for obws-commands 0.0.6
File Size Uploaded Provenance
obws_commands-0.0.6.tar.gz 7.5 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for obws-commands 0.0.6
File Interpreter ABI Platform
obws_commands-0.0.6-py3-none-any.whl Python 3 none any Details

Total release size: 19.8 kB

Release files / obws_commands-0.0.6.tar.gz

Download URL obws_commands-0.0.6.tar.gz
Size 7.5 kB
Tags Source
SHA-256 checksum
How to use checksums
a2db97332a64efe62463bb4fe7a7c7c75ca8537fe29309ee43f88c2e250604f8
BLAKE2b-256 checksum
How to use checksums
65af1587ae1b16d27cbaebe7f4181f14b62d049ea8c7dcbe505c727da73a9cc8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.20

Release files / obws_commands-0.0.6-py3-none-any.whl

Download URL obws_commands-0.0.6-py3-none-any.whl
Size 12.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8320f2ba2b5502bf46136850197191113b2594c9337b795883d9d498fd89fcc9
BLAKE2b-256 checksum
How to use checksums
7be9489fcd7bf2ffcc30e75f4bd604830c470f9546ddaaa58e98b22463c90ba7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.20

Security for obws-commands 0.0.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page