bump version in CHANGELOG

CHANGELOG.md

@@ -5,11 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-# [0.22.0] - 2026-01-09
+# [0.24.0] - 2026-01-09
 
 ### Added
 
 -   new subcommands added to input, see [Input](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#input)
+-   settings command group, see [Settings](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#settings)
+-   media command group, see [Media](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#media)
 
 
 # [0.20.0] - 2025-07-14

README.md

@@ -722,6 +722,99 @@ obsws-cli projector open --monitor-index=1 "test_group"
 obsws-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\screenshot.png"
 ```
 
+#### Settings
+
+-   show: Show current OBS settings.
+    -   flags:
+
+        *optional*
+        -   --video: Show video settings.
+        -   --record: Show recording settings.
+        -   --profile: Show profile settings.
+
+```console
+obsws-cli settings show --video --record
+```
+
+-   profile: Get/set OBS profile settings.
+    -   args: <category> <name> <value>
+
+```console
+obsws-cli settings profile SimpleOutput VBitrate
+
+obsws-cli settings profile SimpleOutput VBitrate 6000
+```
+
+-   stream-service: Get/set OBS stream service settings.
+    -   flags:
+        -   --key: Stream key.
+        -   --server: Stream server URL.
+
+    *optional*
+    -   args: <type>
+
+```console
+obsws-cli settings stream-service
+
+obsws-cli settings stream-service --key='live_xyzxyzxyzxyz' rtmp_common
+```
+
+-   video: Get/set OBS video settings.
+    -   flags:
+
+        *optional*
+        -   --base-width: Base (canvas) width.
+        -   --base-height: Base (canvas) height.
+        -   --output-width: Output (scaled) width.
+        -   --output-height: Output (scaled) height.
+        -   --fps-num: Frames per second numerator.
+        -   --fps-den: Frames per second denominator.
+
+```console
+obsws-cli settings video
+
+obsws-cli settings video --base-width=1920 --base-height=1080
+```
+
+#### Media
+
+-   cursor: Get/set the cursor position of a media input.
+    -   args: InputName
+
+        *optional*
+        -   TimeString
+
+```console
+obsws-cli media cursor "Media"
+
+obsws-cli media cursor "Media" "00:08:30"
+```
+
+-   play: Plays a media input.
+
+```console
+obsws-cli media play "Media"
+```
+
+-   pause: Pauses a media input.
+
+```console
+obsws-cli media pause "Media"
+```
+
+-   stop: Stops a media input.
+
+```console
+obsws-cli media stop "Media"
+```
+
+-   restart: Restarts a media input.
+
+```console
+obsws-cli media restart "Media"
+```
+
+
 ## License
 
 `obsws-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

obsws_cli/__about__.py

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

obsws_cli/app.py

@@ -9,7 +9,7 @@ import typer
 
 from obsws_cli.__about__ import __version__ as version
 
-from . import console, settings, styles
+from . import config, console, styles
 from .alias import RootTyperAliasGroup
 
 app = typer.Typer(cls=RootTyperAliasGroup)
@@ -18,10 +18,12 @@ for sub_typer in (
     'group',
     'hotkey',
     'input',
+    'media',
     'profile',
     'projector',
     'record',
     'replaybuffer',
+    'settings',
     'scene',
     'scenecollection',
     'sceneitem',
@@ -72,7 +74,7 @@ def main(
             help='WebSocket host',
             show_default='localhost',
         ),
-    ] = settings.get('host'),
+    ] = config.get('host'),
     port: Annotated[
         int,
         typer.Option(
@@ -82,7 +84,7 @@ def main(
             help='WebSocket port',
             show_default=4455,
         ),
-    ] = settings.get('port'),
+    ] = config.get('port'),
     password: Annotated[
         str,
         typer.Option(
@@ -92,7 +94,7 @@ def main(
             help='WebSocket password',
             show_default=False,
         ),
-    ] = settings.get('password'),
+    ] = config.get('password'),
     timeout: Annotated[
         int,
         typer.Option(
@@ -102,7 +104,7 @@ def main(
             help='WebSocket timeout',
             show_default=5,
         ),
-    ] = settings.get('timeout'),
+    ] = config.get('timeout'),
     style: Annotated[
         str,
         typer.Option(
@@ -113,7 +115,7 @@ def main(
             show_default='disabled',
             callback=validate_style,
         ),
-    ] = settings.get('style'),
+    ] = config.get('style'),
     no_border: Annotated[
         bool,
         typer.Option(
@@ -123,7 +125,7 @@ def main(
             help='Disable table border styling in the CLI output',
             show_default=False,
         ),
-    ] = settings.get('style_no_border'),
+    ] = config.get('style_no_border'),
     version: Annotated[
         bool,
         typer.Option(
@@ -147,7 +149,7 @@ def main(
             callback=setup_logging,
             hidden=True,
         ),
-    ] = settings.get('debug'),
+    ] = config.get('debug'),
 ):
     """obsws_cli is a command line interface for the OBS WebSocket API."""
     ctx.ensure_object(dict)

obsws_cli/config.py

@@ -0,0 +1,80 @@
+"""module for settings management for obsws-cli."""
+
+from collections import UserDict
+from pathlib import Path
+
+from dotenv import dotenv_values
+
+ConfigValue = str | int
+
+
+class Config(UserDict):
+    """A class to manage config for obsws-cli.
+
+    This class extends UserDict to provide a dictionary-like interface for config.
+    It loads config from environment variables and .env files.
+    The config values are expected to be in uppercase and should start with 'OBS_'.
+
+    Example:
+    -------
+        config = Config()
+        host = config['OBS_HOST']
+        config['OBS_PORT'] = 4455
+
+    """
+
+    PREFIX = 'OBS_'
+
+    def __init__(self, *args, **kwargs):
+        """Initialize the Settings object."""
+        kwargs.update(
+            {
+                **dotenv_values('.env'),
+                **dotenv_values(Path.home() / '.config' / 'obsws-cli' / 'obsws.env'),
+            }
+        )
+        super().__init__(*args, **kwargs)
+
+    def __getitem__(self, key: str) -> ConfigValue:
+        """Get a setting value by key."""
+        key = key.upper()
+        if not key.startswith(Config.PREFIX):
+            key = f'{Config.PREFIX}{key}'
+        return self.data[key]
+
+    def __setitem__(self, key: str, value: ConfigValue):
+        """Set a setting value by key."""
+        key = key.upper()
+        if not key.startswith(Config.PREFIX):
+            key = f'{Config.PREFIX}{key}'
+        self.data[key] = value
+
+
+_config = Config(
+    OBS_HOST='localhost',
+    OBS_PORT=4455,
+    OBS_PASSWORD='',
+    OBS_TIMEOUT=5,
+    OBS_DEBUG=False,
+    OBS_STYLE='disabled',
+    OBS_STYLE_NO_BORDER=False,
+)
+
+
+def get(key: str) -> ConfigValue:
+    """Get a setting value by key.
+
+    Args:
+    ----
+        key (str): The key of the config to retrieve.
+
+    Returns:
+    -------
+        The value of the config.
+
+    Raises:
+    ------
+        KeyError: If the key does not exist in the config.
+
+    """
+    return _config[key]

obsws_cli/media.py

@@ -0,0 +1,99 @@
+"""module containing commands for media inputs."""
+
+from typing import Annotated, Optional
+
+import typer
+
+from . import console, util
+from .alias import SubTyperAliasGroup
+
+app = typer.Typer(cls=SubTyperAliasGroup)
+
+
+@app.callback()
+def main():
+    """Commands for media inputs."""
+
+
+@app.command('cursor | c')
+def cursor(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str, typer.Argument(..., help='The name of the media input.')
+    ],
+    timecode: Annotated[
+        Optional[str],
+        typer.Argument(
+            ..., help='The timecode to set the cursor to (format: HH:MM:SS).'
+        ),
+    ] = None,
+):
+    """Get/set the cursor position of a media input."""
+    if timecode is None:
+        resp = ctx.obj['obsws'].get_media_input_status(input_name)
+        console.out.print(
+            f'Cursor for {console.highlight(ctx, input_name)} is at {util.milliseconds_to_timecode(resp.media_cursor)}.'
+        )
+        return
+
+    cursor_position = util.timecode_to_milliseconds(timecode)
+    ctx.obj['obsws'].set_media_input_cursor(input_name, cursor_position)
+    console.out.print(
+        f'Cursor for {console.highlight(ctx, input_name)} set to {timecode}.'
+    )
+
+
+@app.command('play | p')
+def play(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str, typer.Argument(..., help='The name of the media input.')
+    ],
+):
+    """Get/set the playing status of a media input."""
+    ctx.obj['obsws'].trigger_media_input_action(
+        input_name, 'OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PLAY'
+    )
+    console.out.print(f'Playing media input {console.highlight(ctx, input_name)}.')
+
+
+@app.command('pause | pa')
+def pause(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str, typer.Argument(..., help='The name of the media input.')
+    ],
+):
+    """Pause a media input."""
+    ctx.obj['obsws'].trigger_media_input_action(
+        input_name, 'OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PAUSE'
+    )
+    console.out.print(f'Paused media input {console.highlight(ctx, input_name)}.')
+
+
+@app.command('stop | s')
+def stop(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str, typer.Argument(..., help='The name of the media input.')
+    ],
+):
+    """Stop a media input."""
+    ctx.obj['obsws'].trigger_media_input_action(
+        input_name, 'OBS_WEBSOCKET_MEDIA_INPUT_ACTION_STOP'
+    )
+    console.out.print(f'Stopped media input {console.highlight(ctx, input_name)}.')
+
+
+@app.command('restart | r')
+def restart(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str, typer.Argument(..., help='The name of the media input.')
+    ],
+):
+    """Restart a media input."""
+    ctx.obj['obsws'].trigger_media_input_action(
+        input_name, 'OBS_WEBSOCKET_MEDIA_INPUT_ACTION_RESTART'
+    )
+    console.out.print(f'Restarted media input {console.highlight(ctx, input_name)}.')

obsws_cli/settings.py

@@ -1,80 +1,337 @@
-"""module for settings management for obsws-cli."""
+"""module for settings management."""
 
-from collections import UserDict
+from typing import Annotated, Optional
-from pathlib import Path
 
-from dotenv import dotenv_values
+import typer
+from rich.table import Table
+from rich.text import Text
 
-SettingsValue = str | int
+from . import console, util
+from .alias import SubTyperAliasGroup
+
+app = typer.Typer(cls=SubTyperAliasGroup)
 
 
-class Settings(UserDict):
+@app.callback()
-    """A class to manage settings for obsws-cli.
+def main():
+    """Manage OBS settings."""
 
-    This class extends UserDict to provide a dictionary-like interface for settings.
-    It loads settings from environment variables and .env files.
-    The settings are expected to be in uppercase and should start with 'OBS_'.
 
-    Example:
+@app.command('show | sh')
-    -------
+def show(
-        settings = Settings()
+    ctx: typer.Context,
-        host = settings['OBS_HOST']
+    video: Annotated[
-        settings['OBS_PORT'] = 4455
+        bool, typer.Option('--video', '-v', help='Show video settings.')
+    ] = False,
+    record: Annotated[
+        bool, typer.Option('--record', '-r', help='Show recording settings.')
+    ] = False,
+    profile: Annotated[
+        bool, typer.Option('--profile', '-p', help='Show profile settings.')
+    ] = False,
+):
+    """Show current OBS settings."""
+    if not any([video, record, profile]):
+        video = True
+        record = True
+        profile = True
 
-    """
+    resp = ctx.obj['obsws'].get_video_settings()
-
+    video_table = Table(
-    PREFIX = 'OBS_'
+        title='Video Settings',
-
+        padding=(0, 2),
-    def __init__(self, *args, **kwargs):
+        border_style=ctx.obj['style'].border,
-        """Initialize the Settings object."""
+    )
-        kwargs.update(
+    video_columns = (
-            {
+        ('Setting', 'left', ctx.obj['style'].column),
-                **dotenv_values('.env'),
+        ('Value', 'left', ctx.obj['style'].column),
-                **dotenv_values(Path.home() / '.config' / 'obsws-cli' / 'obsws.env'),
-            }
     )
-        super().__init__(*args, **kwargs)
 
-    def __getitem__(self, key: str) -> SettingsValue:
+    for header_text, justify, style in video_columns:
-        """Get a setting value by key."""
+        video_table.add_column(
-        key = key.upper()
+            Text(header_text, justify='center'),
-        if not key.startswith(Settings.PREFIX):
+            justify=justify,
-            key = f'{Settings.PREFIX}{key}'
+            style=style,
-        return self.data[key]
+        )
 
-    def __setitem__(self, key: str, value: SettingsValue):
+    for setting in resp.attrs():
-        """Set a setting value by key."""
+        video_table.add_row(
-        key = key.upper()
+            util.snakecase_to_titlecase(setting),
-        if not key.startswith(Settings.PREFIX):
+            str(getattr(resp, setting)),
-            key = f'{Settings.PREFIX}{key}'
+            style='' if video_table.row_count % 2 == 0 else 'dim',
-        self.data[key] = value
+        )
+
+    if video:
+        console.out.print(video_table)
+
+    resp = ctx.obj['obsws'].get_record_directory()
+    record_table = Table(
+        title='Recording Settings',
+        padding=(0, 2),
+        border_style=ctx.obj['style'].border,
+    )
+    record_columns = (
+        ('Setting', 'left', ctx.obj['style'].column),
+        ('Value', 'left', ctx.obj['style'].column),
+    )
+    for header_text, justify, style in record_columns:
+        record_table.add_column(
+            Text(header_text, justify='center'),
+            justify=justify,
+            style=style,
+        )
+
+    record_table.add_row(
+        'Directory',
+        resp.record_directory,
+        style='' if record_table.row_count % 2 == 0 else 'dim',
+    )
+
+    if record:
+        console.out.print(record_table)
+
+    profile_table = Table(
+        title='Profile Settings',
+        padding=(0, 2),
+        border_style=ctx.obj['style'].border,
+    )
+    profile_columns = (
+        ('Setting', 'left', ctx.obj['style'].column),
+        ('Value', 'left', ctx.obj['style'].column),
+    )
+    for header_text, justify, style in profile_columns:
+        profile_table.add_column(
+            Text(header_text, justify='center'),
+            justify=justify,
+            style=style,
+        )
+
+    params = [
+        ('Output', 'Mode', 'Output Mode'),
+        ('SimpleOutput', 'StreamEncoder', 'Simple Streaming Encoder'),
+        ('SimpleOutput', 'RecEncoder', 'Simple Recording Encoder'),
+        ('SimpleOutput', 'RecFormat2', 'Simple Recording Video Format'),
+        ('SimpleOutput', 'RecAudioEncoder', 'Simple Recording Audio Format'),
+        ('SimpleOutput', 'RecQuality', 'Simple Recording Quality'),
+        ('AdvOut', 'Encoder', 'Advanced Streaming Encoder'),
+        ('AdvOut', 'RecEncoder', 'Advanced Recording Encoder'),
+        ('AdvOut', 'RecType', 'Advanced Recording Type'),
+        ('AdvOut', 'RecFormat2', 'Advanced Recording Video Format'),
+        ('AdvOut', 'RecAudioEncoder', 'Advanced Recording Audio Format'),
+    ]
+
+    for category, name, display_name in params:
+        resp = ctx.obj['obsws'].get_profile_parameter(
+            category=category,
+            name=name,
+        )
+        if resp.parameter_value is not None:
+            profile_table.add_row(
+                display_name,
+                str(resp.parameter_value),
+                style='' if profile_table.row_count % 2 == 0 else 'dim',
+            )
+
+    if profile:
+        console.out.print(profile_table)
 
 
-_settings = Settings(
+@app.command('profile | pr')
-    OBS_HOST='localhost',
+def profile(
-    OBS_PORT=4455,
+    ctx: typer.Context,
-    OBS_PASSWORD='',
+    category: Annotated[
-    OBS_TIMEOUT=5,
+        str,
-    OBS_DEBUG=False,
+        typer.Argument(
-    OBS_STYLE='disabled',
+            ...,
-    OBS_STYLE_NO_BORDER=False,
+            help='Profile parameter category (e.g., SimpleOutput, AdvOut).',
+        ),
+    ],
+    name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            help='Profile parameter name (e.g., StreamEncoder, RecFormat2).',
+        ),
+    ],
+    value: Annotated[
+        Optional[str],
+        typer.Argument(
+            ...,
+            help='Value to set for the profile parameter. If omitted, the current value is retrieved.',
+        ),
+    ] = None,
+):
+    """Get/set OBS profile settings."""
+    if value is None:
+        resp = ctx.obj['obsws'].get_profile_parameter(
+            category=category,
+            name=name,
+        )
+        console.out.print(
+            f'Parameter Value for [bold]{name}[/bold]: '
+            f'[green]{resp.parameter_value}[/green]'
+        )
+    else:
+        ctx.obj['obsws'].set_profile_parameter(
+            category=category,
+            name=name,
+            value=value,
+        )
+        console.out.print(
+            f'Set Parameter [bold]{name}[/bold] to [green]{value}[/green]'
         )
 
 
-def get(key: str) -> SettingsValue:
+@app.command('stream-service | ss')
-    """Get a setting value by key.
+def stream_service(
+    ctx: typer.Context,
+    type_: Annotated[
+        Optional[str],
+        typer.Argument(
+            ...,
+            help='Stream service type (e.g., Twitch, YouTube). If omitted, current settings are retrieved.',
+        ),
+    ] = None,
+    key: Annotated[
+        Optional[str],
+        typer.Option('--key', '-k', help='Stream key to set. Optional.'),
+    ] = None,
+    server: Annotated[
+        Optional[str],
+        typer.Option('--server', '-s', help='Stream server to set. Optional.'),
+    ] = None,
+):
+    """Get/set OBS stream service settings."""
+    if type_ is None:
+        resp = ctx.obj['obsws'].get_stream_service_settings()
+        table = Table(
+            title='Stream Service Settings',
+            padding=(0, 2),
+            border_style=ctx.obj['style'].border,
+        )
+        columns = (
+            ('Setting', 'left', ctx.obj['style'].column),
+            ('Value', 'left', ctx.obj['style'].column),
+        )
+        for header_text, justify, style in columns:
+            table.add_column(
+                Text(header_text, justify='center'),
+                justify=justify,
+                style=style,
+            )
+        table.add_row(
+            'Type',
+            resp.stream_service_type,
+            style='' if table.row_count % 2 == 0 else 'dim',
+        )
+        table.add_row(
+            'Server',
+            resp.stream_service_settings.get('server', ''),
+            style='' if table.row_count % 2 == 0 else 'dim',
+        )
+        table.add_row(
+            'Key',
+            resp.stream_service_settings.get('key', ''),
+            style='' if table.row_count % 2 == 0 else 'dim',
+        )
+        console.out.print(table)
+    else:
+        current_settings = ctx.obj['obsws'].get_stream_service_settings()
+        if key is None:
+            key = current_settings.stream_service_settings.get('key', '')
+        if server is None:
+            server = current_settings.stream_service_settings.get('server', '')
 
-    Args:
+        ctx.obj['obsws'].set_stream_service_settings(
-    ----
+            ss_type=type_,
-        key (str): The key of the setting to retrieve.
+            ss_settings={'key': key, 'server': server},
+        )
+        console.out.print('Stream service settings updated.')
 
-    Returns:
-    -------
-        The value of the setting.
 
-    Raises:
+@app.command('video | vi')
-    ------
+def video(
-        KeyError: If the key does not exist in the settings.
+    ctx: typer.Context,
+    base_width: Annotated[
+        Optional[int],
+        typer.Option('--base-width', '-bw', help='Set base (canvas) width.'),
+    ] = None,
+    base_height: Annotated[
+        Optional[int],
+        typer.Option('--base-height', '-bh', help='Set base (canvas) height.'),
+    ] = None,
+    output_width: Annotated[
+        Optional[int],
+        typer.Option('--output-width', '-ow', help='Set output (scaled) width.'),
+    ] = None,
+    output_height: Annotated[
+        Optional[int],
+        typer.Option('--output-height', '-oh', help='Set output (scaled) height.'),
+    ] = None,
+    fps_num: Annotated[
+        Optional[int],
+        typer.Option('--fps-num', '-fn', help='Set FPS numerator.'),
+    ] = None,
+    fps_den: Annotated[
+        Optional[int],
+        typer.Option('--fps-den', '-fd', help='Set FPS denominator.'),
+    ] = None,
+):
+    """Get/set OBS video settings."""
+    if not any(
+        [
+            base_width,
+            base_height,
+            output_width,
+            output_height,
+            fps_num,
+            fps_den,
+        ]
+    ):
+        resp = ctx.obj['obsws'].get_video_settings()
+        table = Table(
+            title='Video Settings',
+            padding=(0, 2),
+            border_style=ctx.obj['style'].border,
+        )
+        columns = (
+            ('Setting', 'left', ctx.obj['style'].column),
+            ('Value', 'left', ctx.obj['style'].column),
+        )
+        for header_text, justify, style in columns:
+            table.add_column(
+                Text(header_text, justify='center'),
+                justify=justify,
+                style=style,
+            )
+        for setting in resp.attrs():
+            table.add_row(
+                util.snakecase_to_titlecase(setting),
+                str(getattr(resp, setting)),
+                style='' if table.row_count % 2 == 0 else 'dim',
+            )
+        console.out.print(table)
+    else:
+        current_settings = ctx.obj['obsws'].get_video_settings()
+        if base_width is None:
+            base_width = current_settings.base_width
+        if base_height is None:
+            base_height = current_settings.base_height
+        if output_width is None:
+            output_width = current_settings.output_width
+        if output_height is None:
+            output_height = current_settings.output_height
+        if fps_num is None:
+            fps_num = current_settings.fps_num
+        if fps_den is None:
+            fps_den = current_settings.fps_den
 
-    """
+        ctx.obj['obsws'].set_video_settings(
-    return _settings[key]
+            base_width=base_width,
+            base_height=base_height,
+            out_width=output_width,
+            out_height=output_height,
+            numerator=fps_num,
+            denominator=fps_den,
+        )
+        console.out.print('Video settings updated.')

obsws_cli/util.py

@@ -20,3 +20,28 @@ def check_mark(value: bool, empty_if_false: bool = False) -> str:
     if os.getenv('NO_COLOR', '') != '':
         return '✓' if value else '✗'
     return '✅' if value else '❌'
+
+
+def timecode_to_milliseconds(timecode: str) -> int:
+    """Convert a timecode string (HH:MM:SS) to total milliseconds."""
+    match timecode.split(':'):
+        case [mm, ss]:
+            hours = 0
+            minutes = int(mm)
+            seconds = int(ss)
+        case [hh, mm, ss]:
+            hours = int(hh)
+            minutes = int(mm)
+            seconds = int(ss)
+    return (hours * 3600 + minutes * 60 + seconds) * 1000
+
+
+def milliseconds_to_timecode(milliseconds: int) -> str:
+    """Convert total milliseconds to a timecode string (HH:MM:SS)."""
+    total_seconds = milliseconds // 1000
+    hours = total_seconds // 3600
+    minutes = (total_seconds % 3600) // 60
+    seconds = total_seconds % 60
+    if hours == 0:
+        return f'{minutes:02}:{seconds:02}'
+    return f'{hours:02}:{minutes:02}:{seconds:02}'