mirror of
https://github.com/onyx-and-iris/obsws-cli.git
synced 2026-04-07 01:23:35 +00:00
Compare commits
10 Commits
switch-to-
...
v0.22.0
| Author | SHA1 | Date | |
|---|---|---|---|
| f7e51f8488 | |||
| 8da29ce90e | |||
| 72c6bcee49 | |||
| dceafba065 | |||
| 7a73ec35f6 | |||
| 48e0f6cecd | |||
| 52e13922dc | |||
| f335d8ffd2 | |||
| 286cda8066 | |||
| e851219ced |
@@ -5,6 +5,13 @@ 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/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
# [0.22.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)
|
||||
|
||||
|
||||
# [0.20.0] - 2025-07-14
|
||||
|
||||
### Added
|
||||
|
||||
46
README.md
46
README.md
@@ -298,6 +298,20 @@ obsws-cli group status START "test_group"
|
||||
|
||||
#### 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.
|
||||
- flags:
|
||||
|
||||
@@ -315,6 +329,12 @@ obsws-cli input list
|
||||
obsws-cli input list --input --colour
|
||||
```
|
||||
|
||||
- list-kinds: List all input kinds.
|
||||
|
||||
```console
|
||||
obsws-cli input list-kinds
|
||||
```
|
||||
|
||||
- mute: Mute an input.
|
||||
- args: <input_name>
|
||||
|
||||
@@ -335,6 +355,32 @@ obsws-cli input unmute "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.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# SPDX-FileCopyrightText: 2025-present onyx-and-iris <code@onyxandiris.online>
|
||||
#
|
||||
# SPDX-License-Identifier: MIT
|
||||
__version__ = '0.20.2'
|
||||
__version__ = '0.22.0'
|
||||
|
||||
@@ -103,17 +103,6 @@ def main(
|
||||
show_default=5,
|
||||
),
|
||||
] = settings.get('timeout'),
|
||||
version: Annotated[
|
||||
bool,
|
||||
typer.Option(
|
||||
'--version',
|
||||
'-v',
|
||||
is_eager=True,
|
||||
help='Show the CLI version and exit',
|
||||
show_default=False,
|
||||
callback=version_callback,
|
||||
),
|
||||
] = False,
|
||||
style: Annotated[
|
||||
str,
|
||||
typer.Option(
|
||||
@@ -135,6 +124,17 @@ def main(
|
||||
show_default=False,
|
||||
),
|
||||
] = settings.get('style_no_border'),
|
||||
version: Annotated[
|
||||
bool,
|
||||
typer.Option(
|
||||
'--version',
|
||||
'-v',
|
||||
is_eager=True,
|
||||
help='Show the CLI version and exit',
|
||||
show_default=False,
|
||||
callback=version_callback,
|
||||
),
|
||||
] = False,
|
||||
debug: Annotated[
|
||||
bool,
|
||||
typer.Option(
|
||||
@@ -151,7 +151,9 @@ def main(
|
||||
):
|
||||
"""obsws_cli is a command line interface for the OBS WebSocket API."""
|
||||
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)
|
||||
|
||||
|
||||
|
||||
@@ -24,6 +24,10 @@ def list_(
|
||||
"""List all hotkeys."""
|
||||
resp = ctx.obj['obsws'].get_hotkey_list()
|
||||
|
||||
if not resp.hotkeys:
|
||||
console.out.print('No hotkeys found.')
|
||||
raise typer.Exit()
|
||||
|
||||
table = Table(
|
||||
title='Hotkeys',
|
||||
padding=(0, 2),
|
||||
|
||||
@@ -18,6 +18,69 @@ def main():
|
||||
"""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')
|
||||
def list_(
|
||||
ctx: typer.Context,
|
||||
@@ -105,18 +168,47 @@ def list_(
|
||||
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')
|
||||
def mute(
|
||||
ctx: typer.Context,
|
||||
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."""
|
||||
if not validate.input_in_inputs(ctx, input_name):
|
||||
console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
|
||||
raise typer.Exit(1)
|
||||
|
||||
ctx.obj['obsws'].set_input_mute(
|
||||
name=input_name,
|
||||
muted=True,
|
||||
@@ -130,14 +222,15 @@ def unmute(
|
||||
ctx: typer.Context,
|
||||
input_name: Annotated[
|
||||
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."""
|
||||
if not validate.input_in_inputs(ctx, input_name):
|
||||
console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
|
||||
raise typer.Exit(1)
|
||||
|
||||
ctx.obj['obsws'].set_input_mute(
|
||||
name=input_name,
|
||||
muted=False,
|
||||
@@ -151,14 +244,15 @@ def toggle(
|
||||
ctx: typer.Context,
|
||||
input_name: Annotated[
|
||||
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."""
|
||||
if not validate.input_in_inputs(ctx, input_name):
|
||||
console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
|
||||
raise typer.Exit(1)
|
||||
|
||||
resp = ctx.obj['obsws'].get_input_mute(name=input_name)
|
||||
new_state = not resp.input_muted
|
||||
|
||||
@@ -175,3 +269,188 @@ def toggle(
|
||||
console.out.print(
|
||||
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)}.',
|
||||
)
|
||||
|
||||
@@ -22,6 +22,10 @@ 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
|
||||
)
|
||||
|
||||
@@ -21,16 +21,15 @@ def main():
|
||||
def list_monitors(ctx: typer.Context):
|
||||
"""List available monitors."""
|
||||
resp = ctx.obj['obsws'].get_monitor_list()
|
||||
|
||||
if not resp.monitors:
|
||||
console.out.print('No monitors found.')
|
||||
return
|
||||
|
||||
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),
|
||||
|
||||
@@ -29,6 +29,10 @@ def list_(
|
||||
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)
|
||||
|
||||
@@ -21,6 +21,10 @@ 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),
|
||||
|
||||
@@ -18,13 +18,14 @@ def main():
|
||||
@app.command('current | get')
|
||||
def current(
|
||||
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."""
|
||||
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)
|
||||
if not resp.input_kind.startswith('text_'):
|
||||
console.err.print(
|
||||
@@ -44,7 +45,10 @@ def current(
|
||||
def update(
|
||||
ctx: typer.Context,
|
||||
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[
|
||||
Optional[str],
|
||||
@@ -54,10 +58,6 @@ def update(
|
||||
] = None,
|
||||
):
|
||||
"""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)
|
||||
if not resp.input_kind.startswith('text_'):
|
||||
console.err.print(
|
||||
|
||||
@@ -2,14 +2,28 @@
|
||||
|
||||
import typer
|
||||
|
||||
from . import console
|
||||
|
||||
# type alias for an option that is skipped when the command is run
|
||||
skipped_option = typer.Option(parser=lambda _: _, hidden=True, expose_value=False)
|
||||
|
||||
|
||||
def input_in_inputs(ctx: typer.Context, input_name: str) -> bool:
|
||||
"""Check if an input is in the input list."""
|
||||
inputs = ctx.obj['obsws'].get_input_list().inputs
|
||||
return any(input_.get('inputName') == input_name for input_ in inputs)
|
||||
"""Ensure the given input exists in the list of inputs."""
|
||||
resp = ctx.obj['obsws'].get_input_list()
|
||||
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:
|
||||
@@ -52,3 +66,12 @@ def monitor_exists(ctx: typer.Context, monitor_index: int) -> bool:
|
||||
"""Check if a monitor exists."""
|
||||
resp = ctx.obj['obsws'].get_monitor_list()
|
||||
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 :: 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]
|
||||
@@ -42,9 +42,6 @@ dependencies = ["click-man>=0.5.1"]
|
||||
cli = "obsws-cli {args:}"
|
||||
man = "python man/generate.py --output=./man"
|
||||
|
||||
[tool.hatch.envs.lazyimports.scripts]
|
||||
cli = "obsws-cli {args:}"
|
||||
|
||||
[tool.hatch.envs.hatch-test]
|
||||
randomize = true
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
"""pytest configuration file."""
|
||||
|
||||
import os
|
||||
import time
|
||||
|
||||
import obsws_python as obsws
|
||||
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')
|
||||
|
||||
# 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(
|
||||
sceneName='pytest_scene',
|
||||
inputName='pytest_input',
|
||||
@@ -131,7 +177,7 @@ def pytest_sessionfinish(session, exitstatus):
|
||||
|
||||
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()
|
||||
if resp.output_active:
|
||||
@@ -149,6 +195,8 @@ def pytest_sessionfinish(session, exitstatus):
|
||||
if resp.studio_mode_enabled:
|
||||
session.obsws.set_studio_mode_enabled(False)
|
||||
|
||||
session.obsws.remove_profile('pytest_profile')
|
||||
|
||||
# Close the OBS WebSocket client connection
|
||||
session.obsws.disconnect()
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
||||
|
||||
from obsws_cli.app import app
|
||||
|
||||
runner = CliRunner(mix_stderr=False)
|
||||
runner = CliRunner()
|
||||
|
||||
|
||||
def test_filter_list():
|
||||
|
||||
@@ -1,10 +1,18 @@
|
||||
"""Unit tests for the group command in the OBS WebSocket CLI."""
|
||||
|
||||
import os
|
||||
|
||||
import pytest
|
||||
from typer.testing import CliRunner
|
||||
|
||||
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():
|
||||
|
||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
||||
|
||||
from obsws_cli.app import app
|
||||
|
||||
runner = CliRunner(mix_stderr=False)
|
||||
runner = CliRunner()
|
||||
|
||||
|
||||
def test_hotkey_list():
|
||||
|
||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
||||
|
||||
from obsws_cli.app import app
|
||||
|
||||
runner = CliRunner(mix_stderr=False)
|
||||
runner = CliRunner()
|
||||
|
||||
|
||||
def test_input_list():
|
||||
@@ -13,10 +13,7 @@ def test_input_list():
|
||||
assert result.exit_code == 0
|
||||
assert 'Desktop Audio' in result.stdout
|
||||
assert 'Mic/Aux' in result.stdout
|
||||
assert all(
|
||||
item in result.stdout
|
||||
for item in ('Colour Source', 'Colour Source 2', 'Colour Source 3')
|
||||
)
|
||||
assert all(item in result.stdout for item in ('pytest_input', 'pytest_input_2'))
|
||||
|
||||
|
||||
def test_input_list_filter_input():
|
||||
@@ -39,9 +36,6 @@ def test_input_list_filter_colour():
|
||||
"""Test the input list command with colour filter."""
|
||||
result = runner.invoke(app, ['input', 'list', '--colour'])
|
||||
assert result.exit_code == 0
|
||||
assert all(
|
||||
item in result.stdout
|
||||
for item in ('Colour Source', 'Colour Source 2', 'Colour Source 3')
|
||||
)
|
||||
assert all(item in result.stdout for item in ('pytest_input', 'pytest_input_2'))
|
||||
assert 'Desktop Audio' 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
|
||||
|
||||
runner = CliRunner(mix_stderr=False)
|
||||
runner = CliRunner()
|
||||
|
||||
|
||||
def test_record_start():
|
||||
@@ -49,7 +49,9 @@ def test_record_toggle():
|
||||
|
||||
result = runner.invoke(app, ['record', 'toggle'])
|
||||
assert result.exit_code == 0
|
||||
|
||||
time.sleep(0.5) # Wait for the recording to toggle
|
||||
|
||||
if active:
|
||||
assert 'Recording stopped successfully.' in result.stdout
|
||||
else:
|
||||
|
||||
@@ -1,10 +1,20 @@
|
||||
"""Unit tests for the replaybuffer command in the OBS WebSocket CLI."""
|
||||
|
||||
import os
|
||||
import time
|
||||
|
||||
import pytest
|
||||
from typer.testing import CliRunner
|
||||
|
||||
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():
|
||||
@@ -14,6 +24,9 @@ def test_replaybuffer_start():
|
||||
active = 'Replay buffer is active.' in resp.stdout
|
||||
|
||||
resp = runner.invoke(app, ['replaybuffer', 'start'])
|
||||
|
||||
time.sleep(0.5) # Wait for the replay buffer to start
|
||||
|
||||
if active:
|
||||
assert resp.exit_code != 0
|
||||
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
|
||||
|
||||
resp = runner.invoke(app, ['replaybuffer', 'stop'])
|
||||
|
||||
time.sleep(0.5) # Wait for the replay buffer to stop
|
||||
|
||||
if not active:
|
||||
assert resp.exit_code != 0
|
||||
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
|
||||
|
||||
resp = runner.invoke(app, ['replaybuffer', 'toggle'])
|
||||
assert resp.exit_code == 0
|
||||
|
||||
time.sleep(0.5) # Wait for the replay buffer to toggle
|
||||
|
||||
if active:
|
||||
assert resp.exit_code == 0
|
||||
assert 'Replay buffer is not active.' in resp.stdout
|
||||
else:
|
||||
assert resp.exit_code == 0
|
||||
assert 'Replay buffer is active.' in resp.stdout
|
||||
|
||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
||||
|
||||
from obsws_cli.app import app
|
||||
|
||||
runner = CliRunner(mix_stderr=False)
|
||||
runner = CliRunner()
|
||||
|
||||
|
||||
def test_scene_list():
|
||||
|
||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
||||
|
||||
from obsws_cli.app import app
|
||||
|
||||
runner = CliRunner(mix_stderr=False)
|
||||
runner = CliRunner()
|
||||
|
||||
|
||||
def test_sceneitem_list():
|
||||
|
||||
@@ -6,7 +6,7 @@ from typer.testing import CliRunner
|
||||
|
||||
from obsws_cli.app import app
|
||||
|
||||
runner = CliRunner(mix_stderr=False)
|
||||
runner = CliRunner()
|
||||
|
||||
|
||||
def test_stream_start():
|
||||
@@ -23,7 +23,7 @@ def test_stream_start():
|
||||
else:
|
||||
assert result.exit_code == 0
|
||||
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():
|
||||
@@ -37,7 +37,7 @@ def test_stream_stop():
|
||||
if active:
|
||||
assert result.exit_code == 0
|
||||
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:
|
||||
assert result.exit_code != 0
|
||||
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'])
|
||||
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:
|
||||
assert 'Streaming stopped successfully.' in result.stdout
|
||||
|
||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
||||
|
||||
from obsws_cli.app import app
|
||||
|
||||
runner = CliRunner(mix_stderr=False)
|
||||
runner = CliRunner()
|
||||
|
||||
|
||||
def test_studio_enable():
|
||||
|
||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
||||
|
||||
from obsws_cli.app import app
|
||||
|
||||
runner = CliRunner(mix_stderr=False)
|
||||
runner = CliRunner()
|
||||
|
||||
|
||||
def test_text_update():
|
||||
|
||||
@@ -4,7 +4,7 @@ from typer.testing import CliRunner
|
||||
|
||||
from obsws_cli.app import app
|
||||
|
||||
runner = CliRunner(mix_stderr=False)
|
||||
runner = CliRunner()
|
||||
|
||||
|
||||
def test_version():
|
||||
|
||||
Reference in New Issue
Block a user