mirror of
https://github.com/onyx-and-iris/obsws-cli.git
synced 2026-04-07 09:33:38 +00:00
Compare commits
24 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 3eaa3992a0 | |||
| 7c86aa8a8b | |||
| 09ca892fcb | |||
| 81fcb4e504 | |||
| 3f3b331363 | |||
| 2535fe85c5 | |||
| 7d4485ec05 | |||
| 2c2501e017 | |||
| 356684e5d4 | |||
| f7e51f8488 | |||
| 8da29ce90e | |||
| 72c6bcee49 | |||
| dceafba065 | |||
| 7a73ec35f6 | |||
| 48e0f6cecd | |||
| 52e13922dc | |||
| f335d8ffd2 | |||
| 286cda8066 | |||
| e851219ced | |||
| f852a733c3 | |||
| 44dadcee23 | |||
| ed4531c305 | |||
| ec42a4cdd9 | |||
| 6123c92d00 |
@@ -5,6 +5,15 @@ 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.0] - 2026-01-09
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- new subcommands added to input, see [Input](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#input)
|
||||||
|
- settings command group, see [Settings](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#settings)
|
||||||
|
- media command group, see [Media](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#media)
|
||||||
|
|
||||||
|
|
||||||
# [0.20.0] - 2025-07-14
|
# [0.20.0] - 2025-07-14
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|||||||
139
README.md
139
README.md
@@ -298,6 +298,20 @@ obsws-cli group status START "test_group"
|
|||||||
|
|
||||||
#### Input
|
#### Input
|
||||||
|
|
||||||
|
- create: Create a new input.
|
||||||
|
- args: <input_name> <input_kind>
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli input create 'stream mix' 'wasapi_input_capture'
|
||||||
|
```
|
||||||
|
|
||||||
|
- remove: Remove an input.
|
||||||
|
- args: <input_name>
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli input remove 'stream mix'
|
||||||
|
```
|
||||||
|
|
||||||
- list: List all inputs.
|
- list: List all inputs.
|
||||||
- flags:
|
- flags:
|
||||||
|
|
||||||
@@ -315,6 +329,12 @@ obsws-cli input list
|
|||||||
obsws-cli input list --input --colour
|
obsws-cli input list --input --colour
|
||||||
```
|
```
|
||||||
|
|
||||||
|
- list-kinds: List all input kinds.
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli input list-kinds
|
||||||
|
```
|
||||||
|
|
||||||
- mute: Mute an input.
|
- mute: Mute an input.
|
||||||
- args: <input_name>
|
- args: <input_name>
|
||||||
|
|
||||||
@@ -335,6 +355,32 @@ obsws-cli input unmute "Mic/Aux"
|
|||||||
obsws-cli input toggle "Mic/Aux"
|
obsws-cli input toggle "Mic/Aux"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
- volume: Set the volume of an input.
|
||||||
|
- args: <input_name> <volume>
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli input volume -- 'Desktop Audio' -38.9
|
||||||
|
```
|
||||||
|
|
||||||
|
- show: Show information for an input in the current scene.
|
||||||
|
- args: <input_name>
|
||||||
|
- flags:
|
||||||
|
|
||||||
|
*optional*
|
||||||
|
- --verbose: List all available input devices.
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli input show 'Mic/Aux' --verbose
|
||||||
|
```
|
||||||
|
|
||||||
|
- update: Name of the input to update.
|
||||||
|
- args: <input_name> <device_name>
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli input update 'Mic/Aux' 'Voicemeeter Out B1 (VB-Audio Voicemeeter VAIO)'
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
#### Text
|
#### Text
|
||||||
|
|
||||||
- current: Get the current text for a text input.
|
- current: Get the current text for a text input.
|
||||||
@@ -676,6 +722,99 @@ 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"
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
`obsws-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
|
`obsws-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# SPDX-FileCopyrightText: 2025-present onyx-and-iris <code@onyxandiris.online>
|
# SPDX-FileCopyrightText: 2025-present onyx-and-iris <code@onyxandiris.online>
|
||||||
#
|
#
|
||||||
# SPDX-License-Identifier: MIT
|
# SPDX-License-Identifier: MIT
|
||||||
__version__ = '0.20.1'
|
__version__ = '0.24.0'
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ import typer
|
|||||||
|
|
||||||
from obsws_cli.__about__ import __version__ as version
|
from obsws_cli.__about__ import __version__ as version
|
||||||
|
|
||||||
from . import console, settings, styles
|
from . import config, console, styles
|
||||||
from .alias import RootTyperAliasGroup
|
from .alias import RootTyperAliasGroup
|
||||||
|
|
||||||
app = typer.Typer(cls=RootTyperAliasGroup)
|
app = typer.Typer(cls=RootTyperAliasGroup)
|
||||||
@@ -18,10 +18,12 @@ for sub_typer in (
|
|||||||
'group',
|
'group',
|
||||||
'hotkey',
|
'hotkey',
|
||||||
'input',
|
'input',
|
||||||
|
'media',
|
||||||
'profile',
|
'profile',
|
||||||
'projector',
|
'projector',
|
||||||
'record',
|
'record',
|
||||||
'replaybuffer',
|
'replaybuffer',
|
||||||
|
'settings',
|
||||||
'scene',
|
'scene',
|
||||||
'scenecollection',
|
'scenecollection',
|
||||||
'sceneitem',
|
'sceneitem',
|
||||||
@@ -72,7 +74,7 @@ def main(
|
|||||||
help='WebSocket host',
|
help='WebSocket host',
|
||||||
show_default='localhost',
|
show_default='localhost',
|
||||||
),
|
),
|
||||||
] = settings.get('host'),
|
] = config.get('host'),
|
||||||
port: Annotated[
|
port: Annotated[
|
||||||
int,
|
int,
|
||||||
typer.Option(
|
typer.Option(
|
||||||
@@ -82,7 +84,7 @@ def main(
|
|||||||
help='WebSocket port',
|
help='WebSocket port',
|
||||||
show_default=4455,
|
show_default=4455,
|
||||||
),
|
),
|
||||||
] = settings.get('port'),
|
] = config.get('port'),
|
||||||
password: Annotated[
|
password: Annotated[
|
||||||
str,
|
str,
|
||||||
typer.Option(
|
typer.Option(
|
||||||
@@ -92,7 +94,7 @@ def main(
|
|||||||
help='WebSocket password',
|
help='WebSocket password',
|
||||||
show_default=False,
|
show_default=False,
|
||||||
),
|
),
|
||||||
] = settings.get('password'),
|
] = config.get('password'),
|
||||||
timeout: Annotated[
|
timeout: Annotated[
|
||||||
int,
|
int,
|
||||||
typer.Option(
|
typer.Option(
|
||||||
@@ -102,7 +104,28 @@ def main(
|
|||||||
help='WebSocket timeout',
|
help='WebSocket timeout',
|
||||||
show_default=5,
|
show_default=5,
|
||||||
),
|
),
|
||||||
] = settings.get('timeout'),
|
] = config.get('timeout'),
|
||||||
|
style: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Option(
|
||||||
|
'--style',
|
||||||
|
'-s',
|
||||||
|
envvar='OBS_STYLE',
|
||||||
|
help='Set the style for the CLI output',
|
||||||
|
show_default='disabled',
|
||||||
|
callback=validate_style,
|
||||||
|
),
|
||||||
|
] = config.get('style'),
|
||||||
|
no_border: Annotated[
|
||||||
|
bool,
|
||||||
|
typer.Option(
|
||||||
|
'--no-border',
|
||||||
|
'-b',
|
||||||
|
envvar='OBS_STYLE_NO_BORDER',
|
||||||
|
help='Disable table border styling in the CLI output',
|
||||||
|
show_default=False,
|
||||||
|
),
|
||||||
|
] = config.get('style_no_border'),
|
||||||
version: Annotated[
|
version: Annotated[
|
||||||
bool,
|
bool,
|
||||||
typer.Option(
|
typer.Option(
|
||||||
@@ -114,27 +137,6 @@ def main(
|
|||||||
callback=version_callback,
|
callback=version_callback,
|
||||||
),
|
),
|
||||||
] = False,
|
] = False,
|
||||||
style: Annotated[
|
|
||||||
str,
|
|
||||||
typer.Option(
|
|
||||||
'--style',
|
|
||||||
'-s',
|
|
||||||
envvar='OBS_STYLE',
|
|
||||||
help='Set the style for the CLI output',
|
|
||||||
show_default='disabled',
|
|
||||||
callback=validate_style,
|
|
||||||
),
|
|
||||||
] = settings.get('style'),
|
|
||||||
no_border: Annotated[
|
|
||||||
bool,
|
|
||||||
typer.Option(
|
|
||||||
'--no-border',
|
|
||||||
'-b',
|
|
||||||
envvar='OBS_STYLE_NO_BORDER',
|
|
||||||
help='Disable table border styling in the CLI output',
|
|
||||||
show_default=False,
|
|
||||||
),
|
|
||||||
] = settings.get('style_no_border'),
|
|
||||||
debug: Annotated[
|
debug: Annotated[
|
||||||
bool,
|
bool,
|
||||||
typer.Option(
|
typer.Option(
|
||||||
@@ -147,11 +149,13 @@ def main(
|
|||||||
callback=setup_logging,
|
callback=setup_logging,
|
||||||
hidden=True,
|
hidden=True,
|
||||||
),
|
),
|
||||||
] = settings.get('debug'),
|
] = config.get('debug'),
|
||||||
):
|
):
|
||||||
"""obsws_cli is a command line interface for the OBS WebSocket API."""
|
"""obsws_cli is a command line interface for the OBS WebSocket API."""
|
||||||
ctx.ensure_object(dict)
|
ctx.ensure_object(dict)
|
||||||
ctx.obj['obsws'] = ctx.with_resource(obsws.ReqClient(**ctx.params))
|
ctx.obj['obsws'] = ctx.with_resource(
|
||||||
|
obsws.ReqClient(host=host, port=port, password=password, timeout=timeout)
|
||||||
|
)
|
||||||
ctx.obj['style'] = styles.request_style_obj(style, no_border)
|
ctx.obj['style'] = styles.request_style_obj(style, no_border)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
80
obsws_cli/config.py
Normal file
80
obsws_cli/config.py
Normal file
@@ -0,0 +1,80 @@
|
|||||||
|
"""module for settings management for obsws-cli."""
|
||||||
|
|
||||||
|
from collections import UserDict
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from dotenv import dotenv_values
|
||||||
|
|
||||||
|
ConfigValue = str | int
|
||||||
|
|
||||||
|
|
||||||
|
class Config(UserDict):
|
||||||
|
"""A class to manage config for obsws-cli.
|
||||||
|
|
||||||
|
This class extends UserDict to provide a dictionary-like interface for config.
|
||||||
|
It loads config from environment variables and .env files.
|
||||||
|
The config values are expected to be in uppercase and should start with 'OBS_'.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
-------
|
||||||
|
config = Config()
|
||||||
|
host = config['OBS_HOST']
|
||||||
|
config['OBS_PORT'] = 4455
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
PREFIX = 'OBS_'
|
||||||
|
|
||||||
|
def __init__(self, *args, **kwargs):
|
||||||
|
"""Initialize the Settings object."""
|
||||||
|
kwargs.update(
|
||||||
|
{
|
||||||
|
**dotenv_values('.env'),
|
||||||
|
**dotenv_values(Path.home() / '.config' / 'obsws-cli' / 'obsws.env'),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
super().__init__(*args, **kwargs)
|
||||||
|
|
||||||
|
def __getitem__(self, key: str) -> ConfigValue:
|
||||||
|
"""Get a setting value by key."""
|
||||||
|
key = key.upper()
|
||||||
|
if not key.startswith(Config.PREFIX):
|
||||||
|
key = f'{Config.PREFIX}{key}'
|
||||||
|
return self.data[key]
|
||||||
|
|
||||||
|
def __setitem__(self, key: str, value: ConfigValue):
|
||||||
|
"""Set a setting value by key."""
|
||||||
|
key = key.upper()
|
||||||
|
if not key.startswith(Config.PREFIX):
|
||||||
|
key = f'{Config.PREFIX}{key}'
|
||||||
|
self.data[key] = value
|
||||||
|
|
||||||
|
|
||||||
|
_config = Config(
|
||||||
|
OBS_HOST='localhost',
|
||||||
|
OBS_PORT=4455,
|
||||||
|
OBS_PASSWORD='',
|
||||||
|
OBS_TIMEOUT=5,
|
||||||
|
OBS_DEBUG=False,
|
||||||
|
OBS_STYLE='disabled',
|
||||||
|
OBS_STYLE_NO_BORDER=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def get(key: str) -> ConfigValue:
|
||||||
|
"""Get a setting value by key.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
----
|
||||||
|
key (str): The key of the config to retrieve.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
-------
|
||||||
|
The value of the config.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
------
|
||||||
|
KeyError: If the key does not exist in the config.
|
||||||
|
|
||||||
|
"""
|
||||||
|
return _config[key]
|
||||||
@@ -24,6 +24,10 @@ def list_(
|
|||||||
"""List all hotkeys."""
|
"""List all hotkeys."""
|
||||||
resp = ctx.obj['obsws'].get_hotkey_list()
|
resp = ctx.obj['obsws'].get_hotkey_list()
|
||||||
|
|
||||||
|
if not resp.hotkeys:
|
||||||
|
console.out.print('No hotkeys found.')
|
||||||
|
raise typer.Exit()
|
||||||
|
|
||||||
table = Table(
|
table = Table(
|
||||||
title='Hotkeys',
|
title='Hotkeys',
|
||||||
padding=(0, 2),
|
padding=(0, 2),
|
||||||
|
|||||||
@@ -18,6 +18,69 @@ def main():
|
|||||||
"""Control inputs in OBS."""
|
"""Control inputs in OBS."""
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('create | add')
|
||||||
|
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 | rm')
|
||||||
|
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 | ls')
|
@app.command('list | ls')
|
||||||
def list_(
|
def list_(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
@@ -105,18 +168,47 @@ def list_(
|
|||||||
console.out.print(table)
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('list-kinds | ls-k')
|
||||||
|
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 | m')
|
@app.command('mute | m')
|
||||||
def mute(
|
def mute(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
input_name: Annotated[
|
input_name: Annotated[
|
||||||
str, typer.Argument(..., show_default=False, help='Name of the input to mute.')
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Name of the input to mute.',
|
||||||
|
callback=validate.input_in_inputs,
|
||||||
|
),
|
||||||
],
|
],
|
||||||
):
|
):
|
||||||
"""Mute an input."""
|
"""Mute an input."""
|
||||||
if not validate.input_in_inputs(ctx, input_name):
|
|
||||||
console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj['obsws'].set_input_mute(
|
ctx.obj['obsws'].set_input_mute(
|
||||||
name=input_name,
|
name=input_name,
|
||||||
muted=True,
|
muted=True,
|
||||||
@@ -130,14 +222,15 @@ def unmute(
|
|||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
input_name: Annotated[
|
input_name: Annotated[
|
||||||
str,
|
str,
|
||||||
typer.Argument(..., show_default=False, help='Name of the input to unmute.'),
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Name of the input to unmute.',
|
||||||
|
callback=validate.input_in_inputs,
|
||||||
|
),
|
||||||
],
|
],
|
||||||
):
|
):
|
||||||
"""Unmute an input."""
|
"""Unmute an input."""
|
||||||
if not validate.input_in_inputs(ctx, input_name):
|
|
||||||
console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj['obsws'].set_input_mute(
|
ctx.obj['obsws'].set_input_mute(
|
||||||
name=input_name,
|
name=input_name,
|
||||||
muted=False,
|
muted=False,
|
||||||
@@ -151,14 +244,15 @@ def toggle(
|
|||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
input_name: Annotated[
|
input_name: Annotated[
|
||||||
str,
|
str,
|
||||||
typer.Argument(..., show_default=False, help='Name of the input to toggle.'),
|
typer.Argument(
|
||||||
|
...,
|
||||||
|
show_default=False,
|
||||||
|
help='Name of the input to toggle.',
|
||||||
|
callback=validate.input_in_inputs,
|
||||||
|
),
|
||||||
],
|
],
|
||||||
):
|
):
|
||||||
"""Toggle an input."""
|
"""Toggle an input."""
|
||||||
if not validate.input_in_inputs(ctx, input_name):
|
|
||||||
console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj['obsws'].get_input_mute(name=input_name)
|
resp = ctx.obj['obsws'].get_input_mute(name=input_name)
|
||||||
new_state = not resp.input_muted
|
new_state = not resp.input_muted
|
||||||
|
|
||||||
@@ -175,3 +269,188 @@ def toggle(
|
|||||||
console.out.print(
|
console.out.print(
|
||||||
f'Input {console.highlight(ctx, input_name)} unmuted.',
|
f'Input {console.highlight(ctx, input_name)} unmuted.',
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('volume | vol')
|
||||||
|
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 | s')
|
||||||
|
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 | upd')
|
||||||
|
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)}.',
|
||||||
|
)
|
||||||
|
|||||||
99
obsws_cli/media.py
Normal file
99
obsws_cli/media.py
Normal file
@@ -0,0 +1,99 @@
|
|||||||
|
"""module containing commands for media inputs."""
|
||||||
|
|
||||||
|
from typing import Annotated, Optional
|
||||||
|
|
||||||
|
import typer
|
||||||
|
|
||||||
|
from . import console, util
|
||||||
|
from .alias import SubTyperAliasGroup
|
||||||
|
|
||||||
|
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||||
|
|
||||||
|
|
||||||
|
@app.callback()
|
||||||
|
def main():
|
||||||
|
"""Commands for media inputs."""
|
||||||
|
|
||||||
|
|
||||||
|
@app.command('cursor | c')
|
||||||
|
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).'
|
||||||
|
),
|
||||||
|
] = 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 | p')
|
||||||
|
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 | pa')
|
||||||
|
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 | s')
|
||||||
|
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 | r')
|
||||||
|
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)}.')
|
||||||
@@ -22,6 +22,10 @@ def list_(ctx: typer.Context):
|
|||||||
"""List profiles."""
|
"""List profiles."""
|
||||||
resp = ctx.obj['obsws'].get_profile_list()
|
resp = ctx.obj['obsws'].get_profile_list()
|
||||||
|
|
||||||
|
if not resp.profiles:
|
||||||
|
console.out.print('No profiles found.')
|
||||||
|
raise typer.Exit()
|
||||||
|
|
||||||
table = Table(
|
table = Table(
|
||||||
title='Profiles', padding=(0, 2), border_style=ctx.obj['style'].border
|
title='Profiles', padding=(0, 2), border_style=ctx.obj['style'].border
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -21,16 +21,15 @@ def main():
|
|||||||
def list_monitors(ctx: typer.Context):
|
def list_monitors(ctx: typer.Context):
|
||||||
"""List available monitors."""
|
"""List available monitors."""
|
||||||
resp = ctx.obj['obsws'].get_monitor_list()
|
resp = ctx.obj['obsws'].get_monitor_list()
|
||||||
|
|
||||||
if not resp.monitors:
|
|
||||||
console.out.print('No monitors found.')
|
|
||||||
return
|
|
||||||
|
|
||||||
monitors = sorted(
|
monitors = sorted(
|
||||||
((m['monitorIndex'], m['monitorName']) for m in resp.monitors),
|
((m['monitorIndex'], m['monitorName']) for m in resp.monitors),
|
||||||
key=lambda m: m[0],
|
key=lambda m: m[0],
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if not monitors:
|
||||||
|
console.out.print('No monitors found.')
|
||||||
|
raise typer.Exit()
|
||||||
|
|
||||||
table = Table(
|
table = Table(
|
||||||
title='Available Monitors',
|
title='Available Monitors',
|
||||||
padding=(0, 2),
|
padding=(0, 2),
|
||||||
|
|||||||
@@ -29,6 +29,10 @@ def list_(
|
|||||||
for scene in reversed(resp.scenes)
|
for scene in reversed(resp.scenes)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if not scenes:
|
||||||
|
console.out.print('No scenes found.')
|
||||||
|
raise typer.Exit()
|
||||||
|
|
||||||
active_scene = ctx.obj['obsws'].get_current_program_scene().scene_name
|
active_scene = ctx.obj['obsws'].get_current_program_scene().scene_name
|
||||||
|
|
||||||
table = Table(title='Scenes', padding=(0, 2), border_style=ctx.obj['style'].border)
|
table = Table(title='Scenes', padding=(0, 2), border_style=ctx.obj['style'].border)
|
||||||
|
|||||||
@@ -21,6 +21,10 @@ def list_(ctx: typer.Context):
|
|||||||
"""List all scene collections."""
|
"""List all scene collections."""
|
||||||
resp = ctx.obj['obsws'].get_scene_collection_list()
|
resp = ctx.obj['obsws'].get_scene_collection_list()
|
||||||
|
|
||||||
|
if not resp.scene_collections:
|
||||||
|
console.out.print('No scene collections found.')
|
||||||
|
raise typer.Exit()
|
||||||
|
|
||||||
table = Table(
|
table = Table(
|
||||||
title='Scene Collections',
|
title='Scene Collections',
|
||||||
padding=(0, 2),
|
padding=(0, 2),
|
||||||
|
|||||||
@@ -1,80 +1,337 @@
|
|||||||
"""module for settings management for obsws-cli."""
|
"""module for settings management."""
|
||||||
|
|
||||||
from collections import UserDict
|
from typing import Annotated, Optional
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
from dotenv import dotenv_values
|
import typer
|
||||||
|
from rich.table import Table
|
||||||
|
from rich.text import Text
|
||||||
|
|
||||||
SettingsValue = str | int
|
from . import console, util
|
||||||
|
from .alias import SubTyperAliasGroup
|
||||||
|
|
||||||
|
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||||
|
|
||||||
|
|
||||||
class Settings(UserDict):
|
@app.callback()
|
||||||
"""A class to manage settings for obsws-cli.
|
def main():
|
||||||
|
"""Manage OBS settings."""
|
||||||
|
|
||||||
This class extends UserDict to provide a dictionary-like interface for settings.
|
|
||||||
It loads settings from environment variables and .env files.
|
|
||||||
The settings are expected to be in uppercase and should start with 'OBS_'.
|
|
||||||
|
|
||||||
Example:
|
@app.command('show | sh')
|
||||||
-------
|
def show(
|
||||||
settings = Settings()
|
ctx: typer.Context,
|
||||||
host = settings['OBS_HOST']
|
video: Annotated[
|
||||||
settings['OBS_PORT'] = 4455
|
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(
|
||||||
PREFIX = 'OBS_'
|
title='Video Settings',
|
||||||
|
padding=(0, 2),
|
||||||
def __init__(self, *args, **kwargs):
|
border_style=ctx.obj['style'].border,
|
||||||
"""Initialize the Settings object."""
|
)
|
||||||
kwargs.update(
|
video_columns = (
|
||||||
{
|
('Setting', 'left', ctx.obj['style'].column),
|
||||||
**dotenv_values('.env'),
|
('Value', 'left', ctx.obj['style'].column),
|
||||||
**dotenv_values(Path.home() / '.config' / 'obsws-cli' / 'obsws.env'),
|
|
||||||
}
|
|
||||||
)
|
)
|
||||||
super().__init__(*args, **kwargs)
|
|
||||||
|
|
||||||
def __getitem__(self, key: str) -> SettingsValue:
|
for header_text, justify, style in video_columns:
|
||||||
"""Get a setting value by key."""
|
video_table.add_column(
|
||||||
key = key.upper()
|
Text(header_text, justify='center'),
|
||||||
if not key.startswith(Settings.PREFIX):
|
justify=justify,
|
||||||
key = f'{Settings.PREFIX}{key}'
|
style=style,
|
||||||
return self.data[key]
|
)
|
||||||
|
|
||||||
def __setitem__(self, key: str, value: SettingsValue):
|
for setting in resp.attrs():
|
||||||
"""Set a setting value by key."""
|
video_table.add_row(
|
||||||
key = key.upper()
|
util.snakecase_to_titlecase(setting),
|
||||||
if not key.startswith(Settings.PREFIX):
|
str(getattr(resp, setting)),
|
||||||
key = f'{Settings.PREFIX}{key}'
|
style='' if video_table.row_count % 2 == 0 else 'dim',
|
||||||
self.data[key] = value
|
)
|
||||||
|
|
||||||
|
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)
|
||||||
|
|
||||||
|
|
||||||
_settings = Settings(
|
@app.command('profile | pr')
|
||||||
OBS_HOST='localhost',
|
def profile(
|
||||||
OBS_PORT=4455,
|
ctx: typer.Context,
|
||||||
OBS_PASSWORD='',
|
category: Annotated[
|
||||||
OBS_TIMEOUT=5,
|
str,
|
||||||
OBS_DEBUG=False,
|
typer.Argument(
|
||||||
OBS_STYLE='disabled',
|
...,
|
||||||
OBS_STYLE_NO_BORDER=False,
|
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]'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def get(key: str) -> SettingsValue:
|
@app.command('stream-service | ss')
|
||||||
"""Get a setting value by key.
|
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', '')
|
||||||
|
|
||||||
Args:
|
ctx.obj['obsws'].set_stream_service_settings(
|
||||||
----
|
ss_type=type_,
|
||||||
key (str): The key of the setting to retrieve.
|
ss_settings={'key': key, 'server': server},
|
||||||
|
)
|
||||||
|
console.out.print('Stream service settings updated.')
|
||||||
|
|
||||||
Returns:
|
|
||||||
-------
|
|
||||||
The value of the setting.
|
|
||||||
|
|
||||||
Raises:
|
@app.command('video | vi')
|
||||||
------
|
def video(
|
||||||
KeyError: If the key does not exist in the settings.
|
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(
|
||||||
return _settings[key]
|
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.')
|
||||||
|
|||||||
@@ -18,13 +18,14 @@ def main():
|
|||||||
@app.command('current | get')
|
@app.command('current | get')
|
||||||
def current(
|
def current(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
input_name: Annotated[str, typer.Argument(help='Name of the text input to get.')],
|
input_name: Annotated[
|
||||||
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
help='Name of the text input to get.', callback=validate.input_in_inputs
|
||||||
|
),
|
||||||
|
],
|
||||||
):
|
):
|
||||||
"""Get the current text for a text input."""
|
"""Get the current text for a text input."""
|
||||||
if not validate.input_in_inputs(ctx, input_name):
|
|
||||||
console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj['obsws'].get_input_settings(name=input_name)
|
resp = ctx.obj['obsws'].get_input_settings(name=input_name)
|
||||||
if not resp.input_kind.startswith('text_'):
|
if not resp.input_kind.startswith('text_'):
|
||||||
console.err.print(
|
console.err.print(
|
||||||
@@ -44,7 +45,10 @@ def current(
|
|||||||
def update(
|
def update(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
input_name: Annotated[
|
input_name: Annotated[
|
||||||
str, typer.Argument(help='Name of the text input to update.')
|
str,
|
||||||
|
typer.Argument(
|
||||||
|
help='Name of the text input to update.', callback=validate.input_in_inputs
|
||||||
|
),
|
||||||
],
|
],
|
||||||
new_text: Annotated[
|
new_text: Annotated[
|
||||||
Optional[str],
|
Optional[str],
|
||||||
@@ -54,10 +58,6 @@ def update(
|
|||||||
] = None,
|
] = None,
|
||||||
):
|
):
|
||||||
"""Update the text of a text input."""
|
"""Update the text of a text input."""
|
||||||
if not validate.input_in_inputs(ctx, input_name):
|
|
||||||
console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
resp = ctx.obj['obsws'].get_input_settings(name=input_name)
|
resp = ctx.obj['obsws'].get_input_settings(name=input_name)
|
||||||
if not resp.input_kind.startswith('text_'):
|
if not resp.input_kind.startswith('text_'):
|
||||||
console.err.print(
|
console.err.print(
|
||||||
|
|||||||
@@ -20,3 +20,28 @@ def check_mark(value: bool, empty_if_false: bool = False) -> str:
|
|||||||
if os.getenv('NO_COLOR', '') != '':
|
if os.getenv('NO_COLOR', '') != '':
|
||||||
return '✓' if value else '✗'
|
return '✓' if value else '✗'
|
||||||
return '✅' if value else '❌'
|
return '✅' if value else '❌'
|
||||||
|
|
||||||
|
|
||||||
|
def timecode_to_milliseconds(timecode: str) -> int:
|
||||||
|
"""Convert a timecode string (HH:MM:SS) to total milliseconds."""
|
||||||
|
match timecode.split(':'):
|
||||||
|
case [mm, ss]:
|
||||||
|
hours = 0
|
||||||
|
minutes = int(mm)
|
||||||
|
seconds = int(ss)
|
||||||
|
case [hh, mm, ss]:
|
||||||
|
hours = int(hh)
|
||||||
|
minutes = int(mm)
|
||||||
|
seconds = int(ss)
|
||||||
|
return (hours * 3600 + minutes * 60 + seconds) * 1000
|
||||||
|
|
||||||
|
|
||||||
|
def milliseconds_to_timecode(milliseconds: int) -> str:
|
||||||
|
"""Convert total milliseconds to a timecode string (HH:MM:SS)."""
|
||||||
|
total_seconds = milliseconds // 1000
|
||||||
|
hours = total_seconds // 3600
|
||||||
|
minutes = (total_seconds % 3600) // 60
|
||||||
|
seconds = total_seconds % 60
|
||||||
|
if hours == 0:
|
||||||
|
return f'{minutes:02}:{seconds:02}'
|
||||||
|
return f'{hours:02}:{minutes:02}:{seconds:02}'
|
||||||
|
|||||||
@@ -2,14 +2,28 @@
|
|||||||
|
|
||||||
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) -> bool:
|
||||||
"""Check if an input is in the input list."""
|
"""Ensure the given input exists in the list of inputs."""
|
||||||
inputs = ctx.obj['obsws'].get_input_list().inputs
|
resp = ctx.obj['obsws'].get_input_list()
|
||||||
return any(input_.get('inputName') == input_name for input_ in inputs)
|
if not any(input.get('inputName') == input_name for input in resp.inputs):
|
||||||
|
console.err.print(f'Input [yellow]{input_name}[/yellow] does not exist.')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
return input_name
|
||||||
|
|
||||||
|
|
||||||
|
def input_not_in_inputs(ctx: typer.Context, input_name: str) -> bool:
|
||||||
|
"""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: str) -> bool:
|
def scene_in_scenes(ctx: typer.Context, scene_name: str) -> bool:
|
||||||
@@ -52,3 +66,12 @@ def monitor_exists(ctx: typer.Context, monitor_index: int) -> bool:
|
|||||||
"""Check if a monitor exists."""
|
"""Check if a monitor exists."""
|
||||||
resp = ctx.obj['obsws'].get_monitor_list()
|
resp = ctx.obj['obsws'].get_monitor_list()
|
||||||
return any(monitor['monitorIndex'] == monitor_index for monitor in resp.monitors)
|
return any(monitor['monitorIndex'] == monitor_index for monitor in resp.monitors)
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ classifiers = [
|
|||||||
"Programming Language :: Python :: Implementation :: CPython",
|
"Programming Language :: Python :: Implementation :: CPython",
|
||||||
"Programming Language :: Python :: Implementation :: PyPy",
|
"Programming Language :: Python :: Implementation :: PyPy",
|
||||||
]
|
]
|
||||||
dependencies = ["typer>=0.16.0", "obsws-python>=1.8.0", "python-dotenv>=1.1.0"]
|
dependencies = ["typer>=0.21.1", "obsws-python>=1.8.0", "python-dotenv>=1.1.0"]
|
||||||
|
|
||||||
|
|
||||||
[project.urls]
|
[project.urls]
|
||||||
@@ -42,9 +42,6 @@ dependencies = ["click-man>=0.5.1"]
|
|||||||
cli = "obsws-cli {args:}"
|
cli = "obsws-cli {args:}"
|
||||||
man = "python man/generate.py --output=./man"
|
man = "python man/generate.py --output=./man"
|
||||||
|
|
||||||
[tool.hatch.envs.lazyimports.scripts]
|
|
||||||
cli = "obsws-cli {args:}"
|
|
||||||
|
|
||||||
[tool.hatch.envs.hatch-test]
|
[tool.hatch.envs.hatch-test]
|
||||||
randomize = true
|
randomize = true
|
||||||
|
|
||||||
|
|||||||
@@ -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
|
||||||
@@ -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',
|
||||||
@@ -131,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:
|
||||||
@@ -149,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():
|
||||||
|
|||||||
@@ -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():
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
|||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
def test_hotkey_list():
|
def test_hotkey_list():
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
|||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
def test_input_list():
|
def test_input_list():
|
||||||
@@ -13,10 +13,7 @@ def test_input_list():
|
|||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert 'Desktop Audio' in result.stdout
|
assert 'Desktop Audio' in result.stdout
|
||||||
assert 'Mic/Aux' in result.stdout
|
assert 'Mic/Aux' in result.stdout
|
||||||
assert all(
|
assert all(item in result.stdout for item in ('pytest_input', 'pytest_input_2'))
|
||||||
item in result.stdout
|
|
||||||
for item in ('Colour Source', 'Colour Source 2', 'Colour Source 3')
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_input_list_filter_input():
|
def test_input_list_filter_input():
|
||||||
@@ -39,9 +36,6 @@ def test_input_list_filter_colour():
|
|||||||
"""Test the input list command with colour filter."""
|
"""Test the input list command with colour filter."""
|
||||||
result = runner.invoke(app, ['input', 'list', '--colour'])
|
result = runner.invoke(app, ['input', 'list', '--colour'])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert all(
|
assert all(item in result.stdout for item in ('pytest_input', 'pytest_input_2'))
|
||||||
item in result.stdout
|
|
||||||
for item in ('Colour Source', 'Colour Source 2', 'Colour Source 3')
|
|
||||||
)
|
|
||||||
assert 'Desktop Audio' not in result.stdout
|
assert 'Desktop Audio' not in result.stdout
|
||||||
assert 'Mic/Aux' not in result.stdout
|
assert 'Mic/Aux' not in result.stdout
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ from typer.testing import CliRunner
|
|||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
def test_record_start():
|
def test_record_start():
|
||||||
@@ -49,7 +49,9 @@ def test_record_toggle():
|
|||||||
|
|
||||||
result = runner.invoke(app, ['record', 'toggle'])
|
result = runner.invoke(app, ['record', 'toggle'])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
|
|
||||||
time.sleep(0.5) # Wait for the recording to toggle
|
time.sleep(0.5) # Wait for the recording to toggle
|
||||||
|
|
||||||
if active:
|
if active:
|
||||||
assert 'Recording stopped successfully.' in result.stdout
|
assert 'Recording stopped successfully.' in result.stdout
|
||||||
else:
|
else:
|
||||||
|
|||||||
@@ -1,10 +1,20 @@
|
|||||||
"""Unit tests for the replaybuffer command in the OBS WebSocket CLI."""
|
"""Unit tests for the replaybuffer command in the OBS WebSocket CLI."""
|
||||||
|
|
||||||
|
import os
|
||||||
|
import time
|
||||||
|
|
||||||
|
import pytest
|
||||||
from typer.testing import CliRunner
|
from typer.testing import CliRunner
|
||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
if os.environ.get('OBS_TESTS_SKIP_REPLAYBUFFER_TESTS'):
|
||||||
|
pytest.skip(
|
||||||
|
'Skipping replaybuffer tests as per environment variable',
|
||||||
|
allow_module_level=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_replaybuffer_start():
|
def test_replaybuffer_start():
|
||||||
@@ -14,6 +24,9 @@ def test_replaybuffer_start():
|
|||||||
active = 'Replay buffer is active.' in resp.stdout
|
active = 'Replay buffer is active.' in resp.stdout
|
||||||
|
|
||||||
resp = runner.invoke(app, ['replaybuffer', 'start'])
|
resp = runner.invoke(app, ['replaybuffer', 'start'])
|
||||||
|
|
||||||
|
time.sleep(0.5) # Wait for the replay buffer to start
|
||||||
|
|
||||||
if active:
|
if active:
|
||||||
assert resp.exit_code != 0
|
assert resp.exit_code != 0
|
||||||
assert 'Replay buffer is already active.' in resp.stderr
|
assert 'Replay buffer is already active.' in resp.stderr
|
||||||
@@ -29,6 +42,9 @@ def test_replaybuffer_stop():
|
|||||||
active = 'Replay buffer is active.' in resp.stdout
|
active = 'Replay buffer is active.' in resp.stdout
|
||||||
|
|
||||||
resp = runner.invoke(app, ['replaybuffer', 'stop'])
|
resp = runner.invoke(app, ['replaybuffer', 'stop'])
|
||||||
|
|
||||||
|
time.sleep(0.5) # Wait for the replay buffer to stop
|
||||||
|
|
||||||
if not active:
|
if not active:
|
||||||
assert resp.exit_code != 0
|
assert resp.exit_code != 0
|
||||||
assert 'Replay buffer is not active.' in resp.stderr
|
assert 'Replay buffer is not active.' in resp.stderr
|
||||||
@@ -44,9 +60,11 @@ def test_replaybuffer_toggle():
|
|||||||
active = 'Replay buffer is active.' in resp.stdout
|
active = 'Replay buffer is active.' in resp.stdout
|
||||||
|
|
||||||
resp = runner.invoke(app, ['replaybuffer', 'toggle'])
|
resp = runner.invoke(app, ['replaybuffer', 'toggle'])
|
||||||
if active:
|
|
||||||
assert resp.exit_code == 0
|
assert resp.exit_code == 0
|
||||||
|
|
||||||
|
time.sleep(0.5) # Wait for the replay buffer to toggle
|
||||||
|
|
||||||
|
if active:
|
||||||
assert 'Replay buffer is not active.' in resp.stdout
|
assert 'Replay buffer is not active.' in resp.stdout
|
||||||
else:
|
else:
|
||||||
assert resp.exit_code == 0
|
|
||||||
assert 'Replay buffer is active.' in resp.stdout
|
assert 'Replay buffer is active.' in resp.stdout
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
|||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
def test_scene_list():
|
def test_scene_list():
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
|||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
def test_sceneitem_list():
|
def test_sceneitem_list():
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ from typer.testing import CliRunner
|
|||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
def test_stream_start():
|
def test_stream_start():
|
||||||
@@ -23,7 +23,7 @@ def test_stream_start():
|
|||||||
else:
|
else:
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert 'Streaming started successfully.' in result.stdout
|
assert 'Streaming started successfully.' in result.stdout
|
||||||
time.sleep(1) # Wait for the streaming to start
|
time.sleep(0.5) # Wait for the streaming to start
|
||||||
|
|
||||||
|
|
||||||
def test_stream_stop():
|
def test_stream_stop():
|
||||||
@@ -37,7 +37,7 @@ def test_stream_stop():
|
|||||||
if active:
|
if active:
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert 'Streaming stopped successfully.' in result.stdout
|
assert 'Streaming stopped successfully.' in result.stdout
|
||||||
time.sleep(1) # Wait for the streaming to stop
|
time.sleep(0.5) # Wait for the streaming to stop
|
||||||
else:
|
else:
|
||||||
assert result.exit_code != 0
|
assert result.exit_code != 0
|
||||||
assert 'Streaming is not in progress, cannot stop.' in result.stderr
|
assert 'Streaming is not in progress, cannot stop.' in result.stderr
|
||||||
@@ -52,7 +52,7 @@ def test_stream_toggle():
|
|||||||
result = runner.invoke(app, ['stream', 'toggle'])
|
result = runner.invoke(app, ['stream', 'toggle'])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
|
|
||||||
time.sleep(1) # Wait for the stream to toggle
|
time.sleep(0.5) # Wait for the stream to toggle
|
||||||
|
|
||||||
if active:
|
if active:
|
||||||
assert 'Streaming stopped successfully.' in result.stdout
|
assert 'Streaming stopped successfully.' in result.stdout
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
|||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
def test_studio_enable():
|
def test_studio_enable():
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
|||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
def test_text_update():
|
def test_text_update():
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
|||||||
|
|
||||||
from obsws_cli.app import app
|
from obsws_cli.app import app
|
||||||
|
|
||||||
runner = CliRunner(mix_stderr=False)
|
runner = CliRunner()
|
||||||
|
|
||||||
|
|
||||||
def test_version():
|
def test_version():
|
||||||
|
|||||||
Reference in New Issue
Block a user