onyx_online/obsws-cli
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/obsws-cli.git synced 2025-08-07 04:11:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Compare commits

base: onyx_online:55e60ff97748babb1c0a702a830e32e20d558f23
Branches Tags
onyx_online:main
onyx_online:switch-to-cyclopts
onyx_online:add-record-split-chapter
onyx_online:add-styles
onyx_online:add-filter-subtyper
onyx_online:v0.20.2
onyx_online:v0.20.1
onyx_online:v0.20.0
..
compare: onyx_online:7abbccae99e1065fbb500fa665d28ef51a9ddffb
Branches Tags
onyx_online:main
onyx_online:switch-to-cyclopts
onyx_online:add-record-split-chapter
onyx_online:add-styles
onyx_online:add-filter-subtyper
onyx_online:v0.20.2
onyx_online:v0.20.1
onyx_online:v0.20.0

No commits in common. "55e60ff97748babb1c0a702a830e32e20d558f23" and "7abbccae99e1065fbb500fa665d28ef51a9ddffb" have entirely different histories.
55e60ff977 ... 7abbccae99

24 changed files with 215 additions and 532 deletions
Show Stats Expand all files Collapse all files

9
CHANGELOG.md
View File

@ -5,15 +5,6 @@ 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.18.0] - 2025-06-21
### Added
- Various colouring styles, see [Style](https://github.com/onyx-and-iris/obsws-cli/tree/main?tab=readme-ov-file#style)
- colouring is applied to list tables as well as highlighted information in stdout/stderr output.
- table border styling may be optionally disabled with the --no-border flag.
# [0.17.3] - 2025-06-20 # [0.17.3] - 2025-06-20
### Added ### Added

26
README.md
View File

@ -613,32 +613,12 @@ 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"
``` ```
## Style ## Disable Colouring
By default styling is disabled but you may enable it with: If you prefer colourless output you can set the environment variable `NO_COLOR`, see [NO_COLOR][no-colour].
- --style/-s: Style used in output.
- OBS_STYLE
- --no-border/-b: Disable table border styling in output.
- OBS_STYLE_NO_BORDER
Available styles:
- red
- magenta
- purple
- blue
- cyan
- green
- yellow
- orange
- white
- grey
- navy
- black
```console ```console
obsws-cli --style=cyan --no-border scene list NO_COLOR="1" obsws-cli scene list
``` ```
## License ## License

2
obsws_cli/__about__.py
View File

@ -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.18.2" __version__ = "0.17.6"

35
obsws_cli/app.py
View File

@ -7,9 +7,9 @@ from typing import Annotated
import obsws_python as obsws import obsws_python as obsws
import typer import typer
from obsws_cli.__about__ import __version__ as version from obsws_cli.__about__ import __version__ as obsws_cli_version
from . import console, settings, styles from . import console, settings
from .alias import RootTyperAliasGroup from .alias import RootTyperAliasGroup
app = typer.Typer(cls=RootTyperAliasGroup) app = typer.Typer(cls=RootTyperAliasGroup)
@ -37,7 +37,7 @@ for sub_typer in (
def version_callback(value: bool): def version_callback(value: bool):
"""Show the version of the CLI.""" """Show the version of the CLI."""
if value: if value:
console.out.print(f'obsws-cli version: {version}') console.out.print(f'obsws-cli version: {obsws_cli_version}')
raise typer.Exit() raise typer.Exit()
@ -104,26 +104,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',
),
] = 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(
@ -139,16 +119,13 @@ def main(
] = settings.get('debug'), ] = settings.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.obj = ctx.with_resource(obsws.ReqClient(**ctx.params))
ctx.obj['obsws'] = ctx.with_resource(obsws.ReqClient(**ctx.params))
ctx.obj['style'] = styles.request_style_obj(style, no_border)
@app.command() @app.command()
def obs_version(ctx: typer.Context): def obs_version(ctx: typer.Context):
"""Get the OBS Client and WebSocket versions.""" """Get the OBS Client and WebSocket versions."""
resp = ctx.obj['obsws'].get_version() resp = ctx.obj.get_version()
console.out.print( console.out.print(
f'OBS Client version: {console.highlight(ctx, resp.obs_version)}' f'OBS Client version: {resp.obs_version} with WebSocket version: {resp.obs_web_socket_version}'
f' with WebSocket version: {console.highlight(ctx, resp.obs_web_socket_version)}'
) )

8
obsws_cli/console.py
View File

@ -1,14 +1,6 @@
"""module for console output handling in obsws_cli.""" """module for console output handling in obsws_cli."""
import typer
from rich.console import Console from rich.console import Console
out = Console() out = Console()
err = Console(stderr=True, style='bold red') err = Console(stderr=True, style='bold red')
def highlight(ctx: typer.Context, text: str) -> str:
"""Highlight text using the current context's style."""
if ctx.obj['style'].name == 'no_colour':
return text
return f'[{ctx.obj["style"].highlight}]{text}[/{ctx.obj["style"].highlight}]'

49
obsws_cli/filter.py
View File

@ -5,7 +5,6 @@ from typing import Annotated, Optional
import obsws_python as obsws import obsws_python as obsws
import typer import typer
from rich.table import Table from rich.table import Table
from rich.text import Text
from . import console, util from . import console, util
from .alias import SubTyperAliasGroup from .alias import SubTyperAliasGroup
@ -31,10 +30,10 @@ def list_(
): ):
"""List filters for a source.""" """List filters for a source."""
if not source_name: if not source_name:
source_name = ctx.obj['obsws'].get_current_program_scene().scene_name source_name = ctx.obj.get_current_program_scene().scene_name
try: try:
resp = ctx.obj['obsws'].get_source_filter_list(source_name) resp = ctx.obj.get_source_filter_list(source_name)
except obsws.error.OBSSDKRequestError as e: except obsws.error.OBSSDKRequestError as e:
if e.code == 600: if e.code == 600:
console.err.print( console.err.print(
@ -45,34 +44,28 @@ def list_(
raise raise
if not resp.filters: if not resp.filters:
console.out.print( console.out.print(f'No filters found for source [yellow]{source_name}[/yellow]')
f'No filters found for source {console.highlight(ctx, source_name)}'
)
raise typer.Exit() raise typer.Exit()
table = Table( table = Table(title=f'Filters for Source: {source_name}', padding=(0, 2))
title=f'Filters for Source: {source_name}',
padding=(0, 2),
border_style=ctx.obj['style'].border,
)
columns = [ columns = [
(Text('Filter Name', justify='center'), 'left', ctx.obj['style'].column), ('Filter Name', 'left', 'cyan'),
(Text('Kind', justify='center'), 'left', ctx.obj['style'].column), ('Kind', 'left', 'cyan'),
(Text('Enabled', justify='center'), 'center', None), ('Enabled', 'center', None),
(Text('Settings', justify='center'), 'center', ctx.obj['style'].column), ('Settings', 'center', 'cyan'),
] ]
for name, justify, style in columns: for name, justify, style in columns:
table.add_column(name, justify=justify, style=style) table.add_column(name, justify=justify, style=style)
for filter in resp.filters: for filter in resp.filters:
resp = ctx.obj['obsws'].get_source_filter_default_settings(filter['filterKind']) resp = ctx.obj.get_source_filter_default_settings(filter['filterKind'])
settings = resp.default_filter_settings | filter['filterSettings'] settings = resp.default_filter_settings | filter['filterSettings']
table.add_row( table.add_row(
filter['filterName'], filter['filterName'],
util.snakecase_to_titlecase(filter['filterKind']), util.snakecase_to_titlecase(filter['filterKind']),
util.check_mark(ctx, filter['filterEnabled']), util.check_mark(filter['filterEnabled']),
'\n'.join( '\n'.join(
[ [
f'{util.snakecase_to_titlecase(k):<20} {v:>10}' f'{util.snakecase_to_titlecase(k):<20} {v:>10}'
@ -86,7 +79,7 @@ def list_(
def _get_filter_enabled(ctx: typer.Context, source_name: str, filter_name: str): def _get_filter_enabled(ctx: typer.Context, source_name: str, filter_name: str):
"""Get the status of a filter for a source.""" """Get the status of a filter for a source."""
resp = ctx.obj['obsws'].get_source_filter(source_name, filter_name) resp = ctx.obj.get_source_filter(source_name, filter_name)
return resp.filter_enabled return resp.filter_enabled
@ -113,9 +106,9 @@ def enable(
) )
raise typer.Exit(1) raise typer.Exit(1)
ctx.obj['obsws'].set_source_filter_enabled(source_name, filter_name, enabled=True) ctx.obj.set_source_filter_enabled(source_name, filter_name, enabled=True)
console.out.print( console.out.print(
f'Enabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}' f'Enabled filter [green]{filter_name}[/green] for source [green]{source_name}[/green]'
) )
@ -142,9 +135,9 @@ def disable(
) )
raise typer.Exit(1) raise typer.Exit(1)
ctx.obj['obsws'].set_source_filter_enabled(source_name, filter_name, enabled=False) ctx.obj.set_source_filter_enabled(source_name, filter_name, enabled=False)
console.out.print( console.out.print(
f'Disabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}' f'Disabled filter [green]{filter_name}[/green] for source [green]{source_name}[/green]'
) )
@ -168,16 +161,14 @@ def toggle(
is_enabled = _get_filter_enabled(ctx, source_name, filter_name) is_enabled = _get_filter_enabled(ctx, source_name, filter_name)
new_state = not is_enabled new_state = not is_enabled
ctx.obj['obsws'].set_source_filter_enabled( ctx.obj.set_source_filter_enabled(source_name, filter_name, enabled=new_state)
source_name, filter_name, enabled=new_state
)
if new_state: if new_state:
console.out.print( console.out.print(
f'Enabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}' f'Enabled filter [green]{filter_name}[/green] for source [green]{source_name}[/green]'
) )
else: else:
console.out.print( console.out.print(
f'Disabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}' f'Disabled filter [green]{filter_name}[/green] for source [green]{source_name}[/green]'
) )
@ -201,9 +192,9 @@ def status(
is_enabled = _get_filter_enabled(ctx, source_name, filter_name) is_enabled = _get_filter_enabled(ctx, source_name, filter_name)
if is_enabled: if is_enabled:
console.out.print( console.out.print(
f'Filter {console.highlight(ctx, filter_name)} is enabled for source {console.highlight(ctx, source_name)}' f'Filter [green]{filter_name}[/green] is enabled for source [green]{source_name}[/green]'
) )
else: else:
console.out.print( console.out.print(
f'Filter {console.highlight(ctx, filter_name)} is disabled for source {console.highlight(ctx, source_name)}' f'Filter [green]{filter_name}[/green] is disabled for source [green]{source_name}[/green]'
) )

51
obsws_cli/group.py
View File

@ -4,7 +4,6 @@ from typing import Annotated, Optional
import typer import typer
from rich.table import Table from rich.table import Table
from rich.text import Text
from . import console, util, validate from . import console, util, validate
from .alias import SubTyperAliasGroup from .alias import SubTyperAliasGroup
@ -31,13 +30,13 @@ def list_(
): ):
"""List groups in a scene.""" """List groups in a scene."""
if not scene_name: if not scene_name:
scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name scene_name = ctx.obj.get_current_program_scene().scene_name
if not validate.scene_in_scenes(ctx, scene_name): if not validate.scene_in_scenes(ctx, scene_name):
console.err.print(f"Scene '{scene_name}' not found.") console.err.print(f"Scene '{scene_name}' not found.")
raise typer.Exit(1) raise typer.Exit(1)
resp = ctx.obj['obsws'].get_scene_item_list(scene_name) resp = ctx.obj.get_scene_item_list(scene_name)
groups = [ groups = [
(item.get('sceneItemId'), item.get('sourceName'), item.get('sceneItemEnabled')) (item.get('sceneItemId'), item.get('sourceName'), item.get('sceneItemEnabled'))
for item in resp.scene_items for item in resp.scene_items
@ -45,21 +44,15 @@ def list_(
] ]
if not groups: if not groups:
console.out.print( console.out.print(f"No groups found in scene '{scene_name}'.")
f'No groups found in scene {console.highlight(ctx, scene_name)}.'
)
raise typer.Exit() raise typer.Exit()
table = Table( table = Table(title=f'Groups in Scene: {scene_name}', padding=(0, 2))
title=f'Groups in Scene: {scene_name}',
padding=(0, 2),
border_style=ctx.obj['style'].border,
)
columns = [ columns = [
(Text('ID', justify='center'), 'center', ctx.obj['style'].column), ('ID', 'center', 'cyan'),
(Text('Group Name', justify='center'), 'left', ctx.obj['style'].column), ('Group Name', 'left', 'cyan'),
(Text('Enabled', justify='center'), 'center', None), ('Enabled', 'center', None),
] ]
for column, justify, style in columns: for column, justify, style in columns:
table.add_column(column, justify=justify, style=style) table.add_column(column, justify=justify, style=style)
@ -68,7 +61,7 @@ def list_(
table.add_row( table.add_row(
str(item_id), str(item_id),
group_name, group_name,
util.check_mark(ctx, is_enabled), util.check_mark(is_enabled),
) )
console.out.print(table) console.out.print(table)
@ -103,20 +96,20 @@ def show(
console.err.print(f"Scene '{scene_name}' not found.") console.err.print(f"Scene '{scene_name}' not found.")
raise typer.Exit(1) raise typer.Exit(1)
resp = ctx.obj['obsws'].get_scene_item_list(scene_name) resp = ctx.obj.get_scene_item_list(scene_name)
if (group := _get_group(group_name, resp)) is None: if (group := _get_group(group_name, resp)) is None:
console.err.print( console.err.print(
f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].' f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].'
) )
raise typer.Exit(1) raise typer.Exit(1)
ctx.obj['obsws'].set_scene_item_enabled( ctx.obj.set_scene_item_enabled(
scene_name=scene_name, scene_name=scene_name,
item_id=int(group.get('sceneItemId')), item_id=int(group.get('sceneItemId')),
enabled=True, enabled=True,
) )
console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.') console.out.print(f'Group [green]{group_name}[/green] is now visible.')
@app.command('hide | h') @app.command('hide | h')
@ -134,20 +127,20 @@ def hide(
console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.') console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
raise typer.Exit(1) raise typer.Exit(1)
resp = ctx.obj['obsws'].get_scene_item_list(scene_name) resp = ctx.obj.get_scene_item_list(scene_name)
if (group := _get_group(group_name, resp)) is None: if (group := _get_group(group_name, resp)) is None:
console.err.print( console.err.print(
f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].' f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].'
) )
raise typer.Exit(1) raise typer.Exit(1)
ctx.obj['obsws'].set_scene_item_enabled( ctx.obj.set_scene_item_enabled(
scene_name=scene_name, scene_name=scene_name,
item_id=int(group.get('sceneItemId')), item_id=int(group.get('sceneItemId')),
enabled=False, enabled=False,
) )
console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.') console.out.print(f'Group [green]{group_name}[/green] is now hidden.')
@app.command('toggle | tg') @app.command('toggle | tg')
@ -165,7 +158,7 @@ def toggle(
console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.') console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
raise typer.Exit(1) raise typer.Exit(1)
resp = ctx.obj['obsws'].get_scene_item_list(scene_name) resp = ctx.obj.get_scene_item_list(scene_name)
if (group := _get_group(group_name, resp)) is None: if (group := _get_group(group_name, resp)) is None:
console.err.print( console.err.print(
f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].' f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].'
@ -173,16 +166,16 @@ def toggle(
raise typer.Exit(1) raise typer.Exit(1)
new_state = not group.get('sceneItemEnabled') new_state = not group.get('sceneItemEnabled')
ctx.obj['obsws'].set_scene_item_enabled( ctx.obj.set_scene_item_enabled(
scene_name=scene_name, scene_name=scene_name,
item_id=int(group.get('sceneItemId')), item_id=int(group.get('sceneItemId')),
enabled=new_state, enabled=new_state,
) )
if new_state: if new_state:
console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.') console.out.print(f'Group [green]{group_name}[/green] is now visible.')
else: else:
console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.') console.out.print(f'Group [green]{group_name}[/green] is now hidden.')
@app.command('status | ss') @app.command('status | ss')
@ -200,19 +193,19 @@ def status(
console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.') console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
raise typer.Exit(1) raise typer.Exit(1)
resp = ctx.obj['obsws'].get_scene_item_list(scene_name) resp = ctx.obj.get_scene_item_list(scene_name)
if (group := _get_group(group_name, resp)) is None: if (group := _get_group(group_name, resp)) is None:
console.err.print( console.err.print(
f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].' f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].'
) )
raise typer.Exit(1) raise typer.Exit(1)
enabled = ctx.obj['obsws'].get_scene_item_enabled( enabled = ctx.obj.get_scene_item_enabled(
scene_name=scene_name, scene_name=scene_name,
item_id=int(group.get('sceneItemId')), item_id=int(group.get('sceneItemId')),
) )
if enabled.scene_item_enabled: if enabled.scene_item_enabled:
console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.') console.out.print(f'Group [green]{group_name}[/green] is now visible.')
else: else:
console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.') console.out.print(f'Group [green]{group_name}[/green] is now hidden.')

23
obsws_cli/hotkey.py
View File

@ -4,7 +4,6 @@ from typing import Annotated
import typer import typer
from rich.table import Table from rich.table import Table
from rich.text import Text
from . import console from . import console
from .alias import SubTyperAliasGroup from .alias import SubTyperAliasGroup
@ -22,21 +21,13 @@ def list_(
ctx: typer.Context, ctx: typer.Context,
): ):
"""List all hotkeys.""" """List all hotkeys."""
resp = ctx.obj['obsws'].get_hotkey_list() resp = ctx.obj.get_hotkey_list()
table = Table( table = Table(title='Hotkeys', padding=(0, 2))
title='Hotkeys', table.add_column('Hotkey Name', justify='left', style='cyan')
padding=(0, 2),
border_style=ctx.obj['style'].border,
)
table.add_column(
Text('Hotkey Name', justify='center'),
justify='left',
style=ctx.obj['style'].column,
)
for i, hotkey in enumerate(resp.hotkeys): for hotkey in resp.hotkeys:
table.add_row(hotkey, style='' if i % 2 == 0 else 'dim') table.add_row(hotkey)
console.out.print(table) console.out.print(table)
@ -49,7 +40,7 @@ def trigger(
], ],
): ):
"""Trigger a hotkey by name.""" """Trigger a hotkey by name."""
ctx.obj['obsws'].trigger_hotkey_by_name(hotkey) ctx.obj.trigger_hotkey_by_name(hotkey)
@app.command('trigger-sequence | trs') @app.command('trigger-sequence | trs')
@ -77,4 +68,4 @@ def trigger_sequence(
] = False, ] = False,
): ):
"""Trigger a hotkey by sequence.""" """Trigger a hotkey by sequence."""
ctx.obj['obsws'].trigger_hotkey_by_key_sequence(key_id, shift, ctrl, alt, cmd) ctx.obj.trigger_hotkey_by_key_sequence(key_id, shift, ctrl, alt, cmd)

42
obsws_cli/input.py
View File

@ -5,7 +5,6 @@ from typing import Annotated
import obsws_python as obsws import obsws_python as obsws
import typer import typer
from rich.table import Table from rich.table import Table
from rich.text import Text
from . import console, util, validate from . import console, util, validate
from .alias import SubTyperAliasGroup from .alias import SubTyperAliasGroup
@ -29,7 +28,7 @@ def list_(
uuid: Annotated[bool, typer.Option(help='Show UUIDs of inputs.')] = False, uuid: Annotated[bool, typer.Option(help='Show UUIDs of inputs.')] = False,
): ):
"""List all inputs.""" """List all inputs."""
resp = ctx.obj['obsws'].get_input_list() resp = ctx.obj.get_input_list()
kinds = [] kinds = []
if input: if input:
@ -43,7 +42,7 @@ def list_(
if vlc: if vlc:
kinds.append('vlc') kinds.append('vlc')
if not any([input, output, colour, ffmpeg, vlc]): if not any([input, output, colour, ffmpeg, vlc]):
kinds = ctx.obj['obsws'].get_input_kind_list(False).input_kinds kinds = ctx.obj.get_input_kind_list(False).input_kinds
inputs = sorted( inputs = sorted(
( (
@ -60,19 +59,20 @@ def list_(
console.out.print('No inputs found.') console.out.print('No inputs found.')
raise typer.Exit() raise typer.Exit()
table = Table(title='Inputs', padding=(0, 2), border_style=ctx.obj['style'].border) table = Table(title='Inputs', padding=(0, 2))
if uuid: if uuid:
columns = [ columns = [
(Text('Input Name', justify='center'), 'left', ctx.obj['style'].column), ('Input Name', 'left', 'cyan'),
(Text('Kind', justify='center'), 'center', ctx.obj['style'].column), ('Kind', 'center', 'cyan'),
(Text('Muted', justify='center'), 'center', None), ('Muted', 'center', None),
(Text('UUID', justify='center'), 'left', ctx.obj['style'].column), ('UUID', 'left', 'cyan'),
] ]
else: else:
table.title += ' (UUIDs hidden)'
columns = [ columns = [
(Text('Input Name', justify='center'), 'left', ctx.obj['style'].column), ('Input Name', 'left', 'cyan'),
(Text('Kind', justify='center'), 'center', ctx.obj['style'].column), ('Kind', 'center', 'cyan'),
(Text('Muted', justify='center'), 'center', None), ('Muted', 'center', None),
] ]
for column, justify, style in columns: for column, justify, style in columns:
table.add_column(column, justify=justify, style=style) table.add_column(column, justify=justify, style=style)
@ -80,8 +80,8 @@ def list_(
for input_name, input_kind, input_uuid in inputs: for input_name, input_kind, input_uuid in inputs:
input_mark = '' input_mark = ''
try: try:
input_muted = ctx.obj['obsws'].get_input_mute(name=input_name).input_muted input_muted = ctx.obj.get_input_mute(name=input_name).input_muted
input_mark = util.check_mark(ctx, input_muted) input_mark = util.check_mark(input_muted)
except obsws.error.OBSSDKRequestError as e: except obsws.error.OBSSDKRequestError as e:
if e.code == 604: # Input does not support audio if e.code == 604: # Input does not support audio
input_mark = 'N/A' input_mark = 'N/A'
@ -117,12 +117,12 @@ def mute(
console.err.print(f'Input [yellow]{input_name}[/yellow] not found.') console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
raise typer.Exit(1) raise typer.Exit(1)
ctx.obj['obsws'].set_input_mute( ctx.obj.set_input_mute(
name=input_name, name=input_name,
muted=True, muted=True,
) )
console.out.print(f'Input {console.highlight(ctx, input_name)} muted.') console.out.print(f'Input [green]{input_name}[/green] muted.')
@app.command('unmute | um') @app.command('unmute | um')
@ -138,12 +138,12 @@ def unmute(
console.err.print(f'Input [yellow]{input_name}[/yellow] not found.') console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
raise typer.Exit(1) raise typer.Exit(1)
ctx.obj['obsws'].set_input_mute( ctx.obj.set_input_mute(
name=input_name, name=input_name,
muted=False, muted=False,
) )
console.out.print(f'Input {console.highlight(ctx, input_name)} unmuted.') console.out.print(f'Input [green]{input_name}[/green] unmuted.')
@app.command('toggle | tg') @app.command('toggle | tg')
@ -159,19 +159,19 @@ def toggle(
console.err.print(f'Input [yellow]{input_name}[/yellow] not found.') console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
raise typer.Exit(1) raise typer.Exit(1)
resp = ctx.obj['obsws'].get_input_mute(name=input_name) resp = ctx.obj.get_input_mute(name=input_name)
new_state = not resp.input_muted new_state = not resp.input_muted
ctx.obj['obsws'].set_input_mute( ctx.obj.set_input_mute(
name=input_name, name=input_name,
muted=new_state, muted=new_state,
) )
if new_state: if new_state:
console.out.print( console.out.print(
f'Input {console.highlight(ctx, input_name)} muted.', f'Input [green]{input_name}[/green] muted.',
) )
else: else:
console.out.print( console.out.print(
f'Input {console.highlight(ctx, input_name)} unmuted.', f'Input [green]{input_name}[/green] unmuted.',
) )

35
obsws_cli/profile.py
View File

@ -4,7 +4,6 @@ from typing import Annotated
import typer import typer
from rich.table import Table from rich.table import Table
from rich.text import Text
from . import console, util, validate from . import console, util, validate
from .alias import SubTyperAliasGroup from .alias import SubTyperAliasGroup
@ -20,14 +19,12 @@ def main():
@app.command('list | ls') @app.command('list | ls')
def list_(ctx: typer.Context): def list_(ctx: typer.Context):
"""List profiles.""" """List profiles."""
resp = ctx.obj['obsws'].get_profile_list() resp = ctx.obj.get_profile_list()
table = Table( table = Table(title='Profiles', padding=(0, 2))
title='Profiles', padding=(0, 2), border_style=ctx.obj['style'].border
)
columns = [ columns = [
(Text('Profile Name', justify='center'), 'left', ctx.obj['style'].column), ('Profile Name', 'left', 'cyan'),
(Text('Current', justify='center'), 'center', None), ('Current', 'center', None),
] ]
for column, justify, style in columns: for column, justify, style in columns:
table.add_column(column, justify=justify, style=style) table.add_column(column, justify=justify, style=style)
@ -35,9 +32,7 @@ def list_(ctx: typer.Context):
for profile in resp.profiles: for profile in resp.profiles:
table.add_row( table.add_row(
profile, profile,
util.check_mark( util.check_mark(profile == resp.current_profile_name, empty_if_false=True),
ctx, profile == resp.current_profile_name, empty_if_false=True
),
) )
console.out.print(table) console.out.print(table)
@ -46,10 +41,8 @@ def list_(ctx: typer.Context):
@app.command('current | get') @app.command('current | get')
def current(ctx: typer.Context): def current(ctx: typer.Context):
"""Get the current profile.""" """Get the current profile."""
resp = ctx.obj['obsws'].get_profile_list() resp = ctx.obj.get_profile_list()
console.out.print( console.out.print(resp.current_profile_name)
f'Current profile: {console.highlight(ctx, resp.current_profile_name)}'
)
@app.command('switch | set') @app.command('switch | set')
@ -67,15 +60,15 @@ def switch(
console.err.print(f'Profile [yellow]{profile_name}[/yellow] not found.') console.err.print(f'Profile [yellow]{profile_name}[/yellow] not found.')
raise typer.Exit(1) raise typer.Exit(1)
resp = ctx.obj['obsws'].get_profile_list() resp = ctx.obj.get_profile_list()
if resp.current_profile_name == profile_name: if resp.current_profile_name == profile_name:
console.err.print( console.err.print(
f'Profile [yellow]{profile_name}[/yellow] is already the current profile.' f'Profile [yellow]{profile_name}[/yellow] is already the current profile.'
) )
raise typer.Exit(1) raise typer.Exit(1)
ctx.obj['obsws'].set_current_profile(profile_name) ctx.obj.set_current_profile(profile_name)
console.out.print(f'Switched to profile {console.highlight(ctx, profile_name)}.') console.out.print(f'Switched to profile [green]{profile_name}[/green].')
@app.command('create | new') @app.command('create | new')
@ -91,8 +84,8 @@ def create(
console.err.print(f'Profile [yellow]{profile_name}[/yellow] already exists.') console.err.print(f'Profile [yellow]{profile_name}[/yellow] already exists.')
raise typer.Exit(1) raise typer.Exit(1)
ctx.obj['obsws'].create_profile(profile_name) ctx.obj.create_profile(profile_name)
console.out.print(f'Created profile {console.highlight(ctx, profile_name)}.') console.out.print(f'Created profile [green]{profile_name}[/green].')
@app.command('remove | rm') @app.command('remove | rm')
@ -108,5 +101,5 @@ def remove(
console.err.print(f'Profile [yellow]{profile_name}[/yellow] not found.') console.err.print(f'Profile [yellow]{profile_name}[/yellow] not found.')
raise typer.Exit(1) raise typer.Exit(1)
ctx.obj['obsws'].remove_profile(profile_name) ctx.obj.remove_profile(profile_name)
console.out.print(f'Removed profile {console.highlight(ctx, profile_name)}.') console.out.print(f'Removed profile [green]{profile_name}[/green].')

25
obsws_cli/projector.py
View File

@ -4,7 +4,6 @@ from typing import Annotated
import typer import typer
from rich.table import Table from rich.table import Table
from rich.text import Text
from . import console from . import console
from .alias import SubTyperAliasGroup from .alias import SubTyperAliasGroup
@ -20,7 +19,7 @@ def main():
@app.command('list-monitors | ls-m') @app.command('list-monitors | ls-m')
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.get_monitor_list()
if not resp.monitors: if not resp.monitors:
console.out.print('No monitors found.') console.out.print('No monitors found.')
@ -31,17 +30,9 @@ def list_monitors(ctx: typer.Context):
key=lambda m: m[0], key=lambda m: m[0],
) )
table = Table( table = Table(title='Available Monitors', padding=(0, 2))
title='Available Monitors', table.add_column('Index', justify='center', style='cyan')
padding=(0, 2), table.add_column('Name', style='cyan')
border_style=ctx.obj['style'].border,
)
table.add_column(
Text('Index', justify='center'), justify='center', style=ctx.obj['style'].column
)
table.add_column(
Text('Name', justify='center'), justify='left', style=ctx.obj['style'].column
)
for index, monitor in monitors: for index, monitor in monitors:
table.add_row(str(index), monitor) table.add_row(str(index), monitor)
@ -66,18 +57,18 @@ def open(
): ):
"""Open a fullscreen projector for a source on a specific monitor.""" """Open a fullscreen projector for a source on a specific monitor."""
if not source_name: if not source_name:
source_name = ctx.obj['obsws'].get_current_program_scene().scene_name source_name = ctx.obj.get_current_program_scene().scene_name
monitors = ctx.obj['obsws'].get_monitor_list().monitors monitors = ctx.obj.get_monitor_list().monitors
for monitor in monitors: for monitor in monitors:
if monitor['monitorIndex'] == monitor_index: if monitor['monitorIndex'] == monitor_index:
ctx.obj['obsws'].open_source_projector( ctx.obj.open_source_projector(
source_name=source_name, source_name=source_name,
monitor_index=monitor_index, monitor_index=monitor_index,
) )
console.out.print( console.out.print(
f'Opened projector for source {console.highlight(ctx, source_name)} on monitor {console.highlight(ctx, monitor["monitorName"])}.' f'Opened projector for source [green]{source_name}[/] on monitor [green]{monitor["monitorName"]}[/].'
) )
break break

23
obsws_cli/record.py
View File

@ -18,7 +18,7 @@ def main():
def _get_recording_status(ctx: typer.Context) -> tuple: def _get_recording_status(ctx: typer.Context) -> tuple:
"""Get recording status.""" """Get recording status."""
resp = ctx.obj['obsws'].get_record_status() resp = ctx.obj.get_record_status()
return resp.output_active, resp.output_paused return resp.output_active, resp.output_paused
@ -34,7 +34,7 @@ def start(ctx: typer.Context):
console.err.print(err_msg) console.err.print(err_msg)
raise typer.Exit(1) raise typer.Exit(1)
ctx.obj['obsws'].start_record() ctx.obj.start_record()
console.out.print('Recording started successfully.') console.out.print('Recording started successfully.')
@ -46,16 +46,16 @@ def stop(ctx: typer.Context):
console.err.print('Recording is not in progress, cannot stop.') console.err.print('Recording is not in progress, cannot stop.')
raise typer.Exit(1) raise typer.Exit(1)
resp = ctx.obj['obsws'].stop_record() resp = ctx.obj.stop_record()
console.out.print( console.out.print(
f'Recording stopped successfully. Saved to: {console.highlight(ctx, resp.output_path)}' f'Recording stopped successfully. Saved to: [green]{resp.output_path}[/green]'
) )
@app.command('toggle | tg') @app.command('toggle | tg')
def toggle(ctx: typer.Context): def toggle(ctx: typer.Context):
"""Toggle recording.""" """Toggle recording."""
resp = ctx.obj['obsws'].toggle_record() resp = ctx.obj.toggle_record()
if resp.output_active: if resp.output_active:
console.out.print('Recording started successfully.') console.out.print('Recording started successfully.')
else: else:
@ -86,7 +86,7 @@ def resume(ctx: typer.Context):
console.err.print('Recording is in progress but not paused, cannot resume.') console.err.print('Recording is in progress but not paused, cannot resume.')
raise typer.Exit(1) raise typer.Exit(1)
ctx.obj['obsws'].resume_record() ctx.obj.resume_record()
console.out.print('Recording resumed successfully.') console.out.print('Recording resumed successfully.')
@ -101,7 +101,7 @@ def pause(ctx: typer.Context):
console.err.print('Recording is in progress but already paused, cannot pause.') console.err.print('Recording is in progress but already paused, cannot pause.')
raise typer.Exit(1) raise typer.Exit(1)
ctx.obj['obsws'].pause_record() ctx.obj.pause_record()
console.out.print('Recording paused successfully.') console.out.print('Recording paused successfully.')
@ -121,12 +121,9 @@ def directory(
): ):
"""Get or set the recording directory.""" """Get or set the recording directory."""
if record_directory is not None: if record_directory is not None:
ctx.obj['obsws'].set_record_directory(str(record_directory)) ctx.obj.set_record_directory(str(record_directory))
console.out.print( console.out.print(f'Recording directory updated to: {record_directory}')
f'Recording directory updated to: {console.highlight(ctx, record_directory)}'
)
else: else:
resp = ctx.obj['obsws'].get_record_directory()
console.out.print( console.out.print(
f'Recording directory: {console.highlight(ctx, resp.record_directory)}' f'Recording directory: [green]{ctx.obj.get_record_directory().record_directory}[/green]'
) )

14
obsws_cli/replaybuffer.py
View File

@ -16,31 +16,31 @@ def main():
@app.command('start | s') @app.command('start | s')
def start(ctx: typer.Context): def start(ctx: typer.Context):
"""Start the replay buffer.""" """Start the replay buffer."""
resp = ctx.obj['obsws'].get_replay_buffer_status() resp = ctx.obj.get_replay_buffer_status()
if resp.output_active: if resp.output_active:
console.err.print('Replay buffer is already active.') console.err.print('Replay buffer is already active.')
raise typer.Exit(1) raise typer.Exit(1)
ctx.obj['obsws'].start_replay_buffer() ctx.obj.start_replay_buffer()
console.out.print('Replay buffer started.') console.out.print('Replay buffer started.')
@app.command('stop | st') @app.command('stop | st')
def stop(ctx: typer.Context): def stop(ctx: typer.Context):
"""Stop the replay buffer.""" """Stop the replay buffer."""
resp = ctx.obj['obsws'].get_replay_buffer_status() resp = ctx.obj.get_replay_buffer_status()
if not resp.output_active: if not resp.output_active:
console.err.print('Replay buffer is not active.') console.err.print('Replay buffer is not active.')
raise typer.Exit(1) raise typer.Exit(1)
ctx.obj['obsws'].stop_replay_buffer() ctx.obj.stop_replay_buffer()
console.out.print('Replay buffer stopped.') console.out.print('Replay buffer stopped.')
@app.command('toggle | tg') @app.command('toggle | tg')
def toggle(ctx: typer.Context): def toggle(ctx: typer.Context):
"""Toggle the replay buffer.""" """Toggle the replay buffer."""
resp = ctx.obj['obsws'].toggle_replay_buffer() resp = ctx.obj.toggle_replay_buffer()
if resp.output_active: if resp.output_active:
console.out.print('Replay buffer is active.') console.out.print('Replay buffer is active.')
else: else:
@ -50,7 +50,7 @@ def toggle(ctx: typer.Context):
@app.command('status | ss') @app.command('status | ss')
def status(ctx: typer.Context): def status(ctx: typer.Context):
"""Get the status of the replay buffer.""" """Get the status of the replay buffer."""
resp = ctx.obj['obsws'].get_replay_buffer_status() resp = ctx.obj.get_replay_buffer_status()
if resp.output_active: if resp.output_active:
console.out.print('Replay buffer is active.') console.out.print('Replay buffer is active.')
else: else:
@ -60,5 +60,5 @@ def status(ctx: typer.Context):
@app.command('save | sv') @app.command('save | sv')
def save(ctx: typer.Context): def save(ctx: typer.Context):
"""Save the replay buffer.""" """Save the replay buffer."""
ctx.obj['obsws'].save_replay_buffer() ctx.obj.save_replay_buffer()
console.out.print('Replay buffer saved.') console.out.print('Replay buffer saved.')

47
obsws_cli/scene.py
View File

@ -4,7 +4,6 @@ from typing import Annotated
import typer import typer
from rich.table import Table from rich.table import Table
from rich.text import Text
from . import console, util, validate from . import console, util, validate
from .alias import SubTyperAliasGroup from .alias import SubTyperAliasGroup
@ -23,40 +22,46 @@ def list_(
uuid: Annotated[bool, typer.Option(help='Show UUIDs of scenes')] = False, uuid: Annotated[bool, typer.Option(help='Show UUIDs of scenes')] = False,
): ):
"""List all scenes.""" """List all scenes."""
resp = ctx.obj['obsws'].get_scene_list() resp = ctx.obj.get_scene_list()
scenes = ( scenes = (
(scene.get('sceneName'), scene.get('sceneUuid')) (scene.get('sceneName'), scene.get('sceneUuid'))
for scene in reversed(resp.scenes) for scene in reversed(resp.scenes)
) )
active_scene = ctx.obj['obsws'].get_current_program_scene().scene_name active_scene = ctx.obj.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))
if uuid: if uuid:
columns = [ columns = [
(Text('Scene Name', justify='center'), 'left', ctx.obj['style'].column), ('Scene Name', 'left', 'cyan'),
(Text('Active', justify='center'), 'center', None), ('Active', 'center', None),
(Text('UUID', justify='center'), 'left', ctx.obj['style'].column), ('UUID', 'left', 'cyan'),
] ]
else: else:
table.title += ' (UUIDs hidden)'
columns = [ columns = [
(Text('Scene Name', justify='center'), 'left', ctx.obj['style'].column), ('Scene Name', 'left', 'cyan'),
(Text('Active', justify='center'), 'center', None), ('Active', 'center', None),
] ]
for column, justify, style in columns: for column, justify, style in columns:
table.add_column(column, justify=justify, style=style) table.add_column(column, justify=justify, style=style)
for scene_name, scene_uuid in scenes: for scene_name, scene_uuid in scenes:
if scene_name == active_scene:
scene_output = f'[bold]{scene_name}[/bold]'
else:
scene_output = f'[dim]{scene_name}[/dim]'
if uuid: if uuid:
table.add_row( table.add_row(
scene_name, scene_output,
util.check_mark(ctx, scene_name == active_scene, empty_if_false=True), util.check_mark(scene_name == active_scene, empty_if_false=True),
scene_uuid, scene_uuid,
) )
else: else:
table.add_row( table.add_row(
scene_name, scene_output,
util.check_mark(ctx, scene_name == active_scene, empty_if_false=True), util.check_mark(scene_name == active_scene, empty_if_false=True),
) )
console.out.print(table) console.out.print(table)
@ -75,15 +80,11 @@ def current(
raise typer.Exit(1) raise typer.Exit(1)
if preview: if preview:
resp = ctx.obj['obsws'].get_current_preview_scene() resp = ctx.obj.get_current_preview_scene()
console.out.print( console.out.print(resp.current_preview_scene_name)
f'Current Preview Scene: {console.highlight(ctx, resp.current_preview_scene_name)}'
)
else: else:
resp = ctx.obj['obsws'].get_current_program_scene() resp = ctx.obj.get_current_program_scene()
console.out.print( console.out.print(resp.current_program_scene_name)
f'Current Program Scene: {console.highlight(ctx, resp.current_program_scene_name)}'
)
@app.command('switch | set') @app.command('switch | set')
@ -107,8 +108,8 @@ def switch(
raise typer.Exit(1) raise typer.Exit(1)
if preview: if preview:
ctx.obj['obsws'].set_current_preview_scene(scene_name) ctx.obj.set_current_preview_scene(scene_name)
console.out.print(f'Switched to preview scene: [green]{scene_name}[/green]') console.out.print(f'Switched to preview scene: [green]{scene_name}[/green]')
else: else:
ctx.obj['obsws'].set_current_program_scene(scene_name) ctx.obj.set_current_program_scene(scene_name)
console.out.print(f'Switched to program scene: [green]{scene_name}[/green]') console.out.print(f'Switched to program scene: [green]{scene_name}[/green]')

28
obsws_cli/scenecollection.py
View File

@ -19,16 +19,10 @@ def main():
@app.command('list | ls') @app.command('list | ls')
def list_(ctx: typer.Context): def list_(ctx: typer.Context):
"""List all scene collections.""" """List all scene collections."""
resp = ctx.obj['obsws'].get_scene_collection_list() resp = ctx.obj.get_scene_collection_list()
table = Table( table = Table(title='Scene Collections', padding=(0, 2))
title='Scene Collections', table.add_column('Scene Collection Name', justify='left', style='cyan')
padding=(0, 2),
border_style=ctx.obj['style'].border,
)
table.add_column(
'Scene Collection Name', justify='left', style=ctx.obj['style'].column
)
for scene_collection_name in resp.scene_collections: for scene_collection_name in resp.scene_collections:
table.add_row(scene_collection_name) table.add_row(scene_collection_name)
@ -39,10 +33,8 @@ def list_(ctx: typer.Context):
@app.command('current | get') @app.command('current | get')
def current(ctx: typer.Context): def current(ctx: typer.Context):
"""Get the current scene collection.""" """Get the current scene collection."""
resp = ctx.obj['obsws'].get_scene_collection_list() resp = ctx.obj.get_scene_collection_list()
console.out.print( console.out.print(resp.current_scene_collection_name)
f'Current scene collection: {console.highlight(ctx, resp.current_scene_collection_name)}'
)
@app.command('switch | set') @app.command('switch | set')
@ -60,7 +52,7 @@ def switch(
raise typer.Exit(1) raise typer.Exit(1)
current_scene_collection = ( current_scene_collection = (
ctx.obj['obsws'].get_scene_collection_list().current_scene_collection_name ctx.obj.get_scene_collection_list().current_scene_collection_name
) )
if scene_collection_name == current_scene_collection: if scene_collection_name == current_scene_collection:
console.err.print( console.err.print(
@ -68,9 +60,9 @@ def switch(
) )
raise typer.Exit(1) raise typer.Exit(1)
ctx.obj['obsws'].set_current_scene_collection(scene_collection_name) ctx.obj.set_current_scene_collection(scene_collection_name)
console.out.print( console.out.print(
f'Switched to scene collection {console.highlight(ctx, scene_collection_name)}.' f'Switched to scene collection [green]{scene_collection_name}[/green].'
) )
@ -88,7 +80,7 @@ def create(
) )
raise typer.Exit(1) raise typer.Exit(1)
ctx.obj['obsws'].create_scene_collection(scene_collection_name) ctx.obj.create_scene_collection(scene_collection_name)
console.out.print( console.out.print(
f'Created scene collection {console.highlight(ctx, scene_collection_name)}.' f'Created scene collection [green]{scene_collection_name}[/green].'
) )

85
obsws_cli/sceneitem.py
View File

@ -30,13 +30,13 @@ def list_(
): ):
"""List all items in a scene.""" """List all items in a scene."""
if not scene_name: if not scene_name:
scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name scene_name = ctx.obj.get_current_program_scene().scene_name
if not validate.scene_in_scenes(ctx, scene_name): if not validate.scene_in_scenes(ctx, scene_name):
console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.') console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
raise typer.Exit(1) raise typer.Exit(1)
resp = ctx.obj['obsws'].get_scene_item_list(scene_name) resp = ctx.obj.get_scene_item_list(scene_name)
items = sorted( items = sorted(
( (
( (
@ -52,29 +52,24 @@ def list_(
) )
if not items: if not items:
console.out.print( console.out.print(f'No items found in scene [green]{scene_name}[/green].')
f'No items found in scene {console.highlight(ctx, scene_name)}.'
)
raise typer.Exit() raise typer.Exit()
table = Table( table = Table(title=f'Items in Scene: {scene_name}', padding=(0, 2))
title=f'Items in Scene: {scene_name}',
padding=(0, 2),
border_style=ctx.obj['style'].border,
)
if uuid: if uuid:
columns = [ columns = [
('Item ID', 'center', ctx.obj['style'].column), ('Item ID', 'center', 'cyan'),
('Item Name', 'left', ctx.obj['style'].column), ('Item Name', 'left', 'cyan'),
('In Group', 'left', ctx.obj['style'].column), ('In Group', 'left', 'cyan'),
('Enabled', 'center', None), ('Enabled', 'center', None),
('UUID', 'left', ctx.obj['style'].column), ('UUID', 'left', 'cyan'),
] ]
else: else:
table.title += ' (UUIDs hidden)'
columns = [ columns = [
('Item ID', 'center', ctx.obj['style'].column), ('Item ID', 'center', 'cyan'),
('Item Name', 'left', ctx.obj['style'].column), ('Item Name', 'left', 'cyan'),
('In Group', 'left', ctx.obj['style'].column), ('In Group', 'left', 'cyan'),
('Enabled', 'center', None), ('Enabled', 'center', None),
] ]
# Add columns to the table # Add columns to the table
@ -83,7 +78,7 @@ def list_(
for item_id, item_name, is_group, is_enabled, source_uuid in items: for item_id, item_name, is_group, is_enabled, source_uuid in items:
if is_group: if is_group:
resp = ctx.obj['obsws'].get_group_scene_item_list(item_name) resp = ctx.obj.get_group_scene_item_list(item_name)
group_items = sorted( group_items = sorted(
( (
( (
@ -107,7 +102,7 @@ def list_(
str(group_item_id), str(group_item_id),
group_item_name, group_item_name,
item_name, item_name,
util.check_mark(ctx, is_enabled and group_item_enabled), util.check_mark(is_enabled and group_item_enabled),
group_item_source_uuid, group_item_source_uuid,
) )
else: else:
@ -115,7 +110,7 @@ def list_(
str(group_item_id), str(group_item_id),
group_item_name, group_item_name,
item_name, item_name,
util.check_mark(ctx, is_enabled and group_item_enabled), util.check_mark(is_enabled and group_item_enabled),
) )
else: else:
if uuid: if uuid:
@ -123,7 +118,7 @@ def list_(
str(item_id), str(item_id),
item_name, item_name,
'', '',
util.check_mark(ctx, is_enabled), util.check_mark(is_enabled),
source_uuid, source_uuid,
) )
else: else:
@ -131,7 +126,7 @@ def list_(
str(item_id), str(item_id),
item_name, item_name,
'', '',
util.check_mark(ctx, is_enabled), util.check_mark(is_enabled),
) )
console.out.print(table) console.out.print(table)
@ -171,7 +166,7 @@ def _get_scene_name_and_item_id(
): ):
"""Get the scene name and item ID for the given scene and item name.""" """Get the scene name and item ID for the given scene and item name."""
if group: if group:
resp = ctx.obj['obsws'].get_group_scene_item_list(group) resp = ctx.obj.get_group_scene_item_list(group)
for item in resp.scene_items: for item in resp.scene_items:
if item.get('sourceName') == item_name: if item.get('sourceName') == item_name:
scene_name = group scene_name = group
@ -183,7 +178,7 @@ def _get_scene_name_and_item_id(
) )
raise typer.Exit(1) raise typer.Exit(1)
else: else:
resp = ctx.obj['obsws'].get_scene_item_id(scene_name, item_name) resp = ctx.obj.get_scene_item_id(scene_name, item_name)
scene_item_id = resp.scene_item_id scene_item_id = resp.scene_item_id
return scene_name, scene_item_id return scene_name, scene_item_id
@ -210,7 +205,7 @@ def show(
ctx, scene_name, item_name, group ctx, scene_name, item_name, group
) )
ctx.obj['obsws'].set_scene_item_enabled( ctx.obj.set_scene_item_enabled(
scene_name=scene_name, scene_name=scene_name,
item_id=int(scene_item_id), item_id=int(scene_item_id),
enabled=True, enabled=True,
@ -218,8 +213,7 @@ def show(
if group: if group:
console.out.print( console.out.print(
f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} ' f'Item [green]{item_name}[/green] in group [green]{group}[/green] in scene [green]{old_scene_name}[/green] has been shown.'
f'in scene {console.highlight(ctx, old_scene_name)} has been shown.'
) )
else: else:
# If not in a parent group, just show the scene name # If not in a parent group, just show the scene name
@ -227,7 +221,7 @@ def show(
# which is not the same as the scene name # which is not the same as the scene name
# and is not needed in this case # and is not needed in this case
console.out.print( console.out.print(
f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been shown.' f'Item [green]{item_name}[/green] in scene [green]{scene_name}[/green] has been shown.'
) )
@ -252,7 +246,7 @@ def hide(
ctx, scene_name, item_name, group ctx, scene_name, item_name, group
) )
ctx.obj['obsws'].set_scene_item_enabled( ctx.obj.set_scene_item_enabled(
scene_name=scene_name, scene_name=scene_name,
item_id=int(scene_item_id), item_id=int(scene_item_id),
enabled=False, enabled=False,
@ -260,7 +254,7 @@ def hide(
if group: if group:
console.out.print( console.out.print(
f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} in scene {console.highlight(ctx, old_scene_name)} has been hidden.' f'Item [green]{item_name}[/green] in group [green]{group}[/green] in scene [green]{old_scene_name}[/green] has been hidden.'
) )
else: else:
# If not in a parent group, just show the scene name # If not in a parent group, just show the scene name
@ -268,7 +262,7 @@ def hide(
# which is not the same as the scene name # which is not the same as the scene name
# and is not needed in this case # and is not needed in this case
console.out.print( console.out.print(
f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been hidden.' f'Item [green]{item_name}[/green] in scene [green]{scene_name}[/green] has been hidden.'
) )
@ -295,13 +289,13 @@ def toggle(
ctx, scene_name, item_name, group ctx, scene_name, item_name, group
) )
enabled = ctx.obj['obsws'].get_scene_item_enabled( enabled = ctx.obj.get_scene_item_enabled(
scene_name=scene_name, scene_name=scene_name,
item_id=int(scene_item_id), item_id=int(scene_item_id),
) )
new_state = not enabled.scene_item_enabled new_state = not enabled.scene_item_enabled
ctx.obj['obsws'].set_scene_item_enabled( ctx.obj.set_scene_item_enabled(
scene_name=scene_name, scene_name=scene_name,
item_id=int(scene_item_id), item_id=int(scene_item_id),
enabled=new_state, enabled=new_state,
@ -310,13 +304,11 @@ def toggle(
if group: if group:
if new_state: if new_state:
console.out.print( console.out.print(
f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} ' f'Item [green]{item_name}[/green] in group [green]{group}[/green] in scene [green]{old_scene_name}[/green] has been shown.'
f'in scene {console.highlight(ctx, old_scene_name)} has been shown.'
) )
else: else:
console.out.print( console.out.print(
f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} ' f'Item [green]{item_name}[/green] in group [green]{group}[/green] in scene [green]{old_scene_name}[/green] has been hidden.'
f'in scene {console.highlight(ctx, old_scene_name)} has been hidden.'
) )
else: else:
# If not in a parent group, just show the scene name # If not in a parent group, just show the scene name
@ -325,11 +317,11 @@ def toggle(
# and is not needed in this case # and is not needed in this case
if new_state: if new_state:
console.out.print( console.out.print(
f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been shown.' f'Item [green]{item_name}[/green] in scene [green]{scene_name}[/green] has been shown.'
) )
else: else:
console.out.print( console.out.print(
f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been hidden.' f'Item [green]{item_name}[/green] in scene [green]{scene_name}[/green] has been hidden.'
) )
@ -356,15 +348,14 @@ def visible(
ctx, scene_name, item_name, group ctx, scene_name, item_name, group
) )
enabled = ctx.obj['obsws'].get_scene_item_enabled( enabled = ctx.obj.get_scene_item_enabled(
scene_name=scene_name, scene_name=scene_name,
item_id=int(scene_item_id), item_id=int(scene_item_id),
) )
if group: if group:
console.out.print( console.out.print(
f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} ' f'Item [green]{item_name}[/green] in group [green]{group}[/green] in scene [green]{old_scene_name}[/green] is currently {"visible" if enabled.scene_item_enabled else "hidden"}.'
f'in scene {console.highlight(ctx, old_scene_name)} is currently {"visible" if enabled.scene_item_enabled else "hidden"}.'
) )
else: else:
# If not in a parent group, just show the scene name # If not in a parent group, just show the scene name
@ -372,8 +363,7 @@ def visible(
# which is not the same as the scene name # which is not the same as the scene name
# and is not needed in this case # and is not needed in this case
console.out.print( console.out.print(
f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} ' f'Item [green]{item_name}[/green] in scene [green]{scene_name}[/green] is currently {"visible" if enabled.scene_item_enabled else "hidden"}.'
f'is currently {"visible" if enabled.scene_item_enabled else "hidden"}.'
) )
@ -481,7 +471,7 @@ def transform(
console.err.print('No transform options provided.') console.err.print('No transform options provided.')
raise typer.Exit(1) raise typer.Exit(1)
transform = ctx.obj['obsws'].set_scene_item_transform( transform = ctx.obj.set_scene_item_transform(
scene_name=scene_name, scene_name=scene_name,
item_id=int(scene_item_id), item_id=int(scene_item_id),
transform=transform, transform=transform,
@ -489,8 +479,7 @@ def transform(
if group: if group:
console.out.print( console.out.print(
f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} ' f'Item [green]{item_name}[/green] in group [green]{group}[/green] in scene [green]{old_scene_name}[/green] has been transformed.'
f'in scene {console.highlight(ctx, old_scene_name)} has been transformed.'
) )
else: else:
# If not in a parent group, just show the scene name # If not in a parent group, just show the scene name
@ -498,5 +487,5 @@ def transform(
# which is not the same as the scene name # which is not the same as the scene name
# and is not needed in this case # and is not needed in this case
console.out.print( console.out.print(
f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been transformed.' f'Item [green]{item_name}[/green] in scene [green]{scene_name}[/green] has been transformed.'
) )

4
obsws_cli/screenshot.py
View File

@ -63,7 +63,7 @@ def save(
): ):
"""Take a screenshot and save it to a file.""" """Take a screenshot and save it to a file."""
try: try:
ctx.obj['obsws'].save_source_screenshot( ctx.obj.save_source_screenshot(
name=source_name, name=source_name,
img_format=output_path.suffix.lstrip('.').lower(), img_format=output_path.suffix.lstrip('.').lower(),
file_path=str(output_path), file_path=str(output_path),
@ -87,4 +87,4 @@ def save(
case _: case _:
raise raise
console.out.print(f'Screenshot saved to {console.highlight(ctx, output_path)}.') console.out.print(f'Screenshot saved to [green]{output_path}[/green].')

2
obsws_cli/settings.py
View File

@ -55,8 +55,6 @@ _settings = Settings(
OBS_PASSWORD='', OBS_PASSWORD='',
OBS_TIMEOUT=5, OBS_TIMEOUT=5,
OBS_DEBUG=False, OBS_DEBUG=False,
OBS_STYLE='disabled',
OBS_STYLE_NO_BORDER=False,
) )

8
obsws_cli/stream.py
View File

@ -15,7 +15,7 @@ def main():
def _get_streaming_status(ctx: typer.Context) -> tuple: def _get_streaming_status(ctx: typer.Context) -> tuple:
"""Get streaming status.""" """Get streaming status."""
resp = ctx.obj['obsws'].get_stream_status() resp = ctx.obj.get_stream_status()
return resp.output_active, resp.output_duration return resp.output_active, resp.output_duration
@ -27,7 +27,7 @@ def start(ctx: typer.Context):
console.err.print('Streaming is already in progress, cannot start.') console.err.print('Streaming is already in progress, cannot start.')
raise typer.Exit(1) raise typer.Exit(1)
ctx.obj['obsws'].start_stream() ctx.obj.start_stream()
console.out.print('Streaming started successfully.') console.out.print('Streaming started successfully.')
@ -39,14 +39,14 @@ def stop(ctx: typer.Context):
console.err.print('Streaming is not in progress, cannot stop.') console.err.print('Streaming is not in progress, cannot stop.')
raise typer.Exit(1) raise typer.Exit(1)
ctx.obj['obsws'].stop_stream() ctx.obj.stop_stream()
console.out.print('Streaming stopped successfully.') console.out.print('Streaming stopped successfully.')
@app.command('toggle | tg') @app.command('toggle | tg')
def toggle(ctx: typer.Context): def toggle(ctx: typer.Context):
"""Toggle streaming.""" """Toggle streaming."""
resp = ctx.obj['obsws'].toggle_stream() resp = ctx.obj.toggle_stream()
if resp.output_active: if resp.output_active:
console.out.print('Streaming started successfully.') console.out.print('Streaming started successfully.')
else: else:

12
obsws_cli/studiomode.py
View File

@ -16,33 +16,33 @@ def main():
@app.command('enable | on') @app.command('enable | on')
def enable(ctx: typer.Context): def enable(ctx: typer.Context):
"""Enable studio mode.""" """Enable studio mode."""
ctx.obj['obsws'].set_studio_mode_enabled(True) ctx.obj.set_studio_mode_enabled(True)
console.out.print('Studio mode has been enabled.') console.out.print('Studio mode has been enabled.')
@app.command('disable | off') @app.command('disable | off')
def disable(ctx: typer.Context): def disable(ctx: typer.Context):
"""Disable studio mode.""" """Disable studio mode."""
ctx.obj['obsws'].set_studio_mode_enabled(False) ctx.obj.set_studio_mode_enabled(False)
console.out.print('Studio mode has been disabled.') console.out.print('Studio mode has been disabled.')
@app.command('toggle | tg') @app.command('toggle | tg')
def toggle(ctx: typer.Context): def toggle(ctx: typer.Context):
"""Toggle studio mode.""" """Toggle studio mode."""
resp = ctx.obj['obsws'].get_studio_mode_enabled() resp = ctx.obj.get_studio_mode_enabled()
if resp.studio_mode_enabled: if resp.studio_mode_enabled:
ctx.obj['obsws'].set_studio_mode_enabled(False) ctx.obj.set_studio_mode_enabled(False)
console.out.print('Studio mode is now disabled.') console.out.print('Studio mode is now disabled.')
else: else:
ctx.obj['obsws'].set_studio_mode_enabled(True) ctx.obj.set_studio_mode_enabled(True)
console.out.print('Studio mode is now enabled.') console.out.print('Studio mode is now enabled.')
@app.command('status | ss') @app.command('status | ss')
def status(ctx: typer.Context): def status(ctx: typer.Context):
"""Get the status of studio mode.""" """Get the status of studio mode."""
resp = ctx.obj['obsws'].get_studio_mode_enabled() resp = ctx.obj.get_studio_mode_enabled()
if resp.studio_mode_enabled: if resp.studio_mode_enabled:
console.out.print('Studio mode is enabled.') console.out.print('Studio mode is enabled.')
else: else:

191
obsws_cli/styles.py
View File

@ -1,191 +0,0 @@
"""module containing styles for the OBS WebSocket CLI."""
import os
from dataclasses import dataclass
_registry = {}
def register_style(cls):
"""Register a style class."""
key = cls.__name__.lower()
if key in _registry:
raise ValueError(f'Style {key} is already registered.')
_registry[key] = cls
return cls
@dataclass
class Style:
"""Base class for styles."""
name: str = 'no_colour'
description: str = 'Style disabled'
border: str | None = None
column: str | None = None
highlight: str | None = None
no_border: bool = False
def __post_init__(self):
"""Post-initialization to set default values and normalize the name."""
self.name = self.name.lower()
if self.no_border:
self.border = None
def __str__(self):
"""Return a string representation of the style."""
return f'{self.name} - {self.description}'
@register_style
@dataclass
class Red(Style):
"""Red style."""
name: str = 'red'
description: str = 'Red text color'
border: str = 'red3'
highlight: str = 'red1'
column: str = 'red1'
@register_style
@dataclass
class Magenta(Style):
"""Magenta style."""
name: str = 'magenta'
description: str = 'Magenta text color'
border: str = 'magenta3'
highlight: str = 'orchid1'
column: str = 'orchid1'
@register_style
@dataclass
class Purple(Style):
"""Purple style."""
name: str = 'purple'
description: str = 'Purple text color'
border: str = 'medium_purple4'
highlight: str = 'medium_purple'
column: str = 'medium_purple'
@register_style
@dataclass
class Blue(Style):
"""Blue style."""
name: str = 'blue'
description: str = 'Blue text color'
border: str = 'cornflower_blue'
highlight: str = 'sky_blue2'
column: str = 'sky_blue2'
@register_style
@dataclass
class Cyan(Style):
"""Cyan style."""
name: str = 'cyan'
description: str = 'Cyan text color'
border: str = 'dark_cyan'
highlight: str = 'cyan'
column: str = 'cyan'
@register_style
@dataclass
class Green(Style):
"""Green style."""
name: str = 'green'
description: str = 'Green text color'
border: str = 'green4'
highlight: str = 'spring_green3'
column: str = 'spring_green3'
@register_style
@dataclass
class Yellow(Style):
"""Yellow style."""
name: str = 'yellow'
description: str = 'Yellow text color'
border: str = 'yellow3'
highlight: str = 'wheat1'
column: str = 'wheat1'
@register_style
@dataclass
class Orange(Style):
"""Orange style."""
name: str = 'orange'
description: str = 'Orange text color'
border: str = 'dark_orange'
highlight: str = 'orange1'
column: str = 'orange1'
@register_style
@dataclass
class White(Style):
"""White style."""
name: str = 'white'
description: str = 'White text color'
border: str = 'grey82'
highlight: str = 'grey100'
column: str = 'grey100'
@register_style
@dataclass
class Grey(Style):
"""Grey style."""
name: str = 'grey'
description: str = 'Grey text color'
border: str = 'grey50'
highlight: str = 'grey70'
column: str = 'grey70'
@register_style
@dataclass
class Navy(Style):
"""Navy Blue style."""
name: str = 'navyblue'
description: str = 'Navy Blue text color'
border: str = 'deep_sky_blue4'
highlight: str = 'light_sky_blue3'
column: str = 'light_sky_blue3'
@register_style
@dataclass
class Black(Style):
"""Black style."""
name: str = 'black'
description: str = 'Black text color'
border: str = 'grey19'
column: str = 'grey11'
def request_style_obj(style_name: str, no_border: bool) -> Style:
"""Entry point for style objects. Returns a Style object based on the style name."""
style_name = str(style_name).lower() # coerce the type to string and lowercase it
if style_name not in _registry:
os.environ['NO_COLOR'] = '1' # Disable colour output
return Style()
return _registry[style_name](no_border=no_border)

6
obsws_cli/util.py
View File

@ -2,19 +2,17 @@
import os import os
import typer
def snakecase_to_titlecase(snake_str: str) -> str: def snakecase_to_titlecase(snake_str: str) -> str:
"""Convert a snake_case string to a title case string.""" """Convert a snake_case string to a title case string."""
return snake_str.replace('_', ' ').title() return snake_str.replace('_', ' ').title()
def check_mark(ctx: typer.Context, value: bool, empty_if_false: bool = False) -> str: def check_mark(value: bool, empty_if_false: bool = False) -> str:
"""Return a check mark or cross mark based on the boolean value.""" """Return a check mark or cross mark based on the boolean value."""
if empty_if_false and not value: if empty_if_false and not value:
return '' return ''
if os.getenv('NO_COLOR', '') != '' or ctx.obj['style'].name == 'no_colour': if os.getenv('NO_COLOR', '') != '':
return '✓' if value else '✗' return '✓' if value else '✗'
return '✅' if value else '❌' return '✅' if value else '❌'

14
obsws_cli/validate.py
View File

@ -8,19 +8,19 @@ skipped_option = typer.Option(parser=lambda _: _, hidden=True, expose_value=Fals
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.""" """Check if an input is in the input list."""
inputs = ctx.obj['obsws'].get_input_list().inputs inputs = ctx.obj.get_input_list().inputs
return any(input_.get('inputName') == input_name for input_ in inputs) return any(input_.get('inputName') == input_name for input_ in inputs)
def scene_in_scenes(ctx: typer.Context, scene_name: str) -> bool: def scene_in_scenes(ctx: typer.Context, scene_name: str) -> bool:
"""Check if a scene exists in the list of scenes.""" """Check if a scene exists in the list of scenes."""
resp = ctx.obj['obsws'].get_scene_list() resp = ctx.obj.get_scene_list()
return any(scene.get('sceneName') == scene_name for scene in resp.scenes) return any(scene.get('sceneName') == scene_name for scene in resp.scenes)
def studio_mode_enabled(ctx: typer.Context) -> bool: def studio_mode_enabled(ctx: typer.Context) -> bool:
"""Check if studio mode is enabled.""" """Check if studio mode is enabled."""
resp = ctx.obj['obsws'].get_studio_mode_enabled() resp = ctx.obj.get_studio_mode_enabled()
return resp.studio_mode_enabled return resp.studio_mode_enabled
@ -28,7 +28,7 @@ def scene_collection_in_scene_collections(
ctx: typer.Context, scene_collection_name: str ctx: typer.Context, scene_collection_name: str
) -> bool: ) -> bool:
"""Check if a scene collection exists.""" """Check if a scene collection exists."""
resp = ctx.obj['obsws'].get_scene_collection_list() resp = ctx.obj.get_scene_collection_list()
return any( return any(
collection == scene_collection_name for collection in resp.scene_collections collection == scene_collection_name for collection in resp.scene_collections
) )
@ -38,17 +38,17 @@ def item_in_scene_item_list(
ctx: typer.Context, scene_name: str, item_name: str ctx: typer.Context, scene_name: str, item_name: str
) -> bool: ) -> bool:
"""Check if an item exists in a scene.""" """Check if an item exists in a scene."""
resp = ctx.obj['obsws'].get_scene_item_list(scene_name) resp = ctx.obj.get_scene_item_list(scene_name)
return any(item.get('sourceName') == item_name for item in resp.scene_items) return any(item.get('sourceName') == item_name for item in resp.scene_items)
def profile_exists(ctx: typer.Context, profile_name: str) -> bool: def profile_exists(ctx: typer.Context, profile_name: str) -> bool:
"""Check if a profile exists.""" """Check if a profile exists."""
resp = ctx.obj['obsws'].get_profile_list() resp = ctx.obj.get_profile_list()
return any(profile == profile_name for profile in resp.profiles) return any(profile == profile_name for profile in resp.profiles)
def monitor_exists(ctx: typer.Context, monitor_index: int) -> bool: 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.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)

8
obsws_cli/virtualcam.py
View File

@ -16,21 +16,21 @@ def main():
@app.command('start | s') @app.command('start | s')
def start(ctx: typer.Context): def start(ctx: typer.Context):
"""Start the virtual camera.""" """Start the virtual camera."""
ctx.obj['obsws'].start_virtual_cam() ctx.obj.start_virtual_cam()
console.out.print('Virtual camera started.') console.out.print('Virtual camera started.')
@app.command('stop | p') @app.command('stop | p')
def stop(ctx: typer.Context): def stop(ctx: typer.Context):
"""Stop the virtual camera.""" """Stop the virtual camera."""
ctx.obj['obsws'].stop_virtual_cam() ctx.obj.stop_virtual_cam()
console.out.print('Virtual camera stopped.') console.out.print('Virtual camera stopped.')
@app.command('toggle | tg') @app.command('toggle | tg')
def toggle(ctx: typer.Context): def toggle(ctx: typer.Context):
"""Toggle the virtual camera.""" """Toggle the virtual camera."""
resp = ctx.obj['obsws'].toggle_virtual_cam() resp = ctx.obj.toggle_virtual_cam()
if resp.output_active: if resp.output_active:
console.out.print('Virtual camera is enabled.') console.out.print('Virtual camera is enabled.')
else: else:
@ -40,7 +40,7 @@ def toggle(ctx: typer.Context):
@app.command('status | ss') @app.command('status | ss')
def status(ctx: typer.Context): def status(ctx: typer.Context):
"""Get the status of the virtual camera.""" """Get the status of the virtual camera."""
resp = ctx.obj['obsws'].get_virtual_cam_status() resp = ctx.obj.get_virtual_cam_status()
if resp.output_active: if resp.output_active:
console.out.print('Virtual camera is enabled.') console.out.print('Virtual camera is enabled.')
else: else: