mirror of
https://github.com/onyx-and-iris/obsws-cli.git
synced 2026-04-21 00:13:38 +00:00
Compare commits
115 Commits
ab71414d27
...
v0.24.8
| Author | SHA1 | Date | |
|---|---|---|---|
| 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 | |||
| 1ceb95ab16 | |||
| f06e2d3982 | |||
| 39dff3cc28 | |||
| 967c4ab699 | |||
| dc128720c7 | |||
| 2e3f4267cd | |||
| 000431ab82 | |||
| ec3e31cc4f | |||
| cda0bbedb9 | |||
| d0c96b853d | |||
| 040a41daa7 | |||
| 0c72a10fb7 | |||
| f882302d16 | |||
| 98e0d98cc7 | |||
| c6b22c7cf2 | |||
| c3e55200db | |||
| 4d37714aaf | |||
| 157e1a167c | |||
| d628c5d3a4 | |||
| 4bf8edb692 | |||
| d68326f37a | |||
| a001455dad | |||
| 4632260961 | |||
| 55a7da67db | |||
| 7bec573ef9 | |||
| 55e60ff977 | |||
| 922efddf7a | |||
| 4a0147aa8a | |||
| cec76df1d1 | |||
| 2e5fb3800a | |||
| 3c985f5e9b | |||
| fb17979cb0 | |||
| a1ed208bdf | |||
| 02baa13dba | |||
| 7abbccae99 | |||
| 23282a60d1 | |||
| b6ba66db64 | |||
| c4480895a1 | |||
| fd2e629ec2 | |||
| 85b653891d | |||
| bff5d396a4 | |||
| 47324597d7 | |||
| 9a0659ae35 | |||
| a726f9699f | |||
| fbea2cb896 | |||
| e5040d5ddd | |||
| 39f1b01926 | |||
| e9b3106aa6 | |||
| a26ce74151 | |||
| f1c569f140 | |||
| 093e9a05d4 | |||
| 1a1fbf1da1 | |||
| fd2baf3350 | |||
| 5334879ba9 | |||
| 77dbe52ae6 | |||
| 1ff610410a | |||
| cd7614bfd6 | |||
| 74503f17e0 | |||
| 32bc4277f2 | |||
| 21f1b5e1bb | |||
| 434f8c0e0c | |||
| 81518a14ea | |||
| ddb92bb317 | |||
| 44527b35e2 | |||
| 0bcfc2ae14 |
39
.github/workflows/publish.yml
vendored
Normal file
39
.github/workflows/publish.yml
vendored
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
name: Publish to PyPI
|
||||||
|
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types: [published]
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- 'v*.*.*'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
deploy:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
environment: pypi
|
||||||
|
permissions:
|
||||||
|
# This permission is needed for private repositories.
|
||||||
|
contents: read
|
||||||
|
# IMPORTANT: this permission is mandatory for trusted publishing
|
||||||
|
id-token: write
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Set up Python
|
||||||
|
uses: actions/setup-python@v4
|
||||||
|
with:
|
||||||
|
python-version: '3.11'
|
||||||
|
cache: 'pip'
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
python -m pip install --upgrade pip
|
||||||
|
pip install hatch
|
||||||
|
|
||||||
|
- name: Build package
|
||||||
|
run: hatch build
|
||||||
|
|
||||||
|
- name: Publish on PyPI
|
||||||
|
uses: pypa/gh-action-pypi-publish@release/v1
|
||||||
19
.github/workflows/ruff.yml
vendored
Normal file
19
.github/workflows/ruff.yml
vendored
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
name: Ruff
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
|
||||||
|
pull_request:
|
||||||
|
branches: [main]
|
||||||
|
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
ruff:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: astral-sh/ruff-action@v3
|
||||||
|
with:
|
||||||
|
args: 'format --check --diff'
|
||||||
86
CHANGELOG.md
86
CHANGELOG.md
@@ -5,6 +5,92 @@ 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
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- text command group, see [Text](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#text)
|
||||||
|
|
||||||
|
# [0.19.0] - 2025-06-23
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- record split and record chapter commands, see [Record](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#record)
|
||||||
|
- As of OBS 30.2.0, the only file format supporting *record chapter* is Hybrid MP4.
|
||||||
|
|
||||||
|
# [0.18.0] - 2025-06-21
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Various colouring styles, see [Style](https://github.com/onyx-and-iris/obsws-cli/tree/main?tab=readme-ov-file#style)
|
||||||
|
- colouring is applied to list tables as well as highlighted information in stdout/stderr output.
|
||||||
|
- table border styling may be optionally disabled with the --no-border flag.
|
||||||
|
|
||||||
|
|
||||||
|
# [0.17.3] - 2025-06-20
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- input list, scene list and sceneitem list now accept --uuid flag.
|
||||||
|
- Active column added to scene list table.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- scene list no longer prints the UUIDs by default, enable it with the --uuid flag.
|
||||||
|
- if NO_COLOR is set, print colourless check and cross marks in tables.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Issue with input list not printing all inputs if no filters were applied.
|
||||||
|
|
||||||
|
# [0.16.8] - 2025-06-07
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- filter list:
|
||||||
|
- --ffmpeg, --vlc flags
|
||||||
|
- Muted column to list table
|
||||||
|
|
||||||
|
# [0.16.5] - 2025-06-06
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- [Disable Colouring](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#disable-colouring) section added to README.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- error output:
|
||||||
|
- now printed in bold red.
|
||||||
|
- highlights are now yellow
|
||||||
|
- normal output:
|
||||||
|
- highlights are now green
|
||||||
|
- help messages:
|
||||||
|
- removed a lot of the `[default: None]`, this affects optional flags/arguments without default values.
|
||||||
|
|
||||||
# [0.16.1] - 2025-06-04
|
# [0.16.1] - 2025-06-04
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|||||||
232
README.md
232
README.md
@@ -14,7 +14,9 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
|
|||||||
|
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [Configuration](#configuration)
|
- [Configuration](#configuration)
|
||||||
|
- [Style](#style)
|
||||||
- [Commands](#root-typer)
|
- [Commands](#root-typer)
|
||||||
|
- [Shell Completion](#shell-completion)
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
@@ -47,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 *DEBUG, INFO, WARNING, ERROR, CRITICAL*
|
||||||
|
|
||||||
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:
|
||||||
|
|
||||||
@@ -61,13 +65,45 @@ 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.
|
||||||
|
|
||||||
|
## Style
|
||||||
|
|
||||||
|
Styling is opt-in, by default you will get a colourless output:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
You may enable styling with the --style/-s flag:
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli --style="cyan" sceneitem list
|
||||||
|
```
|
||||||
|
|
||||||
|
Available styles: _red, magenta, purple, blue, cyan, green, yellow, orange, white, grey, navy, black_
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Optionally you may disable border colouring with the --no-border flag:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli --style="cyan" --no-border sceneitem list
|
||||||
|
```
|
||||||
|
|
||||||
|
Or with environment variables:
|
||||||
|
|
||||||
|
```env
|
||||||
|
OBSWS_CLI_STYLE=cyan
|
||||||
|
OBSWS_CLI_STYLE_NO_BORDER=true
|
||||||
|
```
|
||||||
|
|
||||||
## Root Typer
|
## Root Typer
|
||||||
|
|
||||||
- obs-version: Get the OBS Client and WebSocket versions.
|
- obs-version: Get the OBS Client and WebSocket versions.
|
||||||
@@ -81,6 +117,10 @@ obsws-cli obs-version
|
|||||||
#### Scene
|
#### Scene
|
||||||
|
|
||||||
- list: List all scenes.
|
- list: List all scenes.
|
||||||
|
- flags:
|
||||||
|
|
||||||
|
*optional*
|
||||||
|
- --uuid: Show UUIDs of scenes
|
||||||
|
|
||||||
```console
|
```console
|
||||||
obsws-cli scene list
|
obsws-cli scene list
|
||||||
@@ -102,6 +142,10 @@ obsws-cli scene switch LIVE
|
|||||||
#### Scene Item
|
#### Scene Item
|
||||||
|
|
||||||
- list: List all items in a scene.
|
- list: List all items in a scene.
|
||||||
|
- flags:
|
||||||
|
|
||||||
|
*optional*
|
||||||
|
- --uuid: Show UUIDs of scene items
|
||||||
|
|
||||||
*optional*
|
*optional*
|
||||||
- args: <scene_name>
|
- args: <scene_name>
|
||||||
@@ -258,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:
|
||||||
|
|
||||||
@@ -265,6 +323,9 @@ obsws-cli group status START "test_group"
|
|||||||
- --input: Filter by input type.
|
- --input: Filter by input type.
|
||||||
- --output: Filter by output type.
|
- --output: Filter by output type.
|
||||||
- --colour: Filter by colour source type.
|
- --colour: Filter by colour source type.
|
||||||
|
- --ffmpeg: Filter by ffmpeg source type.
|
||||||
|
- --vlc: Filter by VLC source type.
|
||||||
|
- --uuid: Show UUIDs of inputs.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
obsws-cli input list
|
obsws-cli input list
|
||||||
@@ -272,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>
|
||||||
|
|
||||||
@@ -292,6 +359,48 @@ 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
|
||||||
|
|
||||||
|
- current: Get the current text for a text input.
|
||||||
|
- args: <input_name>
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli text current "My Text Input"
|
||||||
|
```
|
||||||
|
|
||||||
|
- update: Update the text of a text input.
|
||||||
|
- args: <input_name> <new_text>
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli text update "My Text Input" "hi OBS!"
|
||||||
|
```
|
||||||
|
|
||||||
#### Record
|
#### Record
|
||||||
|
|
||||||
- start: Start recording.
|
- start: Start recording.
|
||||||
@@ -343,6 +452,21 @@ obsws-cli record directory "/home/me/obs-vids/"
|
|||||||
obsws-cli record directory "C:/Users/me/Videos"
|
obsws-cli record directory "C:/Users/me/Videos"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
- split: Split the current recording.
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli record split
|
||||||
|
```
|
||||||
|
|
||||||
|
- chapter: Create a chapter in the current recording.
|
||||||
|
|
||||||
|
*optional*
|
||||||
|
- args: <chapter_name>
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli record chapter "Chapter Name"
|
||||||
|
```
|
||||||
|
|
||||||
#### Stream
|
#### Stream
|
||||||
|
|
||||||
- start: Start streaming.
|
- start: Start streaming.
|
||||||
@@ -602,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.
|
||||||
@@ -609,3 +834,4 @@ obsws-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos
|
|||||||
|
|
||||||
[obs-studio]: https://obsproject.com/
|
[obs-studio]: https://obsproject.com/
|
||||||
[obs-keyids]: https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h
|
[obs-keyids]: https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h
|
||||||
|
[no-colour]: https://no-color.org/
|
||||||
|
|||||||
BIN
img/coloured-border.png
Executable file
BIN
img/coloured-border.png
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 6.2 KiB |
BIN
img/coloured-no-border.png
Executable file
BIN
img/coloured-no-border.png
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 6.2 KiB |
BIN
img/colourless.png
Executable file
BIN
img/colourless.png
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 5.4 KiB |
@@ -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.16.2"
|
__version__ = '0.24.8'
|
||||||
|
|||||||
@@ -4,4 +4,4 @@
|
|||||||
|
|
||||||
from .app import app
|
from .app import app
|
||||||
|
|
||||||
__all__ = ["app"]
|
__all__ = ['app']
|
||||||
|
|||||||
@@ -1,14 +1,10 @@
|
|||||||
"""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
|
||||||
|
|
||||||
|
|
||||||
class AliasGroup(typer.core.TyperGroup):
|
class RootTyperAliasGroup(typer.core.TyperGroup):
|
||||||
"""A custom group class to handle command name aliases."""
|
"""A custom group class to handle command name aliases for the root typer."""
|
||||||
|
|
||||||
_CMD_SPLIT_P = re.compile(r' ?[,|] ?')
|
|
||||||
|
|
||||||
def __init__(self, *args, **kwargs):
|
def __init__(self, *args, **kwargs):
|
||||||
"""Initialize the AliasGroup."""
|
"""Initialize the AliasGroup."""
|
||||||
@@ -17,12 +13,41 @@ class AliasGroup(typer.core.TyperGroup):
|
|||||||
|
|
||||||
def get_command(self, ctx, cmd_name):
|
def get_command(self, ctx, cmd_name):
|
||||||
"""Get a command by name."""
|
"""Get a command by name."""
|
||||||
cmd_name = self._group_cmd_name(cmd_name)
|
match cmd_name:
|
||||||
|
case 'f':
|
||||||
|
cmd_name = 'filter'
|
||||||
|
case 'g':
|
||||||
|
cmd_name = 'group'
|
||||||
|
case 'hk':
|
||||||
|
cmd_name = 'hotkey'
|
||||||
|
case 'i':
|
||||||
|
cmd_name = 'input'
|
||||||
|
case 'm':
|
||||||
|
cmd_name = 'media'
|
||||||
|
case 'prf':
|
||||||
|
cmd_name = 'profile'
|
||||||
|
case 'prj':
|
||||||
|
cmd_name = 'projector'
|
||||||
|
case 'rc':
|
||||||
|
cmd_name = 'record'
|
||||||
|
case 'rb':
|
||||||
|
cmd_name = 'replaybuffer'
|
||||||
|
case 'sc':
|
||||||
|
cmd_name = 'scene'
|
||||||
|
case 'scc':
|
||||||
|
cmd_name = 'scenecollection'
|
||||||
|
case 'si':
|
||||||
|
cmd_name = 'sceneitem'
|
||||||
|
case 'ss':
|
||||||
|
cmd_name = 'screenshot'
|
||||||
|
case 'set':
|
||||||
|
cmd_name = 'settings'
|
||||||
|
case 'st':
|
||||||
|
cmd_name = 'stream'
|
||||||
|
case 'sm':
|
||||||
|
cmd_name = 'studiomode'
|
||||||
|
case 't':
|
||||||
|
cmd_name = 'text'
|
||||||
|
case 'vc':
|
||||||
|
cmd_name = 'virtualcam'
|
||||||
return super().get_command(ctx, cmd_name)
|
return super().get_command(ctx, cmd_name)
|
||||||
|
|
||||||
def _group_cmd_name(self, default_name):
|
|
||||||
for cmd in self.commands.values():
|
|
||||||
name = cmd.name
|
|
||||||
if name and default_name in self._CMD_SPLIT_P.split(name):
|
|
||||||
return name
|
|
||||||
return default_name
|
|
||||||
|
|||||||
128
obsws_cli/app.py
128
obsws_cli/app.py
@@ -1,49 +1,55 @@
|
|||||||
"""Command line interface for the OBS WebSocket API."""
|
"""Command line interface for the OBS WebSocket API."""
|
||||||
|
|
||||||
import importlib
|
import importlib
|
||||||
|
import logging
|
||||||
|
import pkgutil
|
||||||
from typing import Annotated
|
from typing import Annotated
|
||||||
|
|
||||||
import obsws_python as obsws
|
import obsws_python as obsws
|
||||||
import typer
|
import typer
|
||||||
from rich.console import Console
|
|
||||||
|
|
||||||
from obsws_cli.__about__ import __version__ as obsws_cli_version
|
from obsws_cli.__about__ import __version__ as version
|
||||||
|
|
||||||
from . import settings
|
from . import commands, console, envconfig, styles
|
||||||
from .alias import AliasGroup
|
from .alias import RootTyperAliasGroup
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
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',
|
|
||||||
'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])
|
||||||
|
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
def version_callback(value: bool):
|
def version_callback(value: bool):
|
||||||
"""Show the version of the CLI."""
|
"""Show the version of the CLI."""
|
||||||
if value:
|
if value:
|
||||||
out_console.print(f'obsws-cli version: {obsws_cli_version}')
|
console.out.print(f'obsws-cli version: {version}')
|
||||||
raise typer.Exit()
|
raise typer.Exit()
|
||||||
|
|
||||||
|
|
||||||
|
def setup_logging(loglevel: str):
|
||||||
|
"""Set up logging for the application."""
|
||||||
|
loglevel = loglevel.upper()
|
||||||
|
if loglevel not in ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']:
|
||||||
|
raise typer.BadParameter(
|
||||||
|
f'Invalid log level: {loglevel}. Choose from DEBUG, INFO, WARNING, ERROR, CRITICAL.'
|
||||||
|
)
|
||||||
|
logging.basicConfig(
|
||||||
|
level=loglevel,
|
||||||
|
format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def validate_style(value: str):
|
||||||
|
"""Validate and return the style."""
|
||||||
|
if value not in styles.registry:
|
||||||
|
raise typer.BadParameter(
|
||||||
|
f'Invalid style: {value}. Available styles: {", ".join(styles.registry.keys())}'
|
||||||
|
)
|
||||||
|
return value
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
def main(
|
def main(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
@@ -52,37 +58,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('OBS_HOST'),
|
] = envconfig.get('host'),
|
||||||
port: Annotated[
|
port: Annotated[
|
||||||
int,
|
int,
|
||||||
typer.Option(
|
typer.Option(
|
||||||
'--port', '-P', envvar='OBS_PORT', help='WebSocket port', show_default=4455
|
'--port',
|
||||||
|
'-P',
|
||||||
|
envvar='OBSWS_CLI_PORT',
|
||||||
|
help='WebSocket port',
|
||||||
|
show_default=4455,
|
||||||
),
|
),
|
||||||
] = settings.get('OBS_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='',
|
show_default=False,
|
||||||
),
|
),
|
||||||
] = settings.get('OBS_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('OBS_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(
|
||||||
@@ -94,15 +125,32 @@ def main(
|
|||||||
callback=version_callback,
|
callback=version_callback,
|
||||||
),
|
),
|
||||||
] = False,
|
] = False,
|
||||||
|
loglevel: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Option(
|
||||||
|
'--loglevel',
|
||||||
|
'-l',
|
||||||
|
envvar='OBSWS_CLI_LOGLEVEL',
|
||||||
|
is_eager=True,
|
||||||
|
help='Set the logging level',
|
||||||
|
show_default=False,
|
||||||
|
callback=setup_logging,
|
||||||
|
),
|
||||||
|
] = 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.obj = ctx.with_resource(obsws.ReqClient(**ctx.params))
|
ctx.ensure_object(dict)
|
||||||
|
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)
|
||||||
|
|
||||||
|
|
||||||
@app.command()
|
@app.command()
|
||||||
def obs_version(ctx: typer.Context):
|
def obs_version(ctx: typer.Context):
|
||||||
"""Get the OBS Client and WebSocket versions."""
|
"""Get the OBS Client and WebSocket versions."""
|
||||||
resp = ctx.obj.get_version()
|
resp = ctx.obj['obsws'].get_version()
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f'OBS Client version: {resp.obs_version} with WebSocket version: {resp.obs_web_socket_version}'
|
f'OBS Client version: {console.highlight(ctx, resp.obs_version)}'
|
||||||
|
f' with WebSocket version: {console.highlight(ctx, resp.obs_web_socket_version)}'
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -4,15 +4,12 @@ from typing import Annotated, Optional
|
|||||||
|
|
||||||
import obsws_python as obsws
|
import obsws_python as obsws
|
||||||
import typer
|
import typer
|
||||||
from rich.console import Console
|
|
||||||
from rich.table import Table
|
from rich.table import Table
|
||||||
|
from rich.text import Text
|
||||||
|
|
||||||
from . import util
|
from obsws_cli import console, util
|
||||||
from .alias import AliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
app = typer.Typer()
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
@@ -20,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[
|
||||||
@@ -33,38 +31,48 @@ def list_(
|
|||||||
):
|
):
|
||||||
"""List filters for a source."""
|
"""List filters for a source."""
|
||||||
if not source_name:
|
if not source_name:
|
||||||
source_name = ctx.obj.get_current_program_scene().scene_name
|
source_name = ctx.obj['obsws'].get_current_program_scene().scene_name
|
||||||
|
|
||||||
try:
|
try:
|
||||||
resp = ctx.obj.get_source_filter_list(source_name)
|
resp = ctx.obj['obsws'].get_source_filter_list(source_name)
|
||||||
except obsws.error.OBSSDKRequestError as e:
|
except obsws.error.OBSSDKRequestError as e:
|
||||||
if e.code == 600:
|
if e.code == 600:
|
||||||
err_console.print(f"No source was found by the name of '{source_name}'.")
|
console.err.print(
|
||||||
|
f'No source was found by the name of [yellow]{source_name}[/yellow].'
|
||||||
|
)
|
||||||
raise typer.Exit(1)
|
raise typer.Exit(1)
|
||||||
else:
|
else:
|
||||||
raise
|
raise
|
||||||
|
|
||||||
if not resp.filters:
|
if not resp.filters:
|
||||||
out_console.print(f'No filters found for source {source_name}')
|
console.out.print(
|
||||||
|
f'No filters found for source {console.highlight(ctx, source_name)}'
|
||||||
|
)
|
||||||
raise typer.Exit()
|
raise typer.Exit()
|
||||||
|
|
||||||
table = Table(title=f'Filters for Source: {source_name}', padding=(0, 2))
|
table = Table(
|
||||||
|
title=f'Filters for Source: {source_name}',
|
||||||
for column in ('Filter Name', 'Kind', 'Enabled', 'Settings'):
|
padding=(0, 2),
|
||||||
table.add_column(
|
border_style=ctx.obj['style'].border,
|
||||||
column,
|
|
||||||
justify='left' if column in ('Filter Name', 'Kind') else 'center',
|
|
||||||
style='cyan',
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
columns = [
|
||||||
|
(Text('Filter Name', justify='center'), 'left', ctx.obj['style'].column),
|
||||||
|
(Text('Kind', justify='center'), 'left', ctx.obj['style'].column),
|
||||||
|
(Text('Enabled', justify='center'), 'center', None),
|
||||||
|
(Text('Settings', justify='center'), 'center', ctx.obj['style'].column),
|
||||||
|
]
|
||||||
|
for heading, justify, style in columns:
|
||||||
|
table.add_column(heading, justify=justify, style=style)
|
||||||
|
|
||||||
for filter in resp.filters:
|
for filter in resp.filters:
|
||||||
resp = ctx.obj.get_source_filter_default_settings(filter['filterKind'])
|
resp = ctx.obj['obsws'].get_source_filter_default_settings(filter['filterKind'])
|
||||||
settings = resp.default_filter_settings | filter['filterSettings']
|
settings = resp.default_filter_settings | filter['filterSettings']
|
||||||
|
|
||||||
table.add_row(
|
table.add_row(
|
||||||
filter['filterName'],
|
filter['filterName'],
|
||||||
util.snakecase_to_titlecase(filter['filterKind']),
|
util.snakecase_to_titlecase(filter['filterKind']),
|
||||||
':white_heavy_check_mark:' if filter['filterEnabled'] else ':x:',
|
util.check_mark(filter['filterEnabled']),
|
||||||
'\n'.join(
|
'\n'.join(
|
||||||
[
|
[
|
||||||
f'{util.snakecase_to_titlecase(k):<20} {v:>10}'
|
f'{util.snakecase_to_titlecase(k):<20} {v:>10}'
|
||||||
@@ -73,16 +81,17 @@ def list_(
|
|||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
out_console.print(table)
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
def _get_filter_enabled(ctx: typer.Context, source_name: str, filter_name: str):
|
def _get_filter_enabled(ctx: typer.Context, source_name: str, filter_name: str):
|
||||||
"""Get the status of a filter for a source."""
|
"""Get the status of a filter for a source."""
|
||||||
resp = ctx.obj.get_source_filter(source_name, filter_name)
|
resp = ctx.obj['obsws'].get_source_filter(source_name, filter_name)
|
||||||
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[
|
||||||
@@ -100,16 +109,19 @@ def enable(
|
|||||||
):
|
):
|
||||||
"""Enable a filter for a source."""
|
"""Enable a filter for a source."""
|
||||||
if _get_filter_enabled(ctx, source_name, filter_name):
|
if _get_filter_enabled(ctx, source_name, filter_name):
|
||||||
err_console.print(
|
console.err.print(
|
||||||
f'Filter {filter_name} is already enabled for source {source_name}'
|
f'Filter [yellow]{filter_name}[/yellow] is already enabled for source [yellow]{source_name}[/yellow]'
|
||||||
)
|
)
|
||||||
raise typer.Exit(1)
|
raise typer.Exit(1)
|
||||||
|
|
||||||
ctx.obj.set_source_filter_enabled(source_name, filter_name, enabled=True)
|
ctx.obj['obsws'].set_source_filter_enabled(source_name, filter_name, enabled=True)
|
||||||
out_console.print(f'Enabled filter {filter_name} for source {source_name}')
|
console.out.print(
|
||||||
|
f'Enabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@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[
|
||||||
@@ -127,16 +139,19 @@ def disable(
|
|||||||
):
|
):
|
||||||
"""Disable a filter for a source."""
|
"""Disable a filter for a source."""
|
||||||
if not _get_filter_enabled(ctx, source_name, filter_name):
|
if not _get_filter_enabled(ctx, source_name, filter_name):
|
||||||
err_console.print(
|
console.err.print(
|
||||||
f'Filter {filter_name} is already disabled for source {source_name}'
|
f'Filter [yellow]{filter_name}[/yellow] is already disabled for source [yellow]{source_name}[/yellow]'
|
||||||
)
|
)
|
||||||
raise typer.Exit(1)
|
raise typer.Exit(1)
|
||||||
|
|
||||||
ctx.obj.set_source_filter_enabled(source_name, filter_name, enabled=False)
|
ctx.obj['obsws'].set_source_filter_enabled(source_name, filter_name, enabled=False)
|
||||||
out_console.print(f'Disabled filter {filter_name} for source {source_name}')
|
console.out.print(
|
||||||
|
f'Disabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@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[
|
||||||
@@ -156,14 +171,21 @@ def toggle(
|
|||||||
is_enabled = _get_filter_enabled(ctx, source_name, filter_name)
|
is_enabled = _get_filter_enabled(ctx, source_name, filter_name)
|
||||||
new_state = not is_enabled
|
new_state = not is_enabled
|
||||||
|
|
||||||
ctx.obj.set_source_filter_enabled(source_name, filter_name, enabled=new_state)
|
ctx.obj['obsws'].set_source_filter_enabled(
|
||||||
|
source_name, filter_name, enabled=new_state
|
||||||
|
)
|
||||||
if new_state:
|
if new_state:
|
||||||
out_console.print(f'Enabled filter {filter_name} for source {source_name}')
|
console.out.print(
|
||||||
|
f'Enabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}'
|
||||||
|
)
|
||||||
else:
|
else:
|
||||||
out_console.print(f'Disabled filter {filter_name} for source {source_name}')
|
console.out.print(
|
||||||
|
f'Disabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@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[
|
||||||
@@ -182,6 +204,10 @@ def status(
|
|||||||
"""Get the status of a filter for a source."""
|
"""Get the status of a filter for a source."""
|
||||||
is_enabled = _get_filter_enabled(ctx, source_name, filter_name)
|
is_enabled = _get_filter_enabled(ctx, source_name, filter_name)
|
||||||
if is_enabled:
|
if is_enabled:
|
||||||
out_console.print(f'Filter {filter_name} is enabled for source {source_name}')
|
console.out.print(
|
||||||
|
f'Filter {console.highlight(ctx, filter_name)} is enabled for source {console.highlight(ctx, source_name)}'
|
||||||
|
)
|
||||||
else:
|
else:
|
||||||
out_console.print(f'Filter {filter_name} is disabled for source {source_name}')
|
console.out.print(
|
||||||
|
f'Filter {console.highlight(ctx, filter_name)} is disabled for source {console.highlight(ctx, source_name)}'
|
||||||
|
)
|
||||||
226
obsws_cli/commands/group.py
Normal file
226
obsws_cli/commands/group.py
Normal file
@@ -0,0 +1,226 @@
|
|||||||
|
"""module containing commands for manipulating groups in scenes."""
|
||||||
|
|
||||||
|
from typing import Annotated, Optional
|
||||||
|
|
||||||
|
import typer
|
||||||
|
from rich.table import Table
|
||||||
|
from rich.text import Text
|
||||||
|
|
||||||
|
from obsws_cli import console, util, validate
|
||||||
|
from obsws_cli.protocols import DataclassProtocol
|
||||||
|
|
||||||
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
|
@app.callback()
|
||||||
|
def main():
|
||||||
|
"""Control groups in OBS scenes."""
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('list')
|
||||||
|
@app.command('ls', hidden=True)
|
||||||
|
def list_(
|
||||||
|
ctx: typer.Context,
|
||||||
|
scene_name: Annotated[
|
||||||
|
Optional[str],
|
||||||
|
typer.Argument(
|
||||||
|
show_default='The current scene',
|
||||||
|
help='Scene name to list groups for',
|
||||||
|
callback=validate.scene_in_scenes,
|
||||||
|
),
|
||||||
|
] = None,
|
||||||
|
):
|
||||||
|
"""List groups in a scene."""
|
||||||
|
if scene_name is None:
|
||||||
|
scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name
|
||||||
|
|
||||||
|
resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
|
||||||
|
groups = [
|
||||||
|
(item.get('sceneItemId'), item.get('sourceName'), item.get('sceneItemEnabled'))
|
||||||
|
for item in resp.scene_items
|
||||||
|
if item.get('isGroup')
|
||||||
|
]
|
||||||
|
|
||||||
|
if not groups:
|
||||||
|
console.out.print(
|
||||||
|
f'No groups found in scene {console.highlight(ctx, scene_name)}.'
|
||||||
|
)
|
||||||
|
raise typer.Exit()
|
||||||
|
|
||||||
|
table = Table(
|
||||||
|
title=f'Groups in Scene: {scene_name}',
|
||||||
|
padding=(0, 2),
|
||||||
|
border_style=ctx.obj['style'].border,
|
||||||
|
)
|
||||||
|
|
||||||
|
columns = [
|
||||||
|
(Text('ID', justify='center'), 'center', ctx.obj['style'].column),
|
||||||
|
(Text('Group Name', justify='center'), 'left', ctx.obj['style'].column),
|
||||||
|
(Text('Enabled', justify='center'), 'center', None),
|
||||||
|
]
|
||||||
|
for heading, justify, style in columns:
|
||||||
|
table.add_column(heading, justify=justify, style=style)
|
||||||
|
|
||||||
|
for item_id, group_name, is_enabled in groups:
|
||||||
|
table.add_row(
|
||||||
|
str(item_id),
|
||||||
|
group_name,
|
||||||
|
util.check_mark(is_enabled),
|
||||||
|
)
|
||||||
|
|
||||||
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
|
def _get_group(group_name: str, resp: DataclassProtocol) -> dict | None:
|
||||||
|
"""Get a group from the scene item list response."""
|
||||||
|
group = next(
|
||||||
|
(
|
||||||
|
item
|
||||||
|
for item in resp.scene_items
|
||||||
|
if item.get('sourceName') == group_name and item.get('isGroup')
|
||||||
|
),
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
return group
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('show')
|
||||||
|
@app.command('sh', hidden=True)
|
||||||
|
def show(
|
||||||
|
ctx: typer.Context,
|
||||||
|
scene_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Scene name the group is in',
|
||||||
|
callback=validate.scene_in_scenes,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
group_name: Annotated[
|
||||||
|
str, typer.Argument(..., show_default=False, help='Group name to show')
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Show a group in a scene."""
|
||||||
|
resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
|
||||||
|
if (group := _get_group(group_name, resp)) is None:
|
||||||
|
console.err.print(
|
||||||
|
f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].'
|
||||||
|
)
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
ctx.obj['obsws'].set_scene_item_enabled(
|
||||||
|
scene_name=scene_name,
|
||||||
|
item_id=int(group.get('sceneItemId')),
|
||||||
|
enabled=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('hide')
|
||||||
|
@app.command('h', hidden=True)
|
||||||
|
def hide(
|
||||||
|
ctx: typer.Context,
|
||||||
|
scene_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Scene name the group is in',
|
||||||
|
callback=validate.scene_in_scenes,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
group_name: Annotated[
|
||||||
|
str, typer.Argument(..., show_default=False, help='Group name to hide')
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Hide a group in a scene."""
|
||||||
|
resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
|
||||||
|
if (group := _get_group(group_name, resp)) is None:
|
||||||
|
console.err.print(
|
||||||
|
f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].'
|
||||||
|
)
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
ctx.obj['obsws'].set_scene_item_enabled(
|
||||||
|
scene_name=scene_name,
|
||||||
|
item_id=int(group.get('sceneItemId')),
|
||||||
|
enabled=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('toggle')
|
||||||
|
@app.command('tg', hidden=True)
|
||||||
|
def toggle(
|
||||||
|
ctx: typer.Context,
|
||||||
|
scene_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Scene name the group is in',
|
||||||
|
callback=validate.scene_in_scenes,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
group_name: Annotated[
|
||||||
|
str, typer.Argument(..., show_default=False, help='Group name to toggle')
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Toggle a group in a scene."""
|
||||||
|
resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
|
||||||
|
if (group := _get_group(group_name, resp)) is None:
|
||||||
|
console.err.print(
|
||||||
|
f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].'
|
||||||
|
)
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
new_state = not group.get('sceneItemEnabled')
|
||||||
|
ctx.obj['obsws'].set_scene_item_enabled(
|
||||||
|
scene_name=scene_name,
|
||||||
|
item_id=int(group.get('sceneItemId')),
|
||||||
|
enabled=new_state,
|
||||||
|
)
|
||||||
|
|
||||||
|
if new_state:
|
||||||
|
console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.')
|
||||||
|
else:
|
||||||
|
console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('status')
|
||||||
|
@app.command('ss', hidden=True)
|
||||||
|
def status(
|
||||||
|
ctx: typer.Context,
|
||||||
|
scene_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Scene name the group is in',
|
||||||
|
callback=validate.scene_in_scenes,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
group_name: Annotated[
|
||||||
|
str, typer.Argument(..., show_default=False, help='Group name to check status')
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Get the status of a group in a scene."""
|
||||||
|
resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
|
||||||
|
if (group := _get_group(group_name, resp)) is None:
|
||||||
|
console.err.print(
|
||||||
|
f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].'
|
||||||
|
)
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
enabled = ctx.obj['obsws'].get_scene_item_enabled(
|
||||||
|
scene_name=scene_name,
|
||||||
|
item_id=int(group.get('sceneItemId')),
|
||||||
|
)
|
||||||
|
|
||||||
|
if enabled.scene_item_enabled:
|
||||||
|
console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.')
|
||||||
|
else:
|
||||||
|
console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
|
||||||
@@ -3,14 +3,12 @@
|
|||||||
from typing import Annotated
|
from typing import Annotated
|
||||||
|
|
||||||
import typer
|
import typer
|
||||||
from rich.console import Console
|
|
||||||
from rich.table import Table
|
from rich.table import Table
|
||||||
|
from rich.text import Text
|
||||||
|
|
||||||
from .alias import AliasGroup
|
from obsws_cli import console
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
app = typer.Typer()
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
@@ -18,23 +16,37 @@ 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.get_hotkey_list()
|
resp = ctx.obj['obsws'].get_hotkey_list()
|
||||||
|
|
||||||
table = Table(title='Hotkeys', padding=(0, 2))
|
if not resp.hotkeys:
|
||||||
table.add_column('Hotkey Name', justify='left', style='cyan')
|
console.out.print('No hotkeys found.')
|
||||||
|
raise typer.Exit()
|
||||||
|
|
||||||
for hotkey in resp.hotkeys:
|
table = Table(
|
||||||
table.add_row(hotkey)
|
title='Hotkeys',
|
||||||
|
padding=(0, 2),
|
||||||
|
border_style=ctx.obj['style'].border,
|
||||||
|
)
|
||||||
|
table.add_column(
|
||||||
|
Text('Hotkey Name', justify='center'),
|
||||||
|
justify='left',
|
||||||
|
style=ctx.obj['style'].column,
|
||||||
|
)
|
||||||
|
|
||||||
out_console.print(table)
|
for i, hotkey in enumerate(resp.hotkeys):
|
||||||
|
table.add_row(hotkey, style='' if i % 2 == 0 else 'dim')
|
||||||
|
|
||||||
|
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[
|
||||||
@@ -42,10 +54,11 @@ def trigger(
|
|||||||
],
|
],
|
||||||
):
|
):
|
||||||
"""Trigger a hotkey by name."""
|
"""Trigger a hotkey by name."""
|
||||||
ctx.obj.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[
|
||||||
@@ -70,4 +83,4 @@ def trigger_sequence(
|
|||||||
] = False,
|
] = False,
|
||||||
):
|
):
|
||||||
"""Trigger a hotkey by sequence."""
|
"""Trigger a hotkey by sequence."""
|
||||||
ctx.obj.trigger_hotkey_by_key_sequence(key_id, shift, ctrl, alt, cmd)
|
ctx.obj['obsws'].trigger_hotkey_by_key_sequence(key_id, shift, ctrl, alt, cmd)
|
||||||
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)}.')
|
||||||
121
obsws_cli/commands/profile.py
Normal file
121
obsws_cli/commands/profile.py
Normal file
@@ -0,0 +1,121 @@
|
|||||||
|
"""module containing commands for manipulating profiles in OBS."""
|
||||||
|
|
||||||
|
from typing import Annotated
|
||||||
|
|
||||||
|
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 profiles in OBS."""
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('list')
|
||||||
|
@app.command('ls', hidden=True)
|
||||||
|
def list_(ctx: typer.Context):
|
||||||
|
"""List profiles."""
|
||||||
|
resp = ctx.obj['obsws'].get_profile_list()
|
||||||
|
|
||||||
|
if not resp.profiles:
|
||||||
|
console.out.print('No profiles found.')
|
||||||
|
raise typer.Exit()
|
||||||
|
|
||||||
|
table = Table(
|
||||||
|
title='Profiles', padding=(0, 2), border_style=ctx.obj['style'].border
|
||||||
|
)
|
||||||
|
columns = [
|
||||||
|
(Text('Profile Name', justify='center'), 'left', ctx.obj['style'].column),
|
||||||
|
(Text('Current', justify='center'), 'center', None),
|
||||||
|
]
|
||||||
|
for heading, justify, style in columns:
|
||||||
|
table.add_column(heading, justify=justify, style=style)
|
||||||
|
|
||||||
|
for profile in resp.profiles:
|
||||||
|
table.add_row(
|
||||||
|
profile,
|
||||||
|
util.check_mark(
|
||||||
|
ctx, profile == resp.current_profile_name, empty_if_false=True
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('current')
|
||||||
|
@app.command('get', hidden=True)
|
||||||
|
def current(ctx: typer.Context):
|
||||||
|
"""Get the current profile."""
|
||||||
|
resp = ctx.obj['obsws'].get_profile_list()
|
||||||
|
console.out.print(
|
||||||
|
f'Current profile: {console.highlight(ctx, resp.current_profile_name)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('switch')
|
||||||
|
@app.command('set', hidden=True)
|
||||||
|
def switch(
|
||||||
|
ctx: typer.Context,
|
||||||
|
profile_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Name of the profile to switch to',
|
||||||
|
callback=validate.profile_exists,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Switch to a profile."""
|
||||||
|
resp = ctx.obj['obsws'].get_profile_list()
|
||||||
|
if resp.current_profile_name == profile_name:
|
||||||
|
console.err.print(
|
||||||
|
f'Profile [yellow]{profile_name}[/yellow] is already the current profile.'
|
||||||
|
)
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
ctx.obj['obsws'].set_current_profile(profile_name)
|
||||||
|
console.out.print(f'Switched to profile {console.highlight(ctx, profile_name)}.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('create')
|
||||||
|
@app.command('new', hidden=True)
|
||||||
|
def create(
|
||||||
|
ctx: typer.Context,
|
||||||
|
profile_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Name of the profile to create.',
|
||||||
|
callback=validate.profile_not_exists,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Create a new profile."""
|
||||||
|
ctx.obj['obsws'].create_profile(profile_name)
|
||||||
|
console.out.print(f'Created profile {console.highlight(ctx, profile_name)}.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('remove')
|
||||||
|
@app.command('rm', hidden=True)
|
||||||
|
def remove(
|
||||||
|
ctx: typer.Context,
|
||||||
|
profile_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Name of the profile to remove.',
|
||||||
|
callback=validate.profile_exists,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Remove a profile."""
|
||||||
|
ctx.obj['obsws'].remove_profile(profile_name)
|
||||||
|
console.out.print(f'Removed profile {console.highlight(ctx, profile_name)}.')
|
||||||
89
obsws_cli/commands/projector.py
Normal file
89
obsws_cli/commands/projector.py
Normal file
@@ -0,0 +1,89 @@
|
|||||||
|
"""module containing commands for manipulating projectors in OBS."""
|
||||||
|
|
||||||
|
from typing import Annotated
|
||||||
|
|
||||||
|
import typer
|
||||||
|
from rich.table import Table
|
||||||
|
from rich.text import Text
|
||||||
|
|
||||||
|
from obsws_cli import console
|
||||||
|
|
||||||
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
|
@app.callback()
|
||||||
|
def main():
|
||||||
|
"""Control projectors in OBS."""
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('list-monitors')
|
||||||
|
@app.command('ls-m', hidden=True)
|
||||||
|
def list_monitors(ctx: typer.Context):
|
||||||
|
"""List available monitors."""
|
||||||
|
resp = ctx.obj['obsws'].get_monitor_list()
|
||||||
|
monitors = sorted(
|
||||||
|
((m['monitorIndex'], m['monitorName']) for m in resp.monitors),
|
||||||
|
key=lambda m: m[0],
|
||||||
|
)
|
||||||
|
|
||||||
|
if not monitors:
|
||||||
|
console.out.print('No monitors found.')
|
||||||
|
raise typer.Exit()
|
||||||
|
|
||||||
|
table = Table(
|
||||||
|
title='Available Monitors',
|
||||||
|
padding=(0, 2),
|
||||||
|
border_style=ctx.obj['style'].border,
|
||||||
|
)
|
||||||
|
table.add_column(
|
||||||
|
Text('Index', justify='center'), justify='center', style=ctx.obj['style'].column
|
||||||
|
)
|
||||||
|
table.add_column(
|
||||||
|
Text('Name', justify='center'), justify='left', style=ctx.obj['style'].column
|
||||||
|
)
|
||||||
|
|
||||||
|
for index, monitor in monitors:
|
||||||
|
table.add_row(str(index), monitor)
|
||||||
|
|
||||||
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('open')
|
||||||
|
@app.command('o', hidden=True)
|
||||||
|
def open(
|
||||||
|
ctx: typer.Context,
|
||||||
|
monitor_index: Annotated[
|
||||||
|
int,
|
||||||
|
typer.Option(help='Index of the monitor to open the projector on.'),
|
||||||
|
] = 0,
|
||||||
|
source_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
show_default='The current scene',
|
||||||
|
help='Name of the source to project.',
|
||||||
|
),
|
||||||
|
] = '',
|
||||||
|
):
|
||||||
|
"""Open a fullscreen projector for a source on a specific monitor."""
|
||||||
|
if not source_name:
|
||||||
|
source_name = ctx.obj['obsws'].get_current_program_scene().scene_name
|
||||||
|
|
||||||
|
monitors = ctx.obj['obsws'].get_monitor_list().monitors
|
||||||
|
for monitor in monitors:
|
||||||
|
if monitor['monitorIndex'] == monitor_index:
|
||||||
|
ctx.obj['obsws'].open_source_projector(
|
||||||
|
source_name=source_name,
|
||||||
|
monitor_index=monitor_index,
|
||||||
|
)
|
||||||
|
|
||||||
|
console.out.print(
|
||||||
|
f'Opened projector for source {console.highlight(ctx, source_name)} on monitor {console.highlight(ctx, monitor["monitorName"])}.'
|
||||||
|
)
|
||||||
|
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
console.err.print(
|
||||||
|
f'Monitor with index [yellow]{monitor_index}[/yellow] not found. '
|
||||||
|
f'Use [yellow]obsws-cli projector ls-m[/yellow] to see available monitors.'
|
||||||
|
)
|
||||||
|
raise typer.Exit(code=1)
|
||||||
180
obsws_cli/commands/record.py
Normal file
180
obsws_cli/commands/record.py
Normal file
@@ -0,0 +1,180 @@
|
|||||||
|
"""module for controlling OBS recording functionality."""
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Annotated, Optional
|
||||||
|
|
||||||
|
import typer
|
||||||
|
|
||||||
|
from obsws_cli import console
|
||||||
|
|
||||||
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
|
@app.callback()
|
||||||
|
def main():
|
||||||
|
"""Control OBS recording functionality."""
|
||||||
|
|
||||||
|
|
||||||
|
def _get_recording_status(ctx: typer.Context) -> tuple:
|
||||||
|
"""Get recording status."""
|
||||||
|
resp = ctx.obj['obsws'].get_record_status()
|
||||||
|
return resp.output_active, resp.output_paused
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('start')
|
||||||
|
@app.command('s', hidden=True)
|
||||||
|
def start(ctx: typer.Context):
|
||||||
|
"""Start recording."""
|
||||||
|
active, paused = _get_recording_status(ctx)
|
||||||
|
if active:
|
||||||
|
err_msg = 'Recording is already in progress, cannot start.'
|
||||||
|
if paused:
|
||||||
|
err_msg += ' Try resuming it.'
|
||||||
|
|
||||||
|
console.err.print(err_msg)
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
ctx.obj['obsws'].start_record()
|
||||||
|
console.out.print('Recording started successfully.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('stop')
|
||||||
|
@app.command('st', hidden=True)
|
||||||
|
def stop(ctx: typer.Context):
|
||||||
|
"""Stop recording."""
|
||||||
|
active, _ = _get_recording_status(ctx)
|
||||||
|
if not active:
|
||||||
|
console.err.print('Recording is not in progress, cannot stop.')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
resp = ctx.obj['obsws'].stop_record()
|
||||||
|
console.out.print(
|
||||||
|
f'Recording stopped successfully. Saved to: {console.highlight(ctx, resp.output_path)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('toggle')
|
||||||
|
@app.command('tg', hidden=True)
|
||||||
|
def toggle(ctx: typer.Context):
|
||||||
|
"""Toggle recording."""
|
||||||
|
resp = ctx.obj['obsws'].toggle_record()
|
||||||
|
if resp.output_active:
|
||||||
|
console.out.print('Recording started successfully.')
|
||||||
|
else:
|
||||||
|
console.out.print('Recording stopped successfully.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('status')
|
||||||
|
@app.command('ss', hidden=True)
|
||||||
|
def status(ctx: typer.Context):
|
||||||
|
"""Get recording status."""
|
||||||
|
active, paused = _get_recording_status(ctx)
|
||||||
|
if active:
|
||||||
|
if paused:
|
||||||
|
console.out.print('Recording is in progress and paused.')
|
||||||
|
else:
|
||||||
|
console.out.print('Recording is in progress.')
|
||||||
|
else:
|
||||||
|
console.out.print('Recording is not in progress.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('resume')
|
||||||
|
@app.command('r', hidden=True)
|
||||||
|
def resume(ctx: typer.Context):
|
||||||
|
"""Resume recording."""
|
||||||
|
active, paused = _get_recording_status(ctx)
|
||||||
|
if not active:
|
||||||
|
console.err.print('Recording is not in progress, cannot resume.')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
if not paused:
|
||||||
|
console.err.print('Recording is in progress but not paused, cannot resume.')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
ctx.obj['obsws'].resume_record()
|
||||||
|
console.out.print('Recording resumed successfully.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('pause')
|
||||||
|
@app.command('p', hidden=True)
|
||||||
|
def pause(ctx: typer.Context):
|
||||||
|
"""Pause recording."""
|
||||||
|
active, paused = _get_recording_status(ctx)
|
||||||
|
if not active:
|
||||||
|
console.err.print('Recording is not in progress, cannot pause.')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
if paused:
|
||||||
|
console.err.print('Recording is in progress but already paused, cannot pause.')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
ctx.obj['obsws'].pause_record()
|
||||||
|
console.out.print('Recording paused successfully.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('directory')
|
||||||
|
@app.command('d', hidden=True)
|
||||||
|
def directory(
|
||||||
|
ctx: typer.Context,
|
||||||
|
record_directory: Annotated[
|
||||||
|
Optional[Path],
|
||||||
|
# Since the CLI and OBS may be running on different platforms,
|
||||||
|
# we won't validate the path here.
|
||||||
|
typer.Argument(
|
||||||
|
file_okay=False,
|
||||||
|
dir_okay=True,
|
||||||
|
help='Directory to set for recording.',
|
||||||
|
),
|
||||||
|
] = None,
|
||||||
|
):
|
||||||
|
"""Get or set the recording directory."""
|
||||||
|
if record_directory is not None:
|
||||||
|
ctx.obj['obsws'].set_record_directory(str(record_directory))
|
||||||
|
console.out.print(
|
||||||
|
f'Recording directory updated to: {console.highlight(ctx, record_directory)}'
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
resp = ctx.obj['obsws'].get_record_directory()
|
||||||
|
console.out.print(
|
||||||
|
f'Recording directory: {console.highlight(ctx, resp.record_directory)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('split')
|
||||||
|
@app.command('sp', hidden=True)
|
||||||
|
def split(ctx: typer.Context):
|
||||||
|
"""Split the current recording."""
|
||||||
|
active, paused = _get_recording_status(ctx)
|
||||||
|
if not active:
|
||||||
|
console.err.print('Recording is not in progress, cannot split.')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
if paused:
|
||||||
|
console.err.print('Recording is paused, cannot split.')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
ctx.obj['obsws'].split_record_file()
|
||||||
|
console.out.print('Recording split successfully.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('chapter')
|
||||||
|
@app.command('ch', hidden=True)
|
||||||
|
def chapter(
|
||||||
|
ctx: typer.Context,
|
||||||
|
chapter_name: Annotated[
|
||||||
|
Optional[str],
|
||||||
|
typer.Argument(
|
||||||
|
help='Name of the chapter to create.',
|
||||||
|
),
|
||||||
|
] = None,
|
||||||
|
):
|
||||||
|
"""Create a chapter in the current recording."""
|
||||||
|
active, paused = _get_recording_status(ctx)
|
||||||
|
if not active:
|
||||||
|
console.err.print('Recording is not in progress, cannot create chapter.')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
if paused:
|
||||||
|
console.err.print('Recording is paused, cannot create chapter.')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
ctx.obj['obsws'].create_record_chapter(chapter_name)
|
||||||
|
console.out.print(
|
||||||
|
f'Chapter {console.highlight(ctx, chapter_name or "unnamed")} created successfully.'
|
||||||
|
)
|
||||||
68
obsws_cli/commands/replaybuffer.py
Normal file
68
obsws_cli/commands/replaybuffer.py
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
"""module containing commands for manipulating the replay buffer in OBS."""
|
||||||
|
|
||||||
|
import typer
|
||||||
|
|
||||||
|
from obsws_cli import console
|
||||||
|
|
||||||
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
|
@app.callback()
|
||||||
|
def main():
|
||||||
|
"""Control profiles in OBS."""
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('start')
|
||||||
|
@app.command('s', hidden=True)
|
||||||
|
def start(ctx: typer.Context):
|
||||||
|
"""Start the replay buffer."""
|
||||||
|
resp = ctx.obj['obsws'].get_replay_buffer_status()
|
||||||
|
if resp.output_active:
|
||||||
|
console.err.print('Replay buffer is already active.')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
ctx.obj['obsws'].start_replay_buffer()
|
||||||
|
console.out.print('Replay buffer started.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('stop')
|
||||||
|
@app.command('st', hidden=True)
|
||||||
|
def stop(ctx: typer.Context):
|
||||||
|
"""Stop the replay buffer."""
|
||||||
|
resp = ctx.obj['obsws'].get_replay_buffer_status()
|
||||||
|
if not resp.output_active:
|
||||||
|
console.err.print('Replay buffer is not active.')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
ctx.obj['obsws'].stop_replay_buffer()
|
||||||
|
console.out.print('Replay buffer stopped.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('toggle')
|
||||||
|
@app.command('tg', hidden=True)
|
||||||
|
def toggle(ctx: typer.Context):
|
||||||
|
"""Toggle the replay buffer."""
|
||||||
|
resp = ctx.obj['obsws'].toggle_replay_buffer()
|
||||||
|
if resp.output_active:
|
||||||
|
console.out.print('Replay buffer is active.')
|
||||||
|
else:
|
||||||
|
console.out.print('Replay buffer is not active.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('status')
|
||||||
|
@app.command('ss', hidden=True)
|
||||||
|
def status(ctx: typer.Context):
|
||||||
|
"""Get the status of the replay buffer."""
|
||||||
|
resp = ctx.obj['obsws'].get_replay_buffer_status()
|
||||||
|
if resp.output_active:
|
||||||
|
console.out.print('Replay buffer is active.')
|
||||||
|
else:
|
||||||
|
console.out.print('Replay buffer is not active.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('save')
|
||||||
|
@app.command('sv', hidden=True)
|
||||||
|
def save(ctx: typer.Context):
|
||||||
|
"""Save the replay buffer."""
|
||||||
|
ctx.obj['obsws'].save_replay_buffer()
|
||||||
|
console.out.print('Replay buffer saved.')
|
||||||
124
obsws_cli/commands/scene.py
Normal file
124
obsws_cli/commands/scene.py
Normal file
@@ -0,0 +1,124 @@
|
|||||||
|
"""module containing commands for controlling OBS scenes."""
|
||||||
|
|
||||||
|
from typing import Annotated
|
||||||
|
|
||||||
|
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 OBS scenes."""
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('list')
|
||||||
|
@app.command('ls', hidden=True)
|
||||||
|
def list_(
|
||||||
|
ctx: typer.Context,
|
||||||
|
uuid: Annotated[bool, typer.Option(help='Show UUIDs of scenes')] = False,
|
||||||
|
):
|
||||||
|
"""List all scenes."""
|
||||||
|
resp = ctx.obj['obsws'].get_scene_list()
|
||||||
|
scenes = (
|
||||||
|
(scene.get('sceneName'), scene.get('sceneUuid'))
|
||||||
|
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
|
||||||
|
|
||||||
|
table = Table(title='Scenes', padding=(0, 2), border_style=ctx.obj['style'].border)
|
||||||
|
if uuid:
|
||||||
|
columns = [
|
||||||
|
(Text('Scene Name', justify='center'), 'left', ctx.obj['style'].column),
|
||||||
|
(Text('Active', justify='center'), 'center', None),
|
||||||
|
(Text('UUID', justify='center'), 'left', ctx.obj['style'].column),
|
||||||
|
]
|
||||||
|
else:
|
||||||
|
columns = [
|
||||||
|
(Text('Scene Name', justify='center'), 'left', ctx.obj['style'].column),
|
||||||
|
(Text('Active', justify='center'), 'center', None),
|
||||||
|
]
|
||||||
|
for heading, justify, style in columns:
|
||||||
|
table.add_column(heading, justify=justify, style=style)
|
||||||
|
|
||||||
|
for scene_name, scene_uuid in scenes:
|
||||||
|
if uuid:
|
||||||
|
table.add_row(
|
||||||
|
scene_name,
|
||||||
|
util.check_mark(scene_name == active_scene, empty_if_false=True),
|
||||||
|
scene_uuid,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
table.add_row(
|
||||||
|
scene_name,
|
||||||
|
util.check_mark(scene_name == active_scene, empty_if_false=True),
|
||||||
|
)
|
||||||
|
|
||||||
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('current')
|
||||||
|
@app.command('get', hidden=True)
|
||||||
|
def current(
|
||||||
|
ctx: typer.Context,
|
||||||
|
preview: Annotated[
|
||||||
|
bool,
|
||||||
|
typer.Option(
|
||||||
|
help='Get the preview scene instead of the program scene',
|
||||||
|
callback=validate.studio_mode_enabled,
|
||||||
|
),
|
||||||
|
] = False,
|
||||||
|
):
|
||||||
|
"""Get the current program scene or preview scene."""
|
||||||
|
if preview:
|
||||||
|
resp = ctx.obj['obsws'].get_current_preview_scene()
|
||||||
|
console.out.print(
|
||||||
|
f'Current Preview Scene: {console.highlight(ctx, resp.current_preview_scene_name)}'
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
resp = ctx.obj['obsws'].get_current_program_scene()
|
||||||
|
console.out.print(
|
||||||
|
f'Current Program Scene: {console.highlight(ctx, resp.current_program_scene_name)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('switch')
|
||||||
|
@app.command('set', hidden=True)
|
||||||
|
def switch(
|
||||||
|
ctx: typer.Context,
|
||||||
|
scene_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
help='Name of the scene to switch to',
|
||||||
|
callback=validate.scene_in_scenes,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
preview: Annotated[
|
||||||
|
bool,
|
||||||
|
typer.Option(
|
||||||
|
help='Switch to the preview scene instead of the program scene',
|
||||||
|
callback=validate.studio_mode_enabled,
|
||||||
|
),
|
||||||
|
] = False,
|
||||||
|
):
|
||||||
|
"""Switch to a scene."""
|
||||||
|
if preview:
|
||||||
|
ctx.obj['obsws'].set_current_preview_scene(scene_name)
|
||||||
|
console.out.print(
|
||||||
|
f'Switched to preview scene: {console.highlight(ctx, scene_name)}'
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
ctx.obj['obsws'].set_current_program_scene(scene_name)
|
||||||
|
console.out.print(
|
||||||
|
f'Switched to program scene: {console.highlight(ctx, scene_name)}'
|
||||||
|
)
|
||||||
99
obsws_cli/commands/scenecollection.py
Normal file
99
obsws_cli/commands/scenecollection.py
Normal file
@@ -0,0 +1,99 @@
|
|||||||
|
"""module containing commands for manipulating scene collections."""
|
||||||
|
|
||||||
|
from typing import Annotated
|
||||||
|
|
||||||
|
import typer
|
||||||
|
from rich.table import Table
|
||||||
|
|
||||||
|
from obsws_cli import console, validate
|
||||||
|
|
||||||
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
|
@app.callback()
|
||||||
|
def main():
|
||||||
|
"""Control scene collections in OBS."""
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('list')
|
||||||
|
@app.command('ls', hidden=True)
|
||||||
|
def list_(ctx: typer.Context):
|
||||||
|
"""List all scene collections."""
|
||||||
|
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(
|
||||||
|
title='Scene Collections',
|
||||||
|
padding=(0, 2),
|
||||||
|
border_style=ctx.obj['style'].border,
|
||||||
|
)
|
||||||
|
table.add_column(
|
||||||
|
'Scene Collection Name', justify='left', style=ctx.obj['style'].column
|
||||||
|
)
|
||||||
|
|
||||||
|
for scene_collection_name in resp.scene_collections:
|
||||||
|
table.add_row(scene_collection_name)
|
||||||
|
|
||||||
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('current')
|
||||||
|
@app.command('get', hidden=True)
|
||||||
|
def current(ctx: typer.Context):
|
||||||
|
"""Get the current scene collection."""
|
||||||
|
resp = ctx.obj['obsws'].get_scene_collection_list()
|
||||||
|
console.out.print(
|
||||||
|
f'Current scene collection: {console.highlight(ctx, resp.current_scene_collection_name)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('switch')
|
||||||
|
@app.command('set', hidden=True)
|
||||||
|
def switch(
|
||||||
|
ctx: typer.Context,
|
||||||
|
scene_collection_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
help='Name of the scene collection to switch to',
|
||||||
|
callback=validate.scene_collection_in_scene_collections,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Switch to a scene collection."""
|
||||||
|
current_scene_collection = (
|
||||||
|
ctx.obj['obsws'].get_scene_collection_list().current_scene_collection_name
|
||||||
|
)
|
||||||
|
if scene_collection_name == current_scene_collection:
|
||||||
|
console.err.print(
|
||||||
|
f'Scene collection [yellow]{scene_collection_name}[/yellow] is already active.'
|
||||||
|
)
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
ctx.obj['obsws'].set_current_scene_collection(scene_collection_name)
|
||||||
|
console.out.print(
|
||||||
|
f'Switched to scene collection {console.highlight(ctx, scene_collection_name)}.'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('create')
|
||||||
|
@app.command('new', hidden=True)
|
||||||
|
def create(
|
||||||
|
ctx: typer.Context,
|
||||||
|
scene_collection_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
help='Name of the scene collection to create',
|
||||||
|
callback=validate.scene_collection_not_in_scene_collections,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
):
|
||||||
|
"""Create a new scene collection."""
|
||||||
|
ctx.obj['obsws'].create_scene_collection(scene_collection_name)
|
||||||
|
console.out.print(
|
||||||
|
f'Created scene collection {console.highlight(ctx, scene_collection_name)}.'
|
||||||
|
)
|
||||||
@@ -1,19 +1,13 @@
|
|||||||
"""module containing commands for manipulating items in scenes."""
|
"""module containing commands for manipulating items in scenes."""
|
||||||
|
|
||||||
from collections.abc import Callable
|
|
||||||
from typing import Annotated, Optional
|
from typing import Annotated, Optional
|
||||||
|
|
||||||
import obsws_python as obsws
|
|
||||||
import typer
|
import typer
|
||||||
from rich.console import Console
|
|
||||||
from rich.table import Table
|
from rich.table import Table
|
||||||
|
|
||||||
from . import validate
|
from obsws_cli import console, util, validate
|
||||||
from .alias import AliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
app = typer.Typer()
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
@@ -21,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[
|
||||||
@@ -29,18 +24,16 @@ 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,
|
||||||
):
|
):
|
||||||
"""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.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):
|
resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
|
||||||
err_console.print(f"Scene '{scene_name}' not found.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj.get_scene_item_list(scene_name)
|
|
||||||
items = sorted(
|
items = sorted(
|
||||||
(
|
(
|
||||||
(
|
(
|
||||||
@@ -48,6 +41,7 @@ def list_(
|
|||||||
item.get('sourceName'),
|
item.get('sourceName'),
|
||||||
item.get('isGroup'),
|
item.get('isGroup'),
|
||||||
item.get('sceneItemEnabled'),
|
item.get('sceneItemEnabled'),
|
||||||
|
item.get('sourceUuid', 'N/A'), # Include source UUID
|
||||||
)
|
)
|
||||||
for item in resp.scene_items
|
for item in resp.scene_items
|
||||||
),
|
),
|
||||||
@@ -55,80 +49,118 @@ def list_(
|
|||||||
)
|
)
|
||||||
|
|
||||||
if not items:
|
if not items:
|
||||||
out_console.print(f"No items found in scene '{scene_name}'.")
|
console.out.print(
|
||||||
|
f'No items found in scene {console.highlight(ctx, scene_name)}.'
|
||||||
|
)
|
||||||
raise typer.Exit()
|
raise typer.Exit()
|
||||||
|
|
||||||
table = Table(title=f'Items in Scene: {scene_name}', padding=(0, 2))
|
table = Table(
|
||||||
for column in ('Item ID', 'Item Name', 'In Group', 'Enabled'):
|
title=f'Items in Scene: {scene_name}',
|
||||||
table.add_column(
|
padding=(0, 2),
|
||||||
column, justify='left' if column == 'Item Name' else 'center', style='cyan'
|
border_style=ctx.obj['style'].border,
|
||||||
)
|
)
|
||||||
|
if uuid:
|
||||||
|
columns = [
|
||||||
|
('Item ID', 'center', ctx.obj['style'].column),
|
||||||
|
('Item Name', 'left', ctx.obj['style'].column),
|
||||||
|
('In Group', 'left', ctx.obj['style'].column),
|
||||||
|
('Enabled', 'center', None),
|
||||||
|
('UUID', 'left', ctx.obj['style'].column),
|
||||||
|
]
|
||||||
|
else:
|
||||||
|
columns = [
|
||||||
|
('Item ID', 'center', ctx.obj['style'].column),
|
||||||
|
('Item Name', 'left', ctx.obj['style'].column),
|
||||||
|
('In Group', 'left', ctx.obj['style'].column),
|
||||||
|
('Enabled', 'center', None),
|
||||||
|
]
|
||||||
|
# Add columns to the table
|
||||||
|
for heading, justify, style in columns:
|
||||||
|
table.add_column(heading, justify=justify, style=style)
|
||||||
|
|
||||||
for item_id, item_name, is_group, is_enabled in items:
|
for item_id, item_name, is_group, is_enabled, source_uuid in items:
|
||||||
if is_group:
|
if is_group:
|
||||||
resp = ctx.obj.get_group_scene_item_list(item_name)
|
resp = ctx.obj['obsws'].get_group_scene_item_list(item_name)
|
||||||
group_items = sorted(
|
group_items = sorted(
|
||||||
(
|
(
|
||||||
(
|
(
|
||||||
gi.get('sceneItemId'),
|
gi.get('sceneItemId'),
|
||||||
gi.get('sourceName'),
|
gi.get('sourceName'),
|
||||||
gi.get('sceneItemEnabled'),
|
gi.get('sceneItemEnabled'),
|
||||||
|
gi.get('sourceUuid', 'N/A'), # Include source UUID
|
||||||
)
|
)
|
||||||
for gi in resp.scene_items
|
for gi in resp.scene_items
|
||||||
),
|
),
|
||||||
key=lambda x: x[0], # Sort by sceneItemId
|
key=lambda x: x[0], # Sort by sceneItemId
|
||||||
)
|
)
|
||||||
for group_item_id, group_item_name, group_item_enabled in group_items:
|
for (
|
||||||
|
group_item_id,
|
||||||
|
group_item_name,
|
||||||
|
group_item_enabled,
|
||||||
|
group_item_source_uuid,
|
||||||
|
) in group_items:
|
||||||
|
if uuid:
|
||||||
table.add_row(
|
table.add_row(
|
||||||
str(group_item_id),
|
str(group_item_id),
|
||||||
group_item_name,
|
group_item_name,
|
||||||
item_name,
|
item_name,
|
||||||
':white_heavy_check_mark:'
|
util.check_mark(is_enabled and group_item_enabled),
|
||||||
if is_enabled and group_item_enabled
|
group_item_source_uuid,
|
||||||
else ':x:',
|
)
|
||||||
|
else:
|
||||||
|
table.add_row(
|
||||||
|
str(group_item_id),
|
||||||
|
group_item_name,
|
||||||
|
item_name,
|
||||||
|
util.check_mark(is_enabled and group_item_enabled),
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
if uuid:
|
||||||
|
table.add_row(
|
||||||
|
str(item_id),
|
||||||
|
item_name,
|
||||||
|
'',
|
||||||
|
util.check_mark(is_enabled),
|
||||||
|
source_uuid,
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
table.add_row(
|
table.add_row(
|
||||||
str(item_id),
|
str(item_id),
|
||||||
item_name,
|
item_name,
|
||||||
'',
|
'',
|
||||||
':white_heavy_check_mark:' if is_enabled else ':x:',
|
util.check_mark(is_enabled),
|
||||||
)
|
)
|
||||||
|
|
||||||
out_console.print(table)
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
def _validate_scene_name_and_item_name(
|
def _validate_sources(
|
||||||
func: Callable,
|
|
||||||
):
|
|
||||||
"""Validate the scene name and item name."""
|
|
||||||
|
|
||||||
def wrapper(
|
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
scene_name: str,
|
scene_name: str,
|
||||||
item_name: str,
|
item_name: str,
|
||||||
group: Optional[str] = None,
|
group: Optional[str] = None,
|
||||||
):
|
) -> bool:
|
||||||
|
"""Validate the scene name and item name."""
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
if not validate.scene_in_scenes(ctx, scene_name):
|
||||||
err_console.print(f"Scene '{scene_name}' not found.")
|
console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
|
||||||
raise typer.Exit(1)
|
return False
|
||||||
|
|
||||||
if group:
|
if group:
|
||||||
if not validate.item_in_scene_item_list(ctx, scene_name, group):
|
if not validate.item_in_scene_item_list(ctx, scene_name, group):
|
||||||
err_console.print(
|
console.err.print(
|
||||||
f"Parent group '{group}' not found in scene '{scene_name}'."
|
f'Group [yellow]{group}[/yellow] not found in scene [yellow]{scene_name}[/yellow].'
|
||||||
)
|
)
|
||||||
raise typer.Exit(1)
|
return False
|
||||||
else:
|
else:
|
||||||
if not validate.item_in_scene_item_list(ctx, scene_name, item_name):
|
if not validate.item_in_scene_item_list(ctx, scene_name, item_name):
|
||||||
err_console.print(
|
console.err.print(
|
||||||
f"Item '{item_name}' not found in scene '{scene_name}'."
|
f'Item [yellow]{item_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow]. Is the item in a group? '
|
||||||
|
f'If so use the [yellow]--group[/yellow] option to specify the parent group.\n'
|
||||||
|
'Use [yellow]obsws-cli sceneitem ls[/yellow] for a list of items in the scene.'
|
||||||
)
|
)
|
||||||
raise typer.Exit(1)
|
return False
|
||||||
|
|
||||||
return func(ctx, scene_name, item_name, group)
|
return True
|
||||||
|
|
||||||
return wrapper
|
|
||||||
|
|
||||||
|
|
||||||
def _get_scene_name_and_item_id(
|
def _get_scene_name_and_item_id(
|
||||||
@@ -136,187 +168,39 @@ def _get_scene_name_and_item_id(
|
|||||||
):
|
):
|
||||||
"""Get the scene name and item ID for the given scene and item name."""
|
"""Get the scene name and item ID for the given scene and item name."""
|
||||||
if group:
|
if group:
|
||||||
resp = ctx.obj.get_group_scene_item_list(group)
|
resp = ctx.obj['obsws'].get_group_scene_item_list(group)
|
||||||
for item in resp.scene_items:
|
for item in resp.scene_items:
|
||||||
if item.get('sourceName') == item_name:
|
if item.get('sourceName') == item_name:
|
||||||
scene_name = group
|
scene_name = group
|
||||||
scene_item_id = item.get('sceneItemId')
|
scene_item_id = item.get('sceneItemId')
|
||||||
break
|
break
|
||||||
else:
|
else:
|
||||||
err_console.print(f"Item '{item_name}' not found in group '{group}'.")
|
console.err.print(
|
||||||
raise typer.Exit(1)
|
f'Item [yellow]{item_name}[/yellow] not found in group [yellow]{group}[/yellow].'
|
||||||
else:
|
|
||||||
try:
|
|
||||||
resp = ctx.obj.get_scene_item_id(scene_name, item_name)
|
|
||||||
except obsws.error.OBSSDKRequestError as e:
|
|
||||||
if e.code == 600:
|
|
||||||
err_console.print(
|
|
||||||
f"Item '{item_name}' not found in scene '{scene_name}'. Is the item in a group? "
|
|
||||||
'If so use the --group option to specify the parent group. '
|
|
||||||
'See `obsws-cli sceneitem list` for a list of items in the scene.'
|
|
||||||
)
|
)
|
||||||
raise typer.Exit(1)
|
raise typer.Exit(1)
|
||||||
else:
|
else:
|
||||||
raise
|
resp = ctx.obj['obsws'].get_scene_item_id(scene_name, item_name)
|
||||||
scene_item_id = resp.scene_item_id
|
scene_item_id = resp.scene_item_id
|
||||||
|
|
||||||
return scene_name, scene_item_id
|
return scene_name, scene_item_id
|
||||||
|
|
||||||
|
|
||||||
@_validate_scene_name_and_item_name
|
@app.command('show')
|
||||||
@app.command('show | sh')
|
@app.command('sh', hidden=True)
|
||||||
def show(
|
def show(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
scene_name: Annotated[str, typer.Argument(..., help='Scene name the item is in')],
|
scene_name: Annotated[
|
||||||
|
str, typer.Argument(..., show_default=False, help='Scene name the item is in')
|
||||||
|
],
|
||||||
item_name: Annotated[
|
item_name: Annotated[
|
||||||
str, typer.Argument(..., help='Item name to show in the scene')
|
str,
|
||||||
|
typer.Argument(..., show_default=False, help='Item name to show in the scene'),
|
||||||
],
|
],
|
||||||
group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
|
group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
|
||||||
):
|
):
|
||||||
"""Show an item in a scene."""
|
"""Show an item in a scene."""
|
||||||
scene_name, scene_item_id = _get_scene_name_and_item_id(
|
if not _validate_sources(ctx, scene_name, item_name, group):
|
||||||
ctx, scene_name, item_name, group
|
|
||||||
)
|
|
||||||
|
|
||||||
ctx.obj.set_scene_item_enabled(
|
|
||||||
scene_name=scene_name,
|
|
||||||
item_id=int(scene_item_id),
|
|
||||||
enabled=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
if group:
|
|
||||||
out_console.print(
|
|
||||||
f"Item '{item_name}' in group '{group}' in scene '{scene_name}' has been shown."
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
# If not in a parent group, just show the scene name
|
|
||||||
# This is to avoid confusion with the parent group name
|
|
||||||
# which is not the same as the scene name
|
|
||||||
# and is not needed in this case
|
|
||||||
out_console.print(f"Item '{item_name}' in scene '{scene_name}' has been shown.")
|
|
||||||
|
|
||||||
|
|
||||||
@_validate_scene_name_and_item_name
|
|
||||||
@app.command('hide | h')
|
|
||||||
def hide(
|
|
||||||
ctx: typer.Context,
|
|
||||||
scene_name: Annotated[str, typer.Argument(..., help='Scene name the item is in')],
|
|
||||||
item_name: Annotated[
|
|
||||||
str, typer.Argument(..., help='Item name to hide in the scene')
|
|
||||||
],
|
|
||||||
group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
|
|
||||||
):
|
|
||||||
"""Hide an item in a scene."""
|
|
||||||
scene_name, scene_item_id = _get_scene_name_and_item_id(
|
|
||||||
ctx, scene_name, item_name, group
|
|
||||||
)
|
|
||||||
|
|
||||||
ctx.obj.set_scene_item_enabled(
|
|
||||||
scene_name=scene_name,
|
|
||||||
item_id=int(scene_item_id),
|
|
||||||
enabled=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
if group:
|
|
||||||
out_console.print(
|
|
||||||
f"Item '{item_name}' in group '{group}' in scene '{scene_name}' has been hidden."
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
# If not in a parent group, just show the scene name
|
|
||||||
# This is to avoid confusion with the parent group name
|
|
||||||
# which is not the same as the scene name
|
|
||||||
# and is not needed in this case
|
|
||||||
out_console.print(
|
|
||||||
f"Item '{item_name}' in scene '{scene_name}' has been hidden."
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@_validate_scene_name_and_item_name
|
|
||||||
@app.command('toggle | tg')
|
|
||||||
def toggle(
|
|
||||||
ctx: typer.Context,
|
|
||||||
scene_name: Annotated[str, typer.Argument(..., help='Scene name the item is in')],
|
|
||||||
item_name: Annotated[
|
|
||||||
str, typer.Argument(..., help='Item name to toggle in the scene')
|
|
||||||
],
|
|
||||||
group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
|
|
||||||
):
|
|
||||||
"""Toggle an item in a scene."""
|
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
|
||||||
err_console.print(f"Scene '{scene_name}' not found.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
if group:
|
|
||||||
if not validate.item_in_scene_item_list(ctx, scene_name, group):
|
|
||||||
err_console.print(
|
|
||||||
f"Parent group '{group}' not found in scene '{scene_name}'."
|
|
||||||
)
|
|
||||||
raise typer.Exit(1)
|
|
||||||
else:
|
|
||||||
if not validate.item_in_scene_item_list(ctx, scene_name, item_name):
|
|
||||||
err_console.print(f"Item '{item_name}' not found in scene '{scene_name}'.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
scene_name, scene_item_id = _get_scene_name_and_item_id(
|
|
||||||
ctx, scene_name, item_name, group
|
|
||||||
)
|
|
||||||
|
|
||||||
enabled = ctx.obj.get_scene_item_enabled(
|
|
||||||
scene_name=scene_name,
|
|
||||||
item_id=int(scene_item_id),
|
|
||||||
)
|
|
||||||
new_state = not enabled.scene_item_enabled
|
|
||||||
|
|
||||||
ctx.obj.set_scene_item_enabled(
|
|
||||||
scene_name=scene_name,
|
|
||||||
item_id=int(scene_item_id),
|
|
||||||
enabled=new_state,
|
|
||||||
)
|
|
||||||
|
|
||||||
if group:
|
|
||||||
if new_state:
|
|
||||||
out_console.print(
|
|
||||||
f"Item '{item_name}' in group '{group}' in scene '{scene_name}' has been shown."
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
out_console.print(
|
|
||||||
f"Item '{item_name}' in group '{group}' in scene '{scene_name}' has been hidden."
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
# If not in a parent group, just show the scene name
|
|
||||||
# This is to avoid confusion with the parent group name
|
|
||||||
# which is not the same as the scene name
|
|
||||||
# and is not needed in this case
|
|
||||||
if new_state:
|
|
||||||
out_console.print(
|
|
||||||
f"Item '{item_name}' in scene '{scene_name}' has been shown."
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
out_console.print(
|
|
||||||
f"Item '{item_name}' in scene '{scene_name}' has been hidden."
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@_validate_scene_name_and_item_name
|
|
||||||
@app.command('visible | v')
|
|
||||||
def visible(
|
|
||||||
ctx: typer.Context,
|
|
||||||
scene_name: Annotated[str, typer.Argument(..., help='Scene name the item is in')],
|
|
||||||
item_name: Annotated[
|
|
||||||
str, typer.Argument(..., help='Item name to check visibility in the scene')
|
|
||||||
],
|
|
||||||
group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
|
|
||||||
):
|
|
||||||
"""Check if an item in a scene is visible."""
|
|
||||||
if group:
|
|
||||||
if not validate.item_in_scene_item_list(ctx, scene_name, group):
|
|
||||||
err_console.print(
|
|
||||||
f"Parent group '{group}' not found in scene '{scene_name}'."
|
|
||||||
)
|
|
||||||
raise typer.Exit(1)
|
|
||||||
else:
|
|
||||||
if not validate.item_in_scene_item_list(ctx, scene_name, item_name):
|
|
||||||
err_console.print(f"Item '{item_name}' not found in scene '{scene_name}'.")
|
|
||||||
raise typer.Exit(1)
|
raise typer.Exit(1)
|
||||||
|
|
||||||
old_scene_name = scene_name
|
old_scene_name = scene_name
|
||||||
@@ -324,31 +208,189 @@ def visible(
|
|||||||
ctx, scene_name, item_name, group
|
ctx, scene_name, item_name, group
|
||||||
)
|
)
|
||||||
|
|
||||||
enabled = ctx.obj.get_scene_item_enabled(
|
ctx.obj['obsws'].set_scene_item_enabled(
|
||||||
scene_name=scene_name,
|
scene_name=scene_name,
|
||||||
item_id=int(scene_item_id),
|
item_id=int(scene_item_id),
|
||||||
|
enabled=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
if group:
|
if group:
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f"Item '{item_name}' in group '{group}' in scene '{old_scene_name}' is currently {'visible' if enabled.scene_item_enabled else 'hidden'}."
|
f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} '
|
||||||
|
f'in scene {console.highlight(ctx, old_scene_name)} has been shown.'
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
# If not in a parent group, just show the scene name
|
# If not in a parent group, just show the scene name
|
||||||
# This is to avoid confusion with the parent group name
|
# This is to avoid confusion with the parent group name
|
||||||
# which is not the same as the scene name
|
# which is not the same as the scene name
|
||||||
# and is not needed in this case
|
# and is not needed in this case
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f"Item '{item_name}' in scene '{scene_name}' is currently {'visible' if enabled.scene_item_enabled else 'hidden'}."
|
f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been shown.'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@_validate_scene_name_and_item_name
|
@app.command('hide')
|
||||||
@app.command('transform | t')
|
@app.command('h', hidden=True)
|
||||||
|
def hide(
|
||||||
|
ctx: typer.Context,
|
||||||
|
scene_name: Annotated[
|
||||||
|
str, typer.Argument(..., show_default=False, help='Scene name the item is in')
|
||||||
|
],
|
||||||
|
item_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(..., show_default=False, help='Item name to hide in the scene'),
|
||||||
|
],
|
||||||
|
group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
|
||||||
|
):
|
||||||
|
"""Hide an item in a scene."""
|
||||||
|
if not _validate_sources(ctx, scene_name, item_name, group):
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
old_scene_name = scene_name
|
||||||
|
scene_name, scene_item_id = _get_scene_name_and_item_id(
|
||||||
|
ctx, scene_name, item_name, group
|
||||||
|
)
|
||||||
|
|
||||||
|
ctx.obj['obsws'].set_scene_item_enabled(
|
||||||
|
scene_name=scene_name,
|
||||||
|
item_id=int(scene_item_id),
|
||||||
|
enabled=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
if group:
|
||||||
|
console.out.print(
|
||||||
|
f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} in scene {console.highlight(ctx, old_scene_name)} has been hidden.'
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
# If not in a parent group, just show the scene name
|
||||||
|
# This is to avoid confusion with the parent group name
|
||||||
|
# which is not the same as the scene name
|
||||||
|
# and is not needed in this case
|
||||||
|
console.out.print(
|
||||||
|
f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been hidden.'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('toggle')
|
||||||
|
@app.command('tg', hidden=True)
|
||||||
|
def toggle(
|
||||||
|
ctx: typer.Context,
|
||||||
|
scene_name: Annotated[
|
||||||
|
str, typer.Argument(..., show_default=False, help='Scene name the item is in')
|
||||||
|
],
|
||||||
|
item_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
..., show_default=False, help='Item name to toggle in the scene'
|
||||||
|
),
|
||||||
|
],
|
||||||
|
group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
|
||||||
|
):
|
||||||
|
"""Toggle an item in a scene."""
|
||||||
|
if not _validate_sources(ctx, scene_name, item_name, group):
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
old_scene_name = scene_name
|
||||||
|
scene_name, scene_item_id = _get_scene_name_and_item_id(
|
||||||
|
ctx, scene_name, item_name, group
|
||||||
|
)
|
||||||
|
|
||||||
|
enabled = ctx.obj['obsws'].get_scene_item_enabled(
|
||||||
|
scene_name=scene_name,
|
||||||
|
item_id=int(scene_item_id),
|
||||||
|
)
|
||||||
|
new_state = not enabled.scene_item_enabled
|
||||||
|
|
||||||
|
ctx.obj['obsws'].set_scene_item_enabled(
|
||||||
|
scene_name=scene_name,
|
||||||
|
item_id=int(scene_item_id),
|
||||||
|
enabled=new_state,
|
||||||
|
)
|
||||||
|
|
||||||
|
if group:
|
||||||
|
if new_state:
|
||||||
|
console.out.print(
|
||||||
|
f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} '
|
||||||
|
f'in scene {console.highlight(ctx, old_scene_name)} has been shown.'
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
console.out.print(
|
||||||
|
f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} '
|
||||||
|
f'in scene {console.highlight(ctx, old_scene_name)} has been hidden.'
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
# If not in a parent group, just show the scene name
|
||||||
|
# This is to avoid confusion with the parent group name
|
||||||
|
# which is not the same as the scene name
|
||||||
|
# and is not needed in this case
|
||||||
|
if new_state:
|
||||||
|
console.out.print(
|
||||||
|
f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been shown.'
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
console.out.print(
|
||||||
|
f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been hidden.'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('visible')
|
||||||
|
@app.command('v', hidden=True)
|
||||||
|
def visible(
|
||||||
|
ctx: typer.Context,
|
||||||
|
scene_name: Annotated[
|
||||||
|
str, typer.Argument(..., show_default=False, help='Scene name the item is in')
|
||||||
|
],
|
||||||
|
item_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
..., show_default=False, help='Item name to check visibility in the scene'
|
||||||
|
),
|
||||||
|
],
|
||||||
|
group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
|
||||||
|
):
|
||||||
|
"""Check if an item in a scene is visible."""
|
||||||
|
if not _validate_sources(ctx, scene_name, item_name, group):
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
old_scene_name = scene_name
|
||||||
|
scene_name, scene_item_id = _get_scene_name_and_item_id(
|
||||||
|
ctx, scene_name, item_name, group
|
||||||
|
)
|
||||||
|
|
||||||
|
enabled = ctx.obj['obsws'].get_scene_item_enabled(
|
||||||
|
scene_name=scene_name,
|
||||||
|
item_id=int(scene_item_id),
|
||||||
|
)
|
||||||
|
|
||||||
|
if group:
|
||||||
|
console.out.print(
|
||||||
|
f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} '
|
||||||
|
f'in scene {console.highlight(ctx, old_scene_name)} is currently {"visible" if enabled.scene_item_enabled else "hidden"}.'
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
# If not in a parent group, just show the scene name
|
||||||
|
# This is to avoid confusion with the parent group name
|
||||||
|
# which is not the same as the scene name
|
||||||
|
# and is not needed in this case
|
||||||
|
console.out.print(
|
||||||
|
f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} '
|
||||||
|
f'is currently {"visible" if enabled.scene_item_enabled else "hidden"}.'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('transform')
|
||||||
|
@app.command('t', hidden=True)
|
||||||
def transform(
|
def transform(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
scene_name: str,
|
scene_name: Annotated[
|
||||||
item_name: str,
|
str, typer.Argument(..., show_default=False, help='Scene name the item is in')
|
||||||
|
],
|
||||||
|
item_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
..., show_default=False, help='Item name to transform in the scene'
|
||||||
|
),
|
||||||
|
],
|
||||||
group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
|
group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
|
||||||
alignment: Annotated[
|
alignment: Annotated[
|
||||||
Optional[int], typer.Option(help='Alignment of the item in the scene')
|
Optional[int], typer.Option(help='Alignment of the item in the scene')
|
||||||
@@ -397,15 +439,7 @@ def transform(
|
|||||||
] = None,
|
] = None,
|
||||||
):
|
):
|
||||||
"""Set the transform of an item in a scene."""
|
"""Set the transform of an item in a scene."""
|
||||||
if group:
|
if not _validate_sources(ctx, scene_name, item_name, group):
|
||||||
if not validate.item_in_scene_item_list(ctx, scene_name, group):
|
|
||||||
err_console.print(
|
|
||||||
f"Parent group '{group}' not found in scene '{scene_name}'."
|
|
||||||
)
|
|
||||||
raise typer.Exit(1)
|
|
||||||
else:
|
|
||||||
if not validate.item_in_scene_item_list(ctx, scene_name, item_name):
|
|
||||||
err_console.print(f"Item '{item_name}' not found in scene '{scene_name}'.")
|
|
||||||
raise typer.Exit(1)
|
raise typer.Exit(1)
|
||||||
|
|
||||||
old_scene_name = scene_name
|
old_scene_name = scene_name
|
||||||
@@ -446,24 +480,25 @@ def transform(
|
|||||||
transform['scaleY'] = scale_y
|
transform['scaleY'] = scale_y
|
||||||
|
|
||||||
if not transform:
|
if not transform:
|
||||||
err_console.print('No transform options provided.')
|
console.err.print('No transform options provided.')
|
||||||
raise typer.Exit(1)
|
raise typer.Exit(1)
|
||||||
|
|
||||||
transform = ctx.obj.set_scene_item_transform(
|
transform = ctx.obj['obsws'].set_scene_item_transform(
|
||||||
scene_name=scene_name,
|
scene_name=scene_name,
|
||||||
item_id=int(scene_item_id),
|
item_id=int(scene_item_id),
|
||||||
transform=transform,
|
transform=transform,
|
||||||
)
|
)
|
||||||
|
|
||||||
if group:
|
if group:
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f"Item '{item_name}' in group '{group}' in scene '{old_scene_name}' has been transformed."
|
f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} '
|
||||||
|
f'in scene {console.highlight(ctx, old_scene_name)} has been transformed.'
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
# If not in a parent group, just show the scene name
|
# If not in a parent group, just show the scene name
|
||||||
# This is to avoid confusion with the parent group name
|
# This is to avoid confusion with the parent group name
|
||||||
# which is not the same as the scene name
|
# which is not the same as the scene name
|
||||||
# and is not needed in this case
|
# and is not needed in this case
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f"Item '{item_name}' in scene '{scene_name}' has been transformed."
|
f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been transformed.'
|
||||||
)
|
)
|
||||||
@@ -5,15 +5,10 @@ from typing import Annotated
|
|||||||
|
|
||||||
import obsws_python as obsws
|
import obsws_python as obsws
|
||||||
import typer
|
import typer
|
||||||
from rich.console import Console
|
|
||||||
|
|
||||||
from .alias import AliasGroup
|
from obsws_cli import console
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
app = typer.Typer()
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(
|
|
||||||
stderr=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
@@ -21,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[
|
||||||
@@ -67,7 +63,7 @@ def save(
|
|||||||
):
|
):
|
||||||
"""Take a screenshot and save it to a file."""
|
"""Take a screenshot and save it to a file."""
|
||||||
try:
|
try:
|
||||||
ctx.obj.save_source_screenshot(
|
ctx.obj['obsws'].save_source_screenshot(
|
||||||
name=source_name,
|
name=source_name,
|
||||||
img_format=output_path.suffix.lstrip('.').lower(),
|
img_format=output_path.suffix.lstrip('.').lower(),
|
||||||
file_path=str(output_path),
|
file_path=str(output_path),
|
||||||
@@ -78,15 +74,17 @@ def save(
|
|||||||
except obsws.error.OBSSDKRequestError as e:
|
except obsws.error.OBSSDKRequestError as e:
|
||||||
match e.code:
|
match e.code:
|
||||||
case 403:
|
case 403:
|
||||||
err_console.print(
|
console.err.print(
|
||||||
'The image format (file extension) must be included in the file name '
|
'The [yellow]image format[/yellow] (file extension) must be included in the file name, '
|
||||||
"for example: '/path/to/screenshot.png'.",
|
"for example: '/path/to/screenshot.png'.",
|
||||||
)
|
)
|
||||||
raise typer.Exit(1)
|
raise typer.Exit(1)
|
||||||
case 600:
|
case 600:
|
||||||
err_console.print(f"No source was found by the name of '{source_name}'")
|
console.err.print(
|
||||||
|
f'No source was found by the name of [yellow]{source_name}[/yellow]'
|
||||||
|
)
|
||||||
raise typer.Exit(1)
|
raise typer.Exit(1)
|
||||||
case _:
|
case _:
|
||||||
raise
|
raise
|
||||||
|
|
||||||
out_console.print(f"Screenshot saved to [bold]'{output_path}'[/bold].")
|
console.out.print(f'Screenshot saved to {console.highlight(ctx, output_path)}.')
|
||||||
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.')
|
||||||
@@ -1,13 +1,10 @@
|
|||||||
"""module for controlling OBS stream functionality."""
|
"""module for controlling OBS stream functionality."""
|
||||||
|
|
||||||
import typer
|
import typer
|
||||||
from rich.console import Console
|
|
||||||
|
|
||||||
from .alias import AliasGroup
|
from obsws_cli import console
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
app = typer.Typer()
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.callback()
|
||||||
@@ -17,45 +14,49 @@ def main():
|
|||||||
|
|
||||||
def _get_streaming_status(ctx: typer.Context) -> tuple:
|
def _get_streaming_status(ctx: typer.Context) -> tuple:
|
||||||
"""Get streaming status."""
|
"""Get streaming status."""
|
||||||
resp = ctx.obj.get_stream_status()
|
resp = ctx.obj['obsws'].get_stream_status()
|
||||||
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)
|
||||||
if active:
|
if active:
|
||||||
err_console.print('Streaming is already in progress, cannot start.')
|
console.err.print('Streaming is already in progress, cannot start.')
|
||||||
raise typer.Exit(1)
|
raise typer.Exit(1)
|
||||||
|
|
||||||
ctx.obj.start_stream()
|
ctx.obj['obsws'].start_stream()
|
||||||
out_console.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)
|
||||||
if not active:
|
if not active:
|
||||||
err_console.print('Streaming is not in progress, cannot stop.')
|
console.err.print('Streaming is not in progress, cannot stop.')
|
||||||
raise typer.Exit(1)
|
raise typer.Exit(1)
|
||||||
|
|
||||||
ctx.obj.stop_stream()
|
ctx.obj['obsws'].stop_stream()
|
||||||
out_console.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.toggle_stream()
|
resp = ctx.obj['obsws'].toggle_stream()
|
||||||
if resp.output_active:
|
if resp.output_active:
|
||||||
out_console.print('Streaming started successfully.')
|
console.out.print('Streaming started successfully.')
|
||||||
else:
|
else:
|
||||||
out_console.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)
|
||||||
@@ -65,19 +66,19 @@ def status(ctx: typer.Context):
|
|||||||
minutes = int(seconds // 60)
|
minutes = int(seconds // 60)
|
||||||
seconds = int(seconds % 60)
|
seconds = int(seconds % 60)
|
||||||
if minutes > 0:
|
if minutes > 0:
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f'Streaming is in progress for {minutes} minutes and {seconds} seconds.'
|
f'Streaming is in progress for {minutes} minutes and {seconds} seconds.'
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
if seconds > 0:
|
if seconds > 0:
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f'Streaming is in progress for {seconds} seconds.'
|
f'Streaming is in progress for {seconds} seconds.'
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
out_console.print(
|
console.out.print(
|
||||||
'Streaming is in progress for less than a second.'
|
'Streaming is in progress for less than a second.'
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
out_console.print('Streaming is in progress.')
|
console.out.print('Streaming is in progress.')
|
||||||
else:
|
else:
|
||||||
out_console.print('Streaming is not in progress.')
|
console.out.print('Streaming is not in progress.')
|
||||||
52
obsws_cli/commands/studiomode.py
Normal file
52
obsws_cli/commands/studiomode.py
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
"""module containing commands for manipulating studio mode in OBS."""
|
||||||
|
|
||||||
|
import typer
|
||||||
|
|
||||||
|
from obsws_cli import console
|
||||||
|
|
||||||
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
|
@app.callback()
|
||||||
|
def main():
|
||||||
|
"""Control studio mode in OBS."""
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('enable')
|
||||||
|
@app.command('on', hidden=True)
|
||||||
|
def enable(ctx: typer.Context):
|
||||||
|
"""Enable studio mode."""
|
||||||
|
ctx.obj['obsws'].set_studio_mode_enabled(True)
|
||||||
|
console.out.print('Studio mode has been enabled.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('disable')
|
||||||
|
@app.command('off', hidden=True)
|
||||||
|
def disable(ctx: typer.Context):
|
||||||
|
"""Disable studio mode."""
|
||||||
|
ctx.obj['obsws'].set_studio_mode_enabled(False)
|
||||||
|
console.out.print('Studio mode has been disabled.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('toggle')
|
||||||
|
@app.command('tg', hidden=True)
|
||||||
|
def toggle(ctx: typer.Context):
|
||||||
|
"""Toggle studio mode."""
|
||||||
|
resp = ctx.obj['obsws'].get_studio_mode_enabled()
|
||||||
|
if resp.studio_mode_enabled:
|
||||||
|
ctx.obj['obsws'].set_studio_mode_enabled(False)
|
||||||
|
console.out.print('Studio mode is now disabled.')
|
||||||
|
else:
|
||||||
|
ctx.obj['obsws'].set_studio_mode_enabled(True)
|
||||||
|
console.out.print('Studio mode is now enabled.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('status')
|
||||||
|
@app.command('ss', hidden=True)
|
||||||
|
def status(ctx: typer.Context):
|
||||||
|
"""Get the status of studio mode."""
|
||||||
|
resp = ctx.obj['obsws'].get_studio_mode_enabled()
|
||||||
|
if resp.studio_mode_enabled:
|
||||||
|
console.out.print('Studio mode is enabled.')
|
||||||
|
else:
|
||||||
|
console.out.print('Studio mode is disabled.')
|
||||||
79
obsws_cli/commands/text.py
Normal file
79
obsws_cli/commands/text.py
Normal file
@@ -0,0 +1,79 @@
|
|||||||
|
"""module containing commands for manipulating text inputs."""
|
||||||
|
|
||||||
|
from typing import Annotated, Optional
|
||||||
|
|
||||||
|
import typer
|
||||||
|
|
||||||
|
from obsws_cli import console, validate
|
||||||
|
|
||||||
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
|
@app.callback()
|
||||||
|
def main():
|
||||||
|
"""Control text inputs in OBS."""
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('current')
|
||||||
|
@app.command('get', hidden=True)
|
||||||
|
def current(
|
||||||
|
ctx: typer.Context,
|
||||||
|
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."""
|
||||||
|
resp = ctx.obj['obsws'].get_input_settings(name=input_name)
|
||||||
|
if not resp.input_kind.startswith('text_'):
|
||||||
|
console.err.print(
|
||||||
|
f'Input [yellow]{input_name}[/yellow] is not a text input.',
|
||||||
|
)
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
current_text = resp.input_settings.get('text', '')
|
||||||
|
if not current_text:
|
||||||
|
current_text = '(empty)'
|
||||||
|
console.out.print(
|
||||||
|
f'Current text for input {console.highlight(ctx, input_name)}: {current_text}',
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('update')
|
||||||
|
@app.command('set', hidden=True)
|
||||||
|
def update(
|
||||||
|
ctx: typer.Context,
|
||||||
|
input_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
help='Name of the text input to update.', callback=validate.input_in_inputs
|
||||||
|
),
|
||||||
|
],
|
||||||
|
new_text: Annotated[
|
||||||
|
Optional[str],
|
||||||
|
typer.Argument(
|
||||||
|
help='The new text to set for the input.',
|
||||||
|
),
|
||||||
|
] = None,
|
||||||
|
):
|
||||||
|
"""Update the text of a text input."""
|
||||||
|
resp = ctx.obj['obsws'].get_input_settings(name=input_name)
|
||||||
|
if not resp.input_kind.startswith('text_'):
|
||||||
|
console.err.print(
|
||||||
|
f'Input [yellow]{input_name}[/yellow] is not a text input.',
|
||||||
|
)
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
ctx.obj['obsws'].set_input_settings(
|
||||||
|
name=input_name,
|
||||||
|
settings={'text': new_text},
|
||||||
|
overlay=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
if not new_text:
|
||||||
|
new_text = '(empty)'
|
||||||
|
console.out.print(
|
||||||
|
f'Text for input {console.highlight(ctx, input_name)} updated to: {new_text}',
|
||||||
|
)
|
||||||
50
obsws_cli/commands/virtualcam.py
Normal file
50
obsws_cli/commands/virtualcam.py
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
"""module containing commands for manipulating virtual camera in OBS."""
|
||||||
|
|
||||||
|
import typer
|
||||||
|
|
||||||
|
from obsws_cli import console
|
||||||
|
|
||||||
|
app = typer.Typer()
|
||||||
|
|
||||||
|
|
||||||
|
@app.callback()
|
||||||
|
def main():
|
||||||
|
"""Control virtual camera in OBS."""
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('start')
|
||||||
|
@app.command('s', hidden=True)
|
||||||
|
def start(ctx: typer.Context):
|
||||||
|
"""Start the virtual camera."""
|
||||||
|
ctx.obj['obsws'].start_virtual_cam()
|
||||||
|
console.out.print('Virtual camera started.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('stop')
|
||||||
|
@app.command('p', hidden=True)
|
||||||
|
def stop(ctx: typer.Context):
|
||||||
|
"""Stop the virtual camera."""
|
||||||
|
ctx.obj['obsws'].stop_virtual_cam()
|
||||||
|
console.out.print('Virtual camera stopped.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('toggle')
|
||||||
|
@app.command('tg', hidden=True)
|
||||||
|
def toggle(ctx: typer.Context):
|
||||||
|
"""Toggle the virtual camera."""
|
||||||
|
resp = ctx.obj['obsws'].toggle_virtual_cam()
|
||||||
|
if resp.output_active:
|
||||||
|
console.out.print('Virtual camera is enabled.')
|
||||||
|
else:
|
||||||
|
console.out.print('Virtual camera is disabled.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('status')
|
||||||
|
@app.command('ss', hidden=True)
|
||||||
|
def status(ctx: typer.Context):
|
||||||
|
"""Get the status of the virtual camera."""
|
||||||
|
resp = ctx.obj['obsws'].get_virtual_cam_status()
|
||||||
|
if resp.output_active:
|
||||||
|
console.out.print('Virtual camera is enabled.')
|
||||||
|
else:
|
||||||
|
console.out.print('Virtual camera is disabled.')
|
||||||
12
obsws_cli/console.py
Normal file
12
obsws_cli/console.py
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
"""module for console output handling in obsws_cli."""
|
||||||
|
|
||||||
|
import typer
|
||||||
|
from rich.console import Console
|
||||||
|
|
||||||
|
out = Console()
|
||||||
|
err = Console(stderr=True, style='bold red')
|
||||||
|
|
||||||
|
|
||||||
|
def highlight(ctx: typer.Context, text: str) -> str:
|
||||||
|
"""Highlight text using the current context's style."""
|
||||||
|
return f'[{ctx.obj["style"].highlight}]{text}[/{ctx.obj["style"].highlight}]'
|
||||||
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,203 +0,0 @@
|
|||||||
"""module containing commands for manipulating groups in scenes."""
|
|
||||||
|
|
||||||
from typing import Annotated, Optional
|
|
||||||
|
|
||||||
import typer
|
|
||||||
from rich.console import Console
|
|
||||||
from rich.table import Table
|
|
||||||
|
|
||||||
from . import validate
|
|
||||||
from .alias import AliasGroup
|
|
||||||
from .protocols import DataclassProtocol
|
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
|
||||||
def main():
|
|
||||||
"""Control groups in OBS scenes."""
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('list | ls')
|
|
||||||
def list_(
|
|
||||||
ctx: typer.Context,
|
|
||||||
scene_name: Annotated[
|
|
||||||
Optional[str],
|
|
||||||
typer.Argument(
|
|
||||||
show_default='The current scene',
|
|
||||||
help='Scene name to list groups for',
|
|
||||||
),
|
|
||||||
] = None,
|
|
||||||
):
|
|
||||||
"""List groups in a scene."""
|
|
||||||
if not scene_name:
|
|
||||||
scene_name = ctx.obj.get_current_program_scene().scene_name
|
|
||||||
|
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
|
||||||
err_console.print(f"Scene '{scene_name}' not found.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj.get_scene_item_list(scene_name)
|
|
||||||
groups = [
|
|
||||||
(item.get('sceneItemId'), item.get('sourceName'), item.get('sceneItemEnabled'))
|
|
||||||
for item in resp.scene_items
|
|
||||||
if item.get('isGroup')
|
|
||||||
]
|
|
||||||
|
|
||||||
if not groups:
|
|
||||||
out_console.print(f"No groups found in scene '{scene_name}'.")
|
|
||||||
raise typer.Exit()
|
|
||||||
|
|
||||||
table = Table(title=f'Groups in Scene: {scene_name}', padding=(0, 2))
|
|
||||||
|
|
||||||
for column in ('ID', 'Group Name', 'Enabled'):
|
|
||||||
table.add_column(
|
|
||||||
column, justify='left' if column == 'Group Name' else 'center', style='cyan'
|
|
||||||
)
|
|
||||||
|
|
||||||
for item_id, group_name, is_enabled in groups:
|
|
||||||
table.add_row(
|
|
||||||
str(item_id),
|
|
||||||
group_name,
|
|
||||||
':white_heavy_check_mark:' if is_enabled else ':x:',
|
|
||||||
)
|
|
||||||
|
|
||||||
out_console.print(table)
|
|
||||||
|
|
||||||
|
|
||||||
def _get_group(group_name: str, resp: DataclassProtocol) -> dict | None:
|
|
||||||
"""Get a group from the scene item list response."""
|
|
||||||
group = next(
|
|
||||||
(
|
|
||||||
item
|
|
||||||
for item in resp.scene_items
|
|
||||||
if item.get('sourceName') == group_name and item.get('isGroup')
|
|
||||||
),
|
|
||||||
None,
|
|
||||||
)
|
|
||||||
return group
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('show | sh')
|
|
||||||
def show(
|
|
||||||
ctx: typer.Context,
|
|
||||||
scene_name: Annotated[
|
|
||||||
str,
|
|
||||||
typer.Argument(..., show_default=False, help='Scene name the group is in'),
|
|
||||||
],
|
|
||||||
group_name: Annotated[
|
|
||||||
str, typer.Argument(..., show_default=False, help='Group name to show')
|
|
||||||
],
|
|
||||||
):
|
|
||||||
"""Show a group in a scene."""
|
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
|
||||||
err_console.print(f"Scene '{scene_name}' not found.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj.get_scene_item_list(scene_name)
|
|
||||||
if (group := _get_group(group_name, resp)) is None:
|
|
||||||
err_console.print(f"Group '{group_name}' not found in scene {scene_name}.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.set_scene_item_enabled(
|
|
||||||
scene_name=scene_name,
|
|
||||||
item_id=int(group.get('sceneItemId')),
|
|
||||||
enabled=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
out_console.print(f"Group '{group_name}' is now visible.")
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('hide | h')
|
|
||||||
def hide(
|
|
||||||
ctx: typer.Context,
|
|
||||||
scene_name: Annotated[
|
|
||||||
str, typer.Argument(..., show_default=False, help='Scene name the group is in')
|
|
||||||
],
|
|
||||||
group_name: Annotated[
|
|
||||||
str, typer.Argument(..., show_default=False, help='Group name to hide')
|
|
||||||
],
|
|
||||||
):
|
|
||||||
"""Hide a group in a scene."""
|
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
|
||||||
err_console.print(f"Scene '{scene_name}' not found.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj.get_scene_item_list(scene_name)
|
|
||||||
if (group := _get_group(group_name, resp)) is None:
|
|
||||||
err_console.print(f"Group '{group_name}' not found in scene {scene_name}.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.set_scene_item_enabled(
|
|
||||||
scene_name=scene_name,
|
|
||||||
item_id=int(group.get('sceneItemId')),
|
|
||||||
enabled=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
out_console.print(f"Group '{group_name}' is now hidden.")
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
|
||||||
def toggle(
|
|
||||||
ctx: typer.Context,
|
|
||||||
scene_name: Annotated[
|
|
||||||
str, typer.Argument(..., show_default=False, help='Scene name the group is in')
|
|
||||||
],
|
|
||||||
group_name: Annotated[
|
|
||||||
str, typer.Argument(..., show_default=False, help='Group name to toggle')
|
|
||||||
],
|
|
||||||
):
|
|
||||||
"""Toggle a group in a scene."""
|
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
|
||||||
err_console.print(f"Scene '{scene_name}' not found.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj.get_scene_item_list(scene_name)
|
|
||||||
if (group := _get_group(group_name, resp)) is None:
|
|
||||||
err_console.print(f"Group '{group_name}' not found in scene {scene_name}.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
new_state = not group.get('sceneItemEnabled')
|
|
||||||
ctx.obj.set_scene_item_enabled(
|
|
||||||
scene_name=scene_name,
|
|
||||||
item_id=int(group.get('sceneItemId')),
|
|
||||||
enabled=new_state,
|
|
||||||
)
|
|
||||||
|
|
||||||
if new_state:
|
|
||||||
out_console.print(f"Group '{group_name}' is now visible.")
|
|
||||||
else:
|
|
||||||
out_console.print(f"Group '{group_name}' is now hidden.")
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('status | ss')
|
|
||||||
def status(
|
|
||||||
ctx: typer.Context,
|
|
||||||
scene_name: Annotated[
|
|
||||||
str, typer.Argument(..., show_default=False, help='Scene name the group is in')
|
|
||||||
],
|
|
||||||
group_name: Annotated[
|
|
||||||
str, typer.Argument(..., show_default=False, help='Group name to check status')
|
|
||||||
],
|
|
||||||
):
|
|
||||||
"""Get the status of a group in a scene."""
|
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
|
||||||
err_console.print(f"Scene '{scene_name}' not found.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj.get_scene_item_list(scene_name)
|
|
||||||
if (group := _get_group(group_name, resp)) is None:
|
|
||||||
err_console.print(f"Group '{group_name}' not found in scene {scene_name}.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
enabled = ctx.obj.get_scene_item_enabled(
|
|
||||||
scene_name=scene_name,
|
|
||||||
item_id=int(group.get('sceneItemId')),
|
|
||||||
)
|
|
||||||
|
|
||||||
if enabled.scene_item_enabled:
|
|
||||||
out_console.print(f"Group '{group_name}' is now visible.")
|
|
||||||
else:
|
|
||||||
out_console.print(f"Group '{group_name}' is now hidden.")
|
|
||||||
@@ -1,133 +0,0 @@
|
|||||||
"""module containing commands for manipulating inputs."""
|
|
||||||
|
|
||||||
from typing import Annotated
|
|
||||||
|
|
||||||
import typer
|
|
||||||
from rich.console import Console
|
|
||||||
from rich.table import Table
|
|
||||||
|
|
||||||
from . import util, validate
|
|
||||||
from .alias import AliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@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,
|
|
||||||
):
|
|
||||||
"""List all inputs."""
|
|
||||||
resp = ctx.obj.get_input_list()
|
|
||||||
|
|
||||||
kinds = []
|
|
||||||
if input:
|
|
||||||
kinds.append('input')
|
|
||||||
if output:
|
|
||||||
kinds.append('output')
|
|
||||||
if colour:
|
|
||||||
kinds.append('color')
|
|
||||||
if not any([input, output, colour]):
|
|
||||||
kinds = ['input', 'output', 'color']
|
|
||||||
|
|
||||||
inputs = [
|
|
||||||
(input_.get('inputName'), input_.get('inputKind'))
|
|
||||||
for input_ in filter(
|
|
||||||
lambda input_: any(kind in input_.get('inputKind') for kind in kinds),
|
|
||||||
resp.inputs,
|
|
||||||
)
|
|
||||||
]
|
|
||||||
|
|
||||||
if not inputs:
|
|
||||||
out_console.print('No inputs found.')
|
|
||||||
raise typer.Exit()
|
|
||||||
|
|
||||||
table = Table(title='Inputs', padding=(0, 2))
|
|
||||||
for column in ('Input Name', 'Kind'):
|
|
||||||
table.add_column(
|
|
||||||
column, justify='left' if column == 'Input Name' else 'center', style='cyan'
|
|
||||||
)
|
|
||||||
|
|
||||||
for input_name, input_kind in inputs:
|
|
||||||
table.add_row(
|
|
||||||
input_name,
|
|
||||||
util.snakecase_to_titlecase(input_kind),
|
|
||||||
)
|
|
||||||
|
|
||||||
out_console.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):
|
|
||||||
err_console.print(f"Input '{input_name}' not found.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.set_input_mute(
|
|
||||||
name=input_name,
|
|
||||||
muted=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
out_console.print(f"Input '{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):
|
|
||||||
err_console.print(f"Input '{input_name}' not found.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.set_input_mute(
|
|
||||||
name=input_name,
|
|
||||||
muted=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
out_console.print(f"Input '{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):
|
|
||||||
err_console.print(f"Input '{input_name}' not found.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj.get_input_mute(name=input_name)
|
|
||||||
new_state = not resp.input_muted
|
|
||||||
|
|
||||||
ctx.obj.set_input_mute(
|
|
||||||
name=input_name,
|
|
||||||
muted=new_state,
|
|
||||||
)
|
|
||||||
|
|
||||||
out_console.print(
|
|
||||||
f"Input '{input_name}' {'muted' if new_state else 'unmuted'}.",
|
|
||||||
)
|
|
||||||
@@ -1,106 +0,0 @@
|
|||||||
"""module containing commands for manipulating profiles in OBS."""
|
|
||||||
|
|
||||||
from typing import Annotated
|
|
||||||
|
|
||||||
import typer
|
|
||||||
from rich.console import Console
|
|
||||||
from rich.table import Table
|
|
||||||
|
|
||||||
from . import validate
|
|
||||||
from .alias import AliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
|
||||||
def main():
|
|
||||||
"""Control profiles in OBS."""
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('list | ls')
|
|
||||||
def list_(ctx: typer.Context):
|
|
||||||
"""List profiles."""
|
|
||||||
resp = ctx.obj.get_profile_list()
|
|
||||||
|
|
||||||
table = Table(title='Profiles', padding=(0, 2))
|
|
||||||
for column in ('Profile Name', 'Current'):
|
|
||||||
table.add_column(
|
|
||||||
column,
|
|
||||||
justify='left' if column == 'Profile Name' else 'center',
|
|
||||||
style='cyan',
|
|
||||||
)
|
|
||||||
|
|
||||||
for profile in resp.profiles:
|
|
||||||
table.add_row(
|
|
||||||
profile,
|
|
||||||
':white_heavy_check_mark:' if profile == resp.current_profile_name else '',
|
|
||||||
)
|
|
||||||
|
|
||||||
out_console.print(table)
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('current | get')
|
|
||||||
def current(ctx: typer.Context):
|
|
||||||
"""Get the current profile."""
|
|
||||||
resp = ctx.obj.get_profile_list()
|
|
||||||
out_console.print(resp.current_profile_name)
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('switch | set')
|
|
||||||
def switch(
|
|
||||||
ctx: typer.Context,
|
|
||||||
profile_name: Annotated[
|
|
||||||
str,
|
|
||||||
typer.Argument(
|
|
||||||
..., show_default=False, help='Name of the profile to switch to'
|
|
||||||
),
|
|
||||||
],
|
|
||||||
):
|
|
||||||
"""Switch to a profile."""
|
|
||||||
if not validate.profile_exists(ctx, profile_name):
|
|
||||||
err_console.print(f"Profile '{profile_name}' not found.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj.get_profile_list()
|
|
||||||
if resp.current_profile_name == profile_name:
|
|
||||||
err_console.print(f"Profile '{profile_name}' is already the current profile.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.set_current_profile(profile_name)
|
|
||||||
out_console.print(f"Switched to profile '{profile_name}'.")
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('create | new')
|
|
||||||
def create(
|
|
||||||
ctx: typer.Context,
|
|
||||||
profile_name: Annotated[
|
|
||||||
str,
|
|
||||||
typer.Argument(..., show_default=False, help='Name of the profile to create.'),
|
|
||||||
],
|
|
||||||
):
|
|
||||||
"""Create a new profile."""
|
|
||||||
if validate.profile_exists(ctx, profile_name):
|
|
||||||
err_console.print(f"Profile '{profile_name}' already exists.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.create_profile(profile_name)
|
|
||||||
out_console.print(f"Created profile '{profile_name}'.")
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('remove | rm')
|
|
||||||
def remove(
|
|
||||||
ctx: typer.Context,
|
|
||||||
profile_name: Annotated[
|
|
||||||
str,
|
|
||||||
typer.Argument(..., show_default=False, help='Name of the profile to remove.'),
|
|
||||||
],
|
|
||||||
):
|
|
||||||
"""Remove a profile."""
|
|
||||||
if not validate.profile_exists(ctx, profile_name):
|
|
||||||
err_console.print(f"Profile '{profile_name}' not found.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.remove_profile(profile_name)
|
|
||||||
out_console.print(f"Removed profile '{profile_name}'.")
|
|
||||||
@@ -1,71 +0,0 @@
|
|||||||
"""module containing commands for manipulating projectors in OBS."""
|
|
||||||
|
|
||||||
from typing import Annotated
|
|
||||||
|
|
||||||
import typer
|
|
||||||
from rich.console import Console
|
|
||||||
from rich.table import Table
|
|
||||||
|
|
||||||
from .alias import AliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
|
||||||
def main():
|
|
||||||
"""Control projectors in OBS."""
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('list-monitors | ls-m')
|
|
||||||
def list_monitors(ctx: typer.Context):
|
|
||||||
"""List available monitors."""
|
|
||||||
resp = ctx.obj.get_monitor_list()
|
|
||||||
|
|
||||||
if not resp.monitors:
|
|
||||||
out_console.print('No monitors found.')
|
|
||||||
return
|
|
||||||
|
|
||||||
monitors = sorted(
|
|
||||||
((m['monitorIndex'], m['monitorName']) for m in resp.monitors),
|
|
||||||
key=lambda m: m[0],
|
|
||||||
)
|
|
||||||
|
|
||||||
table = Table(title='Available Monitors', padding=(0, 2))
|
|
||||||
table.add_column('Index', justify='center', style='cyan')
|
|
||||||
table.add_column('Name', style='cyan')
|
|
||||||
|
|
||||||
for index, monitor in monitors:
|
|
||||||
table.add_row(str(index), monitor)
|
|
||||||
|
|
||||||
out_console.print(table)
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('open | o')
|
|
||||||
def open(
|
|
||||||
ctx: typer.Context,
|
|
||||||
monitor_index: Annotated[
|
|
||||||
int,
|
|
||||||
typer.Option(help='Index of the monitor to open the projector on.'),
|
|
||||||
] = 0,
|
|
||||||
source_name: Annotated[
|
|
||||||
str,
|
|
||||||
typer.Argument(
|
|
||||||
show_default='The current scene',
|
|
||||||
help='Name of the source to project.',
|
|
||||||
),
|
|
||||||
] = '',
|
|
||||||
):
|
|
||||||
"""Open a fullscreen projector for a source on a specific monitor."""
|
|
||||||
if not source_name:
|
|
||||||
source_name = ctx.obj.get_current_program_scene().scene_name
|
|
||||||
|
|
||||||
ctx.obj.open_source_projector(
|
|
||||||
source_name=source_name,
|
|
||||||
monitor_index=monitor_index,
|
|
||||||
)
|
|
||||||
|
|
||||||
out_console.print(
|
|
||||||
f'Opened projector for source [bold]{source_name}[/] on monitor [bold]{monitor_index}[/].'
|
|
||||||
)
|
|
||||||
@@ -1,129 +0,0 @@
|
|||||||
"""module for controlling OBS recording functionality."""
|
|
||||||
|
|
||||||
from pathlib import Path
|
|
||||||
from typing import Annotated, Optional
|
|
||||||
|
|
||||||
import typer
|
|
||||||
from rich.console import Console
|
|
||||||
|
|
||||||
from .alias import AliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
|
||||||
def main():
|
|
||||||
"""Control OBS recording functionality."""
|
|
||||||
|
|
||||||
|
|
||||||
def _get_recording_status(ctx: typer.Context) -> tuple:
|
|
||||||
"""Get recording status."""
|
|
||||||
resp = ctx.obj.get_record_status()
|
|
||||||
return resp.output_active, resp.output_paused
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('start | s')
|
|
||||||
def start(ctx: typer.Context):
|
|
||||||
"""Start recording."""
|
|
||||||
active, paused = _get_recording_status(ctx)
|
|
||||||
if active:
|
|
||||||
err_msg = 'Recording is already in progress, cannot start.'
|
|
||||||
if paused:
|
|
||||||
err_msg += ' Try resuming it.'
|
|
||||||
|
|
||||||
err_console.print(err_msg)
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.start_record()
|
|
||||||
out_console.print('Recording started successfully.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('stop | st')
|
|
||||||
def stop(ctx: typer.Context):
|
|
||||||
"""Stop recording."""
|
|
||||||
active, _ = _get_recording_status(ctx)
|
|
||||||
if not active:
|
|
||||||
err_console.print('Recording is not in progress, cannot stop.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj.stop_record()
|
|
||||||
out_console.print(f'Recording stopped successfully. Saved to: {resp.output_path}')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
|
||||||
def toggle(ctx: typer.Context):
|
|
||||||
"""Toggle recording."""
|
|
||||||
resp = ctx.obj.toggle_record()
|
|
||||||
if resp.output_active:
|
|
||||||
out_console.print('Recording started successfully.')
|
|
||||||
else:
|
|
||||||
out_console.print('Recording stopped successfully.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('status | ss')
|
|
||||||
def status(ctx: typer.Context):
|
|
||||||
"""Get recording status."""
|
|
||||||
active, paused = _get_recording_status(ctx)
|
|
||||||
if active:
|
|
||||||
if paused:
|
|
||||||
out_console.print('Recording is in progress and paused.')
|
|
||||||
else:
|
|
||||||
out_console.print('Recording is in progress.')
|
|
||||||
else:
|
|
||||||
out_console.print('Recording is not in progress.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('resume | r')
|
|
||||||
def resume(ctx: typer.Context):
|
|
||||||
"""Resume recording."""
|
|
||||||
active, paused = _get_recording_status(ctx)
|
|
||||||
if not active:
|
|
||||||
err_console.print('Recording is not in progress, cannot resume.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
if not paused:
|
|
||||||
err_console.print('Recording is in progress but not paused, cannot resume.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.resume_record()
|
|
||||||
out_console.print('Recording resumed successfully.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('pause | p')
|
|
||||||
def pause(ctx: typer.Context):
|
|
||||||
"""Pause recording."""
|
|
||||||
active, paused = _get_recording_status(ctx)
|
|
||||||
if not active:
|
|
||||||
err_console.print('Recording is not in progress, cannot pause.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
if paused:
|
|
||||||
err_console.print('Recording is in progress but already paused, cannot pause.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.pause_record()
|
|
||||||
out_console.print('Recording paused successfully.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('directory | d')
|
|
||||||
def directory(
|
|
||||||
ctx: typer.Context,
|
|
||||||
record_directory: Annotated[
|
|
||||||
Optional[Path],
|
|
||||||
# Since the CLI and OBS may be running on different platforms,
|
|
||||||
# we won't validate the path here.
|
|
||||||
typer.Argument(
|
|
||||||
file_okay=False,
|
|
||||||
dir_okay=True,
|
|
||||||
help='Directory to set for recording.',
|
|
||||||
),
|
|
||||||
] = None,
|
|
||||||
):
|
|
||||||
"""Get or set the recording directory."""
|
|
||||||
if record_directory is not None:
|
|
||||||
ctx.obj.set_record_directory(str(record_directory))
|
|
||||||
out_console.print(f'Recording directory updated to: {record_directory}')
|
|
||||||
else:
|
|
||||||
out_console.print(
|
|
||||||
f'Recording directory: {ctx.obj.get_record_directory().record_directory}'
|
|
||||||
)
|
|
||||||
@@ -1,66 +0,0 @@
|
|||||||
"""module containing commands for manipulating the replay buffer in OBS."""
|
|
||||||
|
|
||||||
import typer
|
|
||||||
from rich.console import Console
|
|
||||||
|
|
||||||
from .alias import AliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
|
||||||
def main():
|
|
||||||
"""Control profiles in OBS."""
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('start | s')
|
|
||||||
def start(ctx: typer.Context):
|
|
||||||
"""Start the replay buffer."""
|
|
||||||
resp = ctx.obj.get_replay_buffer_status()
|
|
||||||
if resp.output_active:
|
|
||||||
err_console.print('Replay buffer is already active.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.start_replay_buffer()
|
|
||||||
out_console.print('Replay buffer started.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('stop | st')
|
|
||||||
def stop(ctx: typer.Context):
|
|
||||||
"""Stop the replay buffer."""
|
|
||||||
resp = ctx.obj.get_replay_buffer_status()
|
|
||||||
if not resp.output_active:
|
|
||||||
err_console.print('Replay buffer is not active.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.stop_replay_buffer()
|
|
||||||
out_console.print('Replay buffer stopped.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
|
||||||
def toggle(ctx: typer.Context):
|
|
||||||
"""Toggle the replay buffer."""
|
|
||||||
resp = ctx.obj.toggle_replay_buffer()
|
|
||||||
if resp.output_active:
|
|
||||||
out_console.print('Replay buffer is active.')
|
|
||||||
else:
|
|
||||||
out_console.print('Replay buffer is not active.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('status | ss')
|
|
||||||
def status(ctx: typer.Context):
|
|
||||||
"""Get the status of the replay buffer."""
|
|
||||||
resp = ctx.obj.get_replay_buffer_status()
|
|
||||||
if resp.output_active:
|
|
||||||
out_console.print('Replay buffer is active.')
|
|
||||||
else:
|
|
||||||
out_console.print('Replay buffer is not active.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('save | sv')
|
|
||||||
def save(ctx: typer.Context):
|
|
||||||
"""Save the replay buffer."""
|
|
||||||
ctx.obj.save_replay_buffer()
|
|
||||||
out_console.print('Replay buffer saved.')
|
|
||||||
@@ -1,89 +0,0 @@
|
|||||||
"""module containing commands for controlling OBS scenes."""
|
|
||||||
|
|
||||||
from typing import Annotated
|
|
||||||
|
|
||||||
import typer
|
|
||||||
from rich.console import Console
|
|
||||||
from rich.table import Table
|
|
||||||
|
|
||||||
from . import validate
|
|
||||||
from .alias import AliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
|
||||||
def main():
|
|
||||||
"""Control OBS scenes."""
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('list | ls')
|
|
||||||
def list_(ctx: typer.Context):
|
|
||||||
"""List all scenes."""
|
|
||||||
resp = ctx.obj.get_scene_list()
|
|
||||||
scenes = (
|
|
||||||
(scene.get('sceneName'), scene.get('sceneUuid'))
|
|
||||||
for scene in reversed(resp.scenes)
|
|
||||||
)
|
|
||||||
|
|
||||||
table = Table(title='Scenes', padding=(0, 2))
|
|
||||||
for column in ('Scene Name', 'UUID'):
|
|
||||||
table.add_column(column, justify='left', style='cyan')
|
|
||||||
|
|
||||||
for scene_name, scene_uuid in scenes:
|
|
||||||
table.add_row(
|
|
||||||
scene_name,
|
|
||||||
scene_uuid,
|
|
||||||
)
|
|
||||||
|
|
||||||
out_console.print(table)
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('current | get')
|
|
||||||
def current(
|
|
||||||
ctx: typer.Context,
|
|
||||||
preview: Annotated[
|
|
||||||
bool, typer.Option(help='Get the preview scene instead of the program scene')
|
|
||||||
] = False,
|
|
||||||
):
|
|
||||||
"""Get the current program scene or preview scene."""
|
|
||||||
if preview and not validate.studio_mode_enabled(ctx):
|
|
||||||
err_console.print('Studio mode is not enabled, cannot get preview scene.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
if preview:
|
|
||||||
resp = ctx.obj.get_current_preview_scene()
|
|
||||||
out_console.print(resp.current_preview_scene_name)
|
|
||||||
else:
|
|
||||||
resp = ctx.obj.get_current_program_scene()
|
|
||||||
out_console.print(resp.current_program_scene_name)
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('switch | set')
|
|
||||||
def switch(
|
|
||||||
ctx: typer.Context,
|
|
||||||
scene_name: Annotated[
|
|
||||||
str, typer.Argument(..., help='Name of the scene to switch to')
|
|
||||||
],
|
|
||||||
preview: Annotated[
|
|
||||||
bool,
|
|
||||||
typer.Option(help='Switch to the preview scene instead of the program scene'),
|
|
||||||
] = False,
|
|
||||||
):
|
|
||||||
"""Switch to a scene."""
|
|
||||||
if preview and not validate.studio_mode_enabled(ctx):
|
|
||||||
err_console.print('Studio mode is not enabled, cannot set the preview scene.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
|
||||||
err_console.print(f"Scene '{scene_name}' not found.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
if preview:
|
|
||||||
ctx.obj.set_current_preview_scene(scene_name)
|
|
||||||
out_console.print(f'Switched to preview scene: {scene_name}')
|
|
||||||
else:
|
|
||||||
ctx.obj.set_current_program_scene(scene_name)
|
|
||||||
out_console.print(f'Switched to program scene: {scene_name}')
|
|
||||||
@@ -1,81 +0,0 @@
|
|||||||
"""module containing commands for manipulating scene collections."""
|
|
||||||
|
|
||||||
from typing import Annotated
|
|
||||||
|
|
||||||
import typer
|
|
||||||
from rich.console import Console
|
|
||||||
from rich.table import Table
|
|
||||||
|
|
||||||
from . import validate
|
|
||||||
from .alias import AliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
|
||||||
def main():
|
|
||||||
"""Control scene collections in OBS."""
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('list | ls')
|
|
||||||
def list_(ctx: typer.Context):
|
|
||||||
"""List all scene collections."""
|
|
||||||
resp = ctx.obj.get_scene_collection_list()
|
|
||||||
|
|
||||||
table = Table(title='Scene Collections', padding=(0, 2))
|
|
||||||
table.add_column('Scene Collection Name', justify='left', style='cyan')
|
|
||||||
|
|
||||||
for scene_collection_name in resp.scene_collections:
|
|
||||||
table.add_row(scene_collection_name)
|
|
||||||
|
|
||||||
out_console.print(table)
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('current | get')
|
|
||||||
def current(ctx: typer.Context):
|
|
||||||
"""Get the current scene collection."""
|
|
||||||
resp = ctx.obj.get_scene_collection_list()
|
|
||||||
out_console.print(resp.current_scene_collection_name)
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('switch | set')
|
|
||||||
def switch(
|
|
||||||
ctx: typer.Context,
|
|
||||||
scene_collection_name: Annotated[
|
|
||||||
str, typer.Argument(..., help='Name of the scene collection to switch to')
|
|
||||||
],
|
|
||||||
):
|
|
||||||
"""Switch to a scene collection."""
|
|
||||||
if not validate.scene_collection_in_scene_collections(ctx, scene_collection_name):
|
|
||||||
err_console.print(f"Scene collection '{scene_collection_name}' not found.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
current_scene_collection = (
|
|
||||||
ctx.obj.get_scene_collection_list().current_scene_collection_name
|
|
||||||
)
|
|
||||||
if scene_collection_name == current_scene_collection:
|
|
||||||
err_console.print(
|
|
||||||
f'Scene collection "{scene_collection_name}" is already active.'
|
|
||||||
)
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.set_current_scene_collection(scene_collection_name)
|
|
||||||
out_console.print(f"Switched to scene collection '{scene_collection_name}'")
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('create | new')
|
|
||||||
def create(
|
|
||||||
ctx: typer.Context,
|
|
||||||
scene_collection_name: Annotated[
|
|
||||||
str, typer.Argument(..., help='Name of the scene collection to create')
|
|
||||||
],
|
|
||||||
):
|
|
||||||
"""Create a new scene collection."""
|
|
||||||
if validate.scene_collection_in_scene_collections(ctx, scene_collection_name):
|
|
||||||
err_console.print(f"Scene collection '{scene_collection_name}' already exists.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.create_scene_collection(scene_collection_name)
|
|
||||||
out_console.print(f'Created scene collection {scene_collection_name}')
|
|
||||||
@@ -1,51 +0,0 @@
|
|||||||
"""module for settings management for obsws-cli."""
|
|
||||||
|
|
||||||
from collections import UserDict
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
from dotenv import dotenv_values
|
|
||||||
|
|
||||||
|
|
||||||
class Settings(UserDict):
|
|
||||||
"""Settings for the OBS WebSocket client."""
|
|
||||||
|
|
||||||
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):
|
|
||||||
"""Get a setting value by key."""
|
|
||||||
if not key.startswith('OBS_'):
|
|
||||||
key = f'OBS_{key.upper()}'
|
|
||||||
return self.data[key]
|
|
||||||
|
|
||||||
def __setitem__(self, key, value):
|
|
||||||
"""Set a setting value by key."""
|
|
||||||
self.data[key] = value
|
|
||||||
|
|
||||||
|
|
||||||
_settings = Settings(
|
|
||||||
OBS_HOST='localhost', OBS_PORT=4455, OBS_PASSWORD='', OBS_TIMEOUT=5
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def get(key: str):
|
|
||||||
"""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]
|
|
||||||
@@ -1,51 +0,0 @@
|
|||||||
"""module containing commands for manipulating studio mode in OBS."""
|
|
||||||
|
|
||||||
import typer
|
|
||||||
from rich.console import Console
|
|
||||||
|
|
||||||
from .alias import AliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
|
||||||
def main():
|
|
||||||
"""Control studio mode in OBS."""
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('enable | on')
|
|
||||||
def enable(ctx: typer.Context):
|
|
||||||
"""Enable studio mode."""
|
|
||||||
ctx.obj.set_studio_mode_enabled(True)
|
|
||||||
out_console.print('Studio mode has been enabled.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('disable | off')
|
|
||||||
def disable(ctx: typer.Context):
|
|
||||||
"""Disable studio mode."""
|
|
||||||
ctx.obj.set_studio_mode_enabled(False)
|
|
||||||
out_console.print('Studio mode has been disabled.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
|
||||||
def toggle(ctx: typer.Context):
|
|
||||||
"""Toggle studio mode."""
|
|
||||||
resp = ctx.obj.get_studio_mode_enabled()
|
|
||||||
if resp.studio_mode_enabled:
|
|
||||||
ctx.obj.set_studio_mode_enabled(False)
|
|
||||||
out_console.print('Studio mode is now disabled.')
|
|
||||||
else:
|
|
||||||
ctx.obj.set_studio_mode_enabled(True)
|
|
||||||
out_console.print('Studio mode is now enabled.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('status | ss')
|
|
||||||
def status(ctx: typer.Context):
|
|
||||||
"""Get the status of studio mode."""
|
|
||||||
resp = ctx.obj.get_studio_mode_enabled()
|
|
||||||
if resp.studio_mode_enabled:
|
|
||||||
out_console.print('Studio mode is enabled.')
|
|
||||||
else:
|
|
||||||
out_console.print('Studio mode is disabled.')
|
|
||||||
183
obsws_cli/styles.py
Normal file
183
obsws_cli/styles.py
Normal file
@@ -0,0 +1,183 @@
|
|||||||
|
"""module containing styles for the OBS WebSocket CLI."""
|
||||||
|
|
||||||
|
import os
|
||||||
|
from dataclasses import dataclass
|
||||||
|
|
||||||
|
registry = {}
|
||||||
|
|
||||||
|
|
||||||
|
def register_style(cls):
|
||||||
|
"""Register a style class."""
|
||||||
|
key = cls.__name__.lower()
|
||||||
|
if key in registry:
|
||||||
|
raise ValueError(f'Style {key} is already registered.')
|
||||||
|
registry[key] = cls
|
||||||
|
return cls
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class Style:
|
||||||
|
"""Base class for styles."""
|
||||||
|
|
||||||
|
name: str
|
||||||
|
border: str
|
||||||
|
column: str
|
||||||
|
highlight: str
|
||||||
|
no_border: bool = False
|
||||||
|
|
||||||
|
def __post_init__(self):
|
||||||
|
"""Post-initialization to set default values and normalize the name."""
|
||||||
|
self.name = self.name.lower()
|
||||||
|
if self.no_border:
|
||||||
|
self.border = None
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Disabled(Style):
|
||||||
|
"""Disabled style."""
|
||||||
|
|
||||||
|
name: str = 'disabled'
|
||||||
|
border: str = 'none'
|
||||||
|
column: str = 'none'
|
||||||
|
highlight: str = 'none'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Red(Style):
|
||||||
|
"""Red style."""
|
||||||
|
|
||||||
|
name: str = 'red'
|
||||||
|
border: str = 'red3'
|
||||||
|
column: str = 'red1'
|
||||||
|
highlight: str = 'red1'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Magenta(Style):
|
||||||
|
"""Magenta style."""
|
||||||
|
|
||||||
|
name: str = 'magenta'
|
||||||
|
border: str = 'magenta3'
|
||||||
|
column: str = 'orchid1'
|
||||||
|
highlight: str = 'orchid1'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Purple(Style):
|
||||||
|
"""Purple style."""
|
||||||
|
|
||||||
|
name: str = 'purple'
|
||||||
|
border: str = 'medium_purple4'
|
||||||
|
column: str = 'medium_purple'
|
||||||
|
highlight: str = 'medium_purple'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Blue(Style):
|
||||||
|
"""Blue style."""
|
||||||
|
|
||||||
|
name: str = 'blue'
|
||||||
|
border: str = 'cornflower_blue'
|
||||||
|
column: str = 'sky_blue2'
|
||||||
|
highlight: str = 'sky_blue2'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Cyan(Style):
|
||||||
|
"""Cyan style."""
|
||||||
|
|
||||||
|
name: str = 'cyan'
|
||||||
|
border: str = 'dark_cyan'
|
||||||
|
column: str = 'cyan'
|
||||||
|
highlight: str = 'cyan'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Green(Style):
|
||||||
|
"""Green style."""
|
||||||
|
|
||||||
|
name: str = 'green'
|
||||||
|
border: str = 'green4'
|
||||||
|
column: str = 'spring_green3'
|
||||||
|
highlight: str = 'spring_green3'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Yellow(Style):
|
||||||
|
"""Yellow style."""
|
||||||
|
|
||||||
|
name: str = 'yellow'
|
||||||
|
border: str = 'yellow3'
|
||||||
|
column: str = 'wheat1'
|
||||||
|
highlight: str = 'wheat1'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Orange(Style):
|
||||||
|
"""Orange style."""
|
||||||
|
|
||||||
|
name: str = 'orange'
|
||||||
|
border: str = 'dark_orange'
|
||||||
|
column: str = 'orange1'
|
||||||
|
highlight: str = 'orange1'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class White(Style):
|
||||||
|
"""White style."""
|
||||||
|
|
||||||
|
name: str = 'white'
|
||||||
|
border: str = 'grey82'
|
||||||
|
column: str = 'grey100'
|
||||||
|
highlight: str = 'grey100'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Grey(Style):
|
||||||
|
"""Grey style."""
|
||||||
|
|
||||||
|
name: str = 'grey'
|
||||||
|
border: str = 'grey50'
|
||||||
|
column: str = 'grey70'
|
||||||
|
highlight: str = 'grey70'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Navy(Style):
|
||||||
|
"""Navy Blue style."""
|
||||||
|
|
||||||
|
name: str = 'navyblue'
|
||||||
|
border: str = 'deep_sky_blue4'
|
||||||
|
column: str = 'light_sky_blue3'
|
||||||
|
highlight: str = 'light_sky_blue3'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Black(Style):
|
||||||
|
"""Black style."""
|
||||||
|
|
||||||
|
name: str = 'black'
|
||||||
|
border: str = 'grey19'
|
||||||
|
column: str = 'grey11'
|
||||||
|
highlight: str = 'grey11'
|
||||||
|
|
||||||
|
|
||||||
|
def request_style_obj(style_name: str, no_border: bool) -> Style:
|
||||||
|
"""Entry point for style objects. Returns a Style object based on the style name."""
|
||||||
|
if style_name == 'disabled':
|
||||||
|
os.environ['NO_COLOR'] = '1'
|
||||||
|
|
||||||
|
return registry[style_name.lower()](no_border=no_border)
|
||||||
@@ -1,6 +1,47 @@
|
|||||||
"""module contains utility functions for the obsws_cli package."""
|
"""module contains utility functions for the obsws_cli package."""
|
||||||
|
|
||||||
|
import os
|
||||||
|
|
||||||
def snakecase_to_titlecase(snake_str):
|
|
||||||
|
def snakecase_to_titlecase(snake_str: str) -> str:
|
||||||
"""Convert a snake_case string to a title case string."""
|
"""Convert a snake_case string to a title case string."""
|
||||||
return snake_str.replace('_', ' ').title()
|
return snake_str.replace('_', ' ').title()
|
||||||
|
|
||||||
|
|
||||||
|
def check_mark(value: bool, empty_if_false: bool = False) -> str:
|
||||||
|
"""Return a check mark or cross mark based on the boolean value."""
|
||||||
|
if empty_if_false and not value:
|
||||||
|
return ''
|
||||||
|
|
||||||
|
# rich gracefully handles the absence of colour throughout the rest of the application,
|
||||||
|
# but here we must handle it manually.
|
||||||
|
# If NO_COLOR is set, we return plain text symbols.
|
||||||
|
# Otherwise, we return coloured symbols.
|
||||||
|
if os.getenv('NO_COLOR', '') != '':
|
||||||
|
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,48 +1,142 @@
|
|||||||
"""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.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."""
|
||||||
resp = ctx.obj.get_scene_list()
|
if scene_name is None:
|
||||||
return any(scene.get('sceneName') == scene_name for scene in resp.scenes)
|
return
|
||||||
|
|
||||||
|
resp = ctx.obj['obsws'].get_scene_list()
|
||||||
|
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.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.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(
|
||||||
ctx: typer.Context, scene_name: str, item_name: str
|
ctx: typer.Context, scene_name: str, item_name: str
|
||||||
) -> bool:
|
) -> bool:
|
||||||
"""Check if an item exists in a scene."""
|
"""Check if an item exists in a scene."""
|
||||||
resp = ctx.obj.get_scene_item_list(scene_name)
|
resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
|
||||||
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.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 profile_not_exists(ctx: typer.Context, profile_name: str) -> str:
|
||||||
|
"""Ensure a profile does not exist."""
|
||||||
|
resp = ctx.obj['obsws'].get_profile_list()
|
||||||
|
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
|
||||||
|
|||||||
@@ -1,49 +0,0 @@
|
|||||||
"""module containing commands for manipulating virtual camera in OBS."""
|
|
||||||
|
|
||||||
import typer
|
|
||||||
from rich.console import Console
|
|
||||||
|
|
||||||
from .alias import AliasGroup
|
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
|
||||||
def main():
|
|
||||||
"""Control virtual camera in OBS."""
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('start | s')
|
|
||||||
def start(ctx: typer.Context):
|
|
||||||
"""Start the virtual camera."""
|
|
||||||
ctx.obj.start_virtual_cam()
|
|
||||||
out_console.print('Virtual camera started.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('stop | p')
|
|
||||||
def stop(ctx: typer.Context):
|
|
||||||
"""Stop the virtual camera."""
|
|
||||||
ctx.obj.stop_virtual_cam()
|
|
||||||
out_console.print('Virtual camera stopped.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
|
||||||
def toggle(ctx: typer.Context):
|
|
||||||
"""Toggle the virtual camera."""
|
|
||||||
resp = ctx.obj.toggle_virtual_cam()
|
|
||||||
if resp.output_active:
|
|
||||||
out_console.print('Virtual camera is enabled.')
|
|
||||||
else:
|
|
||||||
out_console.print('Virtual camera is disabled.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('status | ss')
|
|
||||||
def status(ctx: typer.Context):
|
|
||||||
"""Get the status of the virtual camera."""
|
|
||||||
resp = ctx.obj.get_virtual_cam_status()
|
|
||||||
if resp.output_active:
|
|
||||||
out_console.print('Virtual camera is enabled.')
|
|
||||||
else:
|
|
||||||
out_console.print('Virtual camera is disabled.')
|
|
||||||
@@ -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.7.2", "python-dotenv>=1.1.0"]
|
dependencies = ["typer>=0.21.1", "obsws-python>=1.8.0", "python-dotenv>=1.1.0"]
|
||||||
|
|
||||||
|
|
||||||
[project.urls]
|
[project.urls]
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
"""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
|
from dotenv import find_dotenv, load_dotenv
|
||||||
@@ -20,9 +21,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()
|
||||||
@@ -44,9 +45,54 @@ def pytest_sessionstart(session):
|
|||||||
},
|
},
|
||||||
)
|
)
|
||||||
|
|
||||||
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.get('OBS_TESTS_PLATFORM', os.uname().sysname.lower())
|
||||||
|
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',
|
||||||
@@ -71,6 +117,13 @@ def pytest_sessionstart(session):
|
|||||||
},
|
},
|
||||||
sceneItemEnabled=True,
|
sceneItemEnabled=True,
|
||||||
)
|
)
|
||||||
|
session.obsws.create_input(
|
||||||
|
sceneName='pytest_scene',
|
||||||
|
inputName='pytest_text_input',
|
||||||
|
inputKind='text_gdiplus_v3',
|
||||||
|
inputSettings={'text': 'Hello, OBS!'},
|
||||||
|
sceneItemEnabled=True,
|
||||||
|
)
|
||||||
resp = session.obsws.get_scene_item_list('pytest_scene')
|
resp = session.obsws.get_scene_item_list('pytest_scene')
|
||||||
for item in resp.scene_items:
|
for item in resp.scene_items:
|
||||||
if item['sourceName'] == 'pytest_input_2':
|
if item['sourceName'] == 'pytest_input_2':
|
||||||
@@ -124,7 +177,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:
|
||||||
@@ -142,6 +195,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():
|
||||||
@@ -27,4 +27,4 @@ def test_filter_list_invalid_source():
|
|||||||
"""Test the filter list command with an invalid source."""
|
"""Test the filter list command with an invalid source."""
|
||||||
result = runner.invoke(app, ['filter', 'list', 'invalid_source'])
|
result = runner.invoke(app, ['filter', 'list', 'invalid_source'])
|
||||||
assert result.exit_code != 0
|
assert result.exit_code != 0
|
||||||
assert "No source was found by the name of 'invalid_source'" in result.stderr
|
assert 'No source was found by the name of invalid_source' in result.stderr
|
||||||
|
|||||||
@@ -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('OBS_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():
|
||||||
@@ -18,29 +26,29 @@ def test_group_show():
|
|||||||
"""Test the group show command."""
|
"""Test the group show command."""
|
||||||
result = runner.invoke(app, ['group', 'show', 'Scene', 'test_group'])
|
result = runner.invoke(app, ['group', 'show', 'Scene', 'test_group'])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert "Group 'test_group' is now visible." in result.stdout
|
assert 'Group test_group is now visible.' in result.stdout
|
||||||
|
|
||||||
|
|
||||||
def test_group_toggle():
|
def test_group_toggle():
|
||||||
"""Test the group toggle command."""
|
"""Test the group toggle command."""
|
||||||
result = runner.invoke(app, ['group', 'status', 'Scene', 'test_group'])
|
result = runner.invoke(app, ['group', 'status', 'Scene', 'test_group'])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
enabled = "Group 'test_group' is now visible." in result.stdout
|
enabled = 'Group test_group is now visible.' in result.stdout
|
||||||
|
|
||||||
result = runner.invoke(app, ['group', 'toggle', 'Scene', 'test_group'])
|
result = runner.invoke(app, ['group', 'toggle', 'Scene', 'test_group'])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
if enabled:
|
if enabled:
|
||||||
assert "Group 'test_group' is now hidden." in result.stdout
|
assert 'Group test_group is now hidden.' in result.stdout
|
||||||
else:
|
else:
|
||||||
assert "Group 'test_group' is now visible." in result.stdout
|
assert 'Group test_group is now visible.' in result.stdout
|
||||||
|
|
||||||
|
|
||||||
def test_group_status():
|
def test_group_status():
|
||||||
"""Test the group status command."""
|
"""Test the group status command."""
|
||||||
result = runner.invoke(app, ['group', 'show', 'Scene', 'test_group'])
|
result = runner.invoke(app, ['group', 'show', 'Scene', 'test_group'])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert "Group 'test_group' is now visible." in result.stdout
|
assert 'Group test_group is now visible.' in result.stdout
|
||||||
|
|
||||||
result = runner.invoke(app, ['group', 'status', 'Scene', 'test_group'])
|
result = runner.invoke(app, ['group', 'status', 'Scene', 'test_group'])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert "Group 'test_group' is now visible." in result.stdout
|
assert 'Group test_group is now visible.' 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_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():
|
||||||
@@ -36,3 +36,10 @@ def test_scene_switch():
|
|||||||
result = runner.invoke(app, ['scene', 'switch', 'pytest_scene'])
|
result = runner.invoke(app, ['scene', 'switch', 'pytest_scene'])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert 'Switched to program scene: pytest_scene' in result.stdout
|
assert 'Switched to program scene: pytest_scene' in result.stdout
|
||||||
|
|
||||||
|
|
||||||
|
def test_scene_switch_invalid():
|
||||||
|
"""Test the scene switch command with an invalid scene."""
|
||||||
|
result = runner.invoke(app, ['scene', 'switch', 'non_existent_scene'])
|
||||||
|
assert result.exit_code != 0
|
||||||
|
assert 'Scene non_existent_scene not found' in result.stderr
|
||||||
|
|||||||
@@ -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():
|
||||||
@@ -29,6 +29,6 @@ def test_sceneitem_transform():
|
|||||||
)
|
)
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert (
|
assert (
|
||||||
"Item 'pytest_input_2' in scene 'pytest_scene' has been transformed"
|
'Item pytest_input_2 in scene pytest_scene has been transformed'
|
||||||
in result.stdout
|
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_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():
|
||||||
|
|||||||
18
tests/test_text.py
Normal file
18
tests/test_text.py
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
"""Unit tests for the text command in the OBS WebSocket CLI."""
|
||||||
|
|
||||||
|
from typer.testing import CliRunner
|
||||||
|
|
||||||
|
from obsws_cli.app import app
|
||||||
|
|
||||||
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
|
def test_text_update():
|
||||||
|
"""Test the text update command."""
|
||||||
|
result = runner.invoke(app, ['text', 'current', 'pytest_text_input'])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
assert 'Current text for input pytest_text_input: Hello, OBS!' in result.stdout
|
||||||
|
|
||||||
|
result = runner.invoke(app, ['text', 'update', 'pytest_text_input', 'New Text'])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
assert 'Text for input pytest_text_input updated to: New Text' 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_version():
|
def test_version():
|
||||||
|
|||||||
Reference in New Issue
Block a user