Skip to main content

An event-based command line interface for OBS Websocket

Project description

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()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

obws-commands-0.0.3.tar.gz (7.0 kB view hashes)

Uploaded Source

Built Distribution

obws_commands-0.0.3-py3-none-any.whl (11.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page