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.6.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

obws_commands-0.0.6-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

Details for the file obws_commands-0.0.6.tar.gz.

File metadata

  • Download URL: obws_commands-0.0.6.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for obws_commands-0.0.6.tar.gz
Algorithm Hash digest
SHA256 a2db97332a64efe62463bb4fe7a7c7c75ca8537fe29309ee43f88c2e250604f8
MD5 e1a6dfd52695dfbce01d40c9f39aa38f
BLAKE2b-256 65af1587ae1b16d27cbaebe7f4181f14b62d049ea8c7dcbe505c727da73a9cc8

See more details on using hashes here.

File details

Details for the file obws_commands-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: obws_commands-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 12.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for obws_commands-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 8320f2ba2b5502bf46136850197191113b2594c9337b795883d9d498fd89fcc9
MD5 44162bf742381b1fa5102c64855b3376
BLAKE2b-256 7be9489fcd7bf2ffcc30e75f4bd604830c470f9546ddaaa58e98b22463c90ba7

See more details on using hashes here.

Supported by

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