Compare commits

..

No commits in common. "45479563a044dd91160bf947a0ed55f490849b97" and "34067ca61d4da480442d2a6cdeb8ac1c03891d21" have entirely different histories.

21 changed files with 142 additions and 190 deletions

View File

@ -16,7 +16,6 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
- [Configuration](#configuration)
- [Style](#style)
- [Commands](#root-typer)
- [Shell Completion](#shell-completion)
- [License](#license)
## Requirements
@ -815,14 +814,6 @@ obsws-cli media stop "Media"
obsws-cli media restart "Media"
```
## Shell Completion
```console
obsws-cli --install-completion
```
Currently supported shells: *bash* *zsh* *fish* *powershell*
## License

View File

@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2025-present onyx-and-iris <code@onyxandiris.online>
#
# SPDX-License-Identifier: MIT
__version__ = '0.24.7'
__version__ = '0.24.6'

View File

@ -1,5 +1,7 @@
"""module defining a custom group class for handling command name aliases."""
import re
import typer
@ -51,3 +53,25 @@ class RootTyperAliasGroup(typer.core.TyperGroup):
case 'vc':
cmd_name = 'virtualcam'
return super().get_command(ctx, cmd_name)
class SubTyperAliasGroup(typer.core.TyperGroup):
"""A custom group class to handle command name aliases for sub typers."""
_CMD_SPLIT_P = re.compile(r' ?[,|] ?')
def __init__(self, *args, **kwargs):
"""Initialize the AliasGroup."""
super().__init__(*args, **kwargs)
self.no_args_is_help = True
def get_command(self, ctx, cmd_name):
"""Get a command by name."""
cmd_name = self._group_cmd_name(cmd_name)
return super().get_command(ctx, cmd_name)
def _group_cmd_name(self, default_name):
for cmd in self.commands.values():
if cmd.name and default_name in self._CMD_SPLIT_P.split(cmd.name):
return cmd.name
return default_name

View File

@ -8,8 +8,9 @@ from rich.table import Table
from rich.text import Text
from obsws_cli import console, util
from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer()
app = typer.Typer(cls=SubTyperAliasGroup)
@app.callback()
@ -17,8 +18,7 @@ def main():
"""Control filters in OBS scenes."""
@app.command('list')
@app.command('ls', hidden=True)
@app.command('list | ls')
def list_(
ctx: typer.Context,
source_name: Annotated[
@ -90,8 +90,7 @@ def _get_filter_enabled(ctx: typer.Context, source_name: str, filter_name: str):
return resp.filter_enabled
@app.command('enable')
@app.command('on', hidden=True)
@app.command('enable | on')
def enable(
ctx: typer.Context,
source_name: Annotated[
@ -120,8 +119,7 @@ def enable(
)
@app.command('disable')
@app.command('off', hidden=True)
@app.command('disable | off')
def disable(
ctx: typer.Context,
source_name: Annotated[
@ -150,8 +148,7 @@ def disable(
)
@app.command('toggle')
@app.command('tg', hidden=True)
@app.command('toggle | tg')
def toggle(
ctx: typer.Context,
source_name: Annotated[
@ -184,8 +181,7 @@ def toggle(
)
@app.command('status')
@app.command('ss', hidden=True)
@app.command('status | ss')
def status(
ctx: typer.Context,
source_name: Annotated[

View File

@ -7,9 +7,10 @@ from rich.table import Table
from rich.text import Text
from obsws_cli import console, util, validate
from obsws_cli.alias import SubTyperAliasGroup
from obsws_cli.protocols import DataclassProtocol
app = typer.Typer()
app = typer.Typer(cls=SubTyperAliasGroup)
@app.callback()
@ -17,8 +18,7 @@ def main():
"""Control groups in OBS scenes."""
@app.command('list')
@app.command('ls', hidden=True)
@app.command('list | ls')
def list_(
ctx: typer.Context,
scene_name: Annotated[
@ -84,8 +84,7 @@ def _get_group(group_name: str, resp: DataclassProtocol) -> dict | None:
return group
@app.command('show')
@app.command('sh', hidden=True)
@app.command('show | sh')
def show(
ctx: typer.Context,
scene_name: Annotated[
@ -118,8 +117,7 @@ def show(
console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.')
@app.command('hide')
@app.command('h', hidden=True)
@app.command('hide | h')
def hide(
ctx: typer.Context,
scene_name: Annotated[
@ -152,8 +150,7 @@ def hide(
console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
@app.command('toggle')
@app.command('tg', hidden=True)
@app.command('toggle | tg')
def toggle(
ctx: typer.Context,
scene_name: Annotated[
@ -190,8 +187,7 @@ def toggle(
console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
@app.command('status')
@app.command('ss', hidden=True)
@app.command('status | ss')
def status(
ctx: typer.Context,
scene_name: Annotated[

View File

@ -7,8 +7,9 @@ from rich.table import Table
from rich.text import Text
from obsws_cli import console
from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer()
app = typer.Typer(cls=SubTyperAliasGroup)
@app.callback()
@ -16,8 +17,7 @@ def main():
"""Control hotkeys in OBS."""
@app.command('list')
@app.command('ls', hidden=True)
@app.command('list | ls')
def list_(
ctx: typer.Context,
):
@ -45,8 +45,7 @@ def list_(
console.out.print(table)
@app.command('trigger')
@app.command('tr', hidden=True)
@app.command('trigger | tr')
def trigger(
ctx: typer.Context,
hotkey: Annotated[
@ -57,8 +56,7 @@ def trigger(
ctx.obj['obsws'].trigger_hotkey_by_name(hotkey)
@app.command('trigger-sequence')
@app.command('trs', hidden=True)
@app.command('trigger-sequence | trs')
def trigger_sequence(
ctx: typer.Context,
key_id: Annotated[

View File

@ -8,8 +8,9 @@ from rich.table import Table
from rich.text import Text
from obsws_cli import console, util, validate
from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer()
app = typer.Typer(cls=SubTyperAliasGroup)
@app.callback()
@ -17,8 +18,7 @@ def main():
"""Control inputs in OBS."""
@app.command('create')
@app.command('cr', hidden=True)
@app.command('create | add')
def create(
ctx: typer.Context,
input_name: Annotated[
@ -62,8 +62,7 @@ def create(
)
@app.command('remove')
@app.command('rm', hidden=True)
@app.command('remove | rm')
def remove(
ctx: typer.Context,
input_name: Annotated[
@ -82,8 +81,7 @@ def remove(
console.out.print(f'Input {console.highlight(ctx, input_name)} removed.')
@app.command('list')
@app.command('ls', hidden=True)
@app.command('list | ls')
def list_(
ctx: typer.Context,
input: Annotated[bool, typer.Option(help='Filter by input type.')] = False,
@ -170,8 +168,7 @@ def list_(
console.out.print(table)
@app.command('list-kinds')
@app.command('ls-k', hidden=True)
@app.command('list-kinds | ls-k')
def list_kinds(
ctx: typer.Context,
):
@ -198,8 +195,7 @@ def list_kinds(
console.out.print(table)
@app.command('mute')
@app.command('m', hidden=True)
@app.command('mute | m')
def mute(
ctx: typer.Context,
input_name: Annotated[
@ -221,8 +217,7 @@ def mute(
console.out.print(f'Input {console.highlight(ctx, input_name)} muted.')
@app.command('unmute')
@app.command('um', hidden=True)
@app.command('unmute | um')
def unmute(
ctx: typer.Context,
input_name: Annotated[
@ -244,8 +239,7 @@ def unmute(
console.out.print(f'Input {console.highlight(ctx, input_name)} unmuted.')
@app.command('toggle')
@app.command('tg', hidden=True)
@app.command('toggle | tg')
def toggle(
ctx: typer.Context,
input_name: Annotated[
@ -277,8 +271,7 @@ def toggle(
)
@app.command('volume')
@app.command('vol', hidden=True)
@app.command('volume | vol')
def volume(
ctx: typer.Context,
input_name: Annotated[
@ -312,8 +305,7 @@ def volume(
)
@app.command('show')
@app.command('s', hidden=True)
@app.command('show | s')
def show(
ctx: typer.Context,
input_name: Annotated[
@ -406,8 +398,7 @@ def show(
console.out.print(table)
@app.command('update')
@app.command('upd', hidden=True)
@app.command('update | upd')
def update(
ctx: typer.Context,
input_name: Annotated[

View File

@ -5,8 +5,9 @@ from typing import Annotated, Optional
import typer
from obsws_cli import console, util, validate
from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer()
app = typer.Typer(cls=SubTyperAliasGroup)
@app.callback()
@ -14,8 +15,7 @@ def main():
"""Commands for media inputs."""
@app.command('cursor')
@app.command('cur', hidden=True)
@app.command('cursor | c')
def cursor(
ctx: typer.Context,
input_name: Annotated[
@ -45,8 +45,7 @@ def cursor(
)
@app.command('play')
@app.command('p', hidden=True)
@app.command('play | p')
def play(
ctx: typer.Context,
input_name: Annotated[
@ -60,8 +59,7 @@ def play(
console.out.print(f'Playing media input {console.highlight(ctx, input_name)}.')
@app.command('pause')
@app.command('pa', hidden=True)
@app.command('pause | pa')
def pause(
ctx: typer.Context,
input_name: Annotated[
@ -75,8 +73,7 @@ def pause(
console.out.print(f'Paused media input {console.highlight(ctx, input_name)}.')
@app.command('stop')
@app.command('s', hidden=True)
@app.command('stop | s')
def stop(
ctx: typer.Context,
input_name: Annotated[
@ -90,8 +87,7 @@ def stop(
console.out.print(f'Stopped media input {console.highlight(ctx, input_name)}.')
@app.command('restart')
@app.command('r', hidden=True)
@app.command('restart | r')
def restart(
ctx: typer.Context,
input_name: Annotated[

View File

@ -7,8 +7,9 @@ from rich.table import Table
from rich.text import Text
from obsws_cli import console, util, validate
from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer()
app = typer.Typer(cls=SubTyperAliasGroup)
@app.callback()
@ -16,8 +17,7 @@ def main():
"""Control profiles in OBS."""
@app.command('list')
@app.command('ls', hidden=True)
@app.command('list | ls')
def list_(ctx: typer.Context):
"""List profiles."""
resp = ctx.obj['obsws'].get_profile_list()
@ -47,8 +47,7 @@ def list_(ctx: typer.Context):
console.out.print(table)
@app.command('current')
@app.command('get', hidden=True)
@app.command('current | get')
def current(ctx: typer.Context):
"""Get the current profile."""
resp = ctx.obj['obsws'].get_profile_list()
@ -57,8 +56,7 @@ def current(ctx: typer.Context):
)
@app.command('switch')
@app.command('set', hidden=True)
@app.command('switch | set')
def switch(
ctx: typer.Context,
profile_name: Annotated[
@ -83,8 +81,7 @@ def switch(
console.out.print(f'Switched to profile {console.highlight(ctx, profile_name)}.')
@app.command('create')
@app.command('new', hidden=True)
@app.command('create | new')
def create(
ctx: typer.Context,
profile_name: Annotated[
@ -102,8 +99,7 @@ def create(
console.out.print(f'Created profile {console.highlight(ctx, profile_name)}.')
@app.command('remove')
@app.command('rm', hidden=True)
@app.command('remove | rm')
def remove(
ctx: typer.Context,
profile_name: Annotated[

View File

@ -7,8 +7,9 @@ from rich.table import Table
from rich.text import Text
from obsws_cli import console
from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer()
app = typer.Typer(cls=SubTyperAliasGroup)
@app.callback()
@ -16,8 +17,7 @@ def main():
"""Control projectors in OBS."""
@app.command('list-monitors')
@app.command('ls-m', hidden=True)
@app.command('list-monitors | ls-m')
def list_monitors(ctx: typer.Context):
"""List available monitors."""
resp = ctx.obj['obsws'].get_monitor_list()
@ -48,8 +48,7 @@ def list_monitors(ctx: typer.Context):
console.out.print(table)
@app.command('open')
@app.command('o', hidden=True)
@app.command('open | o')
def open(
ctx: typer.Context,
monitor_index: Annotated[

View File

@ -6,8 +6,9 @@ from typing import Annotated, Optional
import typer
from obsws_cli import console
from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer()
app = typer.Typer(cls=SubTyperAliasGroup)
@app.callback()
@ -21,8 +22,7 @@ def _get_recording_status(ctx: typer.Context) -> tuple:
return resp.output_active, resp.output_paused
@app.command('start')
@app.command('s', hidden=True)
@app.command('start | s')
def start(ctx: typer.Context):
"""Start recording."""
active, paused = _get_recording_status(ctx)
@ -38,8 +38,7 @@ def start(ctx: typer.Context):
console.out.print('Recording started successfully.')
@app.command('stop')
@app.command('st', hidden=True)
@app.command('stop | st')
def stop(ctx: typer.Context):
"""Stop recording."""
active, _ = _get_recording_status(ctx)
@ -53,8 +52,7 @@ def stop(ctx: typer.Context):
)
@app.command('toggle')
@app.command('tg', hidden=True)
@app.command('toggle | tg')
def toggle(ctx: typer.Context):
"""Toggle recording."""
resp = ctx.obj['obsws'].toggle_record()
@ -64,8 +62,7 @@ def toggle(ctx: typer.Context):
console.out.print('Recording stopped successfully.')
@app.command('status')
@app.command('ss', hidden=True)
@app.command('status | ss')
def status(ctx: typer.Context):
"""Get recording status."""
active, paused = _get_recording_status(ctx)
@ -78,8 +75,7 @@ def status(ctx: typer.Context):
console.out.print('Recording is not in progress.')
@app.command('resume')
@app.command('r', hidden=True)
@app.command('resume | r')
def resume(ctx: typer.Context):
"""Resume recording."""
active, paused = _get_recording_status(ctx)
@ -94,8 +90,7 @@ def resume(ctx: typer.Context):
console.out.print('Recording resumed successfully.')
@app.command('pause')
@app.command('p', hidden=True)
@app.command('pause | p')
def pause(ctx: typer.Context):
"""Pause recording."""
active, paused = _get_recording_status(ctx)
@ -110,8 +105,7 @@ def pause(ctx: typer.Context):
console.out.print('Recording paused successfully.')
@app.command('directory')
@app.command('d', hidden=True)
@app.command('directory | d')
def directory(
ctx: typer.Context,
record_directory: Annotated[
@ -138,8 +132,7 @@ def directory(
)
@app.command('split')
@app.command('sp', hidden=True)
@app.command('split | sp')
def split(ctx: typer.Context):
"""Split the current recording."""
active, paused = _get_recording_status(ctx)
@ -154,8 +147,7 @@ def split(ctx: typer.Context):
console.out.print('Recording split successfully.')
@app.command('chapter')
@app.command('ch', hidden=True)
@app.command('chapter | ch')
def chapter(
ctx: typer.Context,
chapter_name: Annotated[

View File

@ -3,8 +3,9 @@
import typer
from obsws_cli import console
from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer()
app = typer.Typer(cls=SubTyperAliasGroup)
@app.callback()
@ -12,8 +13,7 @@ def main():
"""Control profiles in OBS."""
@app.command('start')
@app.command('s', hidden=True)
@app.command('start | s')
def start(ctx: typer.Context):
"""Start the replay buffer."""
resp = ctx.obj['obsws'].get_replay_buffer_status()
@ -25,8 +25,7 @@ def start(ctx: typer.Context):
console.out.print('Replay buffer started.')
@app.command('stop')
@app.command('st', hidden=True)
@app.command('stop | st')
def stop(ctx: typer.Context):
"""Stop the replay buffer."""
resp = ctx.obj['obsws'].get_replay_buffer_status()
@ -38,8 +37,7 @@ def stop(ctx: typer.Context):
console.out.print('Replay buffer stopped.')
@app.command('toggle')
@app.command('tg', hidden=True)
@app.command('toggle | tg')
def toggle(ctx: typer.Context):
"""Toggle the replay buffer."""
resp = ctx.obj['obsws'].toggle_replay_buffer()
@ -49,8 +47,7 @@ def toggle(ctx: typer.Context):
console.out.print('Replay buffer is not active.')
@app.command('status')
@app.command('ss', hidden=True)
@app.command('status | ss')
def status(ctx: typer.Context):
"""Get the status of the replay buffer."""
resp = ctx.obj['obsws'].get_replay_buffer_status()
@ -60,8 +57,7 @@ def status(ctx: typer.Context):
console.out.print('Replay buffer is not active.')
@app.command('save')
@app.command('sv', hidden=True)
@app.command('save | sv')
def save(ctx: typer.Context):
"""Save the replay buffer."""
ctx.obj['obsws'].save_replay_buffer()

View File

@ -7,8 +7,9 @@ from rich.table import Table
from rich.text import Text
from obsws_cli import console, util, validate
from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer()
app = typer.Typer(cls=SubTyperAliasGroup)
@app.callback()
@ -16,8 +17,7 @@ def main():
"""Control OBS scenes."""
@app.command('list')
@app.command('ls', hidden=True)
@app.command('list | ls')
def list_(
ctx: typer.Context,
uuid: Annotated[bool, typer.Option(help='Show UUIDs of scenes')] = False,
@ -66,8 +66,7 @@ def list_(
console.out.print(table)
@app.command('current')
@app.command('get', hidden=True)
@app.command('current | get')
def current(
ctx: typer.Context,
preview: Annotated[
@ -91,8 +90,7 @@ def current(
)
@app.command('switch')
@app.command('set', hidden=True)
@app.command('switch | set')
def switch(
ctx: typer.Context,
scene_name: Annotated[

View File

@ -6,8 +6,9 @@ import typer
from rich.table import Table
from obsws_cli import console, validate
from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer()
app = typer.Typer(cls=SubTyperAliasGroup)
@app.callback()
@ -15,8 +16,7 @@ def main():
"""Control scene collections in OBS."""
@app.command('list')
@app.command('ls', hidden=True)
@app.command('list | ls')
def list_(ctx: typer.Context):
"""List all scene collections."""
resp = ctx.obj['obsws'].get_scene_collection_list()
@ -40,8 +40,7 @@ def list_(ctx: typer.Context):
console.out.print(table)
@app.command('current')
@app.command('get', hidden=True)
@app.command('current | get')
def current(ctx: typer.Context):
"""Get the current scene collection."""
resp = ctx.obj['obsws'].get_scene_collection_list()
@ -50,8 +49,7 @@ def current(ctx: typer.Context):
)
@app.command('switch')
@app.command('set', hidden=True)
@app.command('switch | set')
def switch(
ctx: typer.Context,
scene_collection_name: Annotated[
@ -79,8 +77,7 @@ def switch(
)
@app.command('create')
@app.command('new', hidden=True)
@app.command('create | new')
def create(
ctx: typer.Context,
scene_collection_name: Annotated[

View File

@ -6,8 +6,9 @@ import typer
from rich.table import Table
from obsws_cli import console, util, validate
from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer()
app = typer.Typer(cls=SubTyperAliasGroup)
@app.callback()
@ -15,8 +16,7 @@ def main():
"""Control items in OBS scenes."""
@app.command('list')
@app.command('ls', hidden=True)
@app.command('list | ls')
def list_(
ctx: typer.Context,
scene_name: Annotated[
@ -186,8 +186,7 @@ def _get_scene_name_and_item_id(
return scene_name, scene_item_id
@app.command('show')
@app.command('sh', hidden=True)
@app.command('show | sh')
def show(
ctx: typer.Context,
scene_name: Annotated[
@ -229,8 +228,7 @@ def show(
)
@app.command('hide')
@app.command('h', hidden=True)
@app.command('hide | h')
def hide(
ctx: typer.Context,
scene_name: Annotated[
@ -271,8 +269,7 @@ def hide(
)
@app.command('toggle')
@app.command('tg', hidden=True)
@app.command('toggle | tg')
def toggle(
ctx: typer.Context,
scene_name: Annotated[
@ -333,8 +330,7 @@ def toggle(
)
@app.command('visible')
@app.command('v', hidden=True)
@app.command('visible | v')
def visible(
ctx: typer.Context,
scene_name: Annotated[
@ -378,8 +374,7 @@ def visible(
)
@app.command('transform')
@app.command('t', hidden=True)
@app.command('transform | t')
def transform(
ctx: typer.Context,
scene_name: Annotated[

View File

@ -7,8 +7,9 @@ import obsws_python as obsws
import typer
from obsws_cli import console
from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer()
app = typer.Typer(cls=SubTyperAliasGroup)
@app.callback()
@ -16,8 +17,7 @@ def main():
"""Take screenshots using OBS."""
@app.command('save')
@app.command('s', hidden=True)
@app.command('save | sv')
def save(
ctx: typer.Context,
source_name: Annotated[

View File

@ -7,8 +7,9 @@ from rich.table import Table
from rich.text import Text
from obsws_cli import console, util
from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer()
app = typer.Typer(cls=SubTyperAliasGroup)
@app.callback()
@ -16,8 +17,7 @@ def main():
"""Manage OBS settings."""
@app.command('show')
@app.command('sh', hidden=True)
@app.command('show | sh')
def show(
ctx: typer.Context,
video: Annotated[
@ -136,8 +136,7 @@ def show(
console.out.print(profile_table)
@app.command('profile')
@app.command('pr', hidden=True)
@app.command('profile | pr')
def profile(
ctx: typer.Context,
category: Annotated[
@ -183,8 +182,7 @@ def profile(
)
@app.command('stream-service')
@app.command('ss', hidden=True)
@app.command('stream-service | ss')
def stream_service(
ctx: typer.Context,
type_: Annotated[
@ -251,8 +249,7 @@ def stream_service(
console.out.print('Stream service settings updated.')
@app.command('video')
@app.command('vi', hidden=True)
@app.command('video | vi')
def video(
ctx: typer.Context,
base_width: Annotated[

View File

@ -3,8 +3,9 @@
import typer
from obsws_cli import console
from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer()
app = typer.Typer(cls=SubTyperAliasGroup)
@app.callback()
@ -18,8 +19,7 @@ def _get_streaming_status(ctx: typer.Context) -> tuple:
return resp.output_active, resp.output_duration
@app.command('start')
@app.command('s', hidden=True)
@app.command('start | s')
def start(ctx: typer.Context):
"""Start streaming."""
active, _ = _get_streaming_status(ctx)
@ -31,8 +31,7 @@ def start(ctx: typer.Context):
console.out.print('Streaming started successfully.')
@app.command('stop')
@app.command('st', hidden=True)
@app.command('stop | st')
def stop(ctx: typer.Context):
"""Stop streaming."""
active, _ = _get_streaming_status(ctx)
@ -44,8 +43,7 @@ def stop(ctx: typer.Context):
console.out.print('Streaming stopped successfully.')
@app.command('toggle')
@app.command('tg', hidden=True)
@app.command('toggle | tg')
def toggle(ctx: typer.Context):
"""Toggle streaming."""
resp = ctx.obj['obsws'].toggle_stream()
@ -55,8 +53,7 @@ def toggle(ctx: typer.Context):
console.out.print('Streaming stopped successfully.')
@app.command('status')
@app.command('ss', hidden=True)
@app.command('status | ss')
def status(ctx: typer.Context):
"""Get streaming status."""
active, duration = _get_streaming_status(ctx)

View File

@ -3,8 +3,9 @@
import typer
from obsws_cli import console
from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer()
app = typer.Typer(cls=SubTyperAliasGroup)
@app.callback()
@ -12,24 +13,21 @@ def main():
"""Control studio mode in OBS."""
@app.command('enable')
@app.command('on', hidden=True)
@app.command('enable | on')
def enable(ctx: typer.Context):
"""Enable studio mode."""
ctx.obj['obsws'].set_studio_mode_enabled(True)
console.out.print('Studio mode has been enabled.')
@app.command('disable')
@app.command('off', hidden=True)
@app.command('disable | off')
def disable(ctx: typer.Context):
"""Disable studio mode."""
ctx.obj['obsws'].set_studio_mode_enabled(False)
console.out.print('Studio mode has been disabled.')
@app.command('toggle')
@app.command('tg', hidden=True)
@app.command('toggle | tg')
def toggle(ctx: typer.Context):
"""Toggle studio mode."""
resp = ctx.obj['obsws'].get_studio_mode_enabled()
@ -41,8 +39,7 @@ def toggle(ctx: typer.Context):
console.out.print('Studio mode is now enabled.')
@app.command('status')
@app.command('ss', hidden=True)
@app.command('status | ss')
def status(ctx: typer.Context):
"""Get the status of studio mode."""
resp = ctx.obj['obsws'].get_studio_mode_enabled()

View File

@ -5,8 +5,9 @@ from typing import Annotated, Optional
import typer
from obsws_cli import console, validate
from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer()
app = typer.Typer(cls=SubTyperAliasGroup)
@app.callback()
@ -14,8 +15,7 @@ def main():
"""Control text inputs in OBS."""
@app.command('current')
@app.command('get', hidden=True)
@app.command('current | get')
def current(
ctx: typer.Context,
input_name: Annotated[
@ -41,8 +41,7 @@ def current(
)
@app.command('update')
@app.command('set', hidden=True)
@app.command('update | set')
def update(
ctx: typer.Context,
input_name: Annotated[

View File

@ -3,8 +3,9 @@
import typer
from obsws_cli import console
from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer()
app = typer.Typer(cls=SubTyperAliasGroup)
@app.callback()
@ -12,24 +13,21 @@ def main():
"""Control virtual camera in OBS."""
@app.command('start')
@app.command('s', hidden=True)
@app.command('start | s')
def start(ctx: typer.Context):
"""Start the virtual camera."""
ctx.obj['obsws'].start_virtual_cam()
console.out.print('Virtual camera started.')
@app.command('stop')
@app.command('p', hidden=True)
@app.command('stop | p')
def stop(ctx: typer.Context):
"""Stop the virtual camera."""
ctx.obj['obsws'].stop_virtual_cam()
console.out.print('Virtual camera stopped.')
@app.command('toggle')
@app.command('tg', hidden=True)
@app.command('toggle | tg')
def toggle(ctx: typer.Context):
"""Toggle the virtual camera."""
resp = ctx.obj['obsws'].toggle_virtual_cam()
@ -39,8 +37,7 @@ def toggle(ctx: typer.Context):
console.out.print('Virtual camera is disabled.')
@app.command('status')
@app.command('ss', hidden=True)
@app.command('status | ss')
def status(ctx: typer.Context):
"""Get the status of the virtual camera."""
resp = ctx.obj['obsws'].get_virtual_cam_status()