mirror of
https://github.com/onyx-and-iris/obsws-cli.git
synced 2026-04-07 09:33:38 +00:00
Compare commits
69 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 70207c98a0 | |||
| 65b4142692 | |||
| 9e4071aace | |||
| ba61f7d9a1 | |||
| 6a02a4fc86 | |||
| 0c5e1085cc | |||
| 22cf1c817f | |||
| da69702a18 | |||
| 9b0d20effd | |||
| 998e72f43e | |||
| 71d4a81855 | |||
| e8f0764a50 | |||
| d88a0b62ad | |||
| 7f3d47e7b0 | |||
| fb19a67e64 | |||
| 383df9d4e4 | |||
|
|
8116deed27 | ||
|
|
ae57f0dbc3 | ||
| 55e4769f32 | |||
| 35be262b2a | |||
| 58907fe2b5 | |||
| 1a05a89042 | |||
| 13a2443d48 | |||
| 45479563a0 | |||
| 35bd2522cf | |||
| bec10d5d05 | |||
| 9693d4f913 | |||
| 34067ca61d | |||
| 3ca138ef6d | |||
| 1b8bc72097 | |||
| 3a8d4ef0f0 | |||
| 1fc0bef237 | |||
| 8bec6908e5 | |||
| 2c03b28fc6 | |||
| f1e29e0d4f | |||
| c7b60ecaf9 | |||
| a05fce26f2 | |||
| 5355d29a31 | |||
| add9743b00 | |||
| 8aa1fb2c09 | |||
| 5c7fc24839 | |||
| e4ab4ae630 | |||
| 9cdbc657fa | |||
| f74ec9cd93 | |||
| 329aec084c | |||
| 3eaa3992a0 | |||
| 7c86aa8a8b | |||
| 09ca892fcb | |||
| 81fcb4e504 | |||
| 3f3b331363 | |||
| 2535fe85c5 | |||
| 7d4485ec05 | |||
| 2c2501e017 | |||
| 356684e5d4 | |||
| f7e51f8488 | |||
| 8da29ce90e | |||
| 72c6bcee49 | |||
| dceafba065 | |||
| 7a73ec35f6 | |||
| 48e0f6cecd | |||
| 52e13922dc | |||
| f335d8ffd2 | |||
| 286cda8066 | |||
| e851219ced | |||
| f852a733c3 | |||
| 44dadcee23 | |||
| ed4531c305 | |||
| ec42a4cdd9 | |||
| 6123c92d00 |
20
.github/dependabot.yml
vendored
Normal file
20
.github/dependabot.yml
vendored
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# To get started with Dependabot version updates, you'll need to specify which
|
||||||
|
# package ecosystems to update and where the package manifests are located.
|
||||||
|
# Please see the documentation for all configuration options:
|
||||||
|
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
|
||||||
|
|
||||||
|
version: 2
|
||||||
|
updates:
|
||||||
|
- package-ecosystem: "github-actions" # See documentation for possible values
|
||||||
|
directory: "/" # Location of package manifests
|
||||||
|
schedule:
|
||||||
|
interval: "weekly"
|
||||||
|
day: "monday"
|
||||||
|
time: "09:00"
|
||||||
|
|
||||||
|
- package-ecosystem: "pip"
|
||||||
|
directory: "/"
|
||||||
|
schedule:
|
||||||
|
interval: "weekly"
|
||||||
|
day: "monday"
|
||||||
|
time: "09:00"
|
||||||
4
.github/workflows/publish.yml
vendored
4
.github/workflows/publish.yml
vendored
@@ -19,10 +19,10 @@ jobs:
|
|||||||
id-token: write
|
id-token: write
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v6
|
||||||
|
|
||||||
- name: Set up Python
|
- name: Set up Python
|
||||||
uses: actions/setup-python@v4
|
uses: actions/setup-python@v6
|
||||||
with:
|
with:
|
||||||
python-version: '3.11'
|
python-version: '3.11'
|
||||||
cache: 'pip'
|
cache: 'pip'
|
||||||
|
|||||||
2
.github/workflows/ruff.yml
vendored
2
.github/workflows/ruff.yml
vendored
@@ -13,7 +13,7 @@ jobs:
|
|||||||
ruff:
|
ruff:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v6
|
||||||
- uses: astral-sh/ruff-action@v3
|
- uses: astral-sh/ruff-action@v3
|
||||||
with:
|
with:
|
||||||
args: 'format --check --diff'
|
args: 'format --check --diff'
|
||||||
|
|||||||
68
.gitignore
vendored
68
.gitignore
vendored
@@ -1,9 +1,9 @@
|
|||||||
# Auto-generated .gitignore by gignore: github.com/onyx-and-iris/gignore
|
# Generated by ignr: github.com/onyx-and-iris/ignr
|
||||||
|
|
||||||
### Python ###
|
## Python ##
|
||||||
# Byte-compiled / optimized / DLL files
|
# Byte-compiled / optimized / DLL files
|
||||||
__pycache__/
|
__pycache__/
|
||||||
*.py[cod]
|
*.py[codz]
|
||||||
*$py.class
|
*$py.class
|
||||||
|
|
||||||
# C extensions
|
# C extensions
|
||||||
@@ -49,7 +49,7 @@ htmlcov/
|
|||||||
nosetests.xml
|
nosetests.xml
|
||||||
coverage.xml
|
coverage.xml
|
||||||
*.cover
|
*.cover
|
||||||
*.py,cover
|
*.py.cover
|
||||||
.hypothesis/
|
.hypothesis/
|
||||||
.pytest_cache/
|
.pytest_cache/
|
||||||
cover/
|
cover/
|
||||||
@@ -97,20 +97,35 @@ ipython_config.py
|
|||||||
# install all needed dependencies.
|
# install all needed dependencies.
|
||||||
#Pipfile.lock
|
#Pipfile.lock
|
||||||
|
|
||||||
|
# UV
|
||||||
|
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
||||||
|
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
||||||
|
# commonly ignored for libraries.
|
||||||
|
#uv.lock
|
||||||
|
|
||||||
# poetry
|
# poetry
|
||||||
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
||||||
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
||||||
# commonly ignored for libraries.
|
# commonly ignored for libraries.
|
||||||
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
||||||
#poetry.lock
|
#poetry.lock
|
||||||
|
#poetry.toml
|
||||||
|
|
||||||
# pdm
|
# pdm
|
||||||
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
||||||
|
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
|
||||||
|
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
|
||||||
#pdm.lock
|
#pdm.lock
|
||||||
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
|
#pdm.toml
|
||||||
# in version control.
|
.pdm-python
|
||||||
# https://pdm.fming.dev/#use-with-ide
|
.pdm-build/
|
||||||
.pdm.toml
|
|
||||||
|
# pixi
|
||||||
|
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
|
||||||
|
#pixi.lock
|
||||||
|
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
|
||||||
|
# in the .venv directory. It is recommended not to include this directory in version control.
|
||||||
|
.pixi
|
||||||
|
|
||||||
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
||||||
__pypackages__/
|
__pypackages__/
|
||||||
@@ -124,13 +139,13 @@ celerybeat.pid
|
|||||||
|
|
||||||
# Environments
|
# Environments
|
||||||
.env
|
.env
|
||||||
|
.envrc
|
||||||
.venv
|
.venv
|
||||||
env/
|
env/
|
||||||
venv/
|
venv/
|
||||||
ENV/
|
ENV/
|
||||||
env.bak/
|
env.bak/
|
||||||
venv.bak/
|
venv.bak/
|
||||||
.hatch
|
|
||||||
.test.env
|
.test.env
|
||||||
|
|
||||||
# Spyder project settings
|
# Spyder project settings
|
||||||
@@ -164,17 +179,38 @@ cython_debug/
|
|||||||
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
||||||
#.idea/
|
#.idea/
|
||||||
|
|
||||||
### Python Patch ###
|
# Abstra
|
||||||
# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
|
# Abstra is an AI-powered process automation framework.
|
||||||
poetry.toml
|
# Ignore directories containing user credentials, local state, and settings.
|
||||||
|
# Learn more at https://abstra.io/docs
|
||||||
|
.abstra/
|
||||||
|
|
||||||
# ruff
|
# Visual Studio Code
|
||||||
|
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
|
||||||
|
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
||||||
|
# and can be added to the global gitignore or merged into this file. However, if you prefer,
|
||||||
|
# you could uncomment the following to ignore the entire vscode folder
|
||||||
|
# .vscode/
|
||||||
|
|
||||||
|
# Ruff stuff:
|
||||||
.ruff_cache/
|
.ruff_cache/
|
||||||
|
|
||||||
# LSP config files
|
# PyPI configuration file
|
||||||
pyrightconfig.json
|
.pypirc
|
||||||
|
|
||||||
# End of gignore: github.com/onyx-and-iris/gignore
|
# Cursor
|
||||||
|
# Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
|
||||||
|
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
|
||||||
|
# refer to https://docs.cursor.com/context/ignore-files
|
||||||
|
.cursorignore
|
||||||
|
.cursorindexingignore
|
||||||
|
|
||||||
|
# Marimo
|
||||||
|
marimo/_static/
|
||||||
|
marimo/_lsp/
|
||||||
|
__marimo__/
|
||||||
|
|
||||||
|
# End of ignr
|
||||||
|
|
||||||
man/*.1
|
man/*.1
|
||||||
test-*.py
|
test-*.py
|
||||||
|
|||||||
7
.pre-commit-config.yaml
Normal file
7
.pre-commit-config.yaml
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
repos:
|
||||||
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||||
|
rev: v2.3.0
|
||||||
|
hooks:
|
||||||
|
- id: check-yaml
|
||||||
|
- id: end-of-file-fixer
|
||||||
|
- id: trailing-whitespace
|
||||||
25
CHANGELOG.md
25
CHANGELOG.md
@@ -5,6 +5,31 @@ All notable changes to this project will be documented in this file.
|
|||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
# [0.24.8] - 2026-02-07
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- --debug flag removed and replaced with --loglevel. See [Flags](https://github.com/onyx-and-iris/obsws-cli/tree/main?tab=readme-ov-file#flags). This gives the user more control over the level of logging. The default level has been set to WARNING.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- shell completion now works, see [Shell Completion](https://github.com/onyx-and-iris/obsws-cli/tree/main?tab=readme-ov-file#shell-completion). Unfortunately, command aliases in the help output are no longer present as it was breaking shell completion. However, the aliases do still work. See [issue #3](https://github.com/onyx-and-iris/obsws-cli/issues/3)
|
||||||
|
|
||||||
|
# [0.24.6] - 2026-01-26
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- environment variables should now be prefixed with 'OBSWS_CLI_', see [Environment Variables](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#environment-variables)
|
||||||
|
|
||||||
|
# [0.24.0] - 2026-01-09
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- new subcommands added to input, see [Input](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#input)
|
||||||
|
- settings command group, see [Settings](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#settings)
|
||||||
|
- media command group, see [Media](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#media)
|
||||||
|
|
||||||
|
|
||||||
# [0.20.0] - 2025-07-14
|
# [0.20.0] - 2025-07-14
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|||||||
163
README.md
163
README.md
@@ -1,6 +1,6 @@
|
|||||||
# obsws-cli
|
# obsws-cli
|
||||||
|
|
||||||
[](https://github.com/pypa/hatch)
|
[](https://github.com/pypa/hatch)
|
||||||
[](https://github.com/astral-sh/ruff)
|
[](https://github.com/astral-sh/ruff)
|
||||||
|
|
||||||
|
|
||||||
@@ -16,6 +16,7 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
|
|||||||
- [Configuration](#configuration)
|
- [Configuration](#configuration)
|
||||||
- [Style](#style)
|
- [Style](#style)
|
||||||
- [Commands](#root-typer)
|
- [Commands](#root-typer)
|
||||||
|
- [Shell Completion](#shell-completion)
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
@@ -48,6 +49,8 @@ The CLI should now be discoverable as `obsws-cli`
|
|||||||
- --password/-p: Websocket password
|
- --password/-p: Websocket password
|
||||||
- --timeout/-T: Websocket timeout
|
- --timeout/-T: Websocket timeout
|
||||||
- --version/-v: Print the obsws-cli version
|
- --version/-v: Print the obsws-cli version
|
||||||
|
- --loglevel/-l: Set the application's logging level
|
||||||
|
- One of *NOTSET, DEBUG, INFO, WARN, WARNING, ERROR, CRITICAL, FATAL*
|
||||||
|
|
||||||
Pass `--host`, `--port` and `--password` as flags on the root command, for example:
|
Pass `--host`, `--port` and `--password` as flags on the root command, for example:
|
||||||
|
|
||||||
@@ -62,9 +65,10 @@ Store and load environment variables from:
|
|||||||
- `user home directory / .config / obsws-cli / obsws.env`
|
- `user home directory / .config / obsws-cli / obsws.env`
|
||||||
|
|
||||||
```env
|
```env
|
||||||
OBS_HOST=localhost
|
OBSWS_CLI_HOST=localhost
|
||||||
OBS_PORT=4455
|
OBSWS_CLI_PORT=4455
|
||||||
OBS_PASSWORD=<websocket password>
|
OBSWS_CLI_PASSWORD=<websocket password>
|
||||||
|
OBSWS_CLI_LOGLEVEL=DEBUG
|
||||||
```
|
```
|
||||||
|
|
||||||
Flags can be used to override environment variables.
|
Flags can be used to override environment variables.
|
||||||
@@ -96,8 +100,8 @@ obsws-cli --style="cyan" --no-border sceneitem list
|
|||||||
Or with environment variables:
|
Or with environment variables:
|
||||||
|
|
||||||
```env
|
```env
|
||||||
OBS_STYLE=cyan
|
OBSWS_CLI_STYLE=cyan
|
||||||
OBS_STYLE_NO_BORDER=true
|
OBSWS_CLI_STYLE_NO_BORDER=true
|
||||||
```
|
```
|
||||||
|
|
||||||
## Root Typer
|
## Root Typer
|
||||||
@@ -298,6 +302,20 @@ obsws-cli group status START "test_group"
|
|||||||
|
|
||||||
#### Input
|
#### Input
|
||||||
|
|
||||||
|
- create: Create a new input.
|
||||||
|
- args: <input_name> <input_kind>
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli input create 'stream mix' 'wasapi_input_capture'
|
||||||
|
```
|
||||||
|
|
||||||
|
- remove: Remove an input.
|
||||||
|
- args: <input_name>
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli input remove 'stream mix'
|
||||||
|
```
|
||||||
|
|
||||||
- list: List all inputs.
|
- list: List all inputs.
|
||||||
- flags:
|
- flags:
|
||||||
|
|
||||||
@@ -315,6 +333,12 @@ obsws-cli input list
|
|||||||
obsws-cli input list --input --colour
|
obsws-cli input list --input --colour
|
||||||
```
|
```
|
||||||
|
|
||||||
|
- list-kinds: List all input kinds.
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli input list-kinds
|
||||||
|
```
|
||||||
|
|
||||||
- mute: Mute an input.
|
- mute: Mute an input.
|
||||||
- args: <input_name>
|
- args: <input_name>
|
||||||
|
|
||||||
@@ -335,6 +359,32 @@ obsws-cli input unmute "Mic/Aux"
|
|||||||
obsws-cli input toggle "Mic/Aux"
|
obsws-cli input toggle "Mic/Aux"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
- volume: Set the volume of an input.
|
||||||
|
- args: <input_name> <volume>
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli input volume -- 'Desktop Audio' -38.9
|
||||||
|
```
|
||||||
|
|
||||||
|
- show: Show information for an input in the current scene.
|
||||||
|
- args: <input_name>
|
||||||
|
- flags:
|
||||||
|
|
||||||
|
*optional*
|
||||||
|
- --verbose: List all available input devices.
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli input show 'Mic/Aux' --verbose
|
||||||
|
```
|
||||||
|
|
||||||
|
- update: Name of the input to update.
|
||||||
|
- args: <input_name> <device_name>
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli input update 'Mic/Aux' 'Voicemeeter Out B1 (VB-Audio Voicemeeter VAIO)'
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
#### Text
|
#### Text
|
||||||
|
|
||||||
- current: Get the current text for a text input.
|
- current: Get the current text for a text input.
|
||||||
@@ -676,6 +726,107 @@ obsws-cli projector open --monitor-index=1 "test_group"
|
|||||||
obsws-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\screenshot.png"
|
obsws-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\screenshot.png"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Settings
|
||||||
|
|
||||||
|
- show: Show current OBS settings.
|
||||||
|
- flags:
|
||||||
|
|
||||||
|
*optional*
|
||||||
|
- --video: Show video settings.
|
||||||
|
- --record: Show recording settings.
|
||||||
|
- --profile: Show profile settings.
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli settings show --video --record
|
||||||
|
```
|
||||||
|
|
||||||
|
- profile: Get/set OBS profile settings.
|
||||||
|
- args: <category> <name> <value>
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli settings profile SimpleOutput VBitrate
|
||||||
|
|
||||||
|
obsws-cli settings profile SimpleOutput VBitrate 6000
|
||||||
|
```
|
||||||
|
|
||||||
|
- stream-service: Get/set OBS stream service settings.
|
||||||
|
- flags:
|
||||||
|
- --key: Stream key.
|
||||||
|
- --server: Stream server URL.
|
||||||
|
|
||||||
|
*optional*
|
||||||
|
- args: <type>
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli settings stream-service
|
||||||
|
|
||||||
|
obsws-cli settings stream-service --key='live_xyzxyzxyzxyz' rtmp_common
|
||||||
|
```
|
||||||
|
|
||||||
|
- video: Get/set OBS video settings.
|
||||||
|
- flags:
|
||||||
|
|
||||||
|
*optional*
|
||||||
|
- --base-width: Base (canvas) width.
|
||||||
|
- --base-height: Base (canvas) height.
|
||||||
|
- --output-width: Output (scaled) width.
|
||||||
|
- --output-height: Output (scaled) height.
|
||||||
|
- --fps-num: Frames per second numerator.
|
||||||
|
- --fps-den: Frames per second denominator.
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli settings video
|
||||||
|
|
||||||
|
obsws-cli settings video --base-width=1920 --base-height=1080
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Media
|
||||||
|
|
||||||
|
- cursor: Get/set the cursor position of a media input.
|
||||||
|
- args: InputName
|
||||||
|
|
||||||
|
*optional*
|
||||||
|
- TimeString
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli media cursor "Media"
|
||||||
|
|
||||||
|
obsws-cli media cursor "Media" "00:08:30"
|
||||||
|
```
|
||||||
|
|
||||||
|
- play: Plays a media input.
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli media play "Media"
|
||||||
|
```
|
||||||
|
|
||||||
|
- pause: Pauses a media input.
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli media pause "Media"
|
||||||
|
```
|
||||||
|
|
||||||
|
- stop: Stops a media input.
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli media stop "Media"
|
||||||
|
```
|
||||||
|
|
||||||
|
- restart: Restarts a media input.
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli media restart "Media"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Shell Completion
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli --install-completion
|
||||||
|
```
|
||||||
|
|
||||||
|
Currently supported shells: *bash* *zsh* *fish* *powershell*
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
`obsws-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
|
`obsws-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# SPDX-FileCopyrightText: 2025-present onyx-and-iris <code@onyxandiris.online>
|
# SPDX-FileCopyrightText: 2025-present onyx-and-iris <code@onyxandiris.online>
|
||||||
#
|
#
|
||||||
# SPDX-License-Identifier: MIT
|
# SPDX-License-Identifier: MIT
|
||||||
__version__ = '0.20.1'
|
__version__ = '0.24.10'
|
||||||
|
|||||||
@@ -1,7 +1,5 @@
|
|||||||
"""module defining a custom group class for handling command name aliases."""
|
"""module defining a custom group class for handling command name aliases."""
|
||||||
|
|
||||||
import re
|
|
||||||
|
|
||||||
import typer
|
import typer
|
||||||
|
|
||||||
|
|
||||||
@@ -24,6 +22,8 @@ class RootTyperAliasGroup(typer.core.TyperGroup):
|
|||||||
cmd_name = 'hotkey'
|
cmd_name = 'hotkey'
|
||||||
case 'i':
|
case 'i':
|
||||||
cmd_name = 'input'
|
cmd_name = 'input'
|
||||||
|
case 'm':
|
||||||
|
cmd_name = 'media'
|
||||||
case 'prf':
|
case 'prf':
|
||||||
cmd_name = 'profile'
|
cmd_name = 'profile'
|
||||||
case 'prj':
|
case 'prj':
|
||||||
@@ -40,6 +40,8 @@ class RootTyperAliasGroup(typer.core.TyperGroup):
|
|||||||
cmd_name = 'sceneitem'
|
cmd_name = 'sceneitem'
|
||||||
case 'ss':
|
case 'ss':
|
||||||
cmd_name = 'screenshot'
|
cmd_name = 'screenshot'
|
||||||
|
case 'set':
|
||||||
|
cmd_name = 'settings'
|
||||||
case 'st':
|
case 'st':
|
||||||
cmd_name = 'stream'
|
cmd_name = 'stream'
|
||||||
case 'sm':
|
case 'sm':
|
||||||
@@ -49,25 +51,3 @@ class RootTyperAliasGroup(typer.core.TyperGroup):
|
|||||||
case 'vc':
|
case 'vc':
|
||||||
cmd_name = 'virtualcam'
|
cmd_name = 'virtualcam'
|
||||||
return super().get_command(ctx, cmd_name)
|
return super().get_command(ctx, cmd_name)
|
||||||
|
|
||||||
|
|
||||||
class SubTyperAliasGroup(typer.core.TyperGroup):
|
|
||||||
"""A custom group class to handle command name aliases for sub typers."""
|
|
||||||
|
|
||||||
_CMD_SPLIT_P = re.compile(r' ?[,|] ?')
|
|
||||||
|
|
||||||
def __init__(self, *args, **kwargs):
|
|
||||||
"""Initialize the AliasGroup."""
|
|
||||||
super().__init__(*args, **kwargs)
|
|
||||||
self.no_args_is_help = True
|
|
||||||
|
|
||||||
def get_command(self, ctx, cmd_name):
|
|
||||||
"""Get a command by name."""
|
|
||||||
cmd_name = self._group_cmd_name(cmd_name)
|
|
||||||
return super().get_command(ctx, cmd_name)
|
|
||||||
|
|
||||||
def _group_cmd_name(self, default_name):
|
|
||||||
for cmd in self.commands.values():
|
|
||||||
if cmd.name and default_name in self._CMD_SPLIT_P.split(cmd.name):
|
|
||||||
return cmd.name
|
|
||||||
return default_name
|
|
||||||
|
|||||||
117
obsws_cli/app.py
117
obsws_cli/app.py
@@ -2,6 +2,7 @@
|
|||||||
|
|
||||||
import importlib
|
import importlib
|
||||||
import logging
|
import logging
|
||||||
|
import pkgutil
|
||||||
from typing import Annotated
|
from typing import Annotated
|
||||||
|
|
||||||
import obsws_python as obsws
|
import obsws_python as obsws
|
||||||
@@ -9,30 +10,15 @@ import typer
|
|||||||
|
|
||||||
from obsws_cli.__about__ import __version__ as version
|
from obsws_cli.__about__ import __version__ as version
|
||||||
|
|
||||||
from . import console, settings, styles
|
from . import commands, console, envconfig, styles
|
||||||
from .alias import RootTyperAliasGroup
|
from .alias import RootTyperAliasGroup
|
||||||
|
|
||||||
app = typer.Typer(cls=RootTyperAliasGroup)
|
app = typer.Typer(cls=RootTyperAliasGroup)
|
||||||
for sub_typer in (
|
for importer, modname, ispkg in pkgutil.iter_modules(
|
||||||
'filter',
|
commands.__path__, commands.__name__ + '.'
|
||||||
'group',
|
|
||||||
'hotkey',
|
|
||||||
'input',
|
|
||||||
'profile',
|
|
||||||
'projector',
|
|
||||||
'record',
|
|
||||||
'replaybuffer',
|
|
||||||
'scene',
|
|
||||||
'scenecollection',
|
|
||||||
'sceneitem',
|
|
||||||
'screenshot',
|
|
||||||
'stream',
|
|
||||||
'studiomode',
|
|
||||||
'text',
|
|
||||||
'virtualcam',
|
|
||||||
):
|
):
|
||||||
module = importlib.import_module(f'.{sub_typer}', package=__package__)
|
subtyper = importlib.import_module(modname)
|
||||||
app.add_typer(module.app, name=sub_typer)
|
app.add_typer(subtyper.app, name=modname.split('.')[-1])
|
||||||
|
|
||||||
|
|
||||||
def version_callback(value: bool):
|
def version_callback(value: bool):
|
||||||
@@ -42,11 +28,21 @@ def version_callback(value: bool):
|
|||||||
raise typer.Exit()
|
raise typer.Exit()
|
||||||
|
|
||||||
|
|
||||||
def setup_logging(debug: bool):
|
def setup_logging(loglevel: str):
|
||||||
"""Set up logging for the application."""
|
"""Set up logging for the application."""
|
||||||
log_level = logging.DEBUG if debug else logging.CRITICAL
|
level_map = logging.getLevelNamesMapping()
|
||||||
|
try:
|
||||||
|
level_int = level_map[loglevel.upper()]
|
||||||
|
except KeyError:
|
||||||
|
possible_levels = ', '.join(
|
||||||
|
sorted(level_map.keys(), key=lambda k: level_map[k])
|
||||||
|
)
|
||||||
|
raise typer.BadParameter(
|
||||||
|
f'Invalid log level: {loglevel}. Valid options are: {possible_levels}'
|
||||||
|
) from None
|
||||||
|
|
||||||
logging.basicConfig(
|
logging.basicConfig(
|
||||||
level=log_level,
|
level=level_int,
|
||||||
format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
|
format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -68,41 +64,62 @@ def main(
|
|||||||
typer.Option(
|
typer.Option(
|
||||||
'--host',
|
'--host',
|
||||||
'-H',
|
'-H',
|
||||||
envvar='OBS_HOST',
|
envvar='OBSWS_CLI_HOST',
|
||||||
help='WebSocket host',
|
help='WebSocket host',
|
||||||
show_default='localhost',
|
show_default='localhost',
|
||||||
),
|
),
|
||||||
] = settings.get('host'),
|
] = envconfig.get('host'),
|
||||||
port: Annotated[
|
port: Annotated[
|
||||||
int,
|
int,
|
||||||
typer.Option(
|
typer.Option(
|
||||||
'--port',
|
'--port',
|
||||||
'-P',
|
'-P',
|
||||||
envvar='OBS_PORT',
|
envvar='OBSWS_CLI_PORT',
|
||||||
help='WebSocket port',
|
help='WebSocket port',
|
||||||
show_default=4455,
|
show_default=4455,
|
||||||
),
|
),
|
||||||
] = settings.get('port'),
|
] = envconfig.get('port'),
|
||||||
password: Annotated[
|
password: Annotated[
|
||||||
str,
|
str,
|
||||||
typer.Option(
|
typer.Option(
|
||||||
'--password',
|
'--password',
|
||||||
'-p',
|
'-p',
|
||||||
envvar='OBS_PASSWORD',
|
envvar='OBSWS_CLI_PASSWORD',
|
||||||
help='WebSocket password',
|
help='WebSocket password',
|
||||||
show_default=False,
|
show_default=False,
|
||||||
),
|
),
|
||||||
] = settings.get('password'),
|
] = envconfig.get('password'),
|
||||||
timeout: Annotated[
|
timeout: Annotated[
|
||||||
int,
|
int,
|
||||||
typer.Option(
|
typer.Option(
|
||||||
'--timeout',
|
'--timeout',
|
||||||
'-T',
|
'-T',
|
||||||
envvar='OBS_TIMEOUT',
|
envvar='OBSWS_CLI_TIMEOUT',
|
||||||
help='WebSocket timeout',
|
help='WebSocket timeout',
|
||||||
show_default=5,
|
show_default=5,
|
||||||
),
|
),
|
||||||
] = settings.get('timeout'),
|
] = envconfig.get('timeout'),
|
||||||
|
style: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Option(
|
||||||
|
'--style',
|
||||||
|
'-s',
|
||||||
|
envvar='OBSWS_CLI_STYLE',
|
||||||
|
help='Set the style for the CLI output',
|
||||||
|
show_default='disabled',
|
||||||
|
callback=validate_style,
|
||||||
|
),
|
||||||
|
] = envconfig.get('style'),
|
||||||
|
no_border: Annotated[
|
||||||
|
bool,
|
||||||
|
typer.Option(
|
||||||
|
'--no-border',
|
||||||
|
'-b',
|
||||||
|
envvar='OBSWS_CLI_STYLE_NO_BORDER',
|
||||||
|
help='Disable table border styling in the CLI output',
|
||||||
|
show_default=False,
|
||||||
|
),
|
||||||
|
] = envconfig.get('style_no_border'),
|
||||||
version: Annotated[
|
version: Annotated[
|
||||||
bool,
|
bool,
|
||||||
typer.Option(
|
typer.Option(
|
||||||
@@ -114,44 +131,24 @@ def main(
|
|||||||
callback=version_callback,
|
callback=version_callback,
|
||||||
),
|
),
|
||||||
] = False,
|
] = False,
|
||||||
style: Annotated[
|
loglevel: Annotated[
|
||||||
str,
|
str,
|
||||||
typer.Option(
|
typer.Option(
|
||||||
'--style',
|
'--loglevel',
|
||||||
'-s',
|
'-l',
|
||||||
envvar='OBS_STYLE',
|
envvar='OBSWS_CLI_LOGLEVEL',
|
||||||
help='Set the style for the CLI output',
|
|
||||||
show_default='disabled',
|
|
||||||
callback=validate_style,
|
|
||||||
),
|
|
||||||
] = settings.get('style'),
|
|
||||||
no_border: Annotated[
|
|
||||||
bool,
|
|
||||||
typer.Option(
|
|
||||||
'--no-border',
|
|
||||||
'-b',
|
|
||||||
envvar='OBS_STYLE_NO_BORDER',
|
|
||||||
help='Disable table border styling in the CLI output',
|
|
||||||
show_default=False,
|
|
||||||
),
|
|
||||||
] = settings.get('style_no_border'),
|
|
||||||
debug: Annotated[
|
|
||||||
bool,
|
|
||||||
typer.Option(
|
|
||||||
'--debug',
|
|
||||||
'-d',
|
|
||||||
envvar='OBS_DEBUG',
|
|
||||||
is_eager=True,
|
is_eager=True,
|
||||||
help='Enable debug logging',
|
help='Set the logging level',
|
||||||
show_default=False,
|
show_default=False,
|
||||||
callback=setup_logging,
|
callback=setup_logging,
|
||||||
hidden=True,
|
|
||||||
),
|
),
|
||||||
] = settings.get('debug'),
|
] = envconfig.get('loglevel'),
|
||||||
):
|
):
|
||||||
"""obsws_cli is a command line interface for the OBS WebSocket API."""
|
"""obsws_cli is a command line interface for the OBS WebSocket API."""
|
||||||
ctx.ensure_object(dict)
|
ctx.ensure_object(dict)
|
||||||
ctx.obj['obsws'] = ctx.with_resource(obsws.ReqClient(**ctx.params))
|
ctx.obj['obsws'] = ctx.with_resource(
|
||||||
|
obsws.ReqClient(host=host, port=port, password=password, timeout=timeout)
|
||||||
|
)
|
||||||
ctx.obj['style'] = styles.request_style_obj(style, no_border)
|
ctx.obj['style'] = styles.request_style_obj(style, no_border)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -7,10 +7,9 @@ import typer
|
|||||||
from rich.table import Table
|
from rich.table import Table
|
||||||
from rich.text import Text
|
from rich.text import Text
|
||||||
|
|
||||||
from . import console, util
|
from obsws_cli import console, util
|
||||||
from .alias import SubTyperAliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
@@ -18,7 +17,8 @@ def main():
|
|||||||
"""Control filters in OBS scenes."""
|
"""Control filters in OBS scenes."""
|
||||||
|
|
||||||
|
|
||||||
@app.command('list | ls')
|
@app.command('list')
|
||||||
|
@app.command('ls', hidden=True)
|
||||||
def list_(
|
def list_(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
source_name: Annotated[
|
source_name: Annotated[
|
||||||
@@ -90,7 +90,8 @@ def _get_filter_enabled(ctx: typer.Context, source_name: str, filter_name: str):
|
|||||||
return resp.filter_enabled
|
return resp.filter_enabled
|
||||||
|
|
||||||
|
|
||||||
@app.command('enable | on')
|
@app.command('enable')
|
||||||
|
@app.command('on', hidden=True)
|
||||||
def enable(
|
def enable(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
source_name: Annotated[
|
source_name: Annotated[
|
||||||
@@ -119,7 +120,8 @@ def enable(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('disable | off')
|
@app.command('disable')
|
||||||
|
@app.command('off', hidden=True)
|
||||||
def disable(
|
def disable(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
source_name: Annotated[
|
source_name: Annotated[
|
||||||
@@ -148,7 +150,8 @@ def disable(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
@app.command('toggle')
|
||||||
|
@app.command('tg', hidden=True)
|
||||||
def toggle(
|
def toggle(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
source_name: Annotated[
|
source_name: Annotated[
|
||||||
@@ -181,7 +184,8 @@ def toggle(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('status | ss')
|
@app.command('status')
|
||||||
|
@app.command('ss', hidden=True)
|
||||||
def status(
|
def status(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
source_name: Annotated[
|
source_name: Annotated[
|
||||||
@@ -6,11 +6,10 @@ import typer
|
|||||||
from rich.table import Table
|
from rich.table import Table
|
||||||
from rich.text import Text
|
from rich.text import Text
|
||||||
|
|
||||||
from . import console, util, validate
|
from obsws_cli import console, util, validate
|
||||||
from .alias import SubTyperAliasGroup
|
from obsws_cli.protocols import DataclassProtocol
|
||||||
from .protocols import DataclassProtocol
|
|
||||||
|
|
||||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
@@ -18,7 +17,8 @@ def main():
|
|||||||
"""Control groups in OBS scenes."""
|
"""Control groups in OBS scenes."""
|
||||||
|
|
||||||
|
|
||||||
@app.command('list | ls')
|
@app.command('list')
|
||||||
|
@app.command('ls', hidden=True)
|
||||||
def list_(
|
def list_(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
scene_name: Annotated[
|
scene_name: Annotated[
|
||||||
@@ -26,17 +26,14 @@ def list_(
|
|||||||
typer.Argument(
|
typer.Argument(
|
||||||
show_default='The current scene',
|
show_default='The current scene',
|
||||||
help='Scene name to list groups for',
|
help='Scene name to list groups for',
|
||||||
|
callback=validate.scene_in_scenes,
|
||||||
),
|
),
|
||||||
] = None,
|
] = None,
|
||||||
):
|
):
|
||||||
"""List groups in a scene."""
|
"""List groups in a scene."""
|
||||||
if not scene_name:
|
if scene_name is None:
|
||||||
scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name
|
scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name
|
||||||
|
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
|
||||||
console.err.print(f"Scene '{scene_name}' not found.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
|
resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
|
||||||
groups = [
|
groups = [
|
||||||
(item.get('sceneItemId'), item.get('sourceName'), item.get('sceneItemEnabled'))
|
(item.get('sceneItemId'), item.get('sourceName'), item.get('sceneItemEnabled'))
|
||||||
@@ -87,22 +84,24 @@ def _get_group(group_name: str, resp: DataclassProtocol) -> dict | None:
|
|||||||
return group
|
return group
|
||||||
|
|
||||||
|
|
||||||
@app.command('show | sh')
|
@app.command('show')
|
||||||
|
@app.command('sh', hidden=True)
|
||||||
def show(
|
def show(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
scene_name: Annotated[
|
scene_name: Annotated[
|
||||||
str,
|
str,
|
||||||
typer.Argument(..., show_default=False, help='Scene name the group is in'),
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Scene name the group is in',
|
||||||
|
callback=validate.scene_in_scenes,
|
||||||
|
),
|
||||||
],
|
],
|
||||||
group_name: Annotated[
|
group_name: Annotated[
|
||||||
str, typer.Argument(..., show_default=False, help='Group name to show')
|
str, typer.Argument(..., show_default=False, help='Group name to show')
|
||||||
],
|
],
|
||||||
):
|
):
|
||||||
"""Show a group in a scene."""
|
"""Show a group in a scene."""
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
|
||||||
console.err.print(f"Scene '{scene_name}' not found.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
|
resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
|
||||||
if (group := _get_group(group_name, resp)) is None:
|
if (group := _get_group(group_name, resp)) is None:
|
||||||
console.err.print(
|
console.err.print(
|
||||||
@@ -119,21 +118,24 @@ def show(
|
|||||||
console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.')
|
console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('hide | h')
|
@app.command('hide')
|
||||||
|
@app.command('h', hidden=True)
|
||||||
def hide(
|
def hide(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
scene_name: Annotated[
|
scene_name: Annotated[
|
||||||
str, typer.Argument(..., show_default=False, help='Scene name the group is in')
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Scene name the group is in',
|
||||||
|
callback=validate.scene_in_scenes,
|
||||||
|
),
|
||||||
],
|
],
|
||||||
group_name: Annotated[
|
group_name: Annotated[
|
||||||
str, typer.Argument(..., show_default=False, help='Group name to hide')
|
str, typer.Argument(..., show_default=False, help='Group name to hide')
|
||||||
],
|
],
|
||||||
):
|
):
|
||||||
"""Hide a group in a scene."""
|
"""Hide a group in a scene."""
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
|
||||||
console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
|
resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
|
||||||
if (group := _get_group(group_name, resp)) is None:
|
if (group := _get_group(group_name, resp)) is None:
|
||||||
console.err.print(
|
console.err.print(
|
||||||
@@ -150,21 +152,24 @@ def hide(
|
|||||||
console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
|
console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
@app.command('toggle')
|
||||||
|
@app.command('tg', hidden=True)
|
||||||
def toggle(
|
def toggle(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
scene_name: Annotated[
|
scene_name: Annotated[
|
||||||
str, typer.Argument(..., show_default=False, help='Scene name the group is in')
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Scene name the group is in',
|
||||||
|
callback=validate.scene_in_scenes,
|
||||||
|
),
|
||||||
],
|
],
|
||||||
group_name: Annotated[
|
group_name: Annotated[
|
||||||
str, typer.Argument(..., show_default=False, help='Group name to toggle')
|
str, typer.Argument(..., show_default=False, help='Group name to toggle')
|
||||||
],
|
],
|
||||||
):
|
):
|
||||||
"""Toggle a group in a scene."""
|
"""Toggle a group in a scene."""
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
|
||||||
console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
|
resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
|
||||||
if (group := _get_group(group_name, resp)) is None:
|
if (group := _get_group(group_name, resp)) is None:
|
||||||
console.err.print(
|
console.err.print(
|
||||||
@@ -185,21 +190,24 @@ def toggle(
|
|||||||
console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
|
console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('status | ss')
|
@app.command('status')
|
||||||
|
@app.command('ss', hidden=True)
|
||||||
def status(
|
def status(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
scene_name: Annotated[
|
scene_name: Annotated[
|
||||||
str, typer.Argument(..., show_default=False, help='Scene name the group is in')
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Scene name the group is in',
|
||||||
|
callback=validate.scene_in_scenes,
|
||||||
|
),
|
||||||
],
|
],
|
||||||
group_name: Annotated[
|
group_name: Annotated[
|
||||||
str, typer.Argument(..., show_default=False, help='Group name to check status')
|
str, typer.Argument(..., show_default=False, help='Group name to check status')
|
||||||
],
|
],
|
||||||
):
|
):
|
||||||
"""Get the status of a group in a scene."""
|
"""Get the status of a group in a scene."""
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
|
||||||
console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
|
resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
|
||||||
if (group := _get_group(group_name, resp)) is None:
|
if (group := _get_group(group_name, resp)) is None:
|
||||||
console.err.print(
|
console.err.print(
|
||||||
@@ -6,10 +6,9 @@ import typer
|
|||||||
from rich.table import Table
|
from rich.table import Table
|
||||||
from rich.text import Text
|
from rich.text import Text
|
||||||
|
|
||||||
from . import console
|
from obsws_cli import console
|
||||||
from .alias import SubTyperAliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
@@ -17,13 +16,18 @@ def main():
|
|||||||
"""Control hotkeys in OBS."""
|
"""Control hotkeys in OBS."""
|
||||||
|
|
||||||
|
|
||||||
@app.command('list | ls')
|
@app.command('list')
|
||||||
|
@app.command('ls', hidden=True)
|
||||||
def list_(
|
def list_(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
):
|
):
|
||||||
"""List all hotkeys."""
|
"""List all hotkeys."""
|
||||||
resp = ctx.obj['obsws'].get_hotkey_list()
|
resp = ctx.obj['obsws'].get_hotkey_list()
|
||||||
|
|
||||||
|
if not resp.hotkeys:
|
||||||
|
console.out.print('No hotkeys found.')
|
||||||
|
raise typer.Exit()
|
||||||
|
|
||||||
table = Table(
|
table = Table(
|
||||||
title='Hotkeys',
|
title='Hotkeys',
|
||||||
padding=(0, 2),
|
padding=(0, 2),
|
||||||
@@ -41,7 +45,8 @@ def list_(
|
|||||||
console.out.print(table)
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
@app.command('trigger | tr')
|
@app.command('trigger')
|
||||||
|
@app.command('tr', hidden=True)
|
||||||
def trigger(
|
def trigger(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
hotkey: Annotated[
|
hotkey: Annotated[
|
||||||
@@ -52,7 +57,8 @@ def trigger(
|
|||||||
ctx.obj['obsws'].trigger_hotkey_by_name(hotkey)
|
ctx.obj['obsws'].trigger_hotkey_by_name(hotkey)
|
||||||
|
|
||||||
|
|
||||||
@app.command('trigger-sequence | trs')
|
@app.command('trigger-sequence')
|
||||||
|
@app.command('trs', hidden=True)
|
||||||
def trigger_sequence(
|
def trigger_sequence(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
key_id: Annotated[
|
key_id: Annotated[
|
||||||
465
obsws_cli/commands/input.py
Normal file
465
obsws_cli/commands/input.py
Normal file
@@ -0,0 +1,465 @@
|
|||||||
|
"""module containing commands for manipulating inputs."""
|
||||||
|
|
||||||
|
from typing import Annotated
|
||||||
|
|
||||||
|
import obsws_python as obsws
|
||||||
|
import typer
|
||||||
|
from rich.table import Table
|
||||||
|
from rich.text import Text
|
||||||
|
|
||||||
|
from obsws_cli import console, util, validate
|
||||||
|
|
||||||
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
|
@app.callback()
|
||||||
|
def main():
|
||||||
|
"""Control inputs in OBS."""
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('create')
|
||||||
|
@app.command('cr', hidden=True)
|
||||||
|
def create(
|
||||||
|
ctx: typer.Context,
|
||||||
|
input_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Name of the input to create.',
|
||||||
|
callback=validate.input_not_in_inputs,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
input_kind: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Kind of the input to create.',
|
||||||
|
callback=validate.kind_in_input_kinds,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Create a new input."""
|
||||||
|
current_scene = (
|
||||||
|
ctx.obj['obsws'].get_current_program_scene().current_program_scene_name
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
ctx.obj['obsws'].create_input(
|
||||||
|
inputName=input_name,
|
||||||
|
inputKind=input_kind,
|
||||||
|
sceneItemEnabled=True,
|
||||||
|
sceneName=current_scene,
|
||||||
|
inputSettings={},
|
||||||
|
)
|
||||||
|
except obsws.error.OBSSDKRequestError as e:
|
||||||
|
console.err.print(f'Failed to create input: [yellow]{e}[/yellow]')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
console.out.print(
|
||||||
|
f'Input {console.highlight(ctx, input_name)} of kind '
|
||||||
|
f'{console.highlight(ctx, input_kind)} created.',
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('remove')
|
||||||
|
@app.command('rm', hidden=True)
|
||||||
|
def remove(
|
||||||
|
ctx: typer.Context,
|
||||||
|
input_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Name of the input to remove.',
|
||||||
|
callback=validate.input_in_inputs,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Remove an input."""
|
||||||
|
ctx.obj['obsws'].remove_input(name=input_name)
|
||||||
|
|
||||||
|
console.out.print(f'Input {console.highlight(ctx, input_name)} removed.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('list')
|
||||||
|
@app.command('ls', hidden=True)
|
||||||
|
def list_(
|
||||||
|
ctx: typer.Context,
|
||||||
|
input: Annotated[bool, typer.Option(help='Filter by input type.')] = False,
|
||||||
|
output: Annotated[bool, typer.Option(help='Filter by output type.')] = False,
|
||||||
|
colour: Annotated[bool, typer.Option(help='Filter by colour source type.')] = False,
|
||||||
|
ffmpeg: Annotated[bool, typer.Option(help='Filter by ffmpeg source type.')] = False,
|
||||||
|
vlc: Annotated[bool, typer.Option(help='Filter by VLC source type.')] = False,
|
||||||
|
uuid: Annotated[bool, typer.Option(help='Show UUIDs of inputs.')] = False,
|
||||||
|
):
|
||||||
|
"""List all inputs."""
|
||||||
|
resp = ctx.obj['obsws'].get_input_list()
|
||||||
|
|
||||||
|
kinds = []
|
||||||
|
if input:
|
||||||
|
kinds.append('input')
|
||||||
|
if output:
|
||||||
|
kinds.append('output')
|
||||||
|
if colour:
|
||||||
|
kinds.append('color')
|
||||||
|
if ffmpeg:
|
||||||
|
kinds.append('ffmpeg')
|
||||||
|
if vlc:
|
||||||
|
kinds.append('vlc')
|
||||||
|
if not any([input, output, colour, ffmpeg, vlc]):
|
||||||
|
kinds = ctx.obj['obsws'].get_input_kind_list(False).input_kinds
|
||||||
|
|
||||||
|
inputs = sorted(
|
||||||
|
(
|
||||||
|
(input_.get('inputName'), input_.get('inputKind'), input_.get('inputUuid'))
|
||||||
|
for input_ in filter(
|
||||||
|
lambda input_: any(kind in input_.get('inputKind') for kind in kinds),
|
||||||
|
resp.inputs,
|
||||||
|
)
|
||||||
|
),
|
||||||
|
key=lambda x: x[0], # Sort by input name
|
||||||
|
)
|
||||||
|
|
||||||
|
if not inputs:
|
||||||
|
console.out.print('No inputs found.')
|
||||||
|
raise typer.Exit()
|
||||||
|
|
||||||
|
table = Table(title='Inputs', padding=(0, 2), border_style=ctx.obj['style'].border)
|
||||||
|
if uuid:
|
||||||
|
columns = [
|
||||||
|
(Text('Input Name', justify='center'), 'left', ctx.obj['style'].column),
|
||||||
|
(Text('Kind', justify='center'), 'center', ctx.obj['style'].column),
|
||||||
|
(Text('Muted', justify='center'), 'center', None),
|
||||||
|
(Text('UUID', justify='center'), 'left', ctx.obj['style'].column),
|
||||||
|
]
|
||||||
|
else:
|
||||||
|
columns = [
|
||||||
|
(Text('Input Name', justify='center'), 'left', ctx.obj['style'].column),
|
||||||
|
(Text('Kind', justify='center'), 'center', ctx.obj['style'].column),
|
||||||
|
(Text('Muted', justify='center'), 'center', None),
|
||||||
|
]
|
||||||
|
for heading, justify, style in columns:
|
||||||
|
table.add_column(heading, justify=justify, style=style)
|
||||||
|
|
||||||
|
for input_name, input_kind, input_uuid in inputs:
|
||||||
|
input_mark = ''
|
||||||
|
try:
|
||||||
|
input_muted = ctx.obj['obsws'].get_input_mute(name=input_name).input_muted
|
||||||
|
input_mark = util.check_mark(input_muted)
|
||||||
|
except obsws.error.OBSSDKRequestError as e:
|
||||||
|
if e.code == 604: # Input does not support audio
|
||||||
|
input_mark = 'N/A'
|
||||||
|
else:
|
||||||
|
raise
|
||||||
|
|
||||||
|
if uuid:
|
||||||
|
table.add_row(
|
||||||
|
input_name,
|
||||||
|
util.snakecase_to_titlecase(input_kind),
|
||||||
|
input_mark,
|
||||||
|
input_uuid,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
table.add_row(
|
||||||
|
input_name,
|
||||||
|
util.snakecase_to_titlecase(input_kind),
|
||||||
|
input_mark,
|
||||||
|
)
|
||||||
|
|
||||||
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('list-kinds')
|
||||||
|
@app.command('ls-k', hidden=True)
|
||||||
|
def list_kinds(
|
||||||
|
ctx: typer.Context,
|
||||||
|
):
|
||||||
|
"""List all input kinds."""
|
||||||
|
resp = ctx.obj['obsws'].get_input_kind_list(False)
|
||||||
|
kinds = sorted(resp.input_kinds)
|
||||||
|
|
||||||
|
if not kinds:
|
||||||
|
console.out.print('No input kinds found.')
|
||||||
|
raise typer.Exit()
|
||||||
|
|
||||||
|
table = Table(
|
||||||
|
title='Input Kinds', padding=(0, 2), border_style=ctx.obj['style'].border
|
||||||
|
)
|
||||||
|
table.add_column(
|
||||||
|
Text('Input Kind', justify='center'),
|
||||||
|
justify='left',
|
||||||
|
style=ctx.obj['style'].column,
|
||||||
|
)
|
||||||
|
|
||||||
|
for kind in kinds:
|
||||||
|
table.add_row(util.snakecase_to_titlecase(kind))
|
||||||
|
|
||||||
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('mute')
|
||||||
|
@app.command('m', hidden=True)
|
||||||
|
def mute(
|
||||||
|
ctx: typer.Context,
|
||||||
|
input_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Name of the input to mute.',
|
||||||
|
callback=validate.input_in_inputs,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Mute an input."""
|
||||||
|
ctx.obj['obsws'].set_input_mute(
|
||||||
|
name=input_name,
|
||||||
|
muted=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
console.out.print(f'Input {console.highlight(ctx, input_name)} muted.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('unmute')
|
||||||
|
@app.command('um', hidden=True)
|
||||||
|
def unmute(
|
||||||
|
ctx: typer.Context,
|
||||||
|
input_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Name of the input to unmute.',
|
||||||
|
callback=validate.input_in_inputs,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Unmute an input."""
|
||||||
|
ctx.obj['obsws'].set_input_mute(
|
||||||
|
name=input_name,
|
||||||
|
muted=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
console.out.print(f'Input {console.highlight(ctx, input_name)} unmuted.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('toggle')
|
||||||
|
@app.command('tg', hidden=True)
|
||||||
|
def toggle(
|
||||||
|
ctx: typer.Context,
|
||||||
|
input_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Name of the input to toggle.',
|
||||||
|
callback=validate.input_in_inputs,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Toggle an input."""
|
||||||
|
resp = ctx.obj['obsws'].get_input_mute(name=input_name)
|
||||||
|
new_state = not resp.input_muted
|
||||||
|
|
||||||
|
ctx.obj['obsws'].set_input_mute(
|
||||||
|
name=input_name,
|
||||||
|
muted=new_state,
|
||||||
|
)
|
||||||
|
|
||||||
|
if new_state:
|
||||||
|
console.out.print(
|
||||||
|
f'Input {console.highlight(ctx, input_name)} muted.',
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
console.out.print(
|
||||||
|
f'Input {console.highlight(ctx, input_name)} unmuted.',
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('volume')
|
||||||
|
@app.command('vol', hidden=True)
|
||||||
|
def volume(
|
||||||
|
ctx: typer.Context,
|
||||||
|
input_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Name of the input to set volume for.',
|
||||||
|
callback=validate.input_in_inputs,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
volume: Annotated[
|
||||||
|
float,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Volume level to set (-90 to 0).',
|
||||||
|
min=-90,
|
||||||
|
max=0,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Set the volume of an input."""
|
||||||
|
ctx.obj['obsws'].set_input_volume(
|
||||||
|
name=input_name,
|
||||||
|
vol_db=volume,
|
||||||
|
)
|
||||||
|
|
||||||
|
console.out.print(
|
||||||
|
f'Input {console.highlight(ctx, input_name)} volume set to {console.highlight(ctx, volume)}.',
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('show')
|
||||||
|
@app.command('s', hidden=True)
|
||||||
|
def show(
|
||||||
|
ctx: typer.Context,
|
||||||
|
input_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Name of the input to show.',
|
||||||
|
callback=validate.input_in_inputs,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
verbose: Annotated[
|
||||||
|
bool, typer.Option(help='List all available input devices.')
|
||||||
|
] = False,
|
||||||
|
):
|
||||||
|
"""Show information for an input in the current scene."""
|
||||||
|
input_list = ctx.obj['obsws'].get_input_list()
|
||||||
|
for input_ in input_list.inputs:
|
||||||
|
if input_['inputName'] == input_name:
|
||||||
|
input_kind = input_['inputKind']
|
||||||
|
break
|
||||||
|
|
||||||
|
for prop in ['device', 'device_id']:
|
||||||
|
try:
|
||||||
|
device_id = (
|
||||||
|
ctx.obj['obsws']
|
||||||
|
.get_input_settings(
|
||||||
|
name=input_name,
|
||||||
|
)
|
||||||
|
.input_settings.get(prop)
|
||||||
|
)
|
||||||
|
if device_id:
|
||||||
|
break
|
||||||
|
except obsws.error.OBSSDKRequestError:
|
||||||
|
continue
|
||||||
|
else:
|
||||||
|
device_id = '(N/A)'
|
||||||
|
|
||||||
|
for device in (
|
||||||
|
ctx.obj['obsws']
|
||||||
|
.get_input_properties_list_property_items(
|
||||||
|
input_name=input_name,
|
||||||
|
prop_name=prop,
|
||||||
|
)
|
||||||
|
.property_items
|
||||||
|
):
|
||||||
|
if device.get('itemValue') == device_id:
|
||||||
|
device_id = device.get('itemName')
|
||||||
|
break
|
||||||
|
|
||||||
|
table = Table(
|
||||||
|
title='Input Information', padding=(0, 2), border_style=ctx.obj['style'].border
|
||||||
|
)
|
||||||
|
columns = [
|
||||||
|
(Text('Input Name', justify='center'), 'left', ctx.obj['style'].column),
|
||||||
|
(Text('Kind', justify='center'), 'left', ctx.obj['style'].column),
|
||||||
|
(Text('Device', justify='center'), 'left', ctx.obj['style'].column),
|
||||||
|
]
|
||||||
|
for heading, justify, style in columns:
|
||||||
|
table.add_column(heading, justify=justify, style=style)
|
||||||
|
table.add_row(
|
||||||
|
input_name,
|
||||||
|
util.snakecase_to_titlecase(input_kind),
|
||||||
|
device_id,
|
||||||
|
)
|
||||||
|
|
||||||
|
console.out.print(table)
|
||||||
|
|
||||||
|
if verbose:
|
||||||
|
resp = ctx.obj['obsws'].get_input_properties_list_property_items(
|
||||||
|
input_name=input_name,
|
||||||
|
prop_name=prop,
|
||||||
|
)
|
||||||
|
table = Table(
|
||||||
|
title='Devices',
|
||||||
|
padding=(0, 2),
|
||||||
|
border_style=ctx.obj['style'].border,
|
||||||
|
)
|
||||||
|
columns = [
|
||||||
|
(Text('Name', justify='center'), 'left', ctx.obj['style'].column),
|
||||||
|
]
|
||||||
|
for heading, justify, style in columns:
|
||||||
|
table.add_column(heading, justify=justify, style=style)
|
||||||
|
for i, item in enumerate(resp.property_items):
|
||||||
|
table.add_row(
|
||||||
|
item.get('itemName'),
|
||||||
|
style='' if i % 2 == 0 else 'dim',
|
||||||
|
)
|
||||||
|
|
||||||
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('update')
|
||||||
|
@app.command('upd', hidden=True)
|
||||||
|
def update(
|
||||||
|
ctx: typer.Context,
|
||||||
|
input_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Name of the input to update.',
|
||||||
|
callback=validate.input_in_inputs,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
device_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Name of the device to set for the input.',
|
||||||
|
),
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Update a setting for an input."""
|
||||||
|
device_id = None
|
||||||
|
for prop in ['device', 'device_id']:
|
||||||
|
try:
|
||||||
|
for device in (
|
||||||
|
ctx.obj['obsws']
|
||||||
|
.get_input_properties_list_property_items(
|
||||||
|
input_name=input_name,
|
||||||
|
prop_name=prop,
|
||||||
|
)
|
||||||
|
.property_items
|
||||||
|
):
|
||||||
|
if device.get('itemName') == device_name:
|
||||||
|
device_id = device.get('itemValue')
|
||||||
|
break
|
||||||
|
except obsws.error.OBSSDKRequestError:
|
||||||
|
continue
|
||||||
|
if device_id:
|
||||||
|
break
|
||||||
|
|
||||||
|
if not device_id:
|
||||||
|
console.err.print(
|
||||||
|
f'Failed to find device ID for device '
|
||||||
|
f'{console.highlight(ctx, device_name)}.',
|
||||||
|
)
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
ctx.obj['obsws'].set_input_settings(
|
||||||
|
name=input_name, settings={prop: device_id}, overlay=True
|
||||||
|
)
|
||||||
|
|
||||||
|
console.out.print(
|
||||||
|
f'Input {console.highlight(ctx, input_name)} updated to use device '
|
||||||
|
f'{console.highlight(ctx, device_name)}.',
|
||||||
|
)
|
||||||
105
obsws_cli/commands/media.py
Normal file
105
obsws_cli/commands/media.py
Normal file
@@ -0,0 +1,105 @@
|
|||||||
|
"""module containing commands for media inputs."""
|
||||||
|
|
||||||
|
from typing import Annotated, Optional
|
||||||
|
|
||||||
|
import typer
|
||||||
|
|
||||||
|
from obsws_cli import console, util, validate
|
||||||
|
|
||||||
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
|
@app.callback()
|
||||||
|
def main():
|
||||||
|
"""Commands for media inputs."""
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('cursor')
|
||||||
|
@app.command('cur', hidden=True)
|
||||||
|
def cursor(
|
||||||
|
ctx: typer.Context,
|
||||||
|
input_name: Annotated[
|
||||||
|
str, typer.Argument(..., help='The name of the media input.')
|
||||||
|
],
|
||||||
|
timecode: Annotated[
|
||||||
|
Optional[str],
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
help='The timecode to set the cursor to (format: HH:MM:SS).',
|
||||||
|
callback=validate.timecode_format,
|
||||||
|
),
|
||||||
|
] = None,
|
||||||
|
):
|
||||||
|
"""Get/set the cursor position of a media input."""
|
||||||
|
if timecode is None:
|
||||||
|
resp = ctx.obj['obsws'].get_media_input_status(input_name)
|
||||||
|
console.out.print(
|
||||||
|
f'Cursor for {console.highlight(ctx, input_name)} is at {util.milliseconds_to_timecode(resp.media_cursor)}.'
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
cursor_position = util.timecode_to_milliseconds(timecode)
|
||||||
|
ctx.obj['obsws'].set_media_input_cursor(input_name, cursor_position)
|
||||||
|
console.out.print(
|
||||||
|
f'Cursor for {console.highlight(ctx, input_name)} set to {timecode}.'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('play')
|
||||||
|
@app.command('p', hidden=True)
|
||||||
|
def play(
|
||||||
|
ctx: typer.Context,
|
||||||
|
input_name: Annotated[
|
||||||
|
str, typer.Argument(..., help='The name of the media input.')
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Get/set the playing status of a media input."""
|
||||||
|
ctx.obj['obsws'].trigger_media_input_action(
|
||||||
|
input_name, 'OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PLAY'
|
||||||
|
)
|
||||||
|
console.out.print(f'Playing media input {console.highlight(ctx, input_name)}.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('pause')
|
||||||
|
@app.command('pa', hidden=True)
|
||||||
|
def pause(
|
||||||
|
ctx: typer.Context,
|
||||||
|
input_name: Annotated[
|
||||||
|
str, typer.Argument(..., help='The name of the media input.')
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Pause a media input."""
|
||||||
|
ctx.obj['obsws'].trigger_media_input_action(
|
||||||
|
input_name, 'OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PAUSE'
|
||||||
|
)
|
||||||
|
console.out.print(f'Paused media input {console.highlight(ctx, input_name)}.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('stop')
|
||||||
|
@app.command('s', hidden=True)
|
||||||
|
def stop(
|
||||||
|
ctx: typer.Context,
|
||||||
|
input_name: Annotated[
|
||||||
|
str, typer.Argument(..., help='The name of the media input.')
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Stop a media input."""
|
||||||
|
ctx.obj['obsws'].trigger_media_input_action(
|
||||||
|
input_name, 'OBS_WEBSOCKET_MEDIA_INPUT_ACTION_STOP'
|
||||||
|
)
|
||||||
|
console.out.print(f'Stopped media input {console.highlight(ctx, input_name)}.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('restart')
|
||||||
|
@app.command('r', hidden=True)
|
||||||
|
def restart(
|
||||||
|
ctx: typer.Context,
|
||||||
|
input_name: Annotated[
|
||||||
|
str, typer.Argument(..., help='The name of the media input.')
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Restart a media input."""
|
||||||
|
ctx.obj['obsws'].trigger_media_input_action(
|
||||||
|
input_name, 'OBS_WEBSOCKET_MEDIA_INPUT_ACTION_RESTART'
|
||||||
|
)
|
||||||
|
console.out.print(f'Restarted media input {console.highlight(ctx, input_name)}.')
|
||||||
@@ -6,10 +6,9 @@ import typer
|
|||||||
from rich.table import Table
|
from rich.table import Table
|
||||||
from rich.text import Text
|
from rich.text import Text
|
||||||
|
|
||||||
from . import console, util, validate
|
from obsws_cli import console, util, validate
|
||||||
from .alias import SubTyperAliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
@@ -17,11 +16,16 @@ def main():
|
|||||||
"""Control profiles in OBS."""
|
"""Control profiles in OBS."""
|
||||||
|
|
||||||
|
|
||||||
@app.command('list | ls')
|
@app.command('list')
|
||||||
|
@app.command('ls', hidden=True)
|
||||||
def list_(ctx: typer.Context):
|
def list_(ctx: typer.Context):
|
||||||
"""List profiles."""
|
"""List profiles."""
|
||||||
resp = ctx.obj['obsws'].get_profile_list()
|
resp = ctx.obj['obsws'].get_profile_list()
|
||||||
|
|
||||||
|
if not resp.profiles:
|
||||||
|
console.out.print('No profiles found.')
|
||||||
|
raise typer.Exit()
|
||||||
|
|
||||||
table = Table(
|
table = Table(
|
||||||
title='Profiles', padding=(0, 2), border_style=ctx.obj['style'].border
|
title='Profiles', padding=(0, 2), border_style=ctx.obj['style'].border
|
||||||
)
|
)
|
||||||
@@ -43,7 +47,8 @@ def list_(ctx: typer.Context):
|
|||||||
console.out.print(table)
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
@app.command('current | get')
|
@app.command('current')
|
||||||
|
@app.command('get', hidden=True)
|
||||||
def current(ctx: typer.Context):
|
def current(ctx: typer.Context):
|
||||||
"""Get the current profile."""
|
"""Get the current profile."""
|
||||||
resp = ctx.obj['obsws'].get_profile_list()
|
resp = ctx.obj['obsws'].get_profile_list()
|
||||||
@@ -52,21 +57,21 @@ def current(ctx: typer.Context):
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('switch | set')
|
@app.command('switch')
|
||||||
|
@app.command('set', hidden=True)
|
||||||
def switch(
|
def switch(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
profile_name: Annotated[
|
profile_name: Annotated[
|
||||||
str,
|
str,
|
||||||
typer.Argument(
|
typer.Argument(
|
||||||
..., show_default=False, help='Name of the profile to switch to'
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Name of the profile to switch to',
|
||||||
|
callback=validate.profile_exists,
|
||||||
),
|
),
|
||||||
],
|
],
|
||||||
):
|
):
|
||||||
"""Switch to a profile."""
|
"""Switch to a profile."""
|
||||||
if not validate.profile_exists(ctx, profile_name):
|
|
||||||
console.err.print(f'Profile [yellow]{profile_name}[/yellow] not found.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj['obsws'].get_profile_list()
|
resp = ctx.obj['obsws'].get_profile_list()
|
||||||
if resp.current_profile_name == profile_name:
|
if resp.current_profile_name == profile_name:
|
||||||
console.err.print(
|
console.err.print(
|
||||||
@@ -78,35 +83,39 @@ def switch(
|
|||||||
console.out.print(f'Switched to profile {console.highlight(ctx, profile_name)}.')
|
console.out.print(f'Switched to profile {console.highlight(ctx, profile_name)}.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('create | new')
|
@app.command('create')
|
||||||
|
@app.command('new', hidden=True)
|
||||||
def create(
|
def create(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
profile_name: Annotated[
|
profile_name: Annotated[
|
||||||
str,
|
str,
|
||||||
typer.Argument(..., show_default=False, help='Name of the profile to create.'),
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Name of the profile to create.',
|
||||||
|
callback=validate.profile_not_exists,
|
||||||
|
),
|
||||||
],
|
],
|
||||||
):
|
):
|
||||||
"""Create a new profile."""
|
"""Create a new profile."""
|
||||||
if validate.profile_exists(ctx, profile_name):
|
|
||||||
console.err.print(f'Profile [yellow]{profile_name}[/yellow] already exists.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj['obsws'].create_profile(profile_name)
|
ctx.obj['obsws'].create_profile(profile_name)
|
||||||
console.out.print(f'Created profile {console.highlight(ctx, profile_name)}.')
|
console.out.print(f'Created profile {console.highlight(ctx, profile_name)}.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('remove | rm')
|
@app.command('remove')
|
||||||
|
@app.command('rm', hidden=True)
|
||||||
def remove(
|
def remove(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
profile_name: Annotated[
|
profile_name: Annotated[
|
||||||
str,
|
str,
|
||||||
typer.Argument(..., show_default=False, help='Name of the profile to remove.'),
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Name of the profile to remove.',
|
||||||
|
callback=validate.profile_exists,
|
||||||
|
),
|
||||||
],
|
],
|
||||||
):
|
):
|
||||||
"""Remove a profile."""
|
"""Remove a profile."""
|
||||||
if not validate.profile_exists(ctx, profile_name):
|
|
||||||
console.err.print(f'Profile [yellow]{profile_name}[/yellow] not found.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj['obsws'].remove_profile(profile_name)
|
ctx.obj['obsws'].remove_profile(profile_name)
|
||||||
console.out.print(f'Removed profile {console.highlight(ctx, profile_name)}.')
|
console.out.print(f'Removed profile {console.highlight(ctx, profile_name)}.')
|
||||||
@@ -6,10 +6,9 @@ import typer
|
|||||||
from rich.table import Table
|
from rich.table import Table
|
||||||
from rich.text import Text
|
from rich.text import Text
|
||||||
|
|
||||||
from . import console
|
from obsws_cli import console
|
||||||
from .alias import SubTyperAliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
@@ -17,20 +16,20 @@ def main():
|
|||||||
"""Control projectors in OBS."""
|
"""Control projectors in OBS."""
|
||||||
|
|
||||||
|
|
||||||
@app.command('list-monitors | ls-m')
|
@app.command('list-monitors')
|
||||||
|
@app.command('ls-m', hidden=True)
|
||||||
def list_monitors(ctx: typer.Context):
|
def list_monitors(ctx: typer.Context):
|
||||||
"""List available monitors."""
|
"""List available monitors."""
|
||||||
resp = ctx.obj['obsws'].get_monitor_list()
|
resp = ctx.obj['obsws'].get_monitor_list()
|
||||||
|
|
||||||
if not resp.monitors:
|
|
||||||
console.out.print('No monitors found.')
|
|
||||||
return
|
|
||||||
|
|
||||||
monitors = sorted(
|
monitors = sorted(
|
||||||
((m['monitorIndex'], m['monitorName']) for m in resp.monitors),
|
((m['monitorIndex'], m['monitorName']) for m in resp.monitors),
|
||||||
key=lambda m: m[0],
|
key=lambda m: m[0],
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if not monitors:
|
||||||
|
console.out.print('No monitors found.')
|
||||||
|
raise typer.Exit()
|
||||||
|
|
||||||
table = Table(
|
table = Table(
|
||||||
title='Available Monitors',
|
title='Available Monitors',
|
||||||
padding=(0, 2),
|
padding=(0, 2),
|
||||||
@@ -49,7 +48,8 @@ def list_monitors(ctx: typer.Context):
|
|||||||
console.out.print(table)
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
@app.command('open | o')
|
@app.command('open')
|
||||||
|
@app.command('o', hidden=True)
|
||||||
def open(
|
def open(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
monitor_index: Annotated[
|
monitor_index: Annotated[
|
||||||
@@ -5,10 +5,9 @@ from typing import Annotated, Optional
|
|||||||
|
|
||||||
import typer
|
import typer
|
||||||
|
|
||||||
from . import console
|
from obsws_cli import console
|
||||||
from .alias import SubTyperAliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
@@ -22,7 +21,8 @@ def _get_recording_status(ctx: typer.Context) -> tuple:
|
|||||||
return resp.output_active, resp.output_paused
|
return resp.output_active, resp.output_paused
|
||||||
|
|
||||||
|
|
||||||
@app.command('start | s')
|
@app.command('start')
|
||||||
|
@app.command('s', hidden=True)
|
||||||
def start(ctx: typer.Context):
|
def start(ctx: typer.Context):
|
||||||
"""Start recording."""
|
"""Start recording."""
|
||||||
active, paused = _get_recording_status(ctx)
|
active, paused = _get_recording_status(ctx)
|
||||||
@@ -38,7 +38,8 @@ def start(ctx: typer.Context):
|
|||||||
console.out.print('Recording started successfully.')
|
console.out.print('Recording started successfully.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('stop | st')
|
@app.command('stop')
|
||||||
|
@app.command('st', hidden=True)
|
||||||
def stop(ctx: typer.Context):
|
def stop(ctx: typer.Context):
|
||||||
"""Stop recording."""
|
"""Stop recording."""
|
||||||
active, _ = _get_recording_status(ctx)
|
active, _ = _get_recording_status(ctx)
|
||||||
@@ -52,7 +53,8 @@ def stop(ctx: typer.Context):
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
@app.command('toggle')
|
||||||
|
@app.command('tg', hidden=True)
|
||||||
def toggle(ctx: typer.Context):
|
def toggle(ctx: typer.Context):
|
||||||
"""Toggle recording."""
|
"""Toggle recording."""
|
||||||
resp = ctx.obj['obsws'].toggle_record()
|
resp = ctx.obj['obsws'].toggle_record()
|
||||||
@@ -62,7 +64,8 @@ def toggle(ctx: typer.Context):
|
|||||||
console.out.print('Recording stopped successfully.')
|
console.out.print('Recording stopped successfully.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('status | ss')
|
@app.command('status')
|
||||||
|
@app.command('ss', hidden=True)
|
||||||
def status(ctx: typer.Context):
|
def status(ctx: typer.Context):
|
||||||
"""Get recording status."""
|
"""Get recording status."""
|
||||||
active, paused = _get_recording_status(ctx)
|
active, paused = _get_recording_status(ctx)
|
||||||
@@ -75,7 +78,8 @@ def status(ctx: typer.Context):
|
|||||||
console.out.print('Recording is not in progress.')
|
console.out.print('Recording is not in progress.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('resume | r')
|
@app.command('resume')
|
||||||
|
@app.command('r', hidden=True)
|
||||||
def resume(ctx: typer.Context):
|
def resume(ctx: typer.Context):
|
||||||
"""Resume recording."""
|
"""Resume recording."""
|
||||||
active, paused = _get_recording_status(ctx)
|
active, paused = _get_recording_status(ctx)
|
||||||
@@ -90,7 +94,8 @@ def resume(ctx: typer.Context):
|
|||||||
console.out.print('Recording resumed successfully.')
|
console.out.print('Recording resumed successfully.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('pause | p')
|
@app.command('pause')
|
||||||
|
@app.command('p', hidden=True)
|
||||||
def pause(ctx: typer.Context):
|
def pause(ctx: typer.Context):
|
||||||
"""Pause recording."""
|
"""Pause recording."""
|
||||||
active, paused = _get_recording_status(ctx)
|
active, paused = _get_recording_status(ctx)
|
||||||
@@ -105,7 +110,8 @@ def pause(ctx: typer.Context):
|
|||||||
console.out.print('Recording paused successfully.')
|
console.out.print('Recording paused successfully.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('directory | d')
|
@app.command('directory')
|
||||||
|
@app.command('d', hidden=True)
|
||||||
def directory(
|
def directory(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
record_directory: Annotated[
|
record_directory: Annotated[
|
||||||
@@ -132,7 +138,8 @@ def directory(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('split | sp')
|
@app.command('split')
|
||||||
|
@app.command('sp', hidden=True)
|
||||||
def split(ctx: typer.Context):
|
def split(ctx: typer.Context):
|
||||||
"""Split the current recording."""
|
"""Split the current recording."""
|
||||||
active, paused = _get_recording_status(ctx)
|
active, paused = _get_recording_status(ctx)
|
||||||
@@ -147,7 +154,8 @@ def split(ctx: typer.Context):
|
|||||||
console.out.print('Recording split successfully.')
|
console.out.print('Recording split successfully.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('chapter | ch')
|
@app.command('chapter')
|
||||||
|
@app.command('ch', hidden=True)
|
||||||
def chapter(
|
def chapter(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
chapter_name: Annotated[
|
chapter_name: Annotated[
|
||||||
@@ -2,18 +2,18 @@
|
|||||||
|
|
||||||
import typer
|
import typer
|
||||||
|
|
||||||
from . import console
|
from obsws_cli import console
|
||||||
from .alias import SubTyperAliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
def main():
|
def main():
|
||||||
"""Control profiles in OBS."""
|
"""Control the replay buffer in OBS."""
|
||||||
|
|
||||||
|
|
||||||
@app.command('start | s')
|
@app.command('start')
|
||||||
|
@app.command('s', hidden=True)
|
||||||
def start(ctx: typer.Context):
|
def start(ctx: typer.Context):
|
||||||
"""Start the replay buffer."""
|
"""Start the replay buffer."""
|
||||||
resp = ctx.obj['obsws'].get_replay_buffer_status()
|
resp = ctx.obj['obsws'].get_replay_buffer_status()
|
||||||
@@ -25,7 +25,8 @@ def start(ctx: typer.Context):
|
|||||||
console.out.print('Replay buffer started.')
|
console.out.print('Replay buffer started.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('stop | st')
|
@app.command('stop')
|
||||||
|
@app.command('st', hidden=True)
|
||||||
def stop(ctx: typer.Context):
|
def stop(ctx: typer.Context):
|
||||||
"""Stop the replay buffer."""
|
"""Stop the replay buffer."""
|
||||||
resp = ctx.obj['obsws'].get_replay_buffer_status()
|
resp = ctx.obj['obsws'].get_replay_buffer_status()
|
||||||
@@ -37,7 +38,8 @@ def stop(ctx: typer.Context):
|
|||||||
console.out.print('Replay buffer stopped.')
|
console.out.print('Replay buffer stopped.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
@app.command('toggle')
|
||||||
|
@app.command('tg', hidden=True)
|
||||||
def toggle(ctx: typer.Context):
|
def toggle(ctx: typer.Context):
|
||||||
"""Toggle the replay buffer."""
|
"""Toggle the replay buffer."""
|
||||||
resp = ctx.obj['obsws'].toggle_replay_buffer()
|
resp = ctx.obj['obsws'].toggle_replay_buffer()
|
||||||
@@ -47,7 +49,8 @@ def toggle(ctx: typer.Context):
|
|||||||
console.out.print('Replay buffer is not active.')
|
console.out.print('Replay buffer is not active.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('status | ss')
|
@app.command('status')
|
||||||
|
@app.command('ss', hidden=True)
|
||||||
def status(ctx: typer.Context):
|
def status(ctx: typer.Context):
|
||||||
"""Get the status of the replay buffer."""
|
"""Get the status of the replay buffer."""
|
||||||
resp = ctx.obj['obsws'].get_replay_buffer_status()
|
resp = ctx.obj['obsws'].get_replay_buffer_status()
|
||||||
@@ -57,7 +60,8 @@ def status(ctx: typer.Context):
|
|||||||
console.out.print('Replay buffer is not active.')
|
console.out.print('Replay buffer is not active.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('save | sv')
|
@app.command('save')
|
||||||
|
@app.command('sv', hidden=True)
|
||||||
def save(ctx: typer.Context):
|
def save(ctx: typer.Context):
|
||||||
"""Save the replay buffer."""
|
"""Save the replay buffer."""
|
||||||
ctx.obj['obsws'].save_replay_buffer()
|
ctx.obj['obsws'].save_replay_buffer()
|
||||||
@@ -6,10 +6,9 @@ import typer
|
|||||||
from rich.table import Table
|
from rich.table import Table
|
||||||
from rich.text import Text
|
from rich.text import Text
|
||||||
|
|
||||||
from . import console, util, validate
|
from obsws_cli import console, util, validate
|
||||||
from .alias import SubTyperAliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
@@ -17,7 +16,8 @@ def main():
|
|||||||
"""Control OBS scenes."""
|
"""Control OBS scenes."""
|
||||||
|
|
||||||
|
|
||||||
@app.command('list | ls')
|
@app.command('list')
|
||||||
|
@app.command('ls', hidden=True)
|
||||||
def list_(
|
def list_(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
uuid: Annotated[bool, typer.Option(help='Show UUIDs of scenes')] = False,
|
uuid: Annotated[bool, typer.Option(help='Show UUIDs of scenes')] = False,
|
||||||
@@ -29,6 +29,10 @@ def list_(
|
|||||||
for scene in reversed(resp.scenes)
|
for scene in reversed(resp.scenes)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if not scenes:
|
||||||
|
console.out.print('No scenes found.')
|
||||||
|
raise typer.Exit()
|
||||||
|
|
||||||
active_scene = ctx.obj['obsws'].get_current_program_scene().scene_name
|
active_scene = ctx.obj['obsws'].get_current_program_scene().scene_name
|
||||||
|
|
||||||
table = Table(title='Scenes', padding=(0, 2), border_style=ctx.obj['style'].border)
|
table = Table(title='Scenes', padding=(0, 2), border_style=ctx.obj['style'].border)
|
||||||
@@ -62,18 +66,19 @@ def list_(
|
|||||||
console.out.print(table)
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
@app.command('current | get')
|
@app.command('current')
|
||||||
|
@app.command('get', hidden=True)
|
||||||
def current(
|
def current(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
preview: Annotated[
|
preview: Annotated[
|
||||||
bool, typer.Option(help='Get the preview scene instead of the program scene')
|
bool,
|
||||||
|
typer.Option(
|
||||||
|
help='Get the preview scene instead of the program scene',
|
||||||
|
callback=validate.studio_mode_enabled,
|
||||||
|
),
|
||||||
] = False,
|
] = False,
|
||||||
):
|
):
|
||||||
"""Get the current program scene or preview scene."""
|
"""Get the current program scene or preview scene."""
|
||||||
if preview and not validate.studio_mode_enabled(ctx):
|
|
||||||
console.err.print('Studio mode is not enabled, cannot get preview scene.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
if preview:
|
if preview:
|
||||||
resp = ctx.obj['obsws'].get_current_preview_scene()
|
resp = ctx.obj['obsws'].get_current_preview_scene()
|
||||||
console.out.print(
|
console.out.print(
|
||||||
@@ -86,26 +91,27 @@ def current(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('switch | set')
|
@app.command('switch')
|
||||||
|
@app.command('set', hidden=True)
|
||||||
def switch(
|
def switch(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
scene_name: Annotated[
|
scene_name: Annotated[
|
||||||
str, typer.Argument(..., help='Name of the scene to switch to')
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
help='Name of the scene to switch to',
|
||||||
|
callback=validate.scene_in_scenes,
|
||||||
|
),
|
||||||
],
|
],
|
||||||
preview: Annotated[
|
preview: Annotated[
|
||||||
bool,
|
bool,
|
||||||
typer.Option(help='Switch to the preview scene instead of the program scene'),
|
typer.Option(
|
||||||
|
help='Switch to the preview scene instead of the program scene',
|
||||||
|
callback=validate.studio_mode_enabled,
|
||||||
|
),
|
||||||
] = False,
|
] = False,
|
||||||
):
|
):
|
||||||
"""Switch to a scene."""
|
"""Switch to a scene."""
|
||||||
if preview and not validate.studio_mode_enabled(ctx):
|
|
||||||
console.err.print('Studio mode is not enabled, cannot set the preview scene.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
|
||||||
console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
if preview:
|
if preview:
|
||||||
ctx.obj['obsws'].set_current_preview_scene(scene_name)
|
ctx.obj['obsws'].set_current_preview_scene(scene_name)
|
||||||
console.out.print(
|
console.out.print(
|
||||||
@@ -5,10 +5,9 @@ from typing import Annotated
|
|||||||
import typer
|
import typer
|
||||||
from rich.table import Table
|
from rich.table import Table
|
||||||
|
|
||||||
from . import console, validate
|
from obsws_cli import console, validate
|
||||||
from .alias import SubTyperAliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
@@ -16,11 +15,16 @@ def main():
|
|||||||
"""Control scene collections in OBS."""
|
"""Control scene collections in OBS."""
|
||||||
|
|
||||||
|
|
||||||
@app.command('list | ls')
|
@app.command('list')
|
||||||
|
@app.command('ls', hidden=True)
|
||||||
def list_(ctx: typer.Context):
|
def list_(ctx: typer.Context):
|
||||||
"""List all scene collections."""
|
"""List all scene collections."""
|
||||||
resp = ctx.obj['obsws'].get_scene_collection_list()
|
resp = ctx.obj['obsws'].get_scene_collection_list()
|
||||||
|
|
||||||
|
if not resp.scene_collections:
|
||||||
|
console.out.print('No scene collections found.')
|
||||||
|
raise typer.Exit()
|
||||||
|
|
||||||
table = Table(
|
table = Table(
|
||||||
title='Scene Collections',
|
title='Scene Collections',
|
||||||
padding=(0, 2),
|
padding=(0, 2),
|
||||||
@@ -36,7 +40,8 @@ def list_(ctx: typer.Context):
|
|||||||
console.out.print(table)
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
@app.command('current | get')
|
@app.command('current')
|
||||||
|
@app.command('get', hidden=True)
|
||||||
def current(ctx: typer.Context):
|
def current(ctx: typer.Context):
|
||||||
"""Get the current scene collection."""
|
"""Get the current scene collection."""
|
||||||
resp = ctx.obj['obsws'].get_scene_collection_list()
|
resp = ctx.obj['obsws'].get_scene_collection_list()
|
||||||
@@ -45,20 +50,20 @@ def current(ctx: typer.Context):
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('switch | set')
|
@app.command('switch')
|
||||||
|
@app.command('set', hidden=True)
|
||||||
def switch(
|
def switch(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
scene_collection_name: Annotated[
|
scene_collection_name: Annotated[
|
||||||
str, typer.Argument(..., help='Name of the scene collection to switch to')
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
help='Name of the scene collection to switch to',
|
||||||
|
callback=validate.scene_collection_in_scene_collections,
|
||||||
|
),
|
||||||
],
|
],
|
||||||
):
|
):
|
||||||
"""Switch to a scene collection."""
|
"""Switch to a scene collection."""
|
||||||
if not validate.scene_collection_in_scene_collections(ctx, scene_collection_name):
|
|
||||||
console.err.print(
|
|
||||||
f'Scene collection [yellow]{scene_collection_name}[/yellow] not found.'
|
|
||||||
)
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
current_scene_collection = (
|
current_scene_collection = (
|
||||||
ctx.obj['obsws'].get_scene_collection_list().current_scene_collection_name
|
ctx.obj['obsws'].get_scene_collection_list().current_scene_collection_name
|
||||||
)
|
)
|
||||||
@@ -74,20 +79,20 @@ def switch(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('create | new')
|
@app.command('create')
|
||||||
|
@app.command('new', hidden=True)
|
||||||
def create(
|
def create(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
scene_collection_name: Annotated[
|
scene_collection_name: Annotated[
|
||||||
str, typer.Argument(..., help='Name of the scene collection to create')
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
help='Name of the scene collection to create',
|
||||||
|
callback=validate.scene_collection_not_in_scene_collections,
|
||||||
|
),
|
||||||
],
|
],
|
||||||
):
|
):
|
||||||
"""Create a new scene collection."""
|
"""Create a new scene collection."""
|
||||||
if validate.scene_collection_in_scene_collections(ctx, scene_collection_name):
|
|
||||||
console.err.print(
|
|
||||||
f'Scene collection [yellow]{scene_collection_name}[/yellow] already exists.'
|
|
||||||
)
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj['obsws'].create_scene_collection(scene_collection_name)
|
ctx.obj['obsws'].create_scene_collection(scene_collection_name)
|
||||||
console.out.print(
|
console.out.print(
|
||||||
f'Created scene collection {console.highlight(ctx, scene_collection_name)}.'
|
f'Created scene collection {console.highlight(ctx, scene_collection_name)}.'
|
||||||
@@ -5,10 +5,9 @@ from typing import Annotated, Optional
|
|||||||
import typer
|
import typer
|
||||||
from rich.table import Table
|
from rich.table import Table
|
||||||
|
|
||||||
from . import console, util, validate
|
from obsws_cli import console, util, validate
|
||||||
from .alias import SubTyperAliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
@@ -16,7 +15,8 @@ def main():
|
|||||||
"""Control items in OBS scenes."""
|
"""Control items in OBS scenes."""
|
||||||
|
|
||||||
|
|
||||||
@app.command('list | ls')
|
@app.command('list')
|
||||||
|
@app.command('ls', hidden=True)
|
||||||
def list_(
|
def list_(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
scene_name: Annotated[
|
scene_name: Annotated[
|
||||||
@@ -24,18 +24,15 @@ def list_(
|
|||||||
typer.Argument(
|
typer.Argument(
|
||||||
show_default='The current scene',
|
show_default='The current scene',
|
||||||
help='Scene name to list items for',
|
help='Scene name to list items for',
|
||||||
|
callback=validate.scene_in_scenes,
|
||||||
),
|
),
|
||||||
] = None,
|
] = None,
|
||||||
uuid: Annotated[bool, typer.Option(help='Show UUIDs of scene items')] = False,
|
uuid: Annotated[bool, typer.Option(help='Show UUIDs of scene items')] = False,
|
||||||
):
|
):
|
||||||
"""List all items in a scene."""
|
"""List all items in a scene."""
|
||||||
if not scene_name:
|
if scene_name is None:
|
||||||
scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name
|
scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name
|
||||||
|
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
|
||||||
console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
|
resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
|
||||||
items = sorted(
|
items = sorted(
|
||||||
(
|
(
|
||||||
@@ -189,7 +186,8 @@ def _get_scene_name_and_item_id(
|
|||||||
return scene_name, scene_item_id
|
return scene_name, scene_item_id
|
||||||
|
|
||||||
|
|
||||||
@app.command('show | sh')
|
@app.command('show')
|
||||||
|
@app.command('sh', hidden=True)
|
||||||
def show(
|
def show(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
scene_name: Annotated[
|
scene_name: Annotated[
|
||||||
@@ -231,7 +229,8 @@ def show(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('hide | h')
|
@app.command('hide')
|
||||||
|
@app.command('h', hidden=True)
|
||||||
def hide(
|
def hide(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
scene_name: Annotated[
|
scene_name: Annotated[
|
||||||
@@ -272,7 +271,8 @@ def hide(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
@app.command('toggle')
|
||||||
|
@app.command('tg', hidden=True)
|
||||||
def toggle(
|
def toggle(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
scene_name: Annotated[
|
scene_name: Annotated[
|
||||||
@@ -333,7 +333,8 @@ def toggle(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('visible | v')
|
@app.command('visible')
|
||||||
|
@app.command('v', hidden=True)
|
||||||
def visible(
|
def visible(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
scene_name: Annotated[
|
scene_name: Annotated[
|
||||||
@@ -377,7 +378,8 @@ def visible(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('transform | t')
|
@app.command('transform')
|
||||||
|
@app.command('t', hidden=True)
|
||||||
def transform(
|
def transform(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
scene_name: Annotated[
|
scene_name: Annotated[
|
||||||
@@ -6,10 +6,9 @@ from typing import Annotated
|
|||||||
import obsws_python as obsws
|
import obsws_python as obsws
|
||||||
import typer
|
import typer
|
||||||
|
|
||||||
from . import console
|
from obsws_cli import console
|
||||||
from .alias import SubTyperAliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
@@ -17,7 +16,8 @@ def main():
|
|||||||
"""Take screenshots using OBS."""
|
"""Take screenshots using OBS."""
|
||||||
|
|
||||||
|
|
||||||
@app.command('save | sv')
|
@app.command('save')
|
||||||
|
@app.command('s', hidden=True)
|
||||||
def save(
|
def save(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
source_name: Annotated[
|
source_name: Annotated[
|
||||||
340
obsws_cli/commands/settings.py
Normal file
340
obsws_cli/commands/settings.py
Normal file
@@ -0,0 +1,340 @@
|
|||||||
|
"""module for settings management."""
|
||||||
|
|
||||||
|
from typing import Annotated, Optional
|
||||||
|
|
||||||
|
import typer
|
||||||
|
from rich.table import Table
|
||||||
|
from rich.text import Text
|
||||||
|
|
||||||
|
from obsws_cli import console, util
|
||||||
|
|
||||||
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
|
@app.callback()
|
||||||
|
def main():
|
||||||
|
"""Manage OBS settings."""
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('show')
|
||||||
|
@app.command('sh', hidden=True)
|
||||||
|
def show(
|
||||||
|
ctx: typer.Context,
|
||||||
|
video: Annotated[
|
||||||
|
bool, typer.Option('--video', '-v', help='Show video settings.')
|
||||||
|
] = False,
|
||||||
|
record: Annotated[
|
||||||
|
bool, typer.Option('--record', '-r', help='Show recording settings.')
|
||||||
|
] = False,
|
||||||
|
profile: Annotated[
|
||||||
|
bool, typer.Option('--profile', '-p', help='Show profile settings.')
|
||||||
|
] = False,
|
||||||
|
):
|
||||||
|
"""Show current OBS settings."""
|
||||||
|
if not any([video, record, profile]):
|
||||||
|
video = True
|
||||||
|
record = True
|
||||||
|
profile = True
|
||||||
|
|
||||||
|
resp = ctx.obj['obsws'].get_video_settings()
|
||||||
|
video_table = Table(
|
||||||
|
title='Video Settings',
|
||||||
|
padding=(0, 2),
|
||||||
|
border_style=ctx.obj['style'].border,
|
||||||
|
)
|
||||||
|
video_columns = (
|
||||||
|
('Setting', 'left', ctx.obj['style'].column),
|
||||||
|
('Value', 'left', ctx.obj['style'].column),
|
||||||
|
)
|
||||||
|
|
||||||
|
for header_text, justify, style in video_columns:
|
||||||
|
video_table.add_column(
|
||||||
|
Text(header_text, justify='center'),
|
||||||
|
justify=justify,
|
||||||
|
style=style,
|
||||||
|
)
|
||||||
|
|
||||||
|
for setting in resp.attrs():
|
||||||
|
video_table.add_row(
|
||||||
|
util.snakecase_to_titlecase(setting),
|
||||||
|
str(getattr(resp, setting)),
|
||||||
|
style='' if video_table.row_count % 2 == 0 else 'dim',
|
||||||
|
)
|
||||||
|
|
||||||
|
if video:
|
||||||
|
console.out.print(video_table)
|
||||||
|
|
||||||
|
resp = ctx.obj['obsws'].get_record_directory()
|
||||||
|
record_table = Table(
|
||||||
|
title='Recording Settings',
|
||||||
|
padding=(0, 2),
|
||||||
|
border_style=ctx.obj['style'].border,
|
||||||
|
)
|
||||||
|
record_columns = (
|
||||||
|
('Setting', 'left', ctx.obj['style'].column),
|
||||||
|
('Value', 'left', ctx.obj['style'].column),
|
||||||
|
)
|
||||||
|
for header_text, justify, style in record_columns:
|
||||||
|
record_table.add_column(
|
||||||
|
Text(header_text, justify='center'),
|
||||||
|
justify=justify,
|
||||||
|
style=style,
|
||||||
|
)
|
||||||
|
|
||||||
|
record_table.add_row(
|
||||||
|
'Directory',
|
||||||
|
resp.record_directory,
|
||||||
|
style='' if record_table.row_count % 2 == 0 else 'dim',
|
||||||
|
)
|
||||||
|
|
||||||
|
if record:
|
||||||
|
console.out.print(record_table)
|
||||||
|
|
||||||
|
profile_table = Table(
|
||||||
|
title='Profile Settings',
|
||||||
|
padding=(0, 2),
|
||||||
|
border_style=ctx.obj['style'].border,
|
||||||
|
)
|
||||||
|
profile_columns = (
|
||||||
|
('Setting', 'left', ctx.obj['style'].column),
|
||||||
|
('Value', 'left', ctx.obj['style'].column),
|
||||||
|
)
|
||||||
|
for header_text, justify, style in profile_columns:
|
||||||
|
profile_table.add_column(
|
||||||
|
Text(header_text, justify='center'),
|
||||||
|
justify=justify,
|
||||||
|
style=style,
|
||||||
|
)
|
||||||
|
|
||||||
|
params = [
|
||||||
|
('Output', 'Mode', 'Output Mode'),
|
||||||
|
('SimpleOutput', 'StreamEncoder', 'Simple Streaming Encoder'),
|
||||||
|
('SimpleOutput', 'RecEncoder', 'Simple Recording Encoder'),
|
||||||
|
('SimpleOutput', 'RecFormat2', 'Simple Recording Video Format'),
|
||||||
|
('SimpleOutput', 'RecAudioEncoder', 'Simple Recording Audio Format'),
|
||||||
|
('SimpleOutput', 'RecQuality', 'Simple Recording Quality'),
|
||||||
|
('AdvOut', 'Encoder', 'Advanced Streaming Encoder'),
|
||||||
|
('AdvOut', 'RecEncoder', 'Advanced Recording Encoder'),
|
||||||
|
('AdvOut', 'RecType', 'Advanced Recording Type'),
|
||||||
|
('AdvOut', 'RecFormat2', 'Advanced Recording Video Format'),
|
||||||
|
('AdvOut', 'RecAudioEncoder', 'Advanced Recording Audio Format'),
|
||||||
|
]
|
||||||
|
|
||||||
|
for category, name, display_name in params:
|
||||||
|
resp = ctx.obj['obsws'].get_profile_parameter(
|
||||||
|
category=category,
|
||||||
|
name=name,
|
||||||
|
)
|
||||||
|
if resp.parameter_value is not None:
|
||||||
|
profile_table.add_row(
|
||||||
|
display_name,
|
||||||
|
str(resp.parameter_value),
|
||||||
|
style='' if profile_table.row_count % 2 == 0 else 'dim',
|
||||||
|
)
|
||||||
|
|
||||||
|
if profile:
|
||||||
|
console.out.print(profile_table)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('profile')
|
||||||
|
@app.command('pr', hidden=True)
|
||||||
|
def profile(
|
||||||
|
ctx: typer.Context,
|
||||||
|
category: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
help='Profile parameter category (e.g., SimpleOutput, AdvOut).',
|
||||||
|
),
|
||||||
|
],
|
||||||
|
name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
help='Profile parameter name (e.g., StreamEncoder, RecFormat2).',
|
||||||
|
),
|
||||||
|
],
|
||||||
|
value: Annotated[
|
||||||
|
Optional[str],
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
help='Value to set for the profile parameter. If omitted, the current value is retrieved.',
|
||||||
|
),
|
||||||
|
] = None,
|
||||||
|
):
|
||||||
|
"""Get/set OBS profile settings."""
|
||||||
|
if value is None:
|
||||||
|
resp = ctx.obj['obsws'].get_profile_parameter(
|
||||||
|
category=category,
|
||||||
|
name=name,
|
||||||
|
)
|
||||||
|
console.out.print(
|
||||||
|
f'Parameter Value for [bold]{name}[/bold]: '
|
||||||
|
f'[green]{resp.parameter_value}[/green]'
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
ctx.obj['obsws'].set_profile_parameter(
|
||||||
|
category=category,
|
||||||
|
name=name,
|
||||||
|
value=value,
|
||||||
|
)
|
||||||
|
console.out.print(
|
||||||
|
f'Set Parameter [bold]{name}[/bold] to [green]{value}[/green]'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('stream-service')
|
||||||
|
@app.command('ss', hidden=True)
|
||||||
|
def stream_service(
|
||||||
|
ctx: typer.Context,
|
||||||
|
type_: Annotated[
|
||||||
|
Optional[str],
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
help='Stream service type (e.g., Twitch, YouTube). If omitted, current settings are retrieved.',
|
||||||
|
),
|
||||||
|
] = None,
|
||||||
|
key: Annotated[
|
||||||
|
Optional[str],
|
||||||
|
typer.Option('--key', '-k', help='Stream key to set. Optional.'),
|
||||||
|
] = None,
|
||||||
|
server: Annotated[
|
||||||
|
Optional[str],
|
||||||
|
typer.Option('--server', '-s', help='Stream server to set. Optional.'),
|
||||||
|
] = None,
|
||||||
|
):
|
||||||
|
"""Get/set OBS stream service settings."""
|
||||||
|
if type_ is None:
|
||||||
|
resp = ctx.obj['obsws'].get_stream_service_settings()
|
||||||
|
table = Table(
|
||||||
|
title='Stream Service Settings',
|
||||||
|
padding=(0, 2),
|
||||||
|
border_style=ctx.obj['style'].border,
|
||||||
|
)
|
||||||
|
columns = (
|
||||||
|
('Setting', 'left', ctx.obj['style'].column),
|
||||||
|
('Value', 'left', ctx.obj['style'].column),
|
||||||
|
)
|
||||||
|
for header_text, justify, style in columns:
|
||||||
|
table.add_column(
|
||||||
|
Text(header_text, justify='center'),
|
||||||
|
justify=justify,
|
||||||
|
style=style,
|
||||||
|
)
|
||||||
|
table.add_row(
|
||||||
|
'Type',
|
||||||
|
resp.stream_service_type,
|
||||||
|
style='' if table.row_count % 2 == 0 else 'dim',
|
||||||
|
)
|
||||||
|
table.add_row(
|
||||||
|
'Server',
|
||||||
|
resp.stream_service_settings.get('server', ''),
|
||||||
|
style='' if table.row_count % 2 == 0 else 'dim',
|
||||||
|
)
|
||||||
|
table.add_row(
|
||||||
|
'Key',
|
||||||
|
resp.stream_service_settings.get('key', ''),
|
||||||
|
style='' if table.row_count % 2 == 0 else 'dim',
|
||||||
|
)
|
||||||
|
console.out.print(table)
|
||||||
|
else:
|
||||||
|
current_settings = ctx.obj['obsws'].get_stream_service_settings()
|
||||||
|
if key is None:
|
||||||
|
key = current_settings.stream_service_settings.get('key', '')
|
||||||
|
if server is None:
|
||||||
|
server = current_settings.stream_service_settings.get('server', '')
|
||||||
|
|
||||||
|
ctx.obj['obsws'].set_stream_service_settings(
|
||||||
|
ss_type=type_,
|
||||||
|
ss_settings={'key': key, 'server': server},
|
||||||
|
)
|
||||||
|
console.out.print('Stream service settings updated.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('video')
|
||||||
|
@app.command('vi', hidden=True)
|
||||||
|
def video(
|
||||||
|
ctx: typer.Context,
|
||||||
|
base_width: Annotated[
|
||||||
|
Optional[int],
|
||||||
|
typer.Option('--base-width', '-bw', help='Set base (canvas) width.'),
|
||||||
|
] = None,
|
||||||
|
base_height: Annotated[
|
||||||
|
Optional[int],
|
||||||
|
typer.Option('--base-height', '-bh', help='Set base (canvas) height.'),
|
||||||
|
] = None,
|
||||||
|
output_width: Annotated[
|
||||||
|
Optional[int],
|
||||||
|
typer.Option('--output-width', '-ow', help='Set output (scaled) width.'),
|
||||||
|
] = None,
|
||||||
|
output_height: Annotated[
|
||||||
|
Optional[int],
|
||||||
|
typer.Option('--output-height', '-oh', help='Set output (scaled) height.'),
|
||||||
|
] = None,
|
||||||
|
fps_num: Annotated[
|
||||||
|
Optional[int],
|
||||||
|
typer.Option('--fps-num', '-fn', help='Set FPS numerator.'),
|
||||||
|
] = None,
|
||||||
|
fps_den: Annotated[
|
||||||
|
Optional[int],
|
||||||
|
typer.Option('--fps-den', '-fd', help='Set FPS denominator.'),
|
||||||
|
] = None,
|
||||||
|
):
|
||||||
|
"""Get/set OBS video settings."""
|
||||||
|
if not any(
|
||||||
|
[
|
||||||
|
base_width,
|
||||||
|
base_height,
|
||||||
|
output_width,
|
||||||
|
output_height,
|
||||||
|
fps_num,
|
||||||
|
fps_den,
|
||||||
|
]
|
||||||
|
):
|
||||||
|
resp = ctx.obj['obsws'].get_video_settings()
|
||||||
|
table = Table(
|
||||||
|
title='Video Settings',
|
||||||
|
padding=(0, 2),
|
||||||
|
border_style=ctx.obj['style'].border,
|
||||||
|
)
|
||||||
|
columns = (
|
||||||
|
('Setting', 'left', ctx.obj['style'].column),
|
||||||
|
('Value', 'left', ctx.obj['style'].column),
|
||||||
|
)
|
||||||
|
for header_text, justify, style in columns:
|
||||||
|
table.add_column(
|
||||||
|
Text(header_text, justify='center'),
|
||||||
|
justify=justify,
|
||||||
|
style=style,
|
||||||
|
)
|
||||||
|
for setting in resp.attrs():
|
||||||
|
table.add_row(
|
||||||
|
util.snakecase_to_titlecase(setting),
|
||||||
|
str(getattr(resp, setting)),
|
||||||
|
style='' if table.row_count % 2 == 0 else 'dim',
|
||||||
|
)
|
||||||
|
console.out.print(table)
|
||||||
|
else:
|
||||||
|
current_settings = ctx.obj['obsws'].get_video_settings()
|
||||||
|
if base_width is None:
|
||||||
|
base_width = current_settings.base_width
|
||||||
|
if base_height is None:
|
||||||
|
base_height = current_settings.base_height
|
||||||
|
if output_width is None:
|
||||||
|
output_width = current_settings.output_width
|
||||||
|
if output_height is None:
|
||||||
|
output_height = current_settings.output_height
|
||||||
|
if fps_num is None:
|
||||||
|
fps_num = current_settings.fps_num
|
||||||
|
if fps_den is None:
|
||||||
|
fps_den = current_settings.fps_den
|
||||||
|
|
||||||
|
ctx.obj['obsws'].set_video_settings(
|
||||||
|
base_width=base_width,
|
||||||
|
base_height=base_height,
|
||||||
|
out_width=output_width,
|
||||||
|
out_height=output_height,
|
||||||
|
numerator=fps_num,
|
||||||
|
denominator=fps_den,
|
||||||
|
)
|
||||||
|
console.out.print('Video settings updated.')
|
||||||
@@ -2,10 +2,9 @@
|
|||||||
|
|
||||||
import typer
|
import typer
|
||||||
|
|
||||||
from . import console
|
from obsws_cli import console
|
||||||
from .alias import SubTyperAliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
@@ -19,7 +18,8 @@ def _get_streaming_status(ctx: typer.Context) -> tuple:
|
|||||||
return resp.output_active, resp.output_duration
|
return resp.output_active, resp.output_duration
|
||||||
|
|
||||||
|
|
||||||
@app.command('start | s')
|
@app.command('start')
|
||||||
|
@app.command('s', hidden=True)
|
||||||
def start(ctx: typer.Context):
|
def start(ctx: typer.Context):
|
||||||
"""Start streaming."""
|
"""Start streaming."""
|
||||||
active, _ = _get_streaming_status(ctx)
|
active, _ = _get_streaming_status(ctx)
|
||||||
@@ -31,7 +31,8 @@ def start(ctx: typer.Context):
|
|||||||
console.out.print('Streaming started successfully.')
|
console.out.print('Streaming started successfully.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('stop | st')
|
@app.command('stop')
|
||||||
|
@app.command('st', hidden=True)
|
||||||
def stop(ctx: typer.Context):
|
def stop(ctx: typer.Context):
|
||||||
"""Stop streaming."""
|
"""Stop streaming."""
|
||||||
active, _ = _get_streaming_status(ctx)
|
active, _ = _get_streaming_status(ctx)
|
||||||
@@ -43,7 +44,8 @@ def stop(ctx: typer.Context):
|
|||||||
console.out.print('Streaming stopped successfully.')
|
console.out.print('Streaming stopped successfully.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
@app.command('toggle')
|
||||||
|
@app.command('tg', hidden=True)
|
||||||
def toggle(ctx: typer.Context):
|
def toggle(ctx: typer.Context):
|
||||||
"""Toggle streaming."""
|
"""Toggle streaming."""
|
||||||
resp = ctx.obj['obsws'].toggle_stream()
|
resp = ctx.obj['obsws'].toggle_stream()
|
||||||
@@ -53,7 +55,8 @@ def toggle(ctx: typer.Context):
|
|||||||
console.out.print('Streaming stopped successfully.')
|
console.out.print('Streaming stopped successfully.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('status | ss')
|
@app.command('status')
|
||||||
|
@app.command('ss', hidden=True)
|
||||||
def status(ctx: typer.Context):
|
def status(ctx: typer.Context):
|
||||||
"""Get streaming status."""
|
"""Get streaming status."""
|
||||||
active, duration = _get_streaming_status(ctx)
|
active, duration = _get_streaming_status(ctx)
|
||||||
@@ -2,10 +2,9 @@
|
|||||||
|
|
||||||
import typer
|
import typer
|
||||||
|
|
||||||
from . import console
|
from obsws_cli import console
|
||||||
from .alias import SubTyperAliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
@@ -13,21 +12,24 @@ def main():
|
|||||||
"""Control studio mode in OBS."""
|
"""Control studio mode in OBS."""
|
||||||
|
|
||||||
|
|
||||||
@app.command('enable | on')
|
@app.command('enable')
|
||||||
|
@app.command('on', hidden=True)
|
||||||
def enable(ctx: typer.Context):
|
def enable(ctx: typer.Context):
|
||||||
"""Enable studio mode."""
|
"""Enable studio mode."""
|
||||||
ctx.obj['obsws'].set_studio_mode_enabled(True)
|
ctx.obj['obsws'].set_studio_mode_enabled(True)
|
||||||
console.out.print('Studio mode has been enabled.')
|
console.out.print('Studio mode has been enabled.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('disable | off')
|
@app.command('disable')
|
||||||
|
@app.command('off', hidden=True)
|
||||||
def disable(ctx: typer.Context):
|
def disable(ctx: typer.Context):
|
||||||
"""Disable studio mode."""
|
"""Disable studio mode."""
|
||||||
ctx.obj['obsws'].set_studio_mode_enabled(False)
|
ctx.obj['obsws'].set_studio_mode_enabled(False)
|
||||||
console.out.print('Studio mode has been disabled.')
|
console.out.print('Studio mode has been disabled.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
@app.command('toggle')
|
||||||
|
@app.command('tg', hidden=True)
|
||||||
def toggle(ctx: typer.Context):
|
def toggle(ctx: typer.Context):
|
||||||
"""Toggle studio mode."""
|
"""Toggle studio mode."""
|
||||||
resp = ctx.obj['obsws'].get_studio_mode_enabled()
|
resp = ctx.obj['obsws'].get_studio_mode_enabled()
|
||||||
@@ -39,7 +41,8 @@ def toggle(ctx: typer.Context):
|
|||||||
console.out.print('Studio mode is now enabled.')
|
console.out.print('Studio mode is now enabled.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('status | ss')
|
@app.command('status')
|
||||||
|
@app.command('ss', hidden=True)
|
||||||
def status(ctx: typer.Context):
|
def status(ctx: typer.Context):
|
||||||
"""Get the status of studio mode."""
|
"""Get the status of studio mode."""
|
||||||
resp = ctx.obj['obsws'].get_studio_mode_enabled()
|
resp = ctx.obj['obsws'].get_studio_mode_enabled()
|
||||||
@@ -4,10 +4,9 @@ from typing import Annotated, Optional
|
|||||||
|
|
||||||
import typer
|
import typer
|
||||||
|
|
||||||
from . import console, validate
|
from obsws_cli import console, validate
|
||||||
from .alias import SubTyperAliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
@@ -15,16 +14,18 @@ def main():
|
|||||||
"""Control text inputs in OBS."""
|
"""Control text inputs in OBS."""
|
||||||
|
|
||||||
|
|
||||||
@app.command('current | get')
|
@app.command('current')
|
||||||
|
@app.command('get', hidden=True)
|
||||||
def current(
|
def current(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
input_name: Annotated[str, typer.Argument(help='Name of the text input to get.')],
|
input_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
help='Name of the text input to get.', callback=validate.input_in_inputs
|
||||||
|
),
|
||||||
|
],
|
||||||
):
|
):
|
||||||
"""Get the current text for a text input."""
|
"""Get the current text for a text input."""
|
||||||
if not validate.input_in_inputs(ctx, input_name):
|
|
||||||
console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj['obsws'].get_input_settings(name=input_name)
|
resp = ctx.obj['obsws'].get_input_settings(name=input_name)
|
||||||
if not resp.input_kind.startswith('text_'):
|
if not resp.input_kind.startswith('text_'):
|
||||||
console.err.print(
|
console.err.print(
|
||||||
@@ -40,11 +41,15 @@ def current(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('update | set')
|
@app.command('update')
|
||||||
|
@app.command('set', hidden=True)
|
||||||
def update(
|
def update(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
input_name: Annotated[
|
input_name: Annotated[
|
||||||
str, typer.Argument(help='Name of the text input to update.')
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
help='Name of the text input to update.', callback=validate.input_in_inputs
|
||||||
|
),
|
||||||
],
|
],
|
||||||
new_text: Annotated[
|
new_text: Annotated[
|
||||||
Optional[str],
|
Optional[str],
|
||||||
@@ -54,10 +59,6 @@ def update(
|
|||||||
] = None,
|
] = None,
|
||||||
):
|
):
|
||||||
"""Update the text of a text input."""
|
"""Update the text of a text input."""
|
||||||
if not validate.input_in_inputs(ctx, input_name):
|
|
||||||
console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj['obsws'].get_input_settings(name=input_name)
|
resp = ctx.obj['obsws'].get_input_settings(name=input_name)
|
||||||
if not resp.input_kind.startswith('text_'):
|
if not resp.input_kind.startswith('text_'):
|
||||||
console.err.print(
|
console.err.print(
|
||||||
@@ -2,10 +2,9 @@
|
|||||||
|
|
||||||
import typer
|
import typer
|
||||||
|
|
||||||
from . import console
|
from obsws_cli import console
|
||||||
from .alias import SubTyperAliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
@@ -13,21 +12,24 @@ def main():
|
|||||||
"""Control virtual camera in OBS."""
|
"""Control virtual camera in OBS."""
|
||||||
|
|
||||||
|
|
||||||
@app.command('start | s')
|
@app.command('start')
|
||||||
|
@app.command('s', hidden=True)
|
||||||
def start(ctx: typer.Context):
|
def start(ctx: typer.Context):
|
||||||
"""Start the virtual camera."""
|
"""Start the virtual camera."""
|
||||||
ctx.obj['obsws'].start_virtual_cam()
|
ctx.obj['obsws'].start_virtual_cam()
|
||||||
console.out.print('Virtual camera started.')
|
console.out.print('Virtual camera started.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('stop | p')
|
@app.command('stop')
|
||||||
|
@app.command('p', hidden=True)
|
||||||
def stop(ctx: typer.Context):
|
def stop(ctx: typer.Context):
|
||||||
"""Stop the virtual camera."""
|
"""Stop the virtual camera."""
|
||||||
ctx.obj['obsws'].stop_virtual_cam()
|
ctx.obj['obsws'].stop_virtual_cam()
|
||||||
console.out.print('Virtual camera stopped.')
|
console.out.print('Virtual camera stopped.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
@app.command('toggle')
|
||||||
|
@app.command('tg', hidden=True)
|
||||||
def toggle(ctx: typer.Context):
|
def toggle(ctx: typer.Context):
|
||||||
"""Toggle the virtual camera."""
|
"""Toggle the virtual camera."""
|
||||||
resp = ctx.obj['obsws'].toggle_virtual_cam()
|
resp = ctx.obj['obsws'].toggle_virtual_cam()
|
||||||
@@ -37,7 +39,8 @@ def toggle(ctx: typer.Context):
|
|||||||
console.out.print('Virtual camera is disabled.')
|
console.out.print('Virtual camera is disabled.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('status | ss')
|
@app.command('status')
|
||||||
|
@app.command('ss', hidden=True)
|
||||||
def status(ctx: typer.Context):
|
def status(ctx: typer.Context):
|
||||||
"""Get the status of the virtual camera."""
|
"""Get the status of the virtual camera."""
|
||||||
resp = ctx.obj['obsws'].get_virtual_cam_status()
|
resp = ctx.obj['obsws'].get_virtual_cam_status()
|
||||||
146
obsws_cli/envconfig.py
Normal file
146
obsws_cli/envconfig.py
Normal file
@@ -0,0 +1,146 @@
|
|||||||
|
"""module for settings management for obsws-cli."""
|
||||||
|
|
||||||
|
from collections import UserDict
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Any, Union
|
||||||
|
|
||||||
|
from dotenv import dotenv_values
|
||||||
|
|
||||||
|
ConfigValue = Union[str, int, bool]
|
||||||
|
|
||||||
|
|
||||||
|
class EnvConfig(UserDict):
|
||||||
|
"""A class to manage .env config for obsws-cli.
|
||||||
|
|
||||||
|
This class extends UserDict to provide a dictionary-like interface for config.
|
||||||
|
It loads config from .env files in the following priority:
|
||||||
|
1. Local .env file
|
||||||
|
2. User config file (~/.config/obsws-cli/obsws.env)
|
||||||
|
3. Default values
|
||||||
|
|
||||||
|
Note, typer handles reading from environment variables automatically. They take precedence
|
||||||
|
over values set in this class.
|
||||||
|
|
||||||
|
The config values are expected to be in uppercase and should start with 'OBSWS_CLI_'.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
-------
|
||||||
|
config = EnvConfig()
|
||||||
|
host = config['OBSWS_CLI_HOST']
|
||||||
|
config['OBSWS_CLI_PORT'] = 4455
|
||||||
|
# Or with defaults
|
||||||
|
timeout = config.get('OBSWS_CLI_TIMEOUT', 30)
|
||||||
|
# Keys will be normalised to uppercase with prefix
|
||||||
|
debug = config.get('debug', False) # Equivalent to 'OBSWS_CLI_DEBUG'
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
PREFIX = 'OBSWS_CLI_'
|
||||||
|
|
||||||
|
def __init__(self, *args, **kwargs):
|
||||||
|
"""Initialize the Config object with hierarchical loading."""
|
||||||
|
kwargs.update(
|
||||||
|
{
|
||||||
|
**dotenv_values(Path.home() / '.config' / 'obsws-cli' / 'obsws.env'),
|
||||||
|
**dotenv_values('.env'),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
super().__init__(*args, **self._convert_types(kwargs))
|
||||||
|
|
||||||
|
def _convert_types(self, config_data: dict[str, Any]) -> dict[str, ConfigValue]:
|
||||||
|
"""Convert string values to appropriate types."""
|
||||||
|
converted = {}
|
||||||
|
for key, value in config_data.items():
|
||||||
|
if isinstance(value, str):
|
||||||
|
if value.lower() in ('true', 'false'):
|
||||||
|
converted[key] = value.lower() == 'true'
|
||||||
|
elif value.isdigit():
|
||||||
|
converted[key] = int(value)
|
||||||
|
else:
|
||||||
|
converted[key] = value
|
||||||
|
else:
|
||||||
|
converted[key] = value
|
||||||
|
return converted
|
||||||
|
|
||||||
|
def __getitem__(self, key: str) -> ConfigValue:
|
||||||
|
"""Get a setting value by key."""
|
||||||
|
normalised_key = self._normalise_key(key)
|
||||||
|
try:
|
||||||
|
return self.data[normalised_key]
|
||||||
|
except KeyError as e:
|
||||||
|
raise KeyError(
|
||||||
|
f"Config key '{key}' not found. Available keys: {list(self.data.keys())}"
|
||||||
|
) from e
|
||||||
|
|
||||||
|
def __setitem__(self, key: str, value: ConfigValue):
|
||||||
|
"""Set a setting value by key."""
|
||||||
|
normalised_key = self._normalise_key(key)
|
||||||
|
self.data[normalised_key] = value
|
||||||
|
|
||||||
|
def _normalise_key(self, key: str) -> str:
|
||||||
|
"""Normalise a key to uppercase with OBS_ prefix."""
|
||||||
|
key = key.upper()
|
||||||
|
if not key.startswith(self.PREFIX):
|
||||||
|
key = f'{self.PREFIX}{key}'
|
||||||
|
return key
|
||||||
|
|
||||||
|
def get(self, key: str, default=None) -> ConfigValue:
|
||||||
|
"""Get a config value with optional default.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
----
|
||||||
|
key (str): The key to retrieve
|
||||||
|
default: Default value if key is not found
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
-------
|
||||||
|
The config value or default
|
||||||
|
|
||||||
|
"""
|
||||||
|
normalised_key = self._normalise_key(key)
|
||||||
|
if not self.has_key(normalised_key):
|
||||||
|
return default
|
||||||
|
return self[normalised_key]
|
||||||
|
|
||||||
|
def has_key(self, key: str) -> bool:
|
||||||
|
"""Check if a config key exists.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
----
|
||||||
|
key (str): The key to check
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
-------
|
||||||
|
bool: True if key exists, False otherwise
|
||||||
|
|
||||||
|
"""
|
||||||
|
normalised_key = self._normalise_key(key)
|
||||||
|
return normalised_key in self.data
|
||||||
|
|
||||||
|
|
||||||
|
_envconfig = EnvConfig(
|
||||||
|
OBSWS_CLI_HOST='localhost',
|
||||||
|
OBSWS_CLI_PORT=4455,
|
||||||
|
OBSWS_CLI_PASSWORD='',
|
||||||
|
OBSWS_CLI_TIMEOUT=5,
|
||||||
|
OBSWS_CLI_LOGLEVEL='WARNING',
|
||||||
|
OBSWS_CLI_STYLE='disabled',
|
||||||
|
OBSWS_CLI_STYLE_NO_BORDER=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def get(key: str) -> ConfigValue:
|
||||||
|
"""Get a setting value by key from the global config instance.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
----
|
||||||
|
key (str): The key of the config to retrieve.
|
||||||
|
default: Default value if key is not found.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
-------
|
||||||
|
The value of the config or default value.
|
||||||
|
|
||||||
|
"""
|
||||||
|
return _envconfig.get(key)
|
||||||
@@ -1,177 +0,0 @@
|
|||||||
"""module containing commands for manipulating inputs."""
|
|
||||||
|
|
||||||
from typing import Annotated
|
|
||||||
|
|
||||||
import obsws_python as obsws
|
|
||||||
import typer
|
|
||||||
from rich.table import Table
|
|
||||||
from rich.text import Text
|
|
||||||
|
|
||||||
from . import console, util, validate
|
|
||||||
from .alias import SubTyperAliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
|
||||||
def main():
|
|
||||||
"""Control inputs in OBS."""
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('list | ls')
|
|
||||||
def list_(
|
|
||||||
ctx: typer.Context,
|
|
||||||
input: Annotated[bool, typer.Option(help='Filter by input type.')] = False,
|
|
||||||
output: Annotated[bool, typer.Option(help='Filter by output type.')] = False,
|
|
||||||
colour: Annotated[bool, typer.Option(help='Filter by colour source type.')] = False,
|
|
||||||
ffmpeg: Annotated[bool, typer.Option(help='Filter by ffmpeg source type.')] = False,
|
|
||||||
vlc: Annotated[bool, typer.Option(help='Filter by VLC source type.')] = False,
|
|
||||||
uuid: Annotated[bool, typer.Option(help='Show UUIDs of inputs.')] = False,
|
|
||||||
):
|
|
||||||
"""List all inputs."""
|
|
||||||
resp = ctx.obj['obsws'].get_input_list()
|
|
||||||
|
|
||||||
kinds = []
|
|
||||||
if input:
|
|
||||||
kinds.append('input')
|
|
||||||
if output:
|
|
||||||
kinds.append('output')
|
|
||||||
if colour:
|
|
||||||
kinds.append('color')
|
|
||||||
if ffmpeg:
|
|
||||||
kinds.append('ffmpeg')
|
|
||||||
if vlc:
|
|
||||||
kinds.append('vlc')
|
|
||||||
if not any([input, output, colour, ffmpeg, vlc]):
|
|
||||||
kinds = ctx.obj['obsws'].get_input_kind_list(False).input_kinds
|
|
||||||
|
|
||||||
inputs = sorted(
|
|
||||||
(
|
|
||||||
(input_.get('inputName'), input_.get('inputKind'), input_.get('inputUuid'))
|
|
||||||
for input_ in filter(
|
|
||||||
lambda input_: any(kind in input_.get('inputKind') for kind in kinds),
|
|
||||||
resp.inputs,
|
|
||||||
)
|
|
||||||
),
|
|
||||||
key=lambda x: x[0], # Sort by input name
|
|
||||||
)
|
|
||||||
|
|
||||||
if not inputs:
|
|
||||||
console.out.print('No inputs found.')
|
|
||||||
raise typer.Exit()
|
|
||||||
|
|
||||||
table = Table(title='Inputs', padding=(0, 2), border_style=ctx.obj['style'].border)
|
|
||||||
if uuid:
|
|
||||||
columns = [
|
|
||||||
(Text('Input Name', justify='center'), 'left', ctx.obj['style'].column),
|
|
||||||
(Text('Kind', justify='center'), 'center', ctx.obj['style'].column),
|
|
||||||
(Text('Muted', justify='center'), 'center', None),
|
|
||||||
(Text('UUID', justify='center'), 'left', ctx.obj['style'].column),
|
|
||||||
]
|
|
||||||
else:
|
|
||||||
columns = [
|
|
||||||
(Text('Input Name', justify='center'), 'left', ctx.obj['style'].column),
|
|
||||||
(Text('Kind', justify='center'), 'center', ctx.obj['style'].column),
|
|
||||||
(Text('Muted', justify='center'), 'center', None),
|
|
||||||
]
|
|
||||||
for heading, justify, style in columns:
|
|
||||||
table.add_column(heading, justify=justify, style=style)
|
|
||||||
|
|
||||||
for input_name, input_kind, input_uuid in inputs:
|
|
||||||
input_mark = ''
|
|
||||||
try:
|
|
||||||
input_muted = ctx.obj['obsws'].get_input_mute(name=input_name).input_muted
|
|
||||||
input_mark = util.check_mark(input_muted)
|
|
||||||
except obsws.error.OBSSDKRequestError as e:
|
|
||||||
if e.code == 604: # Input does not support audio
|
|
||||||
input_mark = 'N/A'
|
|
||||||
else:
|
|
||||||
raise
|
|
||||||
|
|
||||||
if uuid:
|
|
||||||
table.add_row(
|
|
||||||
input_name,
|
|
||||||
util.snakecase_to_titlecase(input_kind),
|
|
||||||
input_mark,
|
|
||||||
input_uuid,
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
table.add_row(
|
|
||||||
input_name,
|
|
||||||
util.snakecase_to_titlecase(input_kind),
|
|
||||||
input_mark,
|
|
||||||
)
|
|
||||||
|
|
||||||
console.out.print(table)
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('mute | m')
|
|
||||||
def mute(
|
|
||||||
ctx: typer.Context,
|
|
||||||
input_name: Annotated[
|
|
||||||
str, typer.Argument(..., show_default=False, help='Name of the input to mute.')
|
|
||||||
],
|
|
||||||
):
|
|
||||||
"""Mute an input."""
|
|
||||||
if not validate.input_in_inputs(ctx, input_name):
|
|
||||||
console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj['obsws'].set_input_mute(
|
|
||||||
name=input_name,
|
|
||||||
muted=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
console.out.print(f'Input {console.highlight(ctx, input_name)} muted.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('unmute | um')
|
|
||||||
def unmute(
|
|
||||||
ctx: typer.Context,
|
|
||||||
input_name: Annotated[
|
|
||||||
str,
|
|
||||||
typer.Argument(..., show_default=False, help='Name of the input to unmute.'),
|
|
||||||
],
|
|
||||||
):
|
|
||||||
"""Unmute an input."""
|
|
||||||
if not validate.input_in_inputs(ctx, input_name):
|
|
||||||
console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj['obsws'].set_input_mute(
|
|
||||||
name=input_name,
|
|
||||||
muted=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
console.out.print(f'Input {console.highlight(ctx, input_name)} unmuted.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
|
||||||
def toggle(
|
|
||||||
ctx: typer.Context,
|
|
||||||
input_name: Annotated[
|
|
||||||
str,
|
|
||||||
typer.Argument(..., show_default=False, help='Name of the input to toggle.'),
|
|
||||||
],
|
|
||||||
):
|
|
||||||
"""Toggle an input."""
|
|
||||||
if not validate.input_in_inputs(ctx, input_name):
|
|
||||||
console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj['obsws'].get_input_mute(name=input_name)
|
|
||||||
new_state = not resp.input_muted
|
|
||||||
|
|
||||||
ctx.obj['obsws'].set_input_mute(
|
|
||||||
name=input_name,
|
|
||||||
muted=new_state,
|
|
||||||
)
|
|
||||||
|
|
||||||
if new_state:
|
|
||||||
console.out.print(
|
|
||||||
f'Input {console.highlight(ctx, input_name)} muted.',
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
console.out.print(
|
|
||||||
f'Input {console.highlight(ctx, input_name)} unmuted.',
|
|
||||||
)
|
|
||||||
@@ -1,80 +0,0 @@
|
|||||||
"""module for settings management for obsws-cli."""
|
|
||||||
|
|
||||||
from collections import UserDict
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
from dotenv import dotenv_values
|
|
||||||
|
|
||||||
SettingsValue = str | int
|
|
||||||
|
|
||||||
|
|
||||||
class Settings(UserDict):
|
|
||||||
"""A class to manage settings for obsws-cli.
|
|
||||||
|
|
||||||
This class extends UserDict to provide a dictionary-like interface for settings.
|
|
||||||
It loads settings from environment variables and .env files.
|
|
||||||
The settings are expected to be in uppercase and should start with 'OBS_'.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
-------
|
|
||||||
settings = Settings()
|
|
||||||
host = settings['OBS_HOST']
|
|
||||||
settings['OBS_PORT'] = 4455
|
|
||||||
|
|
||||||
"""
|
|
||||||
|
|
||||||
PREFIX = 'OBS_'
|
|
||||||
|
|
||||||
def __init__(self, *args, **kwargs):
|
|
||||||
"""Initialize the Settings object."""
|
|
||||||
kwargs.update(
|
|
||||||
{
|
|
||||||
**dotenv_values('.env'),
|
|
||||||
**dotenv_values(Path.home() / '.config' / 'obsws-cli' / 'obsws.env'),
|
|
||||||
}
|
|
||||||
)
|
|
||||||
super().__init__(*args, **kwargs)
|
|
||||||
|
|
||||||
def __getitem__(self, key: str) -> SettingsValue:
|
|
||||||
"""Get a setting value by key."""
|
|
||||||
key = key.upper()
|
|
||||||
if not key.startswith(Settings.PREFIX):
|
|
||||||
key = f'{Settings.PREFIX}{key}'
|
|
||||||
return self.data[key]
|
|
||||||
|
|
||||||
def __setitem__(self, key: str, value: SettingsValue):
|
|
||||||
"""Set a setting value by key."""
|
|
||||||
key = key.upper()
|
|
||||||
if not key.startswith(Settings.PREFIX):
|
|
||||||
key = f'{Settings.PREFIX}{key}'
|
|
||||||
self.data[key] = value
|
|
||||||
|
|
||||||
|
|
||||||
_settings = Settings(
|
|
||||||
OBS_HOST='localhost',
|
|
||||||
OBS_PORT=4455,
|
|
||||||
OBS_PASSWORD='',
|
|
||||||
OBS_TIMEOUT=5,
|
|
||||||
OBS_DEBUG=False,
|
|
||||||
OBS_STYLE='disabled',
|
|
||||||
OBS_STYLE_NO_BORDER=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def get(key: str) -> SettingsValue:
|
|
||||||
"""Get a setting value by key.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
----
|
|
||||||
key (str): The key of the setting to retrieve.
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
-------
|
|
||||||
The value of the setting.
|
|
||||||
|
|
||||||
Raises:
|
|
||||||
------
|
|
||||||
KeyError: If the key does not exist in the settings.
|
|
||||||
|
|
||||||
"""
|
|
||||||
return _settings[key]
|
|
||||||
@@ -20,3 +20,28 @@ def check_mark(value: bool, empty_if_false: bool = False) -> str:
|
|||||||
if os.getenv('NO_COLOR', '') != '':
|
if os.getenv('NO_COLOR', '') != '':
|
||||||
return '✓' if value else '✗'
|
return '✓' if value else '✗'
|
||||||
return '✅' if value else '❌'
|
return '✅' if value else '❌'
|
||||||
|
|
||||||
|
|
||||||
|
def timecode_to_milliseconds(timecode: str) -> int:
|
||||||
|
"""Convert a timecode string (HH:MM:SS) to total milliseconds."""
|
||||||
|
match timecode.split(':'):
|
||||||
|
case [mm, ss]:
|
||||||
|
hours = 0
|
||||||
|
minutes = int(mm)
|
||||||
|
seconds = int(ss)
|
||||||
|
case [hh, mm, ss]:
|
||||||
|
hours = int(hh)
|
||||||
|
minutes = int(mm)
|
||||||
|
seconds = int(ss)
|
||||||
|
return (hours * 3600 + minutes * 60 + seconds) * 1000
|
||||||
|
|
||||||
|
|
||||||
|
def milliseconds_to_timecode(milliseconds: int) -> str:
|
||||||
|
"""Convert total milliseconds to a timecode string (HH:MM:SS)."""
|
||||||
|
total_seconds = milliseconds // 1000
|
||||||
|
hours = total_seconds // 3600
|
||||||
|
minutes = (total_seconds % 3600) // 60
|
||||||
|
seconds = total_seconds % 60
|
||||||
|
if hours == 0:
|
||||||
|
return f'{minutes:02}:{seconds:02}'
|
||||||
|
return f'{hours:02}:{minutes:02}:{seconds:02}'
|
||||||
|
|||||||
@@ -1,37 +1,84 @@
|
|||||||
"""module containing validation functions."""
|
"""module containing validation functions."""
|
||||||
|
|
||||||
|
from typing import Optional
|
||||||
|
|
||||||
import typer
|
import typer
|
||||||
|
|
||||||
|
from . import console
|
||||||
|
|
||||||
# type alias for an option that is skipped when the command is run
|
# type alias for an option that is skipped when the command is run
|
||||||
skipped_option = typer.Option(parser=lambda _: _, hidden=True, expose_value=False)
|
skipped_option = typer.Option(parser=lambda _: _, hidden=True, expose_value=False)
|
||||||
|
|
||||||
|
|
||||||
def input_in_inputs(ctx: typer.Context, input_name: str) -> bool:
|
def input_in_inputs(ctx: typer.Context, input_name: str) -> str:
|
||||||
"""Check if an input is in the input list."""
|
"""Ensure the given input exists in the list of inputs."""
|
||||||
inputs = ctx.obj['obsws'].get_input_list().inputs
|
resp = ctx.obj['obsws'].get_input_list()
|
||||||
return any(input_.get('inputName') == input_name for input_ in inputs)
|
if not any(input.get('inputName') == input_name for input in resp.inputs):
|
||||||
|
console.err.print(f'Input [yellow]{input_name}[/yellow] does not exist.')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
return input_name
|
||||||
|
|
||||||
|
|
||||||
def scene_in_scenes(ctx: typer.Context, scene_name: str) -> bool:
|
def input_not_in_inputs(ctx: typer.Context, input_name: str) -> str:
|
||||||
|
"""Ensure an input does not already exist in the list of inputs."""
|
||||||
|
resp = ctx.obj['obsws'].get_input_list()
|
||||||
|
if any(input.get('inputName') == input_name for input in resp.inputs):
|
||||||
|
console.err.print(f'Input [yellow]{input_name}[/yellow] already exists.')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
return input_name
|
||||||
|
|
||||||
|
|
||||||
|
def scene_in_scenes(ctx: typer.Context, scene_name: Optional[str]) -> str | None:
|
||||||
"""Check if a scene exists in the list of scenes."""
|
"""Check if a scene exists in the list of scenes."""
|
||||||
|
if scene_name is None:
|
||||||
|
return
|
||||||
|
|
||||||
resp = ctx.obj['obsws'].get_scene_list()
|
resp = ctx.obj['obsws'].get_scene_list()
|
||||||
return any(scene.get('sceneName') == scene_name for scene in resp.scenes)
|
if not any(scene.get('sceneName') == scene_name for scene in resp.scenes):
|
||||||
|
console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
return scene_name
|
||||||
|
|
||||||
|
|
||||||
def studio_mode_enabled(ctx: typer.Context) -> bool:
|
def studio_mode_enabled(ctx: typer.Context, preview: bool) -> bool:
|
||||||
"""Check if studio mode is enabled."""
|
"""Ensure studio mode is enabled if preview option is used."""
|
||||||
resp = ctx.obj['obsws'].get_studio_mode_enabled()
|
resp = ctx.obj['obsws'].get_studio_mode_enabled()
|
||||||
return resp.studio_mode_enabled
|
if preview and not resp.studio_mode_enabled:
|
||||||
|
console.err.print(
|
||||||
|
'Studio mode is disabled. This action requires it to be enabled.'
|
||||||
|
)
|
||||||
|
raise typer.Exit(1)
|
||||||
|
return preview
|
||||||
|
|
||||||
|
|
||||||
def scene_collection_in_scene_collections(
|
def scene_collection_in_scene_collections(
|
||||||
ctx: typer.Context, scene_collection_name: str
|
ctx: typer.Context, scene_collection_name: str
|
||||||
) -> bool:
|
) -> str:
|
||||||
"""Check if a scene collection exists."""
|
"""Ensure a scene collection exists in the list of scene collections."""
|
||||||
resp = ctx.obj['obsws'].get_scene_collection_list()
|
resp = ctx.obj['obsws'].get_scene_collection_list()
|
||||||
return any(
|
if not any(
|
||||||
collection == scene_collection_name for collection in resp.scene_collections
|
collection == scene_collection_name for collection in resp.scene_collections
|
||||||
|
):
|
||||||
|
console.err.print(
|
||||||
|
f'Scene collection [yellow]{scene_collection_name}[/yellow] not found.'
|
||||||
)
|
)
|
||||||
|
raise typer.Exit(1)
|
||||||
|
return scene_collection_name
|
||||||
|
|
||||||
|
|
||||||
|
def scene_collection_not_in_scene_collections(
|
||||||
|
ctx: typer.Context, scene_collection_name: str
|
||||||
|
) -> str:
|
||||||
|
"""Ensure a scene collection does not already exist in the list of scene collections."""
|
||||||
|
resp = ctx.obj['obsws'].get_scene_collection_list()
|
||||||
|
if any(
|
||||||
|
collection == scene_collection_name for collection in resp.scene_collections
|
||||||
|
):
|
||||||
|
console.err.print(
|
||||||
|
f'Scene collection [yellow]{scene_collection_name}[/yellow] already exists.'
|
||||||
|
)
|
||||||
|
raise typer.Exit(1)
|
||||||
|
return scene_collection_name
|
||||||
|
|
||||||
|
|
||||||
def item_in_scene_item_list(
|
def item_in_scene_item_list(
|
||||||
@@ -42,13 +89,54 @@ def item_in_scene_item_list(
|
|||||||
return any(item.get('sourceName') == item_name for item in resp.scene_items)
|
return any(item.get('sourceName') == item_name for item in resp.scene_items)
|
||||||
|
|
||||||
|
|
||||||
def profile_exists(ctx: typer.Context, profile_name: str) -> bool:
|
def profile_exists(ctx: typer.Context, profile_name: str) -> str:
|
||||||
"""Check if a profile exists."""
|
"""Ensure a profile exists."""
|
||||||
resp = ctx.obj['obsws'].get_profile_list()
|
resp = ctx.obj['obsws'].get_profile_list()
|
||||||
return any(profile == profile_name for profile in resp.profiles)
|
if not any(profile == profile_name for profile in resp.profiles):
|
||||||
|
console.err.print(f'Profile [yellow]{profile_name}[/yellow] not found.')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
return profile_name
|
||||||
|
|
||||||
|
|
||||||
def monitor_exists(ctx: typer.Context, monitor_index: int) -> bool:
|
def profile_not_exists(ctx: typer.Context, profile_name: str) -> str:
|
||||||
"""Check if a monitor exists."""
|
"""Ensure a profile does not exist."""
|
||||||
resp = ctx.obj['obsws'].get_monitor_list()
|
resp = ctx.obj['obsws'].get_profile_list()
|
||||||
return any(monitor['monitorIndex'] == monitor_index for monitor in resp.monitors)
|
if any(profile == profile_name for profile in resp.profiles):
|
||||||
|
console.err.print(f'Profile [yellow]{profile_name}[/yellow] already exists.')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
return profile_name
|
||||||
|
|
||||||
|
|
||||||
|
def kind_in_input_kinds(ctx: typer.Context, input_kind: str) -> str:
|
||||||
|
"""Check if an input kind is valid."""
|
||||||
|
resp = ctx.obj['obsws'].get_input_kind_list(False)
|
||||||
|
if not any(kind == input_kind for kind in resp.input_kinds):
|
||||||
|
console.err.print(f'Input kind [yellow]{input_kind}[/yellow] not found.')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
return input_kind
|
||||||
|
|
||||||
|
|
||||||
|
def timecode_format(ctx: typer.Context, timecode: Optional[str]) -> str | None:
|
||||||
|
"""Validate that a timecode is in HH:MM:SS or MM:SS format."""
|
||||||
|
if timecode is None:
|
||||||
|
return
|
||||||
|
|
||||||
|
match timecode.split(':'):
|
||||||
|
case [mm, ss]:
|
||||||
|
if not (mm.isdigit() and ss.isdigit()):
|
||||||
|
console.err.print(
|
||||||
|
f'Timecode [yellow]{timecode}[/yellow] is not valid. Use MM:SS or HH:MM:SS format.'
|
||||||
|
)
|
||||||
|
raise typer.Exit(1)
|
||||||
|
case [hh, mm, ss]:
|
||||||
|
if not (hh.isdigit() and mm.isdigit() and ss.isdigit()):
|
||||||
|
console.err.print(
|
||||||
|
f'Timecode [yellow]{timecode}[/yellow] is not valid. Use MM:SS or HH:MM:SS format.'
|
||||||
|
)
|
||||||
|
raise typer.Exit(1)
|
||||||
|
case _:
|
||||||
|
console.err.print(
|
||||||
|
f'Timecode [yellow]{timecode}[/yellow] is not valid. Use MM:SS or HH:MM:SS format.'
|
||||||
|
)
|
||||||
|
raise typer.Exit(1)
|
||||||
|
return timecode
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ classifiers = [
|
|||||||
"Programming Language :: Python :: Implementation :: CPython",
|
"Programming Language :: Python :: Implementation :: CPython",
|
||||||
"Programming Language :: Python :: Implementation :: PyPy",
|
"Programming Language :: Python :: Implementation :: PyPy",
|
||||||
]
|
]
|
||||||
dependencies = ["typer>=0.16.0", "obsws-python>=1.8.0", "python-dotenv>=1.1.0"]
|
dependencies = ["typer>=0.24.1", "obsws-python>=1.8.0", "python-dotenv>=1.2.2"]
|
||||||
|
|
||||||
|
|
||||||
[project.urls]
|
[project.urls]
|
||||||
@@ -36,14 +36,17 @@ obsws-cli = "obsws_cli:app"
|
|||||||
path = "obsws_cli/__about__.py"
|
path = "obsws_cli/__about__.py"
|
||||||
|
|
||||||
[tool.hatch.envs.default]
|
[tool.hatch.envs.default]
|
||||||
|
workspace.members = [{ path = "../obsws-python" }]
|
||||||
dependencies = ["click-man>=0.5.1"]
|
dependencies = ["click-man>=0.5.1"]
|
||||||
|
|
||||||
[tool.hatch.envs.default.scripts]
|
[tool.hatch.envs.default.scripts]
|
||||||
cli = "obsws-cli {args:}"
|
|
||||||
man = "python man/generate.py --output=./man"
|
man = "python man/generate.py --output=./man"
|
||||||
|
|
||||||
[tool.hatch.envs.lazyimports.scripts]
|
[tool.hatch.env]
|
||||||
cli = "obsws-cli {args:}"
|
requires = ["hatch-dotenv"]
|
||||||
|
|
||||||
|
[tool.hatch.env.collectors.dotenv.hatch-test]
|
||||||
|
env-files = [".env", ".test.env"]
|
||||||
|
|
||||||
[tool.hatch.envs.hatch-test]
|
[tool.hatch.envs.hatch-test]
|
||||||
randomize = true
|
randomize = true
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
"""pytest configuration file."""
|
"""pytest configuration file."""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
import time
|
||||||
|
|
||||||
import obsws_python as obsws
|
import obsws_python as obsws
|
||||||
from dotenv import find_dotenv, load_dotenv
|
|
||||||
|
|
||||||
|
|
||||||
def pytest_configure(config):
|
def pytest_configure(config):
|
||||||
@@ -20,9 +20,9 @@ def pytest_sessionstart(session):
|
|||||||
"""
|
"""
|
||||||
# Initialize the OBS WebSocket client
|
# Initialize the OBS WebSocket client
|
||||||
session.obsws = obsws.ReqClient(
|
session.obsws = obsws.ReqClient(
|
||||||
host=os.environ['OBS_HOST'],
|
host=os.environ['OBSWS_CLI_HOST'],
|
||||||
port=os.environ['OBS_PORT'],
|
port=os.environ['OBSWS_CLI_PORT'],
|
||||||
password=os.environ['OBS_PASSWORD'],
|
password=os.environ['OBSWS_CLI_PASSWORD'],
|
||||||
timeout=5,
|
timeout=5,
|
||||||
)
|
)
|
||||||
resp = session.obsws.get_version()
|
resp = session.obsws.get_version()
|
||||||
@@ -33,20 +33,63 @@ def pytest_sessionstart(session):
|
|||||||
)
|
)
|
||||||
print(' '.join(out))
|
print(' '.join(out))
|
||||||
|
|
||||||
load_dotenv(find_dotenv('.test.env'))
|
|
||||||
|
|
||||||
session.obsws.set_stream_service_settings(
|
session.obsws.set_stream_service_settings(
|
||||||
'rtmp_common',
|
'rtmp_common',
|
||||||
{
|
{
|
||||||
'service': 'Twitch',
|
'service': 'Twitch',
|
||||||
'server': 'auto',
|
'server': 'auto',
|
||||||
'key': os.environ['OBS_STREAM_KEY'],
|
'key': os.environ['OBSWS_CLI_TESTS_STREAM_KEY'],
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
|
|
||||||
session.obsws.set_current_scene_collection('test-collection')
|
session.obsws.create_profile('pytest_profile')
|
||||||
|
time.sleep(0.1) # Wait for the profile to be created
|
||||||
|
session.obsws.set_profile_parameter(
|
||||||
|
'SimpleOutput',
|
||||||
|
'RecRB',
|
||||||
|
'true',
|
||||||
|
)
|
||||||
|
# hack to ensure the replay buffer is enabled
|
||||||
|
session.obsws.set_current_profile('Untitled')
|
||||||
|
session.obsws.set_current_profile('pytest_profile')
|
||||||
session.obsws.create_scene('pytest_scene')
|
session.obsws.create_scene('pytest_scene')
|
||||||
|
|
||||||
|
# Ensure Desktop Audio is created.
|
||||||
|
desktop_audio_kinds = {
|
||||||
|
'windows': 'wasapi_output_capture',
|
||||||
|
'linux': 'pulse_output_capture',
|
||||||
|
'darwin': 'coreaudio_output_capture',
|
||||||
|
}
|
||||||
|
platform = os.environ['OBSWS_CLI_TESTS_PLATFORM']
|
||||||
|
try:
|
||||||
|
session.obsws.create_input(
|
||||||
|
sceneName='pytest_scene',
|
||||||
|
inputName='Desktop Audio',
|
||||||
|
inputKind=desktop_audio_kinds[platform],
|
||||||
|
inputSettings={'device_id': 'default'},
|
||||||
|
sceneItemEnabled=True,
|
||||||
|
)
|
||||||
|
except obsws.error.OBSSDKRequestError as e:
|
||||||
|
if e.code == 601:
|
||||||
|
"""input already exists, continue."""
|
||||||
|
# Ensure Mic/Aux is created.
|
||||||
|
mic_kinds = {
|
||||||
|
'windows': 'wasapi_input_capture',
|
||||||
|
'linux': 'pulse_input_capture',
|
||||||
|
'darwin': 'coreaudio_input_capture',
|
||||||
|
}
|
||||||
|
try:
|
||||||
|
session.obsws.create_input(
|
||||||
|
sceneName='pytest_scene',
|
||||||
|
inputName='Mic/Aux',
|
||||||
|
inputKind=mic_kinds[platform],
|
||||||
|
inputSettings={'device_id': 'default'},
|
||||||
|
sceneItemEnabled=True,
|
||||||
|
)
|
||||||
|
except obsws.error.OBSSDKRequestError as e:
|
||||||
|
if e.code == 601:
|
||||||
|
"""input already exists, continue."""
|
||||||
|
|
||||||
session.obsws.create_input(
|
session.obsws.create_input(
|
||||||
sceneName='pytest_scene',
|
sceneName='pytest_scene',
|
||||||
inputName='pytest_input',
|
inputName='pytest_input',
|
||||||
@@ -131,7 +174,7 @@ def pytest_sessionfinish(session, exitstatus):
|
|||||||
|
|
||||||
session.obsws.remove_scene('pytest_scene')
|
session.obsws.remove_scene('pytest_scene')
|
||||||
|
|
||||||
session.obsws.set_current_scene_collection('default')
|
session.obsws.set_current_scene_collection('Untitled')
|
||||||
|
|
||||||
resp = session.obsws.get_stream_status()
|
resp = session.obsws.get_stream_status()
|
||||||
if resp.output_active:
|
if resp.output_active:
|
||||||
@@ -149,6 +192,8 @@ def pytest_sessionfinish(session, exitstatus):
|
|||||||
if resp.studio_mode_enabled:
|
if resp.studio_mode_enabled:
|
||||||
session.obsws.set_studio_mode_enabled(False)
|
session.obsws.set_studio_mode_enabled(False)
|
||||||
|
|
||||||
|
session.obsws.remove_profile('pytest_profile')
|
||||||
|
|
||||||
# Close the OBS WebSocket client connection
|
# Close the OBS WebSocket client connection
|
||||||
session.obsws.disconnect()
|
session.obsws.disconnect()
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
|||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
def test_filter_list():
|
def test_filter_list():
|
||||||
|
|||||||
@@ -1,10 +1,18 @@
|
|||||||
"""Unit tests for the group command in the OBS WebSocket CLI."""
|
"""Unit tests for the group command in the OBS WebSocket CLI."""
|
||||||
|
|
||||||
|
import os
|
||||||
|
|
||||||
|
import pytest
|
||||||
from typer.testing import CliRunner
|
from typer.testing import CliRunner
|
||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
if os.environ.get('OBSWS_CLI_TESTS_SKIP_GROUP_TESTS'):
|
||||||
|
pytest.skip(
|
||||||
|
'Skipping group tests as per environment variable', allow_module_level=True
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_group_list():
|
def test_group_list():
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
|||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
def test_hotkey_list():
|
def test_hotkey_list():
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
|||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
def test_input_list():
|
def test_input_list():
|
||||||
@@ -13,10 +13,7 @@ def test_input_list():
|
|||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert 'Desktop Audio' in result.stdout
|
assert 'Desktop Audio' in result.stdout
|
||||||
assert 'Mic/Aux' in result.stdout
|
assert 'Mic/Aux' in result.stdout
|
||||||
assert all(
|
assert all(item in result.stdout for item in ('pytest_input', 'pytest_input_2'))
|
||||||
item in result.stdout
|
|
||||||
for item in ('Colour Source', 'Colour Source 2', 'Colour Source 3')
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_input_list_filter_input():
|
def test_input_list_filter_input():
|
||||||
@@ -39,9 +36,6 @@ def test_input_list_filter_colour():
|
|||||||
"""Test the input list command with colour filter."""
|
"""Test the input list command with colour filter."""
|
||||||
result = runner.invoke(app, ['input', 'list', '--colour'])
|
result = runner.invoke(app, ['input', 'list', '--colour'])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert all(
|
assert all(item in result.stdout for item in ('pytest_input', 'pytest_input_2'))
|
||||||
item in result.stdout
|
|
||||||
for item in ('Colour Source', 'Colour Source 2', 'Colour Source 3')
|
|
||||||
)
|
|
||||||
assert 'Desktop Audio' not in result.stdout
|
assert 'Desktop Audio' not in result.stdout
|
||||||
assert 'Mic/Aux' not in result.stdout
|
assert 'Mic/Aux' not in result.stdout
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ from typer.testing import CliRunner
|
|||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
def test_record_start():
|
def test_record_start():
|
||||||
@@ -49,7 +49,9 @@ def test_record_toggle():
|
|||||||
|
|
||||||
result = runner.invoke(app, ['record', 'toggle'])
|
result = runner.invoke(app, ['record', 'toggle'])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
|
|
||||||
time.sleep(0.5) # Wait for the recording to toggle
|
time.sleep(0.5) # Wait for the recording to toggle
|
||||||
|
|
||||||
if active:
|
if active:
|
||||||
assert 'Recording stopped successfully.' in result.stdout
|
assert 'Recording stopped successfully.' in result.stdout
|
||||||
else:
|
else:
|
||||||
|
|||||||
@@ -1,10 +1,20 @@
|
|||||||
"""Unit tests for the replaybuffer command in the OBS WebSocket CLI."""
|
"""Unit tests for the replaybuffer command in the OBS WebSocket CLI."""
|
||||||
|
|
||||||
|
import os
|
||||||
|
import time
|
||||||
|
|
||||||
|
import pytest
|
||||||
from typer.testing import CliRunner
|
from typer.testing import CliRunner
|
||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
if os.environ.get('OBS_TESTS_SKIP_REPLAYBUFFER_TESTS'):
|
||||||
|
pytest.skip(
|
||||||
|
'Skipping replaybuffer tests as per environment variable',
|
||||||
|
allow_module_level=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_replaybuffer_start():
|
def test_replaybuffer_start():
|
||||||
@@ -14,6 +24,9 @@ def test_replaybuffer_start():
|
|||||||
active = 'Replay buffer is active.' in resp.stdout
|
active = 'Replay buffer is active.' in resp.stdout
|
||||||
|
|
||||||
resp = runner.invoke(app, ['replaybuffer', 'start'])
|
resp = runner.invoke(app, ['replaybuffer', 'start'])
|
||||||
|
|
||||||
|
time.sleep(0.5) # Wait for the replay buffer to start
|
||||||
|
|
||||||
if active:
|
if active:
|
||||||
assert resp.exit_code != 0
|
assert resp.exit_code != 0
|
||||||
assert 'Replay buffer is already active.' in resp.stderr
|
assert 'Replay buffer is already active.' in resp.stderr
|
||||||
@@ -29,6 +42,9 @@ def test_replaybuffer_stop():
|
|||||||
active = 'Replay buffer is active.' in resp.stdout
|
active = 'Replay buffer is active.' in resp.stdout
|
||||||
|
|
||||||
resp = runner.invoke(app, ['replaybuffer', 'stop'])
|
resp = runner.invoke(app, ['replaybuffer', 'stop'])
|
||||||
|
|
||||||
|
time.sleep(0.5) # Wait for the replay buffer to stop
|
||||||
|
|
||||||
if not active:
|
if not active:
|
||||||
assert resp.exit_code != 0
|
assert resp.exit_code != 0
|
||||||
assert 'Replay buffer is not active.' in resp.stderr
|
assert 'Replay buffer is not active.' in resp.stderr
|
||||||
@@ -44,9 +60,11 @@ def test_replaybuffer_toggle():
|
|||||||
active = 'Replay buffer is active.' in resp.stdout
|
active = 'Replay buffer is active.' in resp.stdout
|
||||||
|
|
||||||
resp = runner.invoke(app, ['replaybuffer', 'toggle'])
|
resp = runner.invoke(app, ['replaybuffer', 'toggle'])
|
||||||
if active:
|
|
||||||
assert resp.exit_code == 0
|
assert resp.exit_code == 0
|
||||||
|
|
||||||
|
time.sleep(0.5) # Wait for the replay buffer to toggle
|
||||||
|
|
||||||
|
if active:
|
||||||
assert 'Replay buffer is not active.' in resp.stdout
|
assert 'Replay buffer is not active.' in resp.stdout
|
||||||
else:
|
else:
|
||||||
assert resp.exit_code == 0
|
|
||||||
assert 'Replay buffer is active.' in resp.stdout
|
assert 'Replay buffer is active.' in resp.stdout
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
|||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
def test_scene_list():
|
def test_scene_list():
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
|||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
def test_sceneitem_list():
|
def test_sceneitem_list():
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ from typer.testing import CliRunner
|
|||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
def test_stream_start():
|
def test_stream_start():
|
||||||
@@ -23,7 +23,7 @@ def test_stream_start():
|
|||||||
else:
|
else:
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert 'Streaming started successfully.' in result.stdout
|
assert 'Streaming started successfully.' in result.stdout
|
||||||
time.sleep(1) # Wait for the streaming to start
|
time.sleep(0.5) # Wait for the streaming to start
|
||||||
|
|
||||||
|
|
||||||
def test_stream_stop():
|
def test_stream_stop():
|
||||||
@@ -37,7 +37,7 @@ def test_stream_stop():
|
|||||||
if active:
|
if active:
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert 'Streaming stopped successfully.' in result.stdout
|
assert 'Streaming stopped successfully.' in result.stdout
|
||||||
time.sleep(1) # Wait for the streaming to stop
|
time.sleep(0.5) # Wait for the streaming to stop
|
||||||
else:
|
else:
|
||||||
assert result.exit_code != 0
|
assert result.exit_code != 0
|
||||||
assert 'Streaming is not in progress, cannot stop.' in result.stderr
|
assert 'Streaming is not in progress, cannot stop.' in result.stderr
|
||||||
@@ -52,7 +52,7 @@ def test_stream_toggle():
|
|||||||
result = runner.invoke(app, ['stream', 'toggle'])
|
result = runner.invoke(app, ['stream', 'toggle'])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
|
|
||||||
time.sleep(1) # Wait for the stream to toggle
|
time.sleep(0.5) # Wait for the stream to toggle
|
||||||
|
|
||||||
if active:
|
if active:
|
||||||
assert 'Streaming stopped successfully.' in result.stdout
|
assert 'Streaming stopped successfully.' in result.stdout
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
|||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
def test_studio_enable():
|
def test_studio_enable():
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
|||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
def test_text_update():
|
def test_text_update():
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
|||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
def test_version():
|
def test_version():
|
||||||
|
|||||||
Reference in New Issue
Block a user