Compare commits

..

85 Commits

Author SHA1 Message Date
024cc263d4 update completion tags
bump kong-completion version
2026-04-11 01:21:22 +01:00
888d84472e remove replace directive 2026-03-30 09:52:54 +01:00
e3b42e31ca regen gitignore 2026-03-27 14:09:23 +00:00
acf7bc79b2 add local path dep for kong-completion
update the completion tags
2026-03-25 21:08:36 +00:00
e5e0ac3dcf add pre-commit config 2026-03-21 13:58:38 +00:00
f5da566c99 Merge pull request #8 from onyx-and-iris/dependabot/go_modules/github.com/buger/jsonparser-1.1.2
Bump github.com/buger/jsonparser from 1.1.1 to 1.1.2
2026-03-21 03:56:07 +00:00
dependabot[bot]
fa52ccd0f7 Bump github.com/buger/jsonparser from 1.1.1 to 1.1.2
Bumps [github.com/buger/jsonparser](https://github.com/buger/jsonparser) from 1.1.1 to 1.1.2.
- [Release notes](https://github.com/buger/jsonparser/releases)
- [Commits](https://github.com/buger/jsonparser/compare/v1.1.1...v1.1.2)

---
updated-dependencies:
- dependency-name: github.com/buger/jsonparser
  dependency-version: 1.1.2
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-03-21 03:55:48 +00:00
github-actions[bot]
214dccad5b chore: auto-update Go modules 2026-03-16 00:47:47 +00:00
github-actions[bot]
5f3f1f1e88 chore: auto-update Go modules 2026-03-09 00:42:10 +00:00
github-actions[bot]
096104c60e chore: auto-update Go modules 2026-03-02 00:41:41 +00:00
github-actions[bot]
2a6969b93e chore: auto-update Go modules 2026-02-23 00:42:46 +00:00
626600e32a rewrite version func 2026-02-16 01:25:07 +00:00
github-actions[bot]
1614194cbd chore: auto-update Go modules 2026-02-16 00:43:08 +00:00
31c98745d3 add issue report limits 2026-02-15 10:45:57 +00:00
2a9b88b7f8 lint fixes 2026-02-15 10:43:49 +00:00
4f42aa7f36 migrate golangci-lint config to v2
upd conglangci-lint action
2026-02-15 10:43:35 +00:00
7d41439ad6 move connectObs 2026-02-13 08:04:44 +00:00
github-actions[bot]
6320afdc18 chore: auto-update Go modules 2026-02-09 00:43:48 +00:00
b9c352ad82 reword 2026-02-07 05:30:18 +00:00
04305ea51b upd shell completion 2026-02-07 05:27:06 +00:00
github-actions[bot]
13118251c1 chore: auto-update Go modules 2026-02-02 02:43:15 +00:00
cb1bcb5aae add chore: to changelog filter 2026-01-28 21:37:02 +00:00
072afc86dd add 0.18.2 to CHANGELOG 2026-01-24 20:13:07 +00:00
6a629ec3e9 replace emoji-style tick/cross + N/A with cleaner symbols.
update screenshots.
2026-01-24 20:09:22 +00:00
7855ce5d54 add update-go-modules action 2026-01-24 01:01:56 +00:00
6e94157c15 move obs connection logic into run() so we can exit early when running completion 2026-01-24 00:52:53 +00:00
cbd518ca0f add 0.18.0 to CHANGELOG 2026-01-23 19:29:35 +00:00
2f0f9bd904 add support for shell completion 2026-01-23 17:09:11 +00:00
88d41fd700 add aliases for media subcommands 2026-01-09 19:58:43 +00:00
eab9303af7 fix media cursor in README 2026-01-09 19:34:45 +00:00
031d03a625 add 0.17.0 to CHANGELOG 2026-01-09 19:23:13 +00:00
f84e126381 rename media-input to media
replace set-cursor with cursor which can now get/set cursor position
2026-01-09 19:23:13 +00:00
cb4898f2d4 add MediaInputCmd to README 2026-01-09 19:23:13 +00:00
a652b44992 parse timeStr function now returns milliseconds. 2026-01-09 19:23:13 +00:00
f6fbf3c81f implement mediainput command group
note, set-cursor not currently working, possible bug in goobs
2026-01-09 19:21:56 +00:00
f84908f668 remove --show flag from settings video
update README
2026-01-09 12:42:14 +00:00
3ffdf668ff make Type arg optional, if not passed print current stream service settings.
this is a bugfix.
2026-01-09 11:54:55 +00:00
6e37c2c6c7 add settings command group to CHANGELOG. Bump version. 2026-01-08 18:24:48 +00:00
bc6cf46b98 add Settings section to README 2026-01-08 18:20:37 +00:00
51224583c8 implement settings command group
show and profile set were prototyped in:
https://github.com/nzoschke/gobs-cli/blob/config/settings.go
2026-01-08 18:20:22 +00:00
6cdc12790a Merge branch 'input' 2026-01-08 15:41:07 +00:00
8a5ce67ba0 add 0.15.0 to CHANGELOG 2026-01-08 15:36:12 +00:00
474693e0f7 add new input subcommands to README 2026-01-08 15:33:56 +00:00
a960c9ffa5 reorder commands
add input kind-defaults
2026-01-08 15:31:02 +00:00
8ce8727a0a rename input kinds to input list-kinds
rename input delete to input remove

add input volume
2026-01-08 14:14:40 +00:00
Noah Zoschke
fba7c4ce20 format 2025-07-30 07:02:27 -07:00
1cf983a647 add 500ms delays to tests 2025-07-30 08:40:41 +01:00
dbc26bf6ff upd delays to 500ms 2025-07-30 08:40:26 +01:00
Noah Zoschke
c5e7bb4e1a delete 2025-07-29 16:35:10 -07:00
Noah Zoschke
e087fdefe3 update 2025-07-29 16:29:52 -07:00
Noah Zoschke
bd4a6cad4b show verbose 2025-07-29 16:18:56 -07:00
Noah Zoschke
72fc7d4092 kinds 2025-07-29 15:55:44 -07:00
Noah Zoschke
cb735cd666 show 2025-07-29 15:33:22 -07:00
Noah Zoschke
db70f8766d create input 2025-07-29 14:30:49 -07:00
101c7552b2 ensure Mic/Aux is created as well as Desktop Audio
add option to read the OBS platform from env var
2025-07-29 06:54:23 +01:00
1c0ef025c1 add mac build to Taskfile 2025-07-24 00:15:53 +01:00
2b7b8e0bd5 set inputKind for each platform 2025-07-24 00:15:00 +01:00
040ece840c allow skip group tests
enable replay buffer in test setup()
create Desktop Audio input if it doesn't exist.
2025-07-21 14:33:00 +01:00
c6406888a9 display (empty) if no text is set 2025-07-14 03:44:12 +01:00
f65af8298d add 0.14.0 to CHANGELOG 2025-07-14 03:34:18 +01:00
1dfb6f87ac add TextCmd to README 2025-07-14 03:33:58 +01:00
866aedde7c add text command group 2025-07-14 03:33:49 +01:00
9eb6c8a282 use red in example 2025-06-27 13:53:55 +01:00
eb30cae5b7 add 0.13.3 to CHANGELOG 2025-06-27 13:51:42 +01:00
e6c03a2c92 add style to ToC 2025-06-27 13:49:34 +01:00
f6b82383f9 add ToC to README
move style section.

add imgs
2025-06-27 13:48:17 +01:00
55f3b0c981 fix item id alignment 2025-06-27 13:38:51 +01:00
7da80a1ad2 fix patch number... 2025-06-26 12:15:36 +01:00
ea4ca2aeb9 fix patch number 2025-06-26 12:14:40 +01:00
d2f0a64180 changes to help:
- print help on error
- print in compact mode

move version + VersionFlag into main
store version in kong.Vars

add 0.13.3 to CHANGELOG
2025-06-26 12:13:32 +01:00
f01fd0ca84 check if output is paused before attempting record split/chapter.
add note to changelog about supported file format for record chapter.
2025-06-23 08:28:49 +01:00
10d50df445 add 0.13.0 to CHANGELOG 2025-06-23 08:03:52 +01:00
06cefe58ed add record split and record chapter commands 2025-06-23 08:02:31 +01:00
7cd1c78f6a add --no-border to 0.12.1 Added 2025-06-21 20:29:42 +01:00
842d98edd3 upd Style section in README
add example
2025-06-21 20:27:46 +01:00
930b387b85 newContext now requires a StyleConfig, update tests. 2025-06-21 20:27:17 +01:00
2ab1c5bfc3 if --no-border is set, disable the border styling 2025-06-21 20:25:48 +01:00
08f23fe47d add --no-border flag
use it to disable table border styling
2025-06-21 20:25:19 +01:00
bbc6aec230 add note about style env var in README
add 0.12.0 to CHANGELOG
2025-06-21 06:59:36 +01:00
5d0ed2a166 fix --style shortname
add Style section to README
2025-06-21 06:47:25 +01:00
62579b1c5e upd docstrings 2025-06-21 06:44:16 +01:00
9ed00cd67c return colourless check/cross marks if NO_COLOR is set 2025-06-21 06:44:08 +01:00
69bfaf694d add context factory method to tests
update scene_test outputs
2025-06-21 06:43:38 +01:00
7147c3f1ca style tables and add out/err highlights
improve projector open error message if an invalid monitor index is passed.
it now prints the monitor name and suggests `gobs-cli prj ls-m`

improve error message for sceneitem commands if a scene item in a group is queried without the --group flag.
2025-06-21 06:41:12 +01:00
d699939298 add --style flag to root command
define styles
2025-06-21 06:36:05 +01:00
46 changed files with 2726 additions and 550 deletions

View File

@@ -2,11 +2,11 @@ name: CI
on: on:
push: push:
branches: [ "main" ] branches: ['main']
paths: paths:
- '**.go' - '**.go'
pull_request: pull_request:
branches: [ "main" ] branches: ['main']
paths: paths:
- '**.go' - '**.go'
jobs: jobs:
@@ -23,7 +23,8 @@ jobs:
uses: actions/setup-go@v5 uses: actions/setup-go@v5
with: with:
go-version: '1.24' go-version: '1.24'
- name: Install golangci-lint - name: golangci-lint
run: go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest uses: golangci/golangci-lint-action@v9
- name: Run golangci-lint with:
run: golangci-lint run ./... version: v2.6.0
args: --config .golangci.yml

30
.github/workflows/update-go-modules.yml vendored Normal file
View File

@@ -0,0 +1,30 @@
name: Auto-Update Go Modules
on:
schedule:
- cron: '0 0 * * 1' # Runs every Monday at midnight
jobs:
update-go-modules:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout Code
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: stable
- name: Update Dependencies
run: |
go get -u ./...
go mod tidy
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git add go.mod go.sum
git commit -m "chore: auto-update Go modules"
git push

24
.gitignore vendored
View File

@@ -1,6 +1,6 @@
# Auto-generated .gitignore by gignore: github.com/onyx-and-iris/gignore # Generated by ignr: github.com/onyx-and-iris/ignr
### Go ### ## Go ##
# If you prefer the allow list template instead of the deny list, see community template: # If you prefer the allow list template instead of the deny list, see community template:
# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore # https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
# #
@@ -15,23 +15,27 @@ bin/
# Test binary, built with `go test -c` # Test binary, built with `go test -c`
*.test *.test
# Output of the go coverage tool, specifically when used with LiteIDE # Code coverage profiles and other test artifacts
*.out *.out
coverage.*
*.coverprofile
profile.cov
# Dependency directories (remove the comment below to include it) # Dependency directories (remove the comment below to include it)
# vendor/ # vendor/
# Go workspace file # Go workspace file
go.work go.work
go.work.sum
# End of gignore: github.com/onyx-and-iris/gignore # env file
# Environment
.env .env
.envrc
# Editor/IDE
# .idea/
# .vscode/
# End of ignr
# Man pages # Man pages
gobs-cli.1 gobs-cli.1
# Config files
config.yaml

View File

@@ -1,55 +1,144 @@
version: '2'
run: run:
# timeout for analysis, e.g. 30s, 3m, default is 1m
timeout: 3m timeout: 3m
# exclude test files
tests: true tests: true
go: '1.24'
linters: linters:
# Set to true runs only fast linters. disable: [dupl]
# Good option for 'lint on save', pre-commit hook or CI.
fast: true
disable-all: true
enable: enable:
- gosimple # Default enabled linters
- govet - errcheck # Check for unchecked errors
- ineffassign - govet # Go's built-in vetting tool
- staticcheck - ineffassign # Detect ineffectual assignments
- unused - staticcheck # Advanced static analysis
- gofmt - unused # Check for unused code
- gofumpt # Additional useful linters
- misspell - misspell # Detect common misspellings
- unparam - unparam # Check for unused function parameters
- gosec - gosec # Security checks
- asciicheck - asciicheck # Check for non-ASCII characters
- errname - errname # Check error variable names
- gci - godot # Check for missing periods in comments
- godot - revive # Highly configurable linter for style and correctness
- goimports - gocritic # Detect code issues and suggest improvements
- revive - gocyclo # Check for cyclomatic complexity
- dupl # Check for code duplication
- predeclared # Check for shadowing of predeclared identifiers
- copyloopvar # Check for loop variable capture in goroutines
- errorlint # Check for common mistakes in error handling
- goconst # Check for repeated strings that could be constants
- gosmopolitan # Check for non-portable code
linters-settings: settings:
gofmt: misspell:
rewrite-rules: locale: UK
- pattern: 'interface{}'
replacement: 'any'
- pattern: 'a[b:len(a)]'
replacement: 'a[b:]'
misspell: errcheck:
locale: UK check-type-assertions: true
check-blank: true
exclude-functions:
- fmt.Fprintf
- fmt.Fprintln
- fmt.Printf
- fmt.Println
- fmt.Errorf
errcheck: revive:
check-type-assertions: true severity: warning
rules:
# Code quality and style
- name: exported
arguments:
- 'checkPrivateReceivers'
- 'sayRepetitiveInsteadOfStutters'
- name: var-naming
- name: package-comments
- name: range-val-in-closure
- name: time-naming
- name: context-as-argument
- name: context-keys-type
- name: dot-imports
- name: empty-block
- name: error-return
- name: error-strings
- name: error-naming
- name: if-return
- name: increment-decrement
- name: indent-error-flow
- name: receiver-naming
- name: redefines-builtin-id
- name: superfluous-else
- name: unexported-return
- name: unreachable-code
- name: unused-parameter
- name: var-declaration
- name: blank-imports
- name: range
# Disabled rules (can be enabled if needed)
# - name: line-length-limit
# arguments: [120]
# - name: function-length
# arguments: [50, 0]
# - name: cyclomatic
# arguments: [10]
gosec:
excludes:
- G104 # Duplicated errcheck checks
- G115 # integer overflow conversion int -> uint32
exclusions:
warn-unused: false
rules:
# Exclude specific linters for test files
- path: _test\.go
linters:
- gocyclo
- errcheck
- dupl
- gosec
- misspell
- golines
paths:
- vendor
# Formatters configuration
formatters:
# Enable specific formatters
enable:
- gofumpt # Stricter gofmt alternative
- goimports # Organizes imports
- gci # Controls import order/grouping
- golines # Enforces line length
# Formatter-specific settings
settings:
goimports:
local-prefixes: [github.com/onyx-and-iris/gobs-cli]
gci:
# Define import sections order
sections:
- standard # Standard library
- default # Everything else
- prefix(github.com/onyx-and-iris/gobs-cli) # Current module
gofumpt:
extra-rules: true # Enable additional formatting rules
exclusions:
warn-unused: true
paths:
- vendor
issues: issues:
max-same-issues: 0 # Limit the number of same issues reported to avoid spam
max-issues-per-linter: 0 max-same-issues: 50
exclude-use-default: false
exclude: # Limit the number of issues per linter to keep output manageable
# gosec: Duplicated errcheck checks max-issues-per-linter: 100
- G104
exclude-files:
# Exclude vendor directory
- main_test.go

View File

@@ -39,6 +39,7 @@ changelog:
exclude: exclude:
- '^docs:' - '^docs:'
- '^test:' - '^test:'
- '^chore:'
release: release:
footer: >- footer: >-

5
.pre-commit-config.yaml Normal file
View File

@@ -0,0 +1,5 @@
repos:
- repo: https://github.com/tekwizely/pre-commit-golang
rev: v1.0.0-rc.4
hooks:
- id: go-mod-tidy

View File

@@ -5,6 +5,69 @@ 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.2] - 2026-01-23
### Added
- support for shell completion, see [Shell Completion](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#shell-completion)
### Changed
- emoji-style ✅, ❌ replaced with cleaner ●, ○. See [Style](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#style)
# [0.17.0] - 2026-01-09
### Added
- media command group, see [MediaCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#mediacmd)
# [0.16.2] - 2026-01-08
### Added
- new subcommands added to input, see [InputCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#inputcmd)
- settings command group, see [SettingsCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#settingscmd)
# [0.14.1] - 2025-07-14
### Added
- text command group, see [TextCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#textcmd)
# [0.13.3] - 2025-06-27
### Changed
- usage is now printed on errors.
- help is printed in compact mode. This should make it easier to page through help on the root command.
### Fixed
- Item ID alignment in sceneitem list table.
# [0.13.0] - 2025-06-23
### Added
- record split and record chapter commands, see [RecordCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#recordcmd)
- As of OBS 30.2.0, the only file format supporting *record chapter* is Hybrid MP4.
# [0.12.1] - 2025-06-21
### Added
- Various colouring styles, see [Style](https://github.com/onyx-and-iris/gobs-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.
### Changed
- if an itemName is passed to a sceneitem command that's in a group, without the --group flag, a friendlier error message is displayed.
- it will suggest using *gobs-cli si ls* to list sources in the scene.
- if an invalid --monitor-index is passed to projector open a friendlier error message is displayed.
- it will suggest using *gobs-cli prj ls-m* to list available monitors.
# [0.11.0] - 2025-06-20 # [0.11.0] - 2025-06-20
### Added ### Added

237
README.md
View File

@@ -4,6 +4,17 @@ A command line interface for OBS Websocket v5
For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md) For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
-----
## Table of Contents
- [Installation](#installation)
- [Configuration](#configuration)
- [Style](#style)
- [Commands](#commands)
- [Shell Completion](#shell-completion)
- [License](#license)
## Installation ## Installation
```console ```console
@@ -40,6 +51,36 @@ OBS_PASSWORD=<websocket password>
OBS_TIMEOUT=5 OBS_TIMEOUT=5
``` ```
## Style
Styling is opt-in, by default you will get a colourless output:
![colourless](./img/colourless.png)
You may enable styling with the --style/-s flag:
```console
gobs-cli --style="red" sceneitem list
```
Available styles: _red, magenta, purple, blue, cyan, green, yellow, orange, white, grey, navy, black_
![coloured](./img/coloured-border.png)
Optionally you may disable border colouring with the --no-border flag:
![coloured-no-border](./img/coloured-no-border.png)
```console
gobs-cli --style="red" --no-border sceneitem list
```
Or with environment variables:
```env
GOBS_STYLE=red
GOBS_STYLE_NO_BORDER=true
```
## Commands ## Commands
@@ -224,6 +265,20 @@ gobs-cli group status START "test_group"
### InputCmd ### InputCmd
- create: Create input.
- args: Name Kind
```console
gobs-cli input create 'stream mix' 'wasapi_input_capture'
```
- remove: Remove input.
- args: Name
```console
gobs-cli input remove 'stream mix'
```
- list: List all inputs. - list: List all inputs.
- flags: - flags:
@@ -241,6 +296,12 @@ gobs-cli input list
gobs-cli input list --input --colour gobs-cli input list --input --colour
``` ```
- list-kinds: List input kinds.
```console
gobs-cli input list-kinds
```
- mute: Mute input. - mute: Mute input.
- args: InputName - args: InputName
@@ -262,6 +323,50 @@ gobs-cli input unmute "Mic/Aux"
gobs-cli input toggle "Mic/Aux" gobs-cli input toggle "Mic/Aux"
``` ```
- volume: Set input volume.
- args: InputName Volume
```console
gobs-cli input volume -- 'Mic/Aux' -30.6
```
- show: Show input details.
- args: Name
- flags:
*optional*
- --verbose: List all available input devices.
- update: Update input settings.
- args: InputName DeviceName
```console
gobs-cli input update 'Mic/Aux' 'Voicemeeter Out B1 (VB-Audio Voicemeeter VAIO)'
```
- kind-defaults: Get default settings for an input kind.
- args: Kind
```console
gobs-cli input kind-defaults 'wasapi_input_capture'
```
### TextCmd
- current: Display current text for a text input.
- args: InputName
```console
gobs-cli text current "My Text Input"
```
- update: Update the text of a text input.
- args: InputName NewText
```console
gobs-cli text update "My Text Input" "hi OBS!"
```
### RecordCmd ### RecordCmd
- start: Start recording. - start: Start recording.
@@ -313,6 +418,21 @@ gobs-cli record directory "/home/me/obs-vids/"
gobs-cli record directory "C:/Users/me/Videos" gobs-cli record directory "C:/Users/me/Videos"
``` ```
- split: Split recording.
```console
gobs-cli record split
```
- chapter: Create a chapter in the recording.
*optional*
- arg: ChapterName
```console
gobs-cli record chapter "Chapter Name"
```
### StreamCmd ### StreamCmd
- start: Start streaming. - start: Start streaming.
@@ -606,6 +726,121 @@ gobs-cli projector open --monitor-index=1 "test_group"
gobs-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\screenshot.png" gobs-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\screenshot.png"
``` ```
### SettingsCmd
- show: Show settings.
- flags:
*optional*
- --video: Show video settings.
- --record: Show record directory.
- --profile: Show profile parameters.
```console
gobs-cli settings show --video --record
```
- profile: Get/Set profile parameter setting.
- args: Category Name Value
```console
gobs-cli settings profile SimpleOutput VBitrate
gobs-cli settings profile SimpleOutput VBitrate 6000
```
- stream-service: Get/Set stream service setting.
- flags:
- --key: Stream key.
- --server: Stream server URL.
*optional*
- args: Type
```console
gobs-cli settings stream-service
gobs-cli settings stream-service --key='live_xyzxyzxyzxyz' rtmp_common
```
- video: Get/Set video setting.
- 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
gobs-cli settings video
gobs-cli settings video --base-width=1920 --base-height=1080
```
### MediaCmd
- cursor: Get/set the cursor position of a media input.
- args: InputName
*optional*
- TimeString
```console
gobs-cli media cursor "Media"
gobs-cli media cursor "Media" "00:08:30"
```
- play: Plays a media input.
```console
gobs-cli media play "Media"
```
- pause: Pauses a media input.
```console
gobs-cli media pause "Media"
```
- stop: Stops a media input.
```console
gobs-cli media stop "Media"
```
- restart: Restarts a media input.
```console
gobs-cli media restart "Media"
```
## Shell Completion
- completion:
*optional*
- args: Shell
- If no shell is passed completion will attempt to detect the current login shell.
```console
gobs-cli completion
gobs-cli completion bash
```
Currently supported shells: *bash* *zsh* *fish*.
## License
`gobs-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
[userconfigdir]: https://pkg.go.dev/os#UserConfigDir [userconfigdir]: https://pkg.go.dev/os#UserConfigDir
[obs-keyids]: https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h [obs-keyids]: https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h
[no-colour]: https://no-color.org/

View File

@@ -22,6 +22,7 @@ tasks:
cmds: cmds:
- task: build-windows - task: build-windows
- task: build-linux - task: build-linux
- task: build-macos
vet: vet:
desc: Vet the code desc: Vet the code
@@ -46,6 +47,12 @@ tasks:
- GOOS=linux GOARCH=amd64 go build -ldflags "-X 'main.version={{.VERSION}}'" -o {{.BIN_DIR}}/{{.PROGRAM}}_linux_amd64 - GOOS=linux GOARCH=amd64 go build -ldflags "-X 'main.version={{.VERSION}}'" -o {{.BIN_DIR}}/{{.PROGRAM}}_linux_amd64
internal: true internal: true
build-macos:
desc: Build the gobs-cli project for macOS
cmds:
- GOOS=darwin GOARCH=amd64 go build -ldflags "-X 'main.version={{.VERSION}}'" -o {{.BIN_DIR}}/{{.PROGRAM}}_darwin_amd64
internal: true
test: test:
desc: Run tests desc: Run tests
cmds: cmds:

View File

@@ -7,16 +7,17 @@ import (
"strings" "strings"
"github.com/andreykaipov/goobs/api/requests/filters" "github.com/andreykaipov/goobs/api/requests/filters"
"github.com/aquasecurity/table" "github.com/charmbracelet/lipgloss"
"github.com/charmbracelet/lipgloss/table"
) )
// FilterCmd provides commands to manage filters in OBS Studio. // FilterCmd provides commands to manage filters in OBS Studio.
type FilterCmd struct { type FilterCmd struct {
List FilterListCmd `cmd:"" help:"List all filters." aliases:"ls"` List FilterListCmd `cmd:"" help:"List all filters." aliases:"ls" completion-enabled-command-alias:"false"`
Enable FilterEnableCmd `cmd:"" help:"Enable filter." aliases:"on"` Enable FilterEnableCmd `cmd:"" help:"Enable filter." aliases:"on" completion-enabled-command-alias:"false"`
Disable FilterDisableCmd `cmd:"" help:"Disable filter." aliases:"off"` Disable FilterDisableCmd `cmd:"" help:"Disable filter." aliases:"off" completion-enabled-command-alias:"false"`
Toggle FilterToggleCmd `cmd:"" help:"Toggle filter." aliases:"tg"` Toggle FilterToggleCmd `cmd:"" help:"Toggle filter." aliases:"tg" completion-enabled-command-alias:"false"`
Status FilterStatusCmd `cmd:"" help:"Get filter status." aliases:"ss"` Status FilterStatusCmd `cmd:"" help:"Get filter status." aliases:"ss" completion-enabled-command-alias:"false"`
} }
// FilterListCmd provides a command to list all filters in a scene. // FilterListCmd provides a command to list all filters in a scene.
@@ -25,6 +26,7 @@ type FilterListCmd struct {
} }
// Run executes the command to list all filters in a scene. // Run executes the command to list all filters in a scene.
// nolint: misspell
func (cmd *FilterListCmd) Run(ctx *context) error { func (cmd *FilterListCmd) Run(ctx *context) error {
if cmd.SourceName == "" { if cmd.SourceName == "" {
currentScene, err := ctx.Client.Scenes.GetCurrentProgramScene() currentScene, err := ctx.Client.Scenes.GetCurrentProgramScene()
@@ -42,14 +44,39 @@ func (cmd *FilterListCmd) Run(ctx *context) error {
} }
if len(sourceFilters.Filters) == 0 { if len(sourceFilters.Filters) == 0 {
fmt.Fprintf(ctx.Out, "No filters found for source %s.\n", cmd.SourceName) fmt.Fprintf(
ctx.Out,
"No filters found for source %s.\n",
ctx.Style.Highlight(cmd.SourceName),
)
return nil return nil
} }
t := table.New(ctx.Out) t := table.New().Border(lipgloss.RoundedBorder()).
t.SetPadding(3) BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border)).
t.SetAlignment(table.AlignLeft, table.AlignLeft, table.AlignCenter, table.AlignLeft) Headers("Filter Name", "Kind", "Enabled", "Settings").
t.SetHeaders("Filter Name", "Kind", "Enabled", "Settings") StyleFunc(func(row, col int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
switch col {
case 0:
style = style.Align(lipgloss.Left)
case 1:
style = style.Align(lipgloss.Left)
case 2:
style = style.Align(lipgloss.Center)
case 3:
style = style.Align(lipgloss.Left)
}
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
for _, filter := range sourceFilters.Filters { for _, filter := range sourceFilters.Filters {
defaultSettings, err := ctx.Client.Filters.GetSourceFilterDefaultSettings( defaultSettings, err := ctx.Client.Filters.GetSourceFilterDefaultSettings(
@@ -58,7 +85,7 @@ func (cmd *FilterListCmd) Run(ctx *context) error {
) )
if err != nil { if err != nil {
return fmt.Errorf("failed to get default settings for filter %s: %w", return fmt.Errorf("failed to get default settings for filter %s: %w",
filter.FilterName, err) ctx.Style.Error(filter.FilterName), err)
} }
maps.Insert(defaultSettings.DefaultFilterSettings, maps.All(filter.FilterSettings)) maps.Insert(defaultSettings.DefaultFilterSettings, maps.All(filter.FilterSettings))
@@ -70,14 +97,14 @@ func (cmd *FilterListCmd) Run(ctx *context) error {
return strings.ToLower(lines[i]) < strings.ToLower(lines[j]) return strings.ToLower(lines[i]) < strings.ToLower(lines[j])
}) })
t.AddRow( t.Row(
filter.FilterName, filter.FilterName,
snakeCaseToTitleCase(filter.FilterKind), snakeCaseToTitleCase(filter.FilterKind),
getEnabledMark(filter.FilterEnabled), getEnabledMark(filter.FilterEnabled),
strings.Join(lines, "\n"), strings.Join(lines, "\n"),
) )
} }
t.Render() fmt.Fprintln(ctx.Out, t.Render())
return nil return nil
} }
@@ -97,10 +124,10 @@ func (cmd *FilterEnableCmd) Run(ctx *context) error {
) )
if err != nil { if err != nil {
return fmt.Errorf("failed to enable filter %s on source %s: %w", return fmt.Errorf("failed to enable filter %s on source %s: %w",
cmd.FilterName, cmd.SourceName, err) ctx.Style.Error(cmd.FilterName), ctx.Style.Error(cmd.SourceName), err)
} }
fmt.Fprintf(ctx.Out, "Filter %s enabled on source %s.\n", fmt.Fprintf(ctx.Out, "Filter %s enabled on source %s.\n",
cmd.FilterName, cmd.SourceName) ctx.Style.Highlight(cmd.FilterName), ctx.Style.Highlight(cmd.SourceName))
return nil return nil
} }
@@ -120,10 +147,10 @@ func (cmd *FilterDisableCmd) Run(ctx *context) error {
) )
if err != nil { if err != nil {
return fmt.Errorf("failed to disable filter %s on source %s: %w", return fmt.Errorf("failed to disable filter %s on source %s: %w",
cmd.FilterName, cmd.SourceName, err) ctx.Style.Error(cmd.FilterName), ctx.Style.Error(cmd.SourceName), err)
} }
fmt.Fprintf(ctx.Out, "Filter %s disabled on source %s.\n", fmt.Fprintf(ctx.Out, "Filter %s disabled on source %s.\n",
cmd.FilterName, cmd.SourceName) ctx.Style.Highlight(cmd.FilterName), ctx.Style.Highlight(cmd.SourceName))
return nil return nil
} }
@@ -142,7 +169,7 @@ func (cmd *FilterToggleCmd) Run(ctx *context) error {
) )
if err != nil { if err != nil {
return fmt.Errorf("failed to get filter %s on source %s: %w", return fmt.Errorf("failed to get filter %s on source %s: %w",
cmd.FilterName, cmd.SourceName, err) ctx.Style.Error(cmd.FilterName), ctx.Style.Error(cmd.SourceName), err)
} }
newStatus := !filter.FilterEnabled newStatus := !filter.FilterEnabled
@@ -154,15 +181,15 @@ func (cmd *FilterToggleCmd) Run(ctx *context) error {
) )
if err != nil { if err != nil {
return fmt.Errorf("failed to toggle filter %s on source %s: %w", return fmt.Errorf("failed to toggle filter %s on source %s: %w",
cmd.FilterName, cmd.SourceName, err) ctx.Style.Error(cmd.FilterName), ctx.Style.Error(cmd.SourceName), err)
} }
if newStatus { if newStatus {
fmt.Fprintf(ctx.Out, "Filter %s on source %s is now enabled.\n", fmt.Fprintf(ctx.Out, "Filter %s on source %s is now enabled.\n",
cmd.FilterName, cmd.SourceName) ctx.Style.Highlight(cmd.FilterName), ctx.Style.Highlight(cmd.SourceName))
} else { } else {
fmt.Fprintf(ctx.Out, "Filter %s on source %s is now disabled.\n", fmt.Fprintf(ctx.Out, "Filter %s on source %s is now disabled.\n",
cmd.FilterName, cmd.SourceName) ctx.Style.Highlight(cmd.FilterName), ctx.Style.Highlight(cmd.SourceName))
} }
return nil return nil
} }
@@ -182,14 +209,14 @@ func (cmd *FilterStatusCmd) Run(ctx *context) error {
) )
if err != nil { if err != nil {
return fmt.Errorf("failed to get status of filter %s on source %s: %w", return fmt.Errorf("failed to get status of filter %s on source %s: %w",
cmd.FilterName, cmd.SourceName, err) ctx.Style.Error(cmd.FilterName), ctx.Style.Error(cmd.SourceName), err)
} }
if filter.FilterEnabled { if filter.FilterEnabled {
fmt.Fprintf(ctx.Out, "Filter %s on source %s is enabled.\n", fmt.Fprintf(ctx.Out, "Filter %s on source %s is enabled.\n",
cmd.FilterName, cmd.SourceName) ctx.Style.Highlight(cmd.FilterName), ctx.Style.Highlight(cmd.SourceName))
} else { } else {
fmt.Fprintf(ctx.Out, "Filter %s on source %s is disabled.\n", fmt.Fprintf(ctx.Out, "Filter %s on source %s is disabled.\n",
cmd.FilterName, cmd.SourceName) ctx.Style.Highlight(cmd.FilterName), ctx.Style.Highlight(cmd.SourceName))
} }
return nil return nil
} }

View File

@@ -11,10 +11,7 @@ func TestFilterList(t *testing.T) {
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmd := &FilterListCmd{ cmd := &FilterListCmd{
SourceName: "Mic/Aux", SourceName: "Mic/Aux",
@@ -33,13 +30,10 @@ func TestFilterListScene(t *testing.T) {
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmd := &FilterListCmd{ cmd := &FilterListCmd{
SourceName: "gobs-test", SourceName: "gobs-test-scene",
} }
err := cmd.Run(context) err := cmd.Run(context)
if err != nil { if err != nil {
@@ -55,10 +49,7 @@ func TestFilterListEmpty(t *testing.T) {
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmd := &FilterListCmd{ cmd := &FilterListCmd{
SourceName: "NonExistentSource", SourceName: "NonExistentSource",

35
go.mod
View File

@@ -1,27 +1,42 @@
module github.com/onyx-and-iris/gobs-cli module github.com/onyx-and-iris/gobs-cli
go 1.24.0 go 1.25.0
require ( require (
github.com/alecthomas/kong v1.10.0 github.com/alecthomas/kong v1.14.0
github.com/alecthomas/mango-kong v0.1.0 github.com/alecthomas/mango-kong v0.1.0
github.com/andreykaipov/goobs v1.5.6 github.com/andreykaipov/goobs v1.8.2
github.com/aquasecurity/table v1.10.0 github.com/charmbracelet/lipgloss v1.1.0
github.com/jotaen/kong-completion v0.0.13
github.com/titusjaka/kong-dotenv-go v0.1.0 github.com/titusjaka/kong-dotenv-go v0.1.0
) )
require ( require (
github.com/buger/jsonparser v1.1.1 // indirect github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
github.com/buger/jsonparser v1.1.2 // indirect
github.com/charmbracelet/colorprofile v0.4.3 // indirect
github.com/charmbracelet/x/ansi v0.11.6 // indirect
github.com/charmbracelet/x/cellbuf v0.0.15 // indirect
github.com/charmbracelet/x/term v0.2.2 // indirect
github.com/clipperhouse/displaywidth v0.11.0 // indirect
github.com/clipperhouse/uax29/v2 v2.7.0 // indirect
github.com/gorilla/websocket v1.5.3 // indirect github.com/gorilla/websocket v1.5.3 // indirect
github.com/hashicorp/errwrap v1.1.0 // indirect
github.com/hashicorp/go-multierror v1.1.1 // indirect
github.com/hashicorp/logutils v1.0.0 // indirect github.com/hashicorp/logutils v1.0.0 // indirect
github.com/joho/godotenv v1.5.1 // indirect github.com/joho/godotenv v1.5.1 // indirect
github.com/mattn/go-runewidth v0.0.13 // indirect github.com/lucasb-eyer/go-colorful v1.3.0 // indirect
github.com/mattn/go-isatty v0.0.20 // indirect
github.com/mattn/go-runewidth v0.0.21 // indirect
github.com/mitchellh/mapstructure v1.5.0 // indirect github.com/mitchellh/mapstructure v1.5.0 // indirect
github.com/mmcloughlin/profile v0.1.1 // indirect github.com/mmcloughlin/profile v0.1.1 // indirect
github.com/muesli/mango v0.1.1-0.20220205060214-77e2058169ab // indirect github.com/muesli/mango v0.2.0 // indirect
github.com/muesli/roff v0.1.0 // indirect github.com/muesli/roff v0.1.0 // indirect
github.com/muesli/termenv v0.16.0 // indirect
github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d // indirect github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d // indirect
github.com/rivo/uniseg v0.2.0 // indirect github.com/posener/complete v1.2.3 // indirect
golang.org/x/sys v0.1.0 // indirect github.com/rivo/uniseg v0.4.7 // indirect
golang.org/x/term v0.0.0-20220526004731-065cf7ba2467 // indirect github.com/riywo/loginshell v0.0.0-20200815045211-7d26008be1ab // indirect
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
golang.org/x/sys v0.42.0 // indirect
) )

88
go.sum
View File

@@ -1,50 +1,94 @@
github.com/alecthomas/assert/v2 v2.11.0 h1:2Q9r3ki8+JYXvGsDyBXwH3LcJ+WK5D0gc5E8vS6K3D0= github.com/alecthomas/assert/v2 v2.11.0 h1:2Q9r3ki8+JYXvGsDyBXwH3LcJ+WK5D0gc5E8vS6K3D0=
github.com/alecthomas/assert/v2 v2.11.0/go.mod h1:Bze95FyfUr7x34QZrjL+XP+0qgp/zg8yS+TtBj1WA3k= github.com/alecthomas/assert/v2 v2.11.0/go.mod h1:Bze95FyfUr7x34QZrjL+XP+0qgp/zg8yS+TtBj1WA3k=
github.com/alecthomas/kong v1.10.0 h1:8K4rGDpT7Iu+jEXCIJUeKqvpwZHbsFRoebLbnzlmrpw= github.com/alecthomas/kong v1.14.0 h1:gFgEUZWu2ZmZ+UhyZ1bDhuutbKN1nTtJTwh19Wsn21s=
github.com/alecthomas/kong v1.10.0/go.mod h1:p2vqieVMeTAnaC83txKtXe8FLke2X07aruPWXyMPQrU= github.com/alecthomas/kong v1.14.0/go.mod h1:wrlbXem1CWqUV5Vbmss5ISYhsVPkBb1Yo7YKJghju2I=
github.com/alecthomas/mango-kong v0.1.0 h1:iFVfP1k1K4qpml3JUQmD5I8MCQYfIvsD9mRdrw7jJC4= github.com/alecthomas/mango-kong v0.1.0 h1:iFVfP1k1K4qpml3JUQmD5I8MCQYfIvsD9mRdrw7jJC4=
github.com/alecthomas/mango-kong v0.1.0/go.mod h1:t+TYVdsONUolf/BwVcm+15eqcdAj15h4Qe9MMFAwwT4= github.com/alecthomas/mango-kong v0.1.0/go.mod h1:t+TYVdsONUolf/BwVcm+15eqcdAj15h4Qe9MMFAwwT4=
github.com/alecthomas/repr v0.4.0 h1:GhI2A8MACjfegCPVq9f1FLvIBS+DrQ2KQBFZP1iFzXc= github.com/alecthomas/repr v0.5.2 h1:SU73FTI9D1P5UNtvseffFSGmdNci/O6RsqzeXJtP0Qs=
github.com/alecthomas/repr v0.4.0/go.mod h1:Fr0507jx4eOXV7AlPV6AVZLYrLIuIeSOWtW57eE/O/4= github.com/alecthomas/repr v0.5.2/go.mod h1:Fr0507jx4eOXV7AlPV6AVZLYrLIuIeSOWtW57eE/O/4=
github.com/andreykaipov/goobs v1.5.6 h1:eIkEqYN99+2VJvmlY/56Ah60nkRKS6efMQvpM3oUgPQ= github.com/andreykaipov/goobs v1.8.2 h1:jOWjFdSOZ5R4b6U+/30k4OhkqaN847gzHX4IKFsagaw=
github.com/andreykaipov/goobs v1.5.6/go.mod h1:iSZP93FJ4d9X/U1x4DD4IyILLtig+vViqZWBGjLywcY= github.com/andreykaipov/goobs v1.8.2/go.mod h1:4Dl/G+rQXCywV85hdAKwsj8h352KsfILP+QUB1FvRSc=
github.com/aquasecurity/table v1.10.0 h1:gPWV28qp9XSlvXdT3ku8yKQoZE6II0vsmegKpW+dB08= github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=
github.com/aquasecurity/table v1.10.0/go.mod h1:eqOmvjjB7AhXFgFqpJUEE/ietg7RrMSJZXyTN8E/wZw= github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
github.com/buger/jsonparser v1.1.1 h1:2PnMjfWD7wBILjqQbt530v576A/cAbQvEW9gGIpYMUs= github.com/aymanbagabas/go-udiff v0.2.0 h1:TK0fH4MteXUDspT88n8CKzvK0X9O2xu9yQjWpi6yML8=
github.com/buger/jsonparser v1.1.1/go.mod h1:6RYKKt7H4d4+iWqouImQ9R2FZql3VbhNgx27UK13J/0= github.com/aymanbagabas/go-udiff v0.2.0/go.mod h1:RE4Ex0qsGkTAJoQdQQCA0uG+nAzJO/pI/QwceO5fgrA=
github.com/buger/jsonparser v1.1.2 h1:frqHqw7otoVbk5M8LlE/L7HTnIq2v9RX6EJ48i9AxJk=
github.com/buger/jsonparser v1.1.2/go.mod h1:6RYKKt7H4d4+iWqouImQ9R2FZql3VbhNgx27UK13J/0=
github.com/charmbracelet/colorprofile v0.4.3 h1:QPa1IWkYI+AOB+fE+mg/5/4HRMZcaXex9t5KX76i20Q=
github.com/charmbracelet/colorprofile v0.4.3/go.mod h1:/zT4BhpD5aGFpqQQqw7a+VtHCzu+zrQtt1zhMt9mR4Q=
github.com/charmbracelet/lipgloss v1.1.0 h1:vYXsiLHVkK7fp74RkV7b2kq9+zDLoEU4MZoFqR/noCY=
github.com/charmbracelet/lipgloss v1.1.0/go.mod h1:/6Q8FR2o+kj8rz4Dq0zQc3vYf7X+B0binUUBwA0aL30=
github.com/charmbracelet/x/ansi v0.11.6 h1:GhV21SiDz/45W9AnV2R61xZMRri5NlLnl6CVF7ihZW8=
github.com/charmbracelet/x/ansi v0.11.6/go.mod h1:2JNYLgQUsyqaiLovhU2Rv/pb8r6ydXKS3NIttu3VGZQ=
github.com/charmbracelet/x/cellbuf v0.0.15 h1:ur3pZy0o6z/R7EylET877CBxaiE1Sp1GMxoFPAIztPI=
github.com/charmbracelet/x/cellbuf v0.0.15/go.mod h1:J1YVbR7MUuEGIFPCaaZ96KDl5NoS0DAWkskup+mOY+Q=
github.com/charmbracelet/x/exp/golden v0.0.0-20240806155701-69247e0abc2a h1:G99klV19u0QnhiizODirwVksQB91TJKV/UaTnACcG30=
github.com/charmbracelet/x/exp/golden v0.0.0-20240806155701-69247e0abc2a/go.mod h1:wDlXFlCrmJ8J+swcL/MnGUuYnqgQdW9rhSD61oNMb6U=
github.com/charmbracelet/x/term v0.2.2 h1:xVRT/S2ZcKdhhOuSP4t5cLi5o+JxklsoEObBSgfgZRk=
github.com/charmbracelet/x/term v0.2.2/go.mod h1:kF8CY5RddLWrsgVwpw4kAa6TESp6EB5y3uxGLeCqzAI=
github.com/clipperhouse/displaywidth v0.11.0 h1:lBc6kY44VFw+TDx4I8opi/EtL9m20WSEFgwIwO+UVM8=
github.com/clipperhouse/displaywidth v0.11.0/go.mod h1:bkrFNkf81G8HyVqmKGxsPufD3JhNl3dSqnGhOoSD/o0=
github.com/clipperhouse/uax29/v2 v2.7.0 h1:+gs4oBZ2gPfVrKPthwbMzWZDaAFPGYK72F0NJv2v7Vk=
github.com/clipperhouse/uax29/v2 v2.7.0/go.mod h1:EFJ2TJMRUaplDxHKj1qAEhCtQPW2tJSwu5BF98AuoVM=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg= github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
github.com/hashicorp/errwrap v1.1.0 h1:OxrOeh75EUXMY8TBjag2fzXGZ40LB6IKw45YeGUDY2I=
github.com/hashicorp/errwrap v1.1.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
github.com/hashicorp/go-multierror v1.0.0/go.mod h1:dHtQlpGsu+cZNNAkkCN/P3hoUDHhCYQXV3UM06sGGrk=
github.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+lD48awMYo=
github.com/hashicorp/go-multierror v1.1.1/go.mod h1:iw975J/qwKPdAO1clOe2L8331t/9/fmwbPZ6JB6eMoM=
github.com/hashicorp/logutils v1.0.0 h1:dLEQVugN8vlakKOUE3ihGLTZJRB4j+M2cdTm/ORI65Y= github.com/hashicorp/logutils v1.0.0 h1:dLEQVugN8vlakKOUE3ihGLTZJRB4j+M2cdTm/ORI65Y=
github.com/hashicorp/logutils v1.0.0/go.mod h1:QIAnNjmIWmVIIkWDTG1z5v++HQmx9WQRO+LraFDTW64= github.com/hashicorp/logutils v1.0.0/go.mod h1:QIAnNjmIWmVIIkWDTG1z5v++HQmx9WQRO+LraFDTW64=
github.com/hexops/gotextdiff v1.0.3 h1:gitA9+qJrrTCsiCl7+kh75nPqQt1cx4ZkudSTLoUqJM= github.com/hexops/gotextdiff v1.0.3 h1:gitA9+qJrrTCsiCl7+kh75nPqQt1cx4ZkudSTLoUqJM=
github.com/hexops/gotextdiff v1.0.3/go.mod h1:pSWU5MAI3yDq+fZBTazCSJysOMbxWL1BSow5/V2vxeg= github.com/hexops/gotextdiff v1.0.3/go.mod h1:pSWU5MAI3yDq+fZBTazCSJysOMbxWL1BSow5/V2vxeg=
github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0= github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0=
github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4= github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
github.com/mattn/go-runewidth v0.0.13 h1:lTGmDsbAYt5DmK6OnoV7EuIF1wEIFAcxld6ypU4OSgU= github.com/jotaen/kong-completion v0.0.13 h1:fbbqijMmrCgx8sz6bZz+B5p5yJSEAdwJZALsUZ+Ql3s=
github.com/mattn/go-runewidth v0.0.13/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= github.com/jotaen/kong-completion v0.0.13/go.mod h1:dyIG20e3qq128SUBtF8jzI7YtkfzjWMlgbqkAJd6xHQ=
github.com/lucasb-eyer/go-colorful v1.3.0 h1:2/yBRLdWBZKrf7gB40FoiKfAWYQ0lqNcbuQwVHXptag=
github.com/lucasb-eyer/go-colorful v1.3.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
github.com/mattn/go-runewidth v0.0.21 h1:jJKAZiQH+2mIinzCJIaIG9Be1+0NR+5sz/lYEEjdM8w=
github.com/mattn/go-runewidth v0.0.21/go.mod h1:XBkDxAl56ILZc9knddidhrOlY5R/pDhgLpndooCuJAs=
github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY= github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=
github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo= github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
github.com/mmcloughlin/profile v0.1.1 h1:jhDmAqPyebOsVDOCICJoINoLb/AnLBaUw58nFzxWS2w= github.com/mmcloughlin/profile v0.1.1 h1:jhDmAqPyebOsVDOCICJoINoLb/AnLBaUw58nFzxWS2w=
github.com/mmcloughlin/profile v0.1.1/go.mod h1:IhHD7q1ooxgwTgjxQYkACGA77oFTDdFVejUS1/tS/qU= github.com/mmcloughlin/profile v0.1.1/go.mod h1:IhHD7q1ooxgwTgjxQYkACGA77oFTDdFVejUS1/tS/qU=
github.com/muesli/mango v0.1.1-0.20220205060214-77e2058169ab h1:m7QFONkzLK0fVXCjwX5tANcnj1yXxTnYQtnfJiY3tcA= github.com/muesli/mango v0.2.0 h1:iNNc0c5VLQ6fsMgAqGQofByNUBH2Q2nEbD6TaI+5yyQ=
github.com/muesli/mango v0.1.1-0.20220205060214-77e2058169ab/go.mod h1:5XFpbC8jY5UUv89YQciiXNlbi+iJgt29VDC5xbzrLL4= github.com/muesli/mango v0.2.0/go.mod h1:5XFpbC8jY5UUv89YQciiXNlbi+iJgt29VDC5xbzrLL4=
github.com/muesli/roff v0.1.0 h1:YD0lalCotmYuF5HhZliKWlIx7IEhiXeSfq7hNjFqGF8= github.com/muesli/roff v0.1.0 h1:YD0lalCotmYuF5HhZliKWlIx7IEhiXeSfq7hNjFqGF8=
github.com/muesli/roff v0.1.0/go.mod h1:pjAHQM9hdUUwm/krAfrLGgJkXJ+YuhtsfZ42kieB2Ig= github.com/muesli/roff v0.1.0/go.mod h1:pjAHQM9hdUUwm/krAfrLGgJkXJ+YuhtsfZ42kieB2Ig=
github.com/muesli/termenv v0.16.0 h1:S5AlUN9dENB57rsbnkPyfdGuWIlkmzJjbFf0Tf5FWUc=
github.com/muesli/termenv v0.16.0/go.mod h1:ZRfOIKPFDYQoDFF4Olj7/QJbW60Ol/kL1pU3VfY/Cnk=
github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d h1:VhgPp6v9qf9Agr/56bj7Y/xa04UccTW04VP0Qed4vnQ= github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d h1:VhgPp6v9qf9Agr/56bj7Y/xa04UccTW04VP0Qed4vnQ=
github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d/go.mod h1:YUTz3bUH2ZwIWBy3CJBeOBEugqcmXREj14T+iG/4k4U= github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d/go.mod h1:YUTz3bUH2ZwIWBy3CJBeOBEugqcmXREj14T+iG/4k4U=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/rivo/uniseg v0.2.0 h1:S1pD9weZBuJdFmowNwbpi7BJ8TNftyUImj/0WQi72jY= github.com/posener/complete v1.2.3 h1:NP0eAhjcjImqslEwo/1hq7gpajME0fTLTezBKDqfXqo=
github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= github.com/posener/complete v1.2.3/go.mod h1:WZIdtGGp+qx0sLrYKtIRAruyNpv6hFCicSgv7Sy7s/s=
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
github.com/riywo/loginshell v0.0.0-20200815045211-7d26008be1ab h1:ZjX6I48eZSFetPb41dHudEyVr5v953N15TsNZXlkcWY=
github.com/riywo/loginshell v0.0.0-20200815045211-7d26008be1ab/go.mod h1:/PfPXh0EntGc3QAAyUaviy4S9tzy4Zp0e2ilq4voC6E=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
github.com/titusjaka/kong-dotenv-go v0.1.0 h1:TmUjP/sXoNiKLr6oR7n9xrB5XyXi/Ssuebzfz5nxZj4= github.com/titusjaka/kong-dotenv-go v0.1.0 h1:TmUjP/sXoNiKLr6oR7n9xrB5XyXi/Ssuebzfz5nxZj4=
github.com/titusjaka/kong-dotenv-go v0.1.0/go.mod h1:pBgLjcu82oqUgb7+bngK9+Ch7jg49E0YADP8Wnj2MXU= github.com/titusjaka/kong-dotenv-go v0.1.0/go.mod h1:pBgLjcu82oqUgb7+bngK9+Ch7jg49E0YADP8Wnj2MXU=
golang.org/x/sys v0.1.0 h1:kunALQeHf1/185U1i0GOB/fy1IPRDDpuoOOqRReG57U= github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=
golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM=
golang.org/x/term v0.0.0-20220526004731-065cf7ba2467 h1:CBpWXWQpIRjzmkkA+M7q9Fqnwd2mZr3AFqexg8YTfoM= golang.org/x/exp v0.0.0-20231006140011-7918f672742d h1:jtJma62tbqLibJ5sFQz8bKtEM8rJBtfilJ2qTU199MI=
golang.org/x/term v0.0.0-20220526004731-065cf7ba2467/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/exp v0.0.0-20231006140011-7918f672742d/go.mod h1:ldy0pHrwJyGW56pPQzzkH36rKxoZW1tw7ZJpeKx+hdo=
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.42.0 h1:omrd2nAlyT5ESRdCLYdm3+fMfNFE/+Rf4bDIQImRJeo=
golang.org/x/sys v0.42.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

127
group.go
View File

@@ -4,16 +4,17 @@ import (
"fmt" "fmt"
"github.com/andreykaipov/goobs/api/requests/sceneitems" "github.com/andreykaipov/goobs/api/requests/sceneitems"
"github.com/aquasecurity/table" "github.com/charmbracelet/lipgloss"
"github.com/charmbracelet/lipgloss/table"
) )
// GroupCmd provides commands to manage groups in OBS Studio. // GroupCmd provides commands to manage groups in OBS Studio.
type GroupCmd struct { type GroupCmd struct {
List GroupListCmd `cmd:"" help:"List all groups." aliases:"ls"` List GroupListCmd `cmd:"" help:"List all groups." aliases:"ls" completion-enabled-command-alias:"false"`
Show GroupShowCmd `cmd:"" help:"Show group details." aliases:"sh"` Show GroupShowCmd `cmd:"" help:"Show group details." aliases:"sh" completion-enabled-command-alias:"false"`
Hide GroupHideCmd `cmd:"" help:"Hide group." aliases:"h"` Hide GroupHideCmd `cmd:"" help:"Hide group." aliases:"h" completion-enabled-command-alias:"false"`
Toggle GroupToggleCmd `cmd:"" help:"Toggle group." aliases:"tg"` Toggle GroupToggleCmd `cmd:"" help:"Toggle group." aliases:"tg" completion-enabled-command-alias:"false"`
Status GroupStatusCmd `cmd:"" help:"Get group status." aliases:"ss"` Status GroupStatusCmd `cmd:"" help:"Get group status." aliases:"ss" completion-enabled-command-alias:"false"`
} }
// GroupListCmd provides a command to list all groups in a scene. // GroupListCmd provides a command to list all groups in a scene.
@@ -22,6 +23,7 @@ type GroupListCmd struct {
} }
// Run executes the command to list all groups in a scene. // Run executes the command to list all groups in a scene.
// nolint: misspell
func (cmd *GroupListCmd) Run(ctx *context) error { func (cmd *GroupListCmd) Run(ctx *context) error {
if cmd.SceneName == "" { if cmd.SceneName == "" {
currentScene, err := ctx.Client.Scenes.GetCurrentProgramScene() currentScene, err := ctx.Client.Scenes.GetCurrentProgramScene()
@@ -37,17 +39,48 @@ func (cmd *GroupListCmd) Run(ctx *context) error {
return fmt.Errorf("failed to get scene item list: %w", err) return fmt.Errorf("failed to get scene item list: %w", err)
} }
t := table.New(ctx.Out) t := table.New().Border(lipgloss.RoundedBorder()).
t.SetPadding(3) BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border)).
t.SetAlignment(table.AlignCenter, table.AlignLeft, table.AlignCenter) Headers("ID", "Group Name", "Enabled").
t.SetHeaders("ID", "Group Name", "Enabled") StyleFunc(func(row, col int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
switch col {
case 0:
style = style.Align(lipgloss.Center)
case 1:
style = style.Align(lipgloss.Left)
case 2:
style = style.Align(lipgloss.Center)
}
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
var found bool
for _, item := range resp.SceneItems { for _, item := range resp.SceneItems {
if item.IsGroup { if item.IsGroup {
t.AddRow(fmt.Sprintf("%d", item.SceneItemID), item.SourceName, getEnabledMark(item.SceneItemEnabled)) t.Row(
fmt.Sprintf("%d", item.SceneItemID),
item.SourceName,
getEnabledMark(item.SceneItemEnabled),
)
found = true
} }
} }
t.Render()
if !found {
fmt.Fprintf(ctx.Out, "No groups found in scene %s.\n", ctx.Style.Highlight(cmd.SceneName))
return nil
}
fmt.Fprintln(ctx.Out, t.Render())
return nil return nil
} }
@@ -68,20 +101,26 @@ func (cmd *GroupShowCmd) Run(ctx *context) error {
var found bool var found bool
for _, item := range resp.SceneItems { for _, item := range resp.SceneItems {
if item.IsGroup && item.SourceName == cmd.GroupName { if item.IsGroup && item.SourceName == cmd.GroupName {
_, err := ctx.Client.SceneItems.SetSceneItemEnabled(sceneitems.NewSetSceneItemEnabledParams(). _, err := ctx.Client.SceneItems.SetSceneItemEnabled(
WithSceneName(cmd.SceneName). sceneitems.NewSetSceneItemEnabledParams().
WithSceneItemId(item.SceneItemID). WithSceneName(cmd.SceneName).
WithSceneItemEnabled(true)) WithSceneItemId(item.SceneItemID).
WithSceneItemEnabled(true),
)
if err != nil { if err != nil {
return fmt.Errorf("failed to set scene item enabled: %w", err) return fmt.Errorf("failed to set scene item enabled: %w", err)
} }
fmt.Fprintf(ctx.Out, "Group %s is now shown.\n", cmd.GroupName) fmt.Fprintf(ctx.Out, "Group %s is now shown.\n", ctx.Style.Highlight(cmd.GroupName))
found = true found = true
break break
} }
} }
if !found { if !found {
return fmt.Errorf("group '%s' not found", cmd.GroupName) return fmt.Errorf(
"group %s not found in scene %s",
ctx.Style.Error(cmd.GroupName),
ctx.Style.Error(cmd.SceneName),
)
} }
return nil return nil
} }
@@ -103,20 +142,26 @@ func (cmd *GroupHideCmd) Run(ctx *context) error {
var found bool var found bool
for _, item := range resp.SceneItems { for _, item := range resp.SceneItems {
if item.IsGroup && item.SourceName == cmd.GroupName { if item.IsGroup && item.SourceName == cmd.GroupName {
_, err := ctx.Client.SceneItems.SetSceneItemEnabled(sceneitems.NewSetSceneItemEnabledParams(). _, err := ctx.Client.SceneItems.SetSceneItemEnabled(
WithSceneName(cmd.SceneName). sceneitems.NewSetSceneItemEnabledParams().
WithSceneItemId(item.SceneItemID). WithSceneName(cmd.SceneName).
WithSceneItemEnabled(false)) WithSceneItemId(item.SceneItemID).
WithSceneItemEnabled(false),
)
if err != nil { if err != nil {
return fmt.Errorf("failed to set scene item enabled: %w", err) return fmt.Errorf("failed to set scene item enabled: %w", err)
} }
fmt.Fprintf(ctx.Out, "Group %s is now hidden.\n", cmd.GroupName) fmt.Fprintf(ctx.Out, "Group %s is now hidden.\n", ctx.Style.Highlight(cmd.GroupName))
found = true found = true
break break
} }
} }
if !found { if !found {
return fmt.Errorf("group '%s' not found", cmd.GroupName) return fmt.Errorf(
"group %s not found in scene %s",
ctx.Style.Error(cmd.GroupName),
ctx.Style.Error(cmd.SceneName),
)
} }
return nil return nil
} }
@@ -139,24 +184,34 @@ func (cmd *GroupToggleCmd) Run(ctx *context) error {
for _, item := range resp.SceneItems { for _, item := range resp.SceneItems {
if item.IsGroup && item.SourceName == cmd.GroupName { if item.IsGroup && item.SourceName == cmd.GroupName {
newState := !item.SceneItemEnabled newState := !item.SceneItemEnabled
_, err := ctx.Client.SceneItems.SetSceneItemEnabled(sceneitems.NewSetSceneItemEnabledParams(). _, err := ctx.Client.SceneItems.SetSceneItemEnabled(
WithSceneName(cmd.SceneName). sceneitems.NewSetSceneItemEnabledParams().
WithSceneItemId(item.SceneItemID). WithSceneName(cmd.SceneName).
WithSceneItemEnabled(newState)) WithSceneItemId(item.SceneItemID).
WithSceneItemEnabled(newState),
)
if err != nil { if err != nil {
return fmt.Errorf("failed to set scene item enabled: %w", err) return fmt.Errorf("failed to set scene item enabled: %w", err)
} }
if newState { if newState {
fmt.Fprintf(ctx.Out, "Group %s is now shown.\n", cmd.GroupName) fmt.Fprintf(ctx.Out, "Group %s is now shown.\n", ctx.Style.Highlight(cmd.GroupName))
} else { } else {
fmt.Fprintf(ctx.Out, "Group %s is now hidden.\n", cmd.GroupName) fmt.Fprintf(
ctx.Out,
"Group %s is now hidden.\n",
ctx.Style.Highlight(cmd.GroupName),
)
} }
found = true found = true
break break
} }
} }
if !found { if !found {
return fmt.Errorf("group '%s' not found", cmd.GroupName) return fmt.Errorf(
"group %s not found in scene %s",
ctx.Style.Error(cmd.GroupName),
ctx.Style.Error(cmd.SceneName),
)
} }
return nil return nil
@@ -178,12 +233,16 @@ func (cmd *GroupStatusCmd) Run(ctx *context) error {
for _, item := range resp.SceneItems { for _, item := range resp.SceneItems {
if item.IsGroup && item.SourceName == cmd.GroupName { if item.IsGroup && item.SourceName == cmd.GroupName {
if item.SceneItemEnabled { if item.SceneItemEnabled {
fmt.Fprintf(ctx.Out, "Group %s is shown.\n", cmd.GroupName) fmt.Fprintf(ctx.Out, "Group %s is shown.\n", ctx.Style.Highlight(cmd.GroupName))
} else { } else {
fmt.Fprintf(ctx.Out, "Group %s is hidden.\n", cmd.GroupName) fmt.Fprintf(ctx.Out, "Group %s is hidden.\n", ctx.Style.Highlight(cmd.GroupName))
} }
return nil return nil
} }
} }
return fmt.Errorf("group '%s' not found", cmd.GroupName) return fmt.Errorf(
"group %s not found in scene %s",
ctx.Style.Error(cmd.GroupName),
ctx.Style.Error(cmd.SceneName),
)
} }

View File

@@ -2,19 +2,25 @@ package main
import ( import (
"bytes" "bytes"
"os"
"strings" "strings"
"testing" "testing"
) )
func skipIfSkipGroupTests(t *testing.T) {
if os.Getenv("GOBS_TEST_SKIP_GROUP_TESTS") != "" {
t.Skip("Skipping group tests due to GOBS_TEST_SKIP_GROUP_TESTS environment variable")
}
}
func TestGroupList(t *testing.T) { func TestGroupList(t *testing.T) {
skipIfSkipGroupTests(t)
client, disconnect := getClient(t) client, disconnect := getClient(t)
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmd := &GroupListCmd{ cmd := &GroupListCmd{
SceneName: "Scene", SceneName: "Scene",
@@ -29,14 +35,13 @@ func TestGroupList(t *testing.T) {
} }
func TestGroupShow(t *testing.T) { func TestGroupShow(t *testing.T) {
skipIfSkipGroupTests(t)
client, disconnect := getClient(t) client, disconnect := getClient(t)
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmd := &GroupShowCmd{ cmd := &GroupShowCmd{
SceneName: "Scene", SceneName: "Scene",
@@ -52,14 +57,13 @@ func TestGroupShow(t *testing.T) {
} }
func TestGroupToggle(t *testing.T) { func TestGroupToggle(t *testing.T) {
skipIfSkipGroupTests(t)
client, disconnect := getClient(t) client, disconnect := getClient(t)
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmdStatus := &GroupStatusCmd{ cmdStatus := &GroupStatusCmd{
SceneName: "Scene", SceneName: "Scene",
@@ -96,14 +100,13 @@ func TestGroupToggle(t *testing.T) {
} }
func TestGroupStatus(t *testing.T) { func TestGroupStatus(t *testing.T) {
skipIfSkipGroupTests(t)
client, disconnect := getClient(t) client, disconnect := getClient(t)
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmdShow := &GroupShowCmd{ cmdShow := &GroupShowCmd{
SceneName: "Scene", SceneName: "Scene",

View File

@@ -1,16 +1,19 @@
package main package main
import ( import (
"fmt"
"github.com/andreykaipov/goobs/api/requests/general" "github.com/andreykaipov/goobs/api/requests/general"
"github.com/andreykaipov/goobs/api/typedefs" "github.com/andreykaipov/goobs/api/typedefs"
"github.com/aquasecurity/table" "github.com/charmbracelet/lipgloss"
"github.com/charmbracelet/lipgloss/table"
) )
// HotkeyCmd provides commands to manage hotkeys in OBS Studio. // HotkeyCmd provides commands to manage hotkeys in OBS Studio.
type HotkeyCmd struct { type HotkeyCmd struct {
List HotkeyListCmd `cmd:"" help:"List all hotkeys." aliases:"ls"` List HotkeyListCmd `cmd:"" help:"List all hotkeys." aliases:"ls" completion-enabled-command-alias:"false"`
Trigger HotkeyTriggerCmd `cmd:"" help:"Trigger a hotkey by name." aliases:"tr"` Trigger HotkeyTriggerCmd `cmd:"" help:"Trigger a hotkey by name." aliases:"tr" completion-enabled-command-alias:"false"`
TriggerSequence HotkeyTriggerSequenceCmd `cmd:"" help:"Trigger a hotkey by sequence." aliases:"trs"` TriggerSequence HotkeyTriggerSequenceCmd `cmd:"" help:"Trigger a hotkey by sequence." aliases:"trs" completion-enabled-command-alias:"false"`
} }
// HotkeyListCmd provides a command to list all hotkeys. // HotkeyListCmd provides a command to list all hotkeys.
@@ -23,15 +26,26 @@ func (cmd *HotkeyListCmd) Run(ctx *context) error {
return err return err
} }
t := table.New(ctx.Out) t := table.New().Border(lipgloss.RoundedBorder()).
t.SetPadding(3) BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border)).
t.SetAlignment(table.AlignLeft) Headers("Hotkey Name").
t.SetHeaders("Hotkey Name") StyleFunc(func(row, _ int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center) // nolint: misspell
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
for _, hotkey := range resp.Hotkeys { for _, hotkey := range resp.Hotkeys {
t.AddRow(hotkey) t.Row(hotkey)
} }
t.Render() fmt.Fprintln(ctx.Out, t.Render())
return nil return nil
} }

BIN
img/coloured-border.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.4 KiB

BIN
img/coloured-no-border.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.4 KiB

BIN
img/colourless.png Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.6 KiB

439
input.go
View File

@@ -1,20 +1,83 @@
// nolint: misspell
package main package main
import ( import (
"fmt" "fmt"
"maps"
"sort" "sort"
"strings" "strings"
"github.com/andreykaipov/goobs/api/requests/inputs" "github.com/andreykaipov/goobs/api/requests/inputs"
"github.com/aquasecurity/table" "github.com/charmbracelet/lipgloss"
"github.com/charmbracelet/lipgloss/table"
) )
// InputCmd provides commands to manage inputs in OBS Studio. // InputCmd provides commands to manage inputs in OBS Studio.
type InputCmd struct { type InputCmd struct {
List InputListCmd `cmd:"" help:"List all inputs." aliases:"ls"` Create InputCreateCmd `cmd:"" help:"Create input." aliases:"c" completion-enabled-command-alias:"false"`
Mute InputMuteCmd `cmd:"" help:"Mute input." aliases:"m"` Remove InputRemoveCmd `cmd:"" help:"Remove input." aliases:"d" completion-enabled-command-alias:"false"`
Unmute InputUnmuteCmd `cmd:"" help:"Unmute input." aliases:"um"` List InputListCmd `cmd:"" help:"List all inputs." aliases:"ls" completion-enabled-command-alias:"false"`
Toggle InputToggleCmd `cmd:"" help:"Toggle input." aliases:"tg"` ListKinds InputListKindsCmd `cmd:"" help:"List input kinds." aliases:"k" completion-enabled-command-alias:"false"`
Mute InputMuteCmd `cmd:"" help:"Mute input." aliases:"m" completion-enabled-command-alias:"false"`
Unmute InputUnmuteCmd `cmd:"" help:"Unmute input." aliases:"um" completion-enabled-command-alias:"false"`
Toggle InputToggleCmd `cmd:"" help:"Toggle input." aliases:"tg" completion-enabled-command-alias:"false"`
Volume InputVolumeCmd `cmd:"" help:"Set input volume." aliases:"v" completion-enabled-command-alias:"false"`
Show InputShowCmd `cmd:"" help:"Show input details." aliases:"s" completion-enabled-command-alias:"false"`
Update InputUpdateCmd `cmd:"" help:"Update input settings." aliases:"up" completion-enabled-command-alias:"false"`
KindDefaults InputKindDefaultsCmd `cmd:"" help:"Get default settings for an input kind." aliases:"df" completion-enabled-command-alias:"false"`
}
// InputCreateCmd provides a command to create an input.
type InputCreateCmd struct {
Name string `arg:"" help:"Name for the input." required:""`
Kind string `arg:"" help:"Input kind (e.g., coreaudio_input_capture, macos-avcapture)." required:""`
}
// Run executes the command to create an input.
func (cmd *InputCreateCmd) Run(ctx *context) error {
currentScene, err := ctx.Client.Scenes.GetCurrentProgramScene()
if err != nil {
return err
}
_, err = ctx.Client.Inputs.CreateInput(
inputs.NewCreateInputParams().
WithInputKind(cmd.Kind).
WithInputName(cmd.Name).
WithSceneName(currentScene.CurrentProgramSceneName),
)
if err != nil {
return err
}
fmt.Fprintf(
ctx.Out,
"Created input: %s (%s) in scene %s\n",
ctx.Style.Highlight(
cmd.Name,
),
cmd.Kind,
ctx.Style.Highlight(currentScene.CurrentProgramSceneName),
)
return nil
}
// InputRemoveCmd provides a command to remove an input.
type InputRemoveCmd struct {
Name string `arg:"" help:"Name of the input to remove." required:""`
}
// Run executes the command to remove an input.
func (cmd *InputRemoveCmd) Run(ctx *context) error {
_, err := ctx.Client.Inputs.RemoveInput(
inputs.NewRemoveInputParams().WithInputName(cmd.Name),
)
if err != nil {
return fmt.Errorf("failed to delete input: %w", err)
}
fmt.Fprintf(ctx.Out, "Deleted %s\n", ctx.Style.Highlight(cmd.Name))
return nil
} }
// InputListCmd provides a command to list all inputs. // InputListCmd provides a command to list all inputs.
@@ -34,15 +97,35 @@ func (cmd *InputListCmd) Run(ctx *context) error {
return err return err
} }
t := table.New(ctx.Out) t := table.New().Border(lipgloss.RoundedBorder()).
t.SetPadding(3) BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border))
if cmd.UUID { if cmd.UUID {
t.SetAlignment(table.AlignLeft, table.AlignLeft, table.AlignCenter, table.AlignLeft) t.Headers("Input Name", "Kind", "Muted", "UUID")
t.SetHeaders("Input Name", "Kind", "Muted", "UUID")
} else { } else {
t.SetAlignment(table.AlignLeft, table.AlignLeft, table.AlignCenter) t.Headers("Input Name", "Kind", "Muted")
t.SetHeaders("Input Name", "Kind", "Muted")
} }
t.StyleFunc(func(row, col int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
switch col {
case 0:
style = style.Align(lipgloss.Left)
case 1:
style = style.Align(lipgloss.Left)
case 2:
style = style.Align(lipgloss.Center)
case 3:
style = style.Align(lipgloss.Left)
}
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
sort.Slice(resp.Inputs, func(i, j int) bool { sort.Slice(resp.Inputs, func(i, j int) bool {
return resp.Inputs[i].InputName < resp.Inputs[j].InputName return resp.Inputs[i].InputName < resp.Inputs[j].InputName
@@ -55,7 +138,7 @@ func (cmd *InputListCmd) Run(ctx *context) error {
) )
if err != nil { if err != nil {
if err.Error() == "request GetInputMute: InvalidResourceState (604): The specified input does not support audio." { if err.Error() == "request GetInputMute: InvalidResourceState (604): The specified input does not support audio." {
muteMark = "N/A" muteMark = ""
} else { } else {
return fmt.Errorf("failed to get input mute state: %w", err) return fmt.Errorf("failed to get input mute state: %w", err)
} }
@@ -79,9 +162,9 @@ func (cmd *InputListCmd) Run(ctx *context) error {
for _, f := range filters { for _, f := range filters {
if f.enabled && strings.Contains(input.InputKind, f.keyword) { if f.enabled && strings.Contains(input.InputKind, f.keyword) {
if cmd.UUID { if cmd.UUID {
t.AddRow(input.InputName, input.InputKind, muteMark, input.InputUuid) t.Row(input.InputName, input.InputKind, muteMark, input.InputUuid)
} else { } else {
t.AddRow(input.InputName, input.InputKind, muteMark) t.Row(input.InputName, input.InputKind, muteMark)
} }
added = true added = true
break break
@@ -90,13 +173,58 @@ func (cmd *InputListCmd) Run(ctx *context) error {
if !added && (!cmd.Input && !cmd.Output && !cmd.Colour && !cmd.Ffmpeg && !cmd.Vlc) { if !added && (!cmd.Input && !cmd.Output && !cmd.Colour && !cmd.Ffmpeg && !cmd.Vlc) {
if cmd.UUID { if cmd.UUID {
t.AddRow(input.InputName, snakeCaseToTitleCase(input.InputKind), muteMark, input.InputUuid) t.Row(
input.InputName,
snakeCaseToTitleCase(input.InputKind),
muteMark,
input.InputUuid,
)
} else { } else {
t.AddRow(input.InputName, snakeCaseToTitleCase(input.InputKind), muteMark) t.Row(input.InputName, snakeCaseToTitleCase(input.InputKind), muteMark)
} }
} }
} }
t.Render() fmt.Fprintln(ctx.Out, t.Render())
return nil
}
// InputListKindsCmd provides a command to list all input kinds.
type InputListKindsCmd struct{}
// Run executes the command to list all input kinds.
func (cmd *InputListKindsCmd) Run(ctx *context) error {
resp, err := ctx.Client.Inputs.GetInputKindList(
inputs.NewGetInputKindListParams().WithUnversioned(false),
)
if err != nil {
return fmt.Errorf("failed to get input kinds: %w", err)
}
t := table.New().Border(lipgloss.RoundedBorder()).
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border))
t.Headers("Kind")
t.StyleFunc(func(row, col int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
if col == 0 {
style = style.Align(lipgloss.Left)
}
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
for _, kind := range resp.InputKinds {
t.Row(kind)
}
fmt.Fprintln(ctx.Out, t.Render())
return nil return nil
} }
@@ -114,7 +242,7 @@ func (cmd *InputMuteCmd) Run(ctx *context) error {
return fmt.Errorf("failed to mute input: %w", err) return fmt.Errorf("failed to mute input: %w", err)
} }
fmt.Fprintf(ctx.Out, "Muted input: %s\n", cmd.InputName) fmt.Fprintf(ctx.Out, "Muted input: %s\n", ctx.Style.Highlight(cmd.InputName))
return nil return nil
} }
@@ -132,7 +260,7 @@ func (cmd *InputUnmuteCmd) Run(ctx *context) error {
return fmt.Errorf("failed to unmute input: %w", err) return fmt.Errorf("failed to unmute input: %w", err)
} }
fmt.Fprintf(ctx.Out, "Unmuted input: %s\n", cmd.InputName) fmt.Fprintf(ctx.Out, "Unmuted input: %s\n", ctx.Style.Highlight(cmd.InputName))
return nil return nil
} }
@@ -160,9 +288,278 @@ func (cmd *InputToggleCmd) Run(ctx *context) error {
} }
if newMuteState { if newMuteState {
fmt.Fprintf(ctx.Out, "Muted input: %s\n", cmd.InputName) fmt.Fprintf(ctx.Out, "Muted input: %s\n", ctx.Style.Highlight(cmd.InputName))
} else { } else {
fmt.Fprintf(ctx.Out, "Unmuted input: %s\n", cmd.InputName) fmt.Fprintf(ctx.Out, "Unmuted input: %s\n", ctx.Style.Highlight(cmd.InputName))
} }
return nil return nil
} }
// InputVolumeCmd provides a command to set the volume of an input.
type InputVolumeCmd struct {
InputName string `arg:"" help:"Name of the input to set volume for." required:""`
Volume float64 `arg:"" help:"Volume level (-90.0 to 0.0)." required:""`
}
// Run executes the command to set the volume of an input.
// accepts values between -90.0 and 0.0 representing decibels (dB).
func (cmd *InputVolumeCmd) Run(ctx *context) error {
if cmd.Volume < -90.0 || cmd.Volume > 0.0 {
return fmt.Errorf("volume must be between -90.0 and 0.0 dB")
}
_, err := ctx.Client.Inputs.SetInputVolume(
inputs.NewSetInputVolumeParams().
WithInputName(cmd.InputName).
WithInputVolumeDb(cmd.Volume),
)
if err != nil {
return fmt.Errorf("failed to set input volume: %w", err)
}
fmt.Fprintf(ctx.Out, "Set volume of input %s to %.1f dB\n",
ctx.Style.Highlight(cmd.InputName), cmd.Volume)
return nil
}
// InputShowCmd provides a command to show input details.
type InputShowCmd struct {
Name string `arg:"" help:"Name of the input to show." required:""`
Verbose bool ` help:"List all available input devices." flag:""`
}
// Run executes the command to show input details.
func (cmd *InputShowCmd) Run(ctx *context) error {
lresp, err := ctx.Client.Inputs.GetInputList(inputs.NewGetInputListParams())
if err != nil {
return fmt.Errorf("failed to get input list: %w", err)
}
var inputKind string
var found bool
for _, input := range lresp.Inputs {
if input.InputName == cmd.Name {
inputKind = input.InputKind
found = true
break
}
}
if !found {
return fmt.Errorf("input '%s' not found", cmd.Name)
}
prop, name := device(ctx, cmd.Name)
if prop == "" {
return fmt.Errorf("no device property found for input '%s'", cmd.Name)
}
t := table.New().Border(lipgloss.RoundedBorder()).
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border))
t.Headers("Input Name", "Kind", "Device")
t.StyleFunc(func(row, col int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
switch col {
case 0:
style = style.Align(lipgloss.Left)
case 1:
style = style.Align(lipgloss.Left)
case 2:
style = style.Align(lipgloss.Center)
}
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
t.Row(cmd.Name, snakeCaseToTitleCase(inputKind), name)
fmt.Fprintln(ctx.Out, t.Render())
if cmd.Verbose {
deviceListResp, err := ctx.Client.Inputs.GetInputPropertiesListPropertyItems(
inputs.NewGetInputPropertiesListPropertyItemsParams().
WithInputName(cmd.Name).
WithPropertyName(prop),
)
if err != nil {
return fmt.Errorf("failed to get device list: %w", err)
}
t := table.New().Border(lipgloss.RoundedBorder()).
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border))
t.StyleFunc(func(row, col int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
if col == 0 {
style = style.Align(lipgloss.Left)
}
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
t.Headers("Devices")
for _, item := range deviceListResp.PropertyItems {
if item.ItemName != "" {
t.Row(item.ItemName)
}
}
fmt.Fprintln(ctx.Out, t.Render())
}
return nil
}
func device(ctx *context, inputName string) (string, string) {
settings, err := ctx.Client.Inputs.GetInputSettings(
inputs.NewGetInputSettingsParams().WithInputName(inputName),
)
if err != nil {
return "", ""
}
for _, propName := range []string{"device", "device_id"} {
deviceListResp, err := ctx.Client.Inputs.GetInputPropertiesListPropertyItems(
inputs.NewGetInputPropertiesListPropertyItemsParams().
WithInputName(inputName).
WithPropertyName(propName),
)
if err == nil && len(deviceListResp.PropertyItems) > 0 {
for _, item := range deviceListResp.PropertyItems {
if item.ItemValue == settings.InputSettings[propName] {
return propName, item.ItemName
}
}
}
}
return "", ""
}
// InputUpdateCmd provides a command to update input settings.
type InputUpdateCmd struct {
InputName string `arg:"" help:"Name of the input to update." required:""`
DeviceName string `arg:"" help:"Name of the device to set." required:""`
}
// Run executes the command to update input settings.
func (cmd *InputUpdateCmd) Run(ctx *context) error {
// Use the device helper to find the correct device property name
prop, _ := device(ctx, cmd.InputName)
if prop == "" {
return fmt.Errorf("no device property found for input '%s'", cmd.InputName)
}
resp, err := ctx.Client.Inputs.GetInputPropertiesListPropertyItems(
inputs.NewGetInputPropertiesListPropertyItemsParams().
WithInputName(cmd.InputName).
WithPropertyName(prop),
)
if err != nil {
return err
}
var deviceValue any
var found bool
for _, item := range resp.PropertyItems {
if item.ItemName == cmd.DeviceName {
deviceValue = item.ItemValue
found = true
break
}
}
if !found {
return fmt.Errorf("device '%s' not found for input '%s'", cmd.DeviceName, cmd.InputName)
}
sresp, err := ctx.Client.Inputs.GetInputSettings(
inputs.NewGetInputSettingsParams().WithInputName(cmd.InputName),
)
if err != nil {
return err
}
settings := make(map[string]any)
maps.Copy(settings, sresp.InputSettings)
settings[prop] = deviceValue
_, err = ctx.Client.Inputs.SetInputSettings(
inputs.NewSetInputSettingsParams().
WithInputName(cmd.InputName).
WithInputSettings(settings),
)
if err != nil {
return fmt.Errorf("failed to update input settings: %w", err)
}
fmt.Fprintf(ctx.Out, "Input %s %s set to %s\n",
ctx.Style.Highlight(cmd.InputName), prop, ctx.Style.Highlight(cmd.DeviceName))
return nil
}
// InputKindDefaultsCmd provides a command to get default settings for an input kind.
type InputKindDefaultsCmd struct {
Kind string `arg:"" help:"Input kind to get default settings for." required:""`
}
// Run executes the command to get default settings for an input kind.
func (cmd *InputKindDefaultsCmd) Run(ctx *context) error {
resp, err := ctx.Client.Inputs.GetInputDefaultSettings(
inputs.NewGetInputDefaultSettingsParams().
WithInputKind(cmd.Kind),
)
if err != nil {
return fmt.Errorf("failed to get default settings for input kind '%s': %w", cmd.Kind, err)
}
t := table.New().Border(lipgloss.RoundedBorder()).
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border))
t.Headers("Setting", "Value")
t.StyleFunc(func(row, col int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
switch col {
case 0:
style = style.Align(lipgloss.Left)
case 1:
style = style.Align(lipgloss.Center)
}
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
keys := make([]string, 0, len(resp.DefaultInputSettings))
for k := range resp.DefaultInputSettings {
keys = append(keys, k)
}
sort.Strings(keys)
for _, key := range keys {
value := resp.DefaultInputSettings[key]
t.Row(key, fmt.Sprintf("%v", value))
}
fmt.Fprintln(ctx.Out, t.Render())
return nil
}

View File

@@ -11,10 +11,7 @@ func TestInputList(t *testing.T) {
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmd := &InputListCmd{} cmd := &InputListCmd{}
err := cmd.Run(context) err := cmd.Run(context)
@@ -25,9 +22,8 @@ func TestInputList(t *testing.T) {
expectedInputs := []string{ expectedInputs := []string{
"Desktop Audio", "Desktop Audio",
"Mic/Aux", "Mic/Aux",
"Colour Source", "gobs-test-input",
"Colour Source 2", "gobs-test-input-2",
"Colour Source 3",
} }
output := out.String() output := out.String()
for _, input := range expectedInputs { for _, input := range expectedInputs {
@@ -42,10 +38,7 @@ func TestInputListFilterInput(t *testing.T) {
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmd := &InputListCmd{Input: true} cmd := &InputListCmd{Input: true}
err := cmd.Run(context) err := cmd.Run(context)
@@ -58,9 +51,8 @@ func TestInputListFilterInput(t *testing.T) {
} }
expectedFilteredOut := []string{ expectedFilteredOut := []string{
"Desktop Audio", "Desktop Audio",
"Colour Source", "gobs-test-input",
"Colour Source 2", "gobs-test-input-2",
"Colour Source 3",
} }
for _, input := range expectedInputs { for _, input := range expectedInputs {
if !strings.Contains(out.String(), input) { if !strings.Contains(out.String(), input) {
@@ -79,10 +71,7 @@ func TestInputListFilterOutput(t *testing.T) {
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmd := &InputListCmd{Output: true} cmd := &InputListCmd{Output: true}
err := cmd.Run(context) err := cmd.Run(context)
@@ -95,9 +84,8 @@ func TestInputListFilterOutput(t *testing.T) {
} }
expectedFilteredOut := []string{ expectedFilteredOut := []string{
"Mic/Aux", "Mic/Aux",
"Colour Source", "gobs-test-input",
"Colour Source 2", "gobs-test-input-2",
"Colour Source 3",
} }
for _, input := range expectedInputs { for _, input := range expectedInputs {
if !strings.Contains(out.String(), input) { if !strings.Contains(out.String(), input) {
@@ -116,10 +104,7 @@ func TestInputListFilterColour(t *testing.T) {
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmd := &InputListCmd{Colour: true} cmd := &InputListCmd{Colour: true}
err := cmd.Run(context) err := cmd.Run(context)
@@ -128,9 +113,8 @@ func TestInputListFilterColour(t *testing.T) {
} }
expectedInputs := []string{ expectedInputs := []string{
"Colour Source", "gobs-test-input",
"Colour Source 2", "gobs-test-input-2",
"Colour Source 3",
} }
for _, input := range expectedInputs { for _, input := range expectedInputs {
if !strings.Contains(out.String(), input) { if !strings.Contains(out.String(), input) {

151
main.go
View File

@@ -8,51 +8,88 @@ import (
"io" "io"
"os" "os"
"path/filepath" "path/filepath"
"runtime/debug"
"strings"
"time" "time"
"github.com/alecthomas/kong" "github.com/alecthomas/kong"
mangokong "github.com/alecthomas/mango-kong" mangokong "github.com/alecthomas/mango-kong"
"github.com/andreykaipov/goobs" "github.com/andreykaipov/goobs"
kongcompletion "github.com/jotaen/kong-completion"
kongdotenv "github.com/titusjaka/kong-dotenv-go" kongdotenv "github.com/titusjaka/kong-dotenv-go"
) )
var version string // Version of the CLI, set at build time.
// VersionFlag is a custom flag type that prints the version and exits.
type VersionFlag string
func (v VersionFlag) Decode(_ *kong.DecodeContext) error { return nil } // nolint: revive
func (v VersionFlag) IsBool() bool { return true } // nolint: revive
func (v VersionFlag) BeforeApply(app *kong.Kong, vars kong.Vars) error { // nolint: revive, unparam
fmt.Printf("gobs-cli version: %s\n", vars["version"])
app.Exit(0)
return nil
}
// ObsConfig holds the configuration for connecting to the OBS WebSocket server. // ObsConfig holds the configuration for connecting to the OBS WebSocket server.
type ObsConfig struct { type ObsConfig struct {
Host string `flag:"host" help:"Host to connect to." default:"localhost" env:"OBS_HOST" short:"H"` Host string `flag:"host" help:"Host to connect to." default:"localhost" env:"OBS_HOST" short:"H" completion-enabled-flag-short:"false"`
Port int `flag:"port" help:"Port to connect to." default:"4455" env:"OBS_PORT" short:"P"` Port int `flag:"port" help:"Port to connect to." default:"4455" env:"OBS_PORT" short:"P" completion-enabled-flag-short:"false"`
Password string `flag:"password" help:"Password for authentication." default:"" env:"OBS_PASSWORD" short:"p"` Password string `flag:"password" help:"Password for authentication." default:"" env:"OBS_PASSWORD" short:"p" completion-enabled-flag-short:"false"`
Timeout int `flag:"timeout" help:"Timeout in seconds." default:"5" env:"OBS_TIMEOUT" short:"T"` Timeout int `flag:"timeout" help:"Timeout in seconds." default:"5" env:"OBS_TIMEOUT" short:"T" completion-enabled-flag-short:"false"`
}
// StyleConfig holds the configuration for styling the CLI output.
type StyleConfig struct {
Style string `flag:"style" help:"Style used in output." default:"" env:"GOBS_STYLE" short:"s" enum:",red,magenta,purple,blue,cyan,green,yellow,orange,white,grey,navy,black" completion-enabled-flag-short:"false"`
NoBorder bool `flag:"no-border" help:"Disable table border styling in output." default:"false" env:"GOBS_STYLE_NO_BORDER" short:"b" completion-enabled-flag-short:"false"`
} }
// CLI is the main command line interface structure. // CLI is the main command line interface structure.
// It embeds the ObsConfig struct to inherit its fields and flags. // It embeds ObsConfig and StyleConfig to provide configuration options.
type CLI struct { type CLI struct {
ObsConfig `embed:"" help:"OBS WebSocket configuration."` ObsConfig `embed:"" help:"OBS WebSocket configuration."`
StyleConfig `embed:"" help:"Style configuration."`
Man mangokong.ManFlag `help:"Print man page."` Man mangokong.ManFlag `help:"Print man page."`
Version VersionFlag `help:"Print gobs-cli version information and quit" name:"version" short:"v"` Version VersionFlag `help:"Print gobs-cli version information and quit" name:"version" short:"v"`
ObsVersion ObsVersionCmd `help:"Print OBS client and websocket version." cmd:"" aliases:"v"` Completion kongcompletion.Completion `help:"Generate shell completion scripts." cmd:""`
Scene SceneCmd `help:"Manage scenes." cmd:"" aliases:"sc" group:"Scene"`
Sceneitem SceneItemCmd `help:"Manage scene items." cmd:"" aliases:"si" group:"Scene Item"` ObsVersion ObsVersionCmd `cmd:"" help:"Print OBS client and websocket version." aliases:"v" completion-enabled-command-alias:"false"`
Group GroupCmd `help:"Manage groups." cmd:"" aliases:"g" group:"Group"` Scene SceneCmd `cmd:"" help:"Manage scenes." aliases:"sc" completion-enabled-command-alias:"false" group:"Scene"`
Input InputCmd `help:"Manage inputs." cmd:"" aliases:"i" group:"Input"` Sceneitem SceneItemCmd `cmd:"" help:"Manage scene items." aliases:"si" completion-enabled-command-alias:"false" group:"Scene Item"`
Record RecordCmd `help:"Manage recording." cmd:"" aliases:"rec" group:"Recording"` Group GroupCmd `cmd:"" help:"Manage groups." aliases:"g" completion-enabled-command-alias:"false" group:"Group"`
Stream StreamCmd `help:"Manage streaming." cmd:"" aliases:"st" group:"Streaming"` Input InputCmd `cmd:"" help:"Manage inputs." aliases:"i" completion-enabled-command-alias:"false" group:"Input"`
Scenecollection SceneCollectionCmd `help:"Manage scene collections." cmd:"" aliases:"scn" group:"Scene Collection"` Text TextCmd `cmd:"" help:"Manage text inputs." aliases:"t" completion-enabled-command-alias:"false" group:"Text Input"`
Profile ProfileCmd `help:"Manage profiles." cmd:"" aliases:"p" group:"Profile"` Record RecordCmd `cmd:"" help:"Manage recording." aliases:"rec" completion-enabled-command-alias:"false" group:"Recording"`
Replaybuffer ReplayBufferCmd `help:"Manage replay buffer." cmd:"" aliases:"rb" group:"Replay Buffer"` Stream StreamCmd `cmd:"" help:"Manage streaming." aliases:"st" completion-enabled-command-alias:"false" group:"Streaming"`
Studiomode StudioModeCmd `help:"Manage studio mode." cmd:"" aliases:"sm" group:"Studio Mode"` Scenecollection SceneCollectionCmd `cmd:"" help:"Manage scene collections." aliases:"scn" completion-enabled-command-alias:"false" group:"Scene Collection"`
Virtualcam VirtualCamCmd `help:"Manage virtual camera." cmd:"" aliases:"vc" group:"Virtual Camera"` Profile ProfileCmd `cmd:"" help:"Manage profiles." aliases:"p" completion-enabled-command-alias:"false" group:"Profile"`
Hotkey HotkeyCmd `help:"Manage hotkeys." cmd:"" aliases:"hk" group:"Hotkey"` Replaybuffer ReplayBufferCmd `cmd:"" help:"Manage replay buffer." aliases:"rb" completion-enabled-command-alias:"false" group:"Replay Buffer"`
Filter FilterCmd `help:"Manage filters." cmd:"" aliases:"f" group:"Filter"` Studiomode StudioModeCmd `cmd:"" help:"Manage studio mode." aliases:"sm" completion-enabled-command-alias:"false" group:"Studio Mode"`
Projector ProjectorCmd `help:"Manage projectors." cmd:"" aliases:"prj" group:"Projector"` Virtualcam VirtualCamCmd `cmd:"" help:"Manage virtual camera." aliases:"vc" completion-enabled-command-alias:"false" group:"Virtual Camera"`
Screenshot ScreenshotCmd `help:"Take screenshots." cmd:"" aliases:"ss" group:"Screenshot"` Hotkey HotkeyCmd `cmd:"" help:"Manage hotkeys." aliases:"hk" completion-enabled-command-alias:"false" group:"Hotkey"`
Filter FilterCmd `cmd:"" help:"Manage filters." aliases:"f" completion-enabled-command-alias:"false" group:"Filter"`
Projector ProjectorCmd `cmd:"" help:"Manage projectors." aliases:"prj" completion-enabled-command-alias:"false" group:"Projector"`
Screenshot ScreenshotCmd `cmd:"" help:"Take screenshots." aliases:"ss" completion-enabled-command-alias:"false" group:"Screenshot"`
Settings SettingsCmd `cmd:"" help:"Manage video and profile settings." aliases:"set" completion-enabled-command-alias:"false" group:"Settings"`
Media MediaCmd `cmd:"" help:"Manage media inputs." aliases:"mi" completion-enabled-command-alias:"false" group:"Media Input"`
} }
type context struct { type context struct {
Client *goobs.Client Client *goobs.Client
Out io.Writer Out io.Writer
Style *Style
}
func newContext(client *goobs.Client, out io.Writer, styleCfg StyleConfig) *context {
return &context{
Client: client,
Out: out,
Style: styleFromFlag(styleCfg),
}
} }
func main() { func main() {
@@ -63,22 +100,61 @@ func main() {
} }
var cli CLI var cli CLI
kongcompletion.Register(kong.Must(&cli))
ctx := kong.Parse( ctx := kong.Parse(
&cli, &cli,
kong.Name("GOBS-CLI"), kong.Name("gobs-cli"),
kong.Description("A command line tool to interact with OBS Websocket."), kong.Description("A command line tool to interact with OBS Websocket."),
kong.Configuration(kongdotenv.ENVFileReader, ".env", filepath.Join(userConfigDir, "gobs-cli", "config.env")), kong.Configuration(
kongdotenv.ENVFileReader,
".env",
filepath.Join(userConfigDir, "gobs-cli", "config.env"),
),
kong.UsageOnError(),
kong.ConfigureHelp(kong.HelpOptions{
Compact: true,
}),
kong.Vars{
"version": func() string {
if version != "" {
return version
}
info, ok := debug.ReadBuildInfo()
if !ok {
return "(unable to read version)"
}
return strings.Split(info.Main.Version, "-")[0]
}(),
},
) )
client, err := connectObs(cli.ObsConfig) ctx.FatalIfErrorf(run(ctx, cli.ObsConfig, cli.StyleConfig))
ctx.FatalIfErrorf(err) }
ctx.Bind(&context{ // run executes the command line interface.
Client: client, // It connects to the OBS WebSocket server and binds the context to the selected command.
Out: os.Stdout, // It also handles the "completion" command separately to avoid unnecessary connections.
}) func run(ctx *kong.Context, obsCfg ObsConfig, styleCfg StyleConfig) error {
if ctx.Selected().Name == "completion" {
return ctx.Run()
}
ctx.FatalIfErrorf(run(ctx, client)) client, err := connectObs(obsCfg)
if err != nil {
return err
}
defer func() error {
if err := client.Disconnect(); err != nil {
return fmt.Errorf("failed to disconnect from OBS: %w", err)
}
return nil
}() // nolint: errcheck
ctx.Bind(newContext(client, os.Stdout, styleCfg))
return ctx.Run()
} }
// connectObs creates a new OBS client and connects to the OBS WebSocket server. // connectObs creates a new OBS client and connects to the OBS WebSocket server.
@@ -93,16 +169,3 @@ func connectObs(cfg ObsConfig) (*goobs.Client, error) {
} }
return client, nil return client, nil
} }
// run executes the command line interface.
// It disconnects the OBS client after the command is executed.
func run(ctx *kong.Context, client *goobs.Client) error {
defer func() error {
if err := client.Disconnect(); err != nil {
return fmt.Errorf("failed to disconnect from OBS: %w", err)
}
return nil
}()
return ctx.Run()
}

View File

@@ -2,7 +2,9 @@ package main
import ( import (
"os" "os"
"runtime"
"testing" "testing"
"time"
"github.com/andreykaipov/goobs" "github.com/andreykaipov/goobs"
"github.com/andreykaipov/goobs/api/requests/config" "github.com/andreykaipov/goobs/api/requests/config"
@@ -41,7 +43,6 @@ func TestMain(m *testing.M) {
if err != nil { if err != nil {
os.Exit(1) os.Exit(1)
} }
defer client.Disconnect()
setup(client) setup(client)
@@ -49,11 +50,13 @@ func TestMain(m *testing.M) {
exitCode := m.Run() exitCode := m.Run()
teardown(client) teardown(client)
client.Disconnect()
// Exit with the appropriate code // Exit with the appropriate code
os.Exit(exitCode) os.Exit(exitCode)
} }
// nolint: misspell
func setup(client *goobs.Client) { func setup(client *goobs.Client) {
client.Config.SetStreamServiceSettings(config.NewSetStreamServiceSettingsParams(). client.Config.SetStreamServiceSettings(config.NewSetStreamServiceSettingsParams().
WithStreamServiceType("rtmp_common"). WithStreamServiceType("rtmp_common").
@@ -62,13 +65,23 @@ func setup(client *goobs.Client) {
Key: os.Getenv("OBS_STREAM_KEY"), Key: os.Getenv("OBS_STREAM_KEY"),
})) }))
client.Config.SetCurrentSceneCollection(config.NewSetCurrentSceneCollectionParams(). client.Config.CreateProfile(config.NewCreateProfileParams().
WithSceneCollectionName("test-collection")) WithProfileName("gobs-test-profile"))
time.Sleep(100 * time.Millisecond) // Wait for the profile to be created
client.Config.SetProfileParameter(config.NewSetProfileParameterParams().
WithParameterCategory("SimpleOutput").
WithParameterName("RecRB").
WithParameterValue("true"))
// hack to ensure the Replay Buffer setting is applied
client.Config.SetCurrentProfile(config.NewSetCurrentProfileParams().
WithProfileName("Untitled"))
client.Config.SetCurrentProfile(config.NewSetCurrentProfileParams().
WithProfileName("gobs-test-profile"))
client.Scenes.CreateScene(scenes.NewCreateSceneParams(). client.Scenes.CreateScene(scenes.NewCreateSceneParams().
WithSceneName("gobs-test")) WithSceneName("gobs-test-scene"))
client.Inputs.CreateInput(inputs.NewCreateInputParams(). client.Inputs.CreateInput(inputs.NewCreateInputParams().
WithSceneName("gobs-test"). WithSceneName("gobs-test-scene").
WithInputName("gobs-test-input"). WithInputName("gobs-test-input").
WithInputKind("color_source_v3"). WithInputKind("color_source_v3").
WithInputSettings(map[string]any{ WithInputSettings(map[string]any{
@@ -79,7 +92,7 @@ func setup(client *goobs.Client) {
}). }).
WithSceneItemEnabled(true)) WithSceneItemEnabled(true))
client.Inputs.CreateInput(inputs.NewCreateInputParams(). client.Inputs.CreateInput(inputs.NewCreateInputParams().
WithSceneName("gobs-test"). WithSceneName("gobs-test-scene").
WithInputName("gobs-test-input-2"). WithInputName("gobs-test-input-2").
WithInputKind("color_source_v3"). WithInputKind("color_source_v3").
WithInputSettings(map[string]any{ WithInputSettings(map[string]any{
@@ -90,6 +103,37 @@ func setup(client *goobs.Client) {
}). }).
WithSceneItemEnabled(true)) WithSceneItemEnabled(true))
// ensure Desktop Audio input is created
desktopAudioKinds := map[string]string{
"windows": "wasapi_output_capture",
"linux": "pulse_output_capture",
"darwin": "coreaudio_output_capture",
}
platform := os.Getenv("GOBS_TEST_PLATFORM")
if platform == "" {
platform = runtime.GOOS
}
client.Inputs.CreateInput(inputs.NewCreateInputParams().
WithSceneName("gobs-test-scene").
WithInputName("Desktop Audio").
WithInputKind(desktopAudioKinds[platform]).
WithInputSettings(map[string]any{
"device_id": "default",
}))
// ensure Mic/Aux input is created
micKinds := map[string]string{
"windows": "wasapi_input_capture",
"linux": "pulse_input_capture",
"darwin": "coreaudio_input_capture",
}
client.Inputs.CreateInput(inputs.NewCreateInputParams().
WithSceneName("gobs-test-scene").
WithInputName("Mic/Aux").
WithInputKind(micKinds[platform]).
WithInputSettings(map[string]any{
"device_id": "default",
}))
// Create source filter on an audio input // Create source filter on an audio input
client.Filters.CreateSourceFilter(filters.NewCreateSourceFilterParams(). client.Filters.CreateSourceFilter(filters.NewCreateSourceFilterParams().
WithSourceName("Mic/Aux"). WithSourceName("Mic/Aux").
@@ -106,7 +150,7 @@ func setup(client *goobs.Client) {
// Create source filter on a scene // Create source filter on a scene
client.Filters.CreateSourceFilter(filters.NewCreateSourceFilterParams(). client.Filters.CreateSourceFilter(filters.NewCreateSourceFilterParams().
WithSourceName("gobs-test"). WithSourceName("gobs-test-scene").
WithFilterName("test_filter"). WithFilterName("test_filter").
WithFilterKind("luma_key_filter_v2"). WithFilterKind("luma_key_filter_v2").
WithFilterSettings(map[string]any{ WithFilterSettings(map[string]any{
@@ -115,18 +159,21 @@ func setup(client *goobs.Client) {
} }
func teardown(client *goobs.Client) { func teardown(client *goobs.Client) {
client.Config.RemoveProfile(config.NewRemoveProfileParams().
WithProfileName("gobs-test-profile"))
client.Filters.RemoveSourceFilter(filters.NewRemoveSourceFilterParams(). client.Filters.RemoveSourceFilter(filters.NewRemoveSourceFilterParams().
WithSourceName("Mic/Aux"). WithSourceName("Mic/Aux").
WithFilterName("test_filter")) WithFilterName("test_filter"))
client.Filters.RemoveSourceFilter(filters.NewRemoveSourceFilterParams(). client.Filters.RemoveSourceFilter(filters.NewRemoveSourceFilterParams().
WithSourceName("gobs-test"). WithSourceName("gobs-test-scene").
WithFilterName("test_filter")) WithFilterName("test_filter"))
client.Scenes.RemoveScene(scenes.NewRemoveSceneParams(). client.Scenes.RemoveScene(scenes.NewRemoveSceneParams().
WithSceneName("gobs-test")) WithSceneName("gobs-test-scene"))
client.Config.SetCurrentSceneCollection(config.NewSetCurrentSceneCollectionParams(). client.Config.SetCurrentSceneCollection(config.NewSetCurrentSceneCollectionParams().
WithSceneCollectionName("default")) WithSceneCollectionName("Untitled"))
client.Stream.StopStream() client.Stream.StopStream()
client.Record.StopRecord() client.Record.StopRecord()

140
media.go Normal file
View File

@@ -0,0 +1,140 @@
package main
import (
"fmt"
"github.com/andreykaipov/goobs/api/requests/mediainputs"
)
// MediaCmd represents a collection of commands to control media inputs.
type MediaCmd struct {
Cursor MediaCursorCmd `cmd:"" help:"Get/set the cursor position of a media input." aliases:"c" completion-enabled-command-alias:"false"`
Play MediaPlayCmd `cmd:"" help:"Plays a media input." aliases:"p" completion-enabled-command-alias:"false"`
Pause MediaPauseCmd `cmd:"" help:"Pauses a media input." aliases:"pa" completion-enabled-command-alias:"false"`
Stop MediaStopCmd `cmd:"" help:"Stops a media input." aliases:"s" completion-enabled-command-alias:"false"`
Restart MediaRestartCmd `cmd:"" help:"Restarts a media input." aliases:"r" completion-enabled-command-alias:"false"`
}
// MediaCursorCmd represents the command to get or set the cursor position of a media input.
type MediaCursorCmd struct {
InputName string `arg:"" help:"Name of the media input."`
TimeString string `arg:"" help:"Time position to set the cursor to (e.g., '00:01:30' for 1 minute 30 seconds). If not provided, the current cursor position will be displayed." optional:""`
}
// Run executes the command to set the cursor position of the media input.
func (cmd *MediaCursorCmd) Run(ctx *context) error {
if cmd.TimeString == "" {
resp, err := ctx.Client.MediaInputs.GetMediaInputStatus(
mediainputs.NewGetMediaInputStatusParams().
WithInputName(cmd.InputName))
if err != nil {
return fmt.Errorf("failed to get media input cursor: %w", err)
}
fmt.Fprintf(
ctx.Out,
"%s cursor position: %s\n",
ctx.Style.Highlight(cmd.InputName),
formatMillisecondsToTimeString(resp.MediaCursor),
)
return nil
}
position, err := parseTimeStringToMilliseconds(cmd.TimeString)
if err != nil {
return fmt.Errorf("failed to parse time string: %w", err)
}
_, err = ctx.Client.MediaInputs.SetMediaInputCursor(
mediainputs.NewSetMediaInputCursorParams().
WithInputName(cmd.InputName).
WithMediaCursor(position))
if err != nil {
return fmt.Errorf("failed to set media input cursor: %w", err)
}
fmt.Fprintf(
ctx.Out,
"Set %s cursor to %s (%.0f ms)\n",
ctx.Style.Highlight(cmd.InputName),
ctx.Style.Highlight(cmd.TimeString),
position,
)
return nil
}
// MediaPlayCmd represents the command to play a media input.
type MediaPlayCmd struct {
InputName string `arg:"" help:"Name of the media input."`
}
// Run executes the command to play the media input.
func (cmd *MediaPlayCmd) Run(ctx *context) error {
_, err := ctx.Client.MediaInputs.TriggerMediaInputAction(
mediainputs.NewTriggerMediaInputActionParams().
WithInputName(cmd.InputName).
WithMediaAction("OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PLAY"))
if err != nil {
return fmt.Errorf("failed to play media input: %w", err)
}
fmt.Fprintln(ctx.Out, "Playing media input:", cmd.InputName)
return nil
}
// MediaPauseCmd represents the command to pause a media input.
type MediaPauseCmd struct {
InputName string `arg:"" help:"Name of the media input."`
}
// Run executes the command to pause the media input.
func (cmd *MediaPauseCmd) Run(ctx *context) error {
_, err := ctx.Client.MediaInputs.TriggerMediaInputAction(
mediainputs.NewTriggerMediaInputActionParams().
WithInputName(cmd.InputName).
WithMediaAction("OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PAUSE"))
if err != nil {
return fmt.Errorf("failed to pause media input: %w", err)
}
fmt.Fprintln(ctx.Out, "Pausing media input:", cmd.InputName)
return nil
}
// MediaStopCmd represents the command to stop a media input.
type MediaStopCmd struct {
InputName string `arg:"" help:"Name of the media input."`
}
// Run executes the command to stop the media input.
func (cmd *MediaStopCmd) Run(ctx *context) error {
_, err := ctx.Client.MediaInputs.TriggerMediaInputAction(
mediainputs.NewTriggerMediaInputActionParams().
WithInputName(cmd.InputName).
WithMediaAction("OBS_WEBSOCKET_MEDIA_INPUT_ACTION_STOP"))
if err != nil {
return fmt.Errorf("failed to stop media input: %w", err)
}
fmt.Fprintln(ctx.Out, "Stopping media input:", cmd.InputName)
return nil
}
// MediaRestartCmd represents the command to restart a media input.
type MediaRestartCmd struct {
InputName string `arg:"" help:"Name of the media input."`
}
// Run executes the command to restart the media input.
func (cmd *MediaRestartCmd) Run(ctx *context) error {
_, err := ctx.Client.MediaInputs.TriggerMediaInputAction(
mediainputs.NewTriggerMediaInputActionParams().
WithInputName(cmd.InputName).
WithMediaAction("OBS_WEBSOCKET_MEDIA_INPUT_ACTION_RESTART"))
if err != nil {
return fmt.Errorf("failed to restart media input: %w", err)
}
fmt.Fprintln(ctx.Out, "Restarting media input:", cmd.InputName)
return nil
}

View File

@@ -5,32 +5,51 @@ import (
"slices" "slices"
"github.com/andreykaipov/goobs/api/requests/config" "github.com/andreykaipov/goobs/api/requests/config"
"github.com/aquasecurity/table" "github.com/charmbracelet/lipgloss"
"github.com/charmbracelet/lipgloss/table"
) )
// ProfileCmd provides commands to manage profiles in OBS Studio. // ProfileCmd provides commands to manage profiles in OBS Studio.
type ProfileCmd struct { type ProfileCmd struct {
List ProfileListCmd `help:"List profiles." cmd:"" aliases:"ls"` List ProfileListCmd `cmd:"" help:"List profiles." aliases:"ls" completion-enabled-command-alias:"false"`
Current ProfileCurrentCmd `help:"Get current profile." cmd:"" aliases:"c"` Current ProfileCurrentCmd `cmd:"" help:"Get current profile." aliases:"c" completion-enabled-command-alias:"false"`
Switch ProfileSwitchCmd `help:"Switch profile." cmd:"" aliases:"sw"` Switch ProfileSwitchCmd `cmd:"" help:"Switch profile." aliases:"sw" completion-enabled-command-alias:"false"`
Create ProfileCreateCmd `help:"Create profile." cmd:"" aliases:"new"` Create ProfileCreateCmd `cmd:"" help:"Create profile." aliases:"new" completion-enabled-command-alias:"false"`
Remove ProfileRemoveCmd `help:"Remove profile." cmd:"" aliases:"rm"` Remove ProfileRemoveCmd `cmd:"" help:"Remove profile." aliases:"rm" completion-enabled-command-alias:"false"`
} }
// ProfileListCmd provides a command to list all profiles. // ProfileListCmd provides a command to list all profiles.
type ProfileListCmd struct{} // size = 0x0 type ProfileListCmd struct{} // size = 0x0
// Run executes the command to list all profiles. // Run executes the command to list all profiles.
// nolint: misspell
func (cmd *ProfileListCmd) Run(ctx *context) error { func (cmd *ProfileListCmd) Run(ctx *context) error {
profiles, err := ctx.Client.Config.GetProfileList() profiles, err := ctx.Client.Config.GetProfileList()
if err != nil { if err != nil {
return err return err
} }
t := table.New(ctx.Out) t := table.New().Border(lipgloss.RoundedBorder()).
t.SetPadding(3) BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border)).
t.SetAlignment(table.AlignLeft, table.AlignCenter) Headers("Profile Name", "Current").
t.SetHeaders("Profile Name", "Current") StyleFunc(func(row, col int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
switch col {
case 0:
style = style.Align(lipgloss.Left)
case 1:
style = style.Align(lipgloss.Center)
}
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
for _, profile := range profiles.Profiles { for _, profile := range profiles.Profiles {
var enabledMark string var enabledMark string
@@ -38,9 +57,9 @@ func (cmd *ProfileListCmd) Run(ctx *context) error {
enabledMark = getEnabledMark(true) enabledMark = getEnabledMark(true)
} }
t.AddRow(profile, enabledMark) t.Row(profile, enabledMark)
} }
t.Render() fmt.Fprintln(ctx.Out, t.Render())
return nil return nil
} }
@@ -53,7 +72,7 @@ func (cmd *ProfileCurrentCmd) Run(ctx *context) error {
if err != nil { if err != nil {
return err return err
} }
fmt.Fprintf(ctx.Out, "Current profile: %s\n", profiles.CurrentProfileName) fmt.Fprintf(ctx.Out, "Current profile: %s\n", ctx.Style.Highlight(profiles.CurrentProfileName))
return nil return nil
} }
@@ -72,15 +91,22 @@ func (cmd *ProfileSwitchCmd) Run(ctx *context) error {
current := profiles.CurrentProfileName current := profiles.CurrentProfileName
if current == cmd.Name { if current == cmd.Name {
return nil return fmt.Errorf("already using profile %s", ctx.Style.Error(cmd.Name))
} }
_, err = ctx.Client.Config.SetCurrentProfile(config.NewSetCurrentProfileParams().WithProfileName(cmd.Name)) _, err = ctx.Client.Config.SetCurrentProfile(
config.NewSetCurrentProfileParams().WithProfileName(cmd.Name),
)
if err != nil { if err != nil {
return err return fmt.Errorf("failed to switch to profile %s: %w", ctx.Style.Error(cmd.Name), err)
} }
fmt.Fprintf(ctx.Out, "Switched from profile %s to %s\n", current, cmd.Name) fmt.Fprintf(
ctx.Out,
"Switched from profile %s to %s\n",
ctx.Style.Highlight(current),
ctx.Style.Highlight(cmd.Name),
)
return nil return nil
} }
@@ -98,15 +124,17 @@ func (cmd *ProfileCreateCmd) Run(ctx *context) error {
} }
if slices.Contains(profiles.Profiles, cmd.Name) { if slices.Contains(profiles.Profiles, cmd.Name) {
return fmt.Errorf("profile %s already exists", cmd.Name) return fmt.Errorf("profile %s already exists", ctx.Style.Error(cmd.Name))
} }
_, err = ctx.Client.Config.CreateProfile(config.NewCreateProfileParams().WithProfileName(cmd.Name)) _, err = ctx.Client.Config.CreateProfile(
config.NewCreateProfileParams().WithProfileName(cmd.Name),
)
if err != nil { if err != nil {
return err return fmt.Errorf("failed to create profile %s: %w", ctx.Style.Error(cmd.Name), err)
} }
fmt.Fprintf(ctx.Out, "Created profile: %s\n", cmd.Name) fmt.Fprintf(ctx.Out, "Created profile: %s\n", ctx.Style.Highlight(cmd.Name))
return nil return nil
} }
@@ -124,19 +152,23 @@ func (cmd *ProfileRemoveCmd) Run(ctx *context) error {
} }
if !slices.Contains(profiles.Profiles, cmd.Name) { if !slices.Contains(profiles.Profiles, cmd.Name) {
return fmt.Errorf("profile %s does not exist", cmd.Name) return fmt.Errorf("profile %s does not exist", ctx.Style.Error(cmd.Name))
} }
// Prevent deletion of the current profile
// This is allowed in OBS Studio (with a confirmation prompt), but we want to prevent it here
if profiles.CurrentProfileName == cmd.Name { if profiles.CurrentProfileName == cmd.Name {
return fmt.Errorf("cannot delete current profile %s", cmd.Name) return fmt.Errorf("cannot delete current profile %s", ctx.Style.Error(cmd.Name))
} }
_, err = ctx.Client.Config.RemoveProfile(config.NewRemoveProfileParams().WithProfileName(cmd.Name)) _, err = ctx.Client.Config.RemoveProfile(
config.NewRemoveProfileParams().WithProfileName(cmd.Name),
)
if err != nil { if err != nil {
return err return fmt.Errorf("failed to delete profile %s: %w", ctx.Style.Error(cmd.Name), err)
} }
fmt.Fprintf(ctx.Out, "Deleted profile: %s\n", cmd.Name) fmt.Fprintf(ctx.Out, "Deleted profile: %s\n", ctx.Style.Highlight(cmd.Name))
return nil return nil
} }

View File

@@ -4,19 +4,21 @@ import (
"fmt" "fmt"
"github.com/andreykaipov/goobs/api/requests/ui" "github.com/andreykaipov/goobs/api/requests/ui"
"github.com/aquasecurity/table" "github.com/charmbracelet/lipgloss"
"github.com/charmbracelet/lipgloss/table"
) )
// ProjectorCmd provides a command to manage projectors in OBS. // ProjectorCmd provides a command to manage projectors in OBS.
type ProjectorCmd struct { type ProjectorCmd struct {
ListMonitors ProjectorListMonitorsCmd `cmd:"" help:"List available monitors." aliases:"ls-m"` ListMonitors ProjectorListMonitorsCmd `cmd:"" help:"List available monitors." aliases:"ls-m" completion-enabled-command-alias:"false"`
Open ProjectorOpenCmd `cmd:"" help:"Open a fullscreen projector for a source on a specific monitor." aliases:"o"` Open ProjectorOpenCmd `cmd:"" help:"Open a fullscreen projector for a source on a specific monitor." aliases:"o" completion-enabled-command-alias:"false"`
} }
// ProjectorListMonitorsCmd provides a command to list all monitors available for projectors. // ProjectorListMonitorsCmd provides a command to list all monitors available for projectors.
type ProjectorListMonitorsCmd struct{} // size = 0x0 type ProjectorListMonitorsCmd struct{} // size = 0x0
// Run executes the command to list all monitors available for projectors. // Run executes the command to list all monitors available for projectors.
// nolint: misspell
func (cmd *ProjectorListMonitorsCmd) Run(ctx *context) error { func (cmd *ProjectorListMonitorsCmd) Run(ctx *context) error {
monitors, err := ctx.Client.Ui.GetMonitorList() monitors, err := ctx.Client.Ui.GetMonitorList()
if err != nil { if err != nil {
@@ -24,20 +26,37 @@ func (cmd *ProjectorListMonitorsCmd) Run(ctx *context) error {
} }
if len(monitors.Monitors) == 0 { if len(monitors.Monitors) == 0 {
ctx.Out.Write([]byte("No monitors found for projectors.\n")) fmt.Fprintf(ctx.Out, "No monitors found.\n")
return nil return nil
} }
t := table.New(ctx.Out) t := table.New().Border(lipgloss.RoundedBorder()).
t.SetPadding(3) BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border)).
t.SetAlignment(table.AlignCenter, table.AlignLeft) Headers("Monitor ID", "Monitor Name").
t.SetHeaders("Monitor ID", "Monitor Name") StyleFunc(func(row, col int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
switch col {
case 0:
style = style.Align(lipgloss.Center)
case 1:
style = style.Align(lipgloss.Left)
}
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
for _, monitor := range monitors.Monitors { for _, monitor := range monitors.Monitors {
t.AddRow(fmt.Sprintf("%d", monitor.MonitorIndex), monitor.MonitorName) t.Row(fmt.Sprintf("%d", monitor.MonitorIndex), monitor.MonitorName)
} }
t.Render() fmt.Fprintln(ctx.Out, t.Render())
return nil return nil
} }
@@ -57,10 +76,39 @@ func (cmd *ProjectorOpenCmd) Run(ctx *context) error {
cmd.SourceName = currentScene.SceneName cmd.SourceName = currentScene.SceneName
} }
ctx.Client.Ui.OpenSourceProjector(ui.NewOpenSourceProjectorParams(). monitors, err := ctx.Client.Ui.GetMonitorList()
if err != nil {
return err
}
var monitorName string
for _, monitor := range monitors.Monitors {
if monitor.MonitorIndex == cmd.MonitorIndex {
monitorName = monitor.MonitorName
break
}
}
if monitorName == "" {
return fmt.Errorf(
"monitor with index %s not found. use %s to list available monitors",
ctx.Style.Error(fmt.Sprintf("%d", cmd.MonitorIndex)),
ctx.Style.Error("gobs-cli prj ls-m"),
)
}
_, err = ctx.Client.Ui.OpenSourceProjector(ui.NewOpenSourceProjectorParams().
WithSourceName(cmd.SourceName). WithSourceName(cmd.SourceName).
WithMonitorIndex(cmd.MonitorIndex)) WithMonitorIndex(cmd.MonitorIndex))
if err != nil {
return fmt.Errorf("failed to open projector: %w", err)
}
fmt.Fprintf(ctx.Out, "Opened projector for source '%s' on monitor index %d.\n", cmd.SourceName, cmd.MonitorIndex) fmt.Fprintf(
ctx.Out,
"Opened projector for source %s on monitor %s.\n",
ctx.Style.Highlight(cmd.SourceName),
ctx.Style.Highlight(monitorName),
)
return nil return nil
} }

103
record.go
View File

@@ -4,17 +4,20 @@ import (
"fmt" "fmt"
"github.com/andreykaipov/goobs/api/requests/config" "github.com/andreykaipov/goobs/api/requests/config"
"github.com/andreykaipov/goobs/api/requests/record"
) )
// RecordCmd handles the recording commands. // RecordCmd handles the recording commands.
type RecordCmd struct { type RecordCmd struct {
Start RecordStartCmd `cmd:"" help:"Start recording." aliases:"s"` Start RecordStartCmd `cmd:"" help:"Start recording." aliases:"s" completion-enabled-command-alias:"false"`
Stop RecordStopCmd `cmd:"" help:"Stop recording." aliases:"st"` Stop RecordStopCmd `cmd:"" help:"Stop recording." aliases:"st" completion-enabled-command-alias:"false"`
Toggle RecordToggleCmd `cmd:"" help:"Toggle recording." aliases:"tg"` Toggle RecordToggleCmd `cmd:"" help:"Toggle recording." aliases:"tg" completion-enabled-command-alias:"false"`
Status RecordStatusCmd `cmd:"" help:"Show recording status." aliases:"ss"` Status RecordStatusCmd `cmd:"" help:"Show recording status." aliases:"ss" completion-enabled-command-alias:"false"`
Pause RecordPauseCmd `cmd:"" help:"Pause recording." aliases:"p"` Pause RecordPauseCmd `cmd:"" help:"Pause recording." aliases:"p" completion-enabled-command-alias:"false"`
Resume RecordResumeCmd `cmd:"" help:"Resume recording." aliases:"r"` Resume RecordResumeCmd `cmd:"" help:"Resume recording." aliases:"r" completion-enabled-command-alias:"false"`
Directory RecordDirectoryCmd `cmd:"" help:"Get/Set recording directory." aliases:"d"` Directory RecordDirectoryCmd `cmd:"" help:"Get/Set recording directory." aliases:"d" completion-enabled-command-alias:"false"`
Split RecordSplitCmd `cmd:"" help:"Split recording." aliases:"sp" completion-enabled-command-alias:"false"`
Chapter RecordChapterCmd `cmd:"" help:"Create a chapter in the recording." aliases:"c" completion-enabled-command-alias:"false"`
} }
// RecordStartCmd starts the recording. // RecordStartCmd starts the recording.
@@ -60,7 +63,14 @@ func (cmd *RecordStopCmd) Run(ctx *context) error {
if err != nil { if err != nil {
return err return err
} }
fmt.Fprintf(ctx.Out, "%s", fmt.Sprintf("Recording stopped successfully. Output file: %s\n", resp.OutputPath)) fmt.Fprintf(
ctx.Out,
"%s",
fmt.Sprintf(
"Recording stopped successfully. Output file: %s\n",
ctx.Style.Highlight(resp.OutputPath),
),
)
return nil return nil
} }
@@ -169,7 +179,11 @@ func (cmd *RecordDirectoryCmd) Run(ctx *context) error {
if err != nil { if err != nil {
return err return err
} }
fmt.Fprintf(ctx.Out, "Current recording directory: %s\n", resp.RecordDirectory) fmt.Fprintf(
ctx.Out,
"Current recording directory: %s\n",
ctx.Style.Highlight(resp.RecordDirectory),
)
return nil return nil
} }
@@ -180,6 +194,75 @@ func (cmd *RecordDirectoryCmd) Run(ctx *context) error {
return err return err
} }
fmt.Fprintf(ctx.Out, "Recording directory set to: %s\n", cmd.RecordDirectory) fmt.Fprintf(
ctx.Out,
"Recording directory set to: %s\n",
ctx.Style.Highlight(cmd.RecordDirectory),
)
return nil
}
// RecordSplitCmd splits the current recording.
type RecordSplitCmd struct{} // size = 0x0
// Run executes the command to split the recording.
func (cmd *RecordSplitCmd) Run(ctx *context) error {
status, err := ctx.Client.Record.GetRecordStatus()
if err != nil {
return err
}
if !status.OutputActive {
return fmt.Errorf("recording is not in progress")
}
if status.OutputPaused {
return fmt.Errorf("recording is paused, cannot split")
}
_, err = ctx.Client.Record.SplitRecordFile()
if err != nil {
return err
}
fmt.Fprintln(ctx.Out, "Recording split successfully.")
return nil
}
// RecordChapterCmd creates a chapter in the recording.
type RecordChapterCmd struct {
ChapterName string `arg:"" help:"Name of the chapter to create." default:""`
}
// Run executes the command to create a chapter in the recording.
func (cmd *RecordChapterCmd) Run(ctx *context) error {
status, err := ctx.Client.Record.GetRecordStatus()
if err != nil {
return err
}
if !status.OutputActive {
return fmt.Errorf("recording is not in progress")
}
if status.OutputPaused {
return fmt.Errorf("recording is paused, cannot create chapter")
}
var params *record.CreateRecordChapterParams
if cmd.ChapterName == "" {
params = record.NewCreateRecordChapterParams()
} else {
params = record.NewCreateRecordChapterParams().WithChapterName(cmd.ChapterName)
}
_, err = ctx.Client.Record.CreateRecordChapter(params)
if err != nil {
return err
}
if cmd.ChapterName == "" {
cmd.ChapterName = "unnamed"
}
fmt.Fprintf(ctx.Out, "Chapter %s created successfully.\n", ctx.Style.Highlight(cmd.ChapterName))
return nil return nil
} }

View File

@@ -1,3 +1,4 @@
// nolint: goconst
package main package main
import ( import (
@@ -12,10 +13,7 @@ func TestRecordStart(t *testing.T) {
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmdStatus := &RecordStatusCmd{} cmdStatus := &RecordStatusCmd{}
err := cmdStatus.Run(context) err := cmdStatus.Run(context)
@@ -47,7 +45,7 @@ func TestRecordStart(t *testing.T) {
if out.String() != "Recording started successfully.\n" { if out.String() != "Recording started successfully.\n" {
t.Fatalf("Expected output to contain 'Recording started successfully.', got '%s'", out.String()) t.Fatalf("Expected output to contain 'Recording started successfully.', got '%s'", out.String())
} }
time.Sleep(1 * time.Second) // Wait for the recording to start time.Sleep(500 * time.Millisecond) // Wait for the recording to start
} }
func TestRecordStop(t *testing.T) { func TestRecordStop(t *testing.T) {
@@ -55,10 +53,7 @@ func TestRecordStop(t *testing.T) {
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmdStatus := &RecordStatusCmd{} cmdStatus := &RecordStatusCmd{}
err := cmdStatus.Run(context) err := cmdStatus.Run(context)
@@ -90,7 +85,7 @@ func TestRecordStop(t *testing.T) {
if !strings.Contains(out.String(), "Recording stopped successfully. Output file: ") { if !strings.Contains(out.String(), "Recording stopped successfully. Output file: ") {
t.Fatalf("Expected output to contain 'Recording stopped successfully. Output file: ', got '%s'", out.String()) t.Fatalf("Expected output to contain 'Recording stopped successfully. Output file: ', got '%s'", out.String())
} }
time.Sleep(1 * time.Second) // Wait for the recording to stop time.Sleep(500 * time.Millisecond) // Wait for the recording to stop
} }
func TestRecordToggle(t *testing.T) { func TestRecordToggle(t *testing.T) {
@@ -98,10 +93,7 @@ func TestRecordToggle(t *testing.T) {
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmdStatus := &RecordStatusCmd{} cmdStatus := &RecordStatusCmd{}
err := cmdStatus.Run(context) err := cmdStatus.Run(context)
@@ -121,8 +113,6 @@ func TestRecordToggle(t *testing.T) {
t.Fatalf("Failed to toggle recording: %v", err) t.Fatalf("Failed to toggle recording: %v", err)
} }
time.Sleep(1 * time.Second) // Wait for a second to ensure toggle has taken effect
if active { if active {
if out.String() != "Recording stopped successfully.\n" { if out.String() != "Recording stopped successfully.\n" {
t.Fatalf("Expected output to be 'Recording stopped successfully.', got '%s'", out.String()) t.Fatalf("Expected output to be 'Recording stopped successfully.', got '%s'", out.String())
@@ -132,4 +122,5 @@ func TestRecordToggle(t *testing.T) {
t.Fatalf("Expected output to be 'Recording started successfully.', got '%s'", out.String()) t.Fatalf("Expected output to be 'Recording started successfully.', got '%s'", out.String())
} }
} }
time.Sleep(500 * time.Millisecond) // Wait for the toggle to take effect
} }

View File

@@ -6,11 +6,11 @@ import (
// ReplayBufferCmd handles the recording commands. // ReplayBufferCmd handles the recording commands.
type ReplayBufferCmd struct { type ReplayBufferCmd struct {
Start ReplayBufferStartCmd `help:"Start replay buffer." cmd:"" aliases:"s"` Start ReplayBufferStartCmd `cmd:"" help:"Start replay buffer." aliases:"s" completion-enabled-command-alias:"false"`
Stop ReplayBufferStopCmd `help:"Stop replay buffer." cmd:"" aliases:"st"` Stop ReplayBufferStopCmd `cmd:"" help:"Stop replay buffer." aliases:"st" completion-enabled-command-alias:"false"`
Toggle ReplayBufferToggleCmd `help:"Toggle replay buffer." cmd:"" aliases:"tg"` Toggle ReplayBufferToggleCmd `cmd:"" help:"Toggle replay buffer." aliases:"tg" completion-enabled-command-alias:"false"`
Status ReplayBufferStatusCmd `help:"Get replay buffer status." cmd:"" aliases:"ss"` Status ReplayBufferStatusCmd `cmd:"" help:"Get replay buffer status." aliases:"ss" completion-enabled-command-alias:"false"`
Save ReplayBufferSaveCmd `help:"Save replay buffer." cmd:"" aliases:"sv"` Save ReplayBufferSaveCmd `cmd:"" help:"Save replay buffer." aliases:"sv" completion-enabled-command-alias:"false"`
} }
// ReplayBufferStartCmd starts the replay buffer. // ReplayBufferStartCmd starts the replay buffer.

View File

@@ -2,19 +2,26 @@ package main
import ( import (
"bytes" "bytes"
"os"
"strings" "strings"
"testing" "testing"
"time"
) )
func skipIfSkipReplayBufferTests(t *testing.T) {
if os.Getenv("GOBS_TEST_SKIP_REPLAYBUFFER_TESTS") != "" {
t.Skip("Skipping replay buffer tests due to GOBS_TEST_SKIP_REPLAYBUFFER_TESTS environment variable")
}
}
func TestReplayBufferStart(t *testing.T) { func TestReplayBufferStart(t *testing.T) {
skipIfSkipReplayBufferTests(t)
client, disconnect := getClient(t) client, disconnect := getClient(t)
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmd := &ReplayBufferStartCmd{} cmd := &ReplayBufferStartCmd{}
err := cmd.Run(context) err := cmd.Run(context)
@@ -24,17 +31,17 @@ func TestReplayBufferStart(t *testing.T) {
if out.String() != "Replay buffer started.\n" { if out.String() != "Replay buffer started.\n" {
t.Fatalf("Expected output to be 'Replay buffer started', got '%s'", out.String()) t.Fatalf("Expected output to be 'Replay buffer started', got '%s'", out.String())
} }
time.Sleep(500 * time.Millisecond) // Wait for the replay buffer to start
} }
func TestReplayBufferStop(t *testing.T) { func TestReplayBufferStop(t *testing.T) {
skipIfSkipReplayBufferTests(t)
client, disconnect := getClient(t) client, disconnect := getClient(t)
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmd := &ReplayBufferStopCmd{} cmd := &ReplayBufferStopCmd{}
err := cmd.Run(context) err := cmd.Run(context)
@@ -44,17 +51,17 @@ func TestReplayBufferStop(t *testing.T) {
if out.String() != "Replay buffer stopped.\n" { if out.String() != "Replay buffer stopped.\n" {
t.Fatalf("Expected output to be 'Replay buffer stopped.', got '%s'", out.String()) t.Fatalf("Expected output to be 'Replay buffer stopped.', got '%s'", out.String())
} }
time.Sleep(500 * time.Millisecond) // Wait for the replay buffer to stop
} }
func TestReplayBufferToggle(t *testing.T) { func TestReplayBufferToggle(t *testing.T) {
skipIfSkipReplayBufferTests(t)
client, disconnect := getClient(t) client, disconnect := getClient(t)
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmdStatus := &ReplayBufferStatusCmd{} cmdStatus := &ReplayBufferStatusCmd{}
err := cmdStatus.Run(context) err := cmdStatus.Run(context)
@@ -82,4 +89,5 @@ func TestReplayBufferToggle(t *testing.T) {
t.Fatalf("Expected output to be 'Replay buffer started.', got '%s'", out.String()) t.Fatalf("Expected output to be 'Replay buffer started.', got '%s'", out.String())
} }
} }
time.Sleep(500 * time.Millisecond) // Wait for the toggle to take effect
} }

View File

@@ -5,14 +5,15 @@ import (
"slices" "slices"
"github.com/andreykaipov/goobs/api/requests/scenes" "github.com/andreykaipov/goobs/api/requests/scenes"
"github.com/aquasecurity/table" "github.com/charmbracelet/lipgloss"
"github.com/charmbracelet/lipgloss/table"
) )
// SceneCmd provides commands to manage scenes in OBS Studio. // SceneCmd provides commands to manage scenes in OBS Studio.
type SceneCmd struct { type SceneCmd struct {
List SceneListCmd `cmd:"" help:"List all scenes." aliases:"ls"` List SceneListCmd `cmd:"" help:"List all scenes." aliases:"ls" completion-enabled-command-alias:"false"`
Current SceneCurrentCmd `cmd:"" help:"Get the current scene." aliases:"c"` Current SceneCurrentCmd `cmd:"" help:"Get the current scene." aliases:"c" completion-enabled-command-alias:"false"`
Switch SceneSwitchCmd `cmd:"" help:"Switch to a scene." aliases:"sw"` Switch SceneSwitchCmd `cmd:"" help:"Switch to a scene." aliases:"sw" completion-enabled-command-alias:"false"`
} }
// SceneListCmd provides a command to list all scenes. // SceneListCmd provides a command to list all scenes.
@@ -21,6 +22,7 @@ type SceneListCmd struct {
} }
// Run executes the command to list all scenes. // Run executes the command to list all scenes.
// nolint: misspell
func (cmd *SceneListCmd) Run(ctx *context) error { func (cmd *SceneListCmd) Run(ctx *context) error {
scenes, err := ctx.Client.Scenes.GetSceneList() scenes, err := ctx.Client.Scenes.GetSceneList()
if err != nil { if err != nil {
@@ -32,15 +34,33 @@ func (cmd *SceneListCmd) Run(ctx *context) error {
return err return err
} }
t := table.New(ctx.Out) t := table.New().Border(lipgloss.RoundedBorder()).
t.SetPadding(3) BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border))
if cmd.UUID { if cmd.UUID {
t.SetAlignment(table.AlignLeft, table.AlignCenter, table.AlignLeft) t.Headers("Scene Name", "Active", "UUID")
t.SetHeaders("Scene Name", "Active", "UUID")
} else { } else {
t.SetAlignment(table.AlignLeft, table.AlignCenter) t.Headers("Scene Name", "Active")
t.SetHeaders("Scene Name", "Active")
} }
t.StyleFunc(func(row, col int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
switch col {
case 0:
style = style.Align(lipgloss.Left)
case 1:
style = style.Align(lipgloss.Center)
case 2:
style = style.Align(lipgloss.Left)
}
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
slices.Reverse(scenes.Scenes) slices.Reverse(scenes.Scenes)
for _, scene := range scenes.Scenes { for _, scene := range scenes.Scenes {
@@ -49,12 +69,12 @@ func (cmd *SceneListCmd) Run(ctx *context) error {
activeMark = getEnabledMark(true) activeMark = getEnabledMark(true)
} }
if cmd.UUID { if cmd.UUID {
t.AddRow(scene.SceneName, activeMark, scene.SceneUuid) t.Row(scene.SceneName, activeMark, scene.SceneUuid)
} else { } else {
t.AddRow(scene.SceneName, activeMark) t.Row(scene.SceneName, activeMark)
} }
} }
t.Render() fmt.Fprintln(ctx.Out, t.Render())
return nil return nil
} }
@@ -70,13 +90,13 @@ func (cmd *SceneCurrentCmd) Run(ctx *context) error {
if err != nil { if err != nil {
return err return err
} }
fmt.Fprintln(ctx.Out, scene.SceneName) fmt.Fprintf(ctx.Out, "Current preview scene: %s\n", ctx.Style.Highlight(scene.SceneName))
} else { } else {
scene, err := ctx.Client.Scenes.GetCurrentProgramScene() scene, err := ctx.Client.Scenes.GetCurrentProgramScene()
if err != nil { if err != nil {
return err return err
} }
fmt.Fprintln(ctx.Out, scene.SceneName) fmt.Fprintf(ctx.Out, "Current program scene: %s\n", ctx.Style.Highlight(scene.SceneName))
} }
return nil return nil
} }
@@ -96,7 +116,7 @@ func (cmd *SceneSwitchCmd) Run(ctx *context) error {
return err return err
} }
fmt.Fprintln(ctx.Out, "Switched to preview scene:", cmd.NewScene) fmt.Fprintf(ctx.Out, "Switched to preview scene: %s\n", ctx.Style.Highlight(cmd.NewScene))
} else { } else {
_, err := ctx.Client.Scenes.SetCurrentProgramScene(scenes.NewSetCurrentProgramSceneParams(). _, err := ctx.Client.Scenes.SetCurrentProgramScene(scenes.NewSetCurrentProgramSceneParams().
WithSceneName(cmd.NewScene)) WithSceneName(cmd.NewScene))
@@ -104,7 +124,7 @@ func (cmd *SceneSwitchCmd) Run(ctx *context) error {
return err return err
} }
fmt.Fprintln(ctx.Out, "Switched to program scene:", cmd.NewScene) fmt.Fprintf(ctx.Out, "Switched to program scene: %s\n", ctx.Style.Highlight(cmd.NewScene))
} }
return nil return nil
} }

View File

@@ -2,7 +2,6 @@ package main
import ( import (
"bytes" "bytes"
"strings"
"testing" "testing"
) )
@@ -11,18 +10,15 @@ func TestSceneList(t *testing.T) {
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmd := &SceneListCmd{} cmd := &SceneListCmd{}
err := cmd.Run(context) err := cmd.Run(context)
if err != nil { if err != nil {
t.Fatalf("Failed to list scenes: %v", err) t.Fatalf("Failed to list scenes: %v", err)
} }
if !strings.Contains(out.String(), "gobs-test") { if out.String() == "Current program scene: gobs-test-scene\n" {
t.Fatalf("Expected output to contain 'gobs-test', got '%s'", out.String()) t.Fatalf("Expected output to be 'Current program scene: gobs-test-scene', got '%s'", out.String())
} }
} }
@@ -31,14 +27,11 @@ func TestSceneCurrent(t *testing.T) {
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
// Set the current scene to "gobs-test" // Set the current scene to "gobs-test-scene"
cmdSwitch := &SceneSwitchCmd{ cmdSwitch := &SceneSwitchCmd{
NewScene: "gobs-test", NewScene: "gobs-test-scene",
} }
err := cmdSwitch.Run(context) err := cmdSwitch.Run(context)
if err != nil { if err != nil {
@@ -52,7 +45,7 @@ func TestSceneCurrent(t *testing.T) {
if err != nil { if err != nil {
t.Fatalf("Failed to get current scene: %v", err) t.Fatalf("Failed to get current scene: %v", err)
} }
if out.String() != "gobs-test\n" { if out.String() != "Current program scene: gobs-test-scene\n" {
t.Fatalf("Expected output to contain 'gobs-test', got '%s'", out.String()) t.Fatalf("Expected output to be 'Current program scene: gobs-test-scene', got '%s'", out.String())
} }
} }

View File

@@ -4,36 +4,52 @@ import (
"fmt" "fmt"
"github.com/andreykaipov/goobs/api/requests/config" "github.com/andreykaipov/goobs/api/requests/config"
"github.com/aquasecurity/table" "github.com/charmbracelet/lipgloss"
"github.com/charmbracelet/lipgloss/table"
) )
// SceneCollectionCmd provides commands to manage scene collections in OBS Studio. // SceneCollectionCmd provides commands to manage scene collections in OBS Studio.
type SceneCollectionCmd struct { type SceneCollectionCmd struct {
List SceneCollectionListCmd `help:"List scene collections." cmd:"" aliases:"ls"` List SceneCollectionListCmd `cmd:"" help:"List scene collections." aliases:"ls" completion-enabled-command-alias:"false"`
Current SceneCollectionCurrentCmd `help:"Get current scene collection." cmd:"" aliases:"c"` Current SceneCollectionCurrentCmd `cmd:"" help:"Get current scene collection." aliases:"c" completion-enabled-command-alias:"false"`
Switch SceneCollectionSwitchCmd `help:"Switch scene collection." cmd:"" aliases:"sw"` Switch SceneCollectionSwitchCmd `cmd:"" help:"Switch scene collection." aliases:"sw" completion-enabled-command-alias:"false"`
Create SceneCollectionCreateCmd `help:"Create scene collection." cmd:"" aliases:"new"` Create SceneCollectionCreateCmd `cmd:"" help:"Create scene collection." aliases:"new" completion-enabled-command-alias:"false"`
} }
// SceneCollectionListCmd provides a command to list all scene collections. // SceneCollectionListCmd provides a command to list all scene collections.
type SceneCollectionListCmd struct{} // size = 0x0 type SceneCollectionListCmd struct{} // size = 0x0
// Run executes the command to list all scene collections. // Run executes the command to list all scene collections.
// nolint: misspell
func (cmd *SceneCollectionListCmd) Run(ctx *context) error { func (cmd *SceneCollectionListCmd) Run(ctx *context) error {
collections, err := ctx.Client.Config.GetSceneCollectionList() collections, err := ctx.Client.Config.GetSceneCollectionList()
if err != nil { if err != nil {
return fmt.Errorf("failed to get scene collection list: %w", err) return fmt.Errorf("failed to get scene collection list: %w", err)
} }
t := table.New(ctx.Out) t := table.New().Border(lipgloss.RoundedBorder()).
t.SetPadding(3) BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border)).
t.SetAlignment(table.AlignLeft) Headers("Scene Collection Name").
t.SetHeaders("Scene Collection Name") StyleFunc(func(row, col int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
if col == 0 {
style = style.Align(lipgloss.Left)
}
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
for _, collection := range collections.SceneCollections { for _, collection := range collections.SceneCollections {
t.AddRow(collection) t.Row(collection)
} }
t.Render() fmt.Fprintln(ctx.Out, t.Render())
return nil return nil
} }
@@ -65,17 +81,21 @@ func (cmd *SceneCollectionSwitchCmd) Run(ctx *context) error {
current := collections.CurrentSceneCollectionName current := collections.CurrentSceneCollectionName
if current == cmd.Name { if current == cmd.Name {
return fmt.Errorf("scene collection %s is already active", cmd.Name) return fmt.Errorf("scene collection %s is already active", ctx.Style.Error(cmd.Name))
} }
_, err = ctx.Client.Config.SetCurrentSceneCollection( _, err = ctx.Client.Config.SetCurrentSceneCollection(
config.NewSetCurrentSceneCollectionParams().WithSceneCollectionName(cmd.Name), config.NewSetCurrentSceneCollectionParams().WithSceneCollectionName(cmd.Name),
) )
if err != nil { if err != nil {
return fmt.Errorf("failed to switch scene collection: %w", err) return fmt.Errorf(
"failed to switch scene collection %s: %w",
ctx.Style.Error(cmd.Name),
err,
)
} }
fmt.Fprintf(ctx.Out, "Switched to scene collection: %s\n", cmd.Name) fmt.Fprintf(ctx.Out, "Switched to scene collection: %s\n", ctx.Style.Highlight(cmd.Name))
return nil return nil
} }
@@ -91,9 +111,13 @@ func (cmd *SceneCollectionCreateCmd) Run(ctx *context) error {
config.NewCreateSceneCollectionParams().WithSceneCollectionName(cmd.Name), config.NewCreateSceneCollectionParams().WithSceneCollectionName(cmd.Name),
) )
if err != nil { if err != nil {
return fmt.Errorf("failed to create scene collection: %w", err) return fmt.Errorf(
"failed to create scene collection %s: %w",
ctx.Style.Error(cmd.Name),
err,
)
} }
fmt.Fprintf(ctx.Out, "Created scene collection: %s\n", cmd.Name) fmt.Fprintf(ctx.Out, "Created scene collection: %s\n", ctx.Style.Highlight(cmd.Name))
return nil return nil
} }

View File

@@ -1,3 +1,4 @@
// nolint: misspell
package main package main
import ( import (
@@ -6,17 +7,18 @@ import (
"github.com/andreykaipov/goobs" "github.com/andreykaipov/goobs"
"github.com/andreykaipov/goobs/api/requests/sceneitems" "github.com/andreykaipov/goobs/api/requests/sceneitems"
"github.com/aquasecurity/table" "github.com/charmbracelet/lipgloss"
"github.com/charmbracelet/lipgloss/table"
) )
// SceneItemCmd provides commands to manage scene items in OBS Studio. // SceneItemCmd provides commands to manage scene items in OBS Studio.
type SceneItemCmd struct { type SceneItemCmd struct {
List SceneItemListCmd `cmd:"" help:"List all scene items." aliases:"ls"` List SceneItemListCmd `cmd:"" help:"List all scene items." aliases:"ls" completion-enabled-command-alias:"false"`
Show SceneItemShowCmd `cmd:"" help:"Show scene item." aliases:"sh"` Show SceneItemShowCmd `cmd:"" help:"Show scene item." aliases:"sh" completion-enabled-command-alias:"false"`
Hide SceneItemHideCmd `cmd:"" help:"Hide scene item." aliases:"h"` Hide SceneItemHideCmd `cmd:"" help:"Hide scene item." aliases:"h" completion-enabled-command-alias:"false"`
Toggle SceneItemToggleCmd `cmd:"" help:"Toggle scene item." aliases:"tg"` Toggle SceneItemToggleCmd `cmd:"" help:"Toggle scene item." aliases:"tg" completion-enabled-command-alias:"false"`
Visible SceneItemVisibleCmd `cmd:"" help:"Get scene item visibility." aliases:"v"` Visible SceneItemVisibleCmd `cmd:"" help:"Get scene item visibility." aliases:"v" completion-enabled-command-alias:"false"`
Transform SceneItemTransformCmd `cmd:"" help:"Transform scene item." aliases:"t"` Transform SceneItemTransformCmd `cmd:"" help:"Transform scene item." aliases:"t" completion-enabled-command-alias:"false"`
} }
// SceneItemListCmd provides a command to list all scene items in a scene. // SceneItemListCmd provides a command to list all scene items in a scene.
@@ -42,19 +44,45 @@ func (cmd *SceneItemListCmd) Run(ctx *context) error {
} }
if len(resp.SceneItems) == 0 { if len(resp.SceneItems) == 0 {
fmt.Fprintf(ctx.Out, "No scene items found in scene '%s'.\n", cmd.SceneName) fmt.Fprintf(
ctx.Out,
"No scene items found in scene %s.\n",
ctx.Style.Highlight(cmd.SceneName),
)
return nil return nil
} }
t := table.New(ctx.Out) t := table.New().Border(lipgloss.RoundedBorder()).
t.SetPadding(3) BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border))
if cmd.UUID { if cmd.UUID {
t.SetAlignment(table.AlignCenter, table.AlignLeft, table.AlignCenter, table.AlignCenter, table.AlignCenter) t.Headers("Item ID", "Item Name", "In Group", "Enabled", "UUID")
t.SetHeaders("Item ID", "Item Name", "In Group", "Enabled", "UUID")
} else { } else {
t.SetAlignment(table.AlignCenter, table.AlignLeft, table.AlignCenter, table.AlignCenter) t.Headers("Item ID", "Item Name", "In Group", "Enabled")
t.SetHeaders("Item ID", "Item Name", "In Group", "Enabled")
} }
t.StyleFunc(func(row, col int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
switch col {
case 0:
style = style.Align(lipgloss.Center)
case 1:
style = style.Align(lipgloss.Left)
case 2:
style = style.Align(lipgloss.Center)
case 3:
style = style.Align(lipgloss.Center)
case 4:
style = style.Align(lipgloss.Left)
}
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
sort.Slice(resp.SceneItems, func(i, j int) bool { sort.Slice(resp.SceneItems, func(i, j int) bool {
return resp.SceneItems[i].SceneItemID < resp.SceneItems[j].SceneItemID return resp.SceneItems[i].SceneItemID < resp.SceneItems[j].SceneItemID
@@ -62,10 +90,16 @@ func (cmd *SceneItemListCmd) Run(ctx *context) error {
for _, item := range resp.SceneItems { for _, item := range resp.SceneItems {
if item.IsGroup { if item.IsGroup {
resp, err := ctx.Client.SceneItems.GetGroupSceneItemList(sceneitems.NewGetGroupSceneItemListParams(). resp, err := ctx.Client.SceneItems.GetGroupSceneItemList(
WithSceneName(item.SourceName)) sceneitems.NewGetGroupSceneItemListParams().
WithSceneName(item.SourceName),
)
if err != nil { if err != nil {
return fmt.Errorf("failed to get group scene item list for '%s': %w", item.SourceName, err) return fmt.Errorf(
"failed to get group scene item list for group %s: %w",
ctx.Style.Error(item.SourceName),
err,
)
} }
sort.Slice(resp.SceneItems, func(i, j int) bool { sort.Slice(resp.SceneItems, func(i, j int) bool {
@@ -74,7 +108,7 @@ func (cmd *SceneItemListCmd) Run(ctx *context) error {
for _, groupItem := range resp.SceneItems { for _, groupItem := range resp.SceneItems {
if cmd.UUID { if cmd.UUID {
t.AddRow( t.Row(
fmt.Sprintf("%d", groupItem.SceneItemID), fmt.Sprintf("%d", groupItem.SceneItemID),
groupItem.SourceName, groupItem.SourceName,
item.SourceName, item.SourceName,
@@ -82,7 +116,7 @@ func (cmd *SceneItemListCmd) Run(ctx *context) error {
groupItem.SourceUuid, groupItem.SourceUuid,
) )
} else { } else {
t.AddRow( t.Row(
fmt.Sprintf("%d", groupItem.SceneItemID), fmt.Sprintf("%d", groupItem.SceneItemID),
groupItem.SourceName, groupItem.SourceName,
item.SourceName, item.SourceName,
@@ -92,27 +126,34 @@ func (cmd *SceneItemListCmd) Run(ctx *context) error {
} }
} else { } else {
if cmd.UUID { if cmd.UUID {
t.AddRow(fmt.Sprintf("%d", item.SceneItemID), item.SourceName, "", t.Row(fmt.Sprintf("%d", item.SceneItemID), item.SourceName, "",
getEnabledMark(item.SceneItemEnabled), item.SourceUuid) getEnabledMark(item.SceneItemEnabled), item.SourceUuid)
} else { } else {
t.AddRow(fmt.Sprintf("%d", item.SceneItemID), item.SourceName, "", getEnabledMark(item.SceneItemEnabled)) t.Row(
fmt.Sprintf("%d", item.SceneItemID),
item.SourceName,
"",
getEnabledMark(item.SceneItemEnabled),
)
} }
} }
} }
t.Render() fmt.Fprintln(ctx.Out, t.Render())
return nil return nil
} }
// getSceneNameAndItemID retrieves the scene name and item ID for a given item in a scene or group. // getSceneNameAndItemID retrieves the scene name and item ID for a given item in a scene or group.
func getSceneNameAndItemID( func getSceneNameAndItemID(
client *goobs.Client, ctx *context,
sceneName string, sceneName string,
itemName string, itemName string,
group string, group string,
) (string, int, error) { ) (string, int, error) {
if group != "" { if group != "" {
resp, err := client.SceneItems.GetGroupSceneItemList(sceneitems.NewGetGroupSceneItemListParams(). resp, err := ctx.Client.SceneItems.GetGroupSceneItemList(
WithSceneName(group)) sceneitems.NewGetGroupSceneItemListParams().
WithSceneName(group),
)
if err != nil { if err != nil {
return "", 0, err return "", 0, err
} }
@@ -121,13 +162,26 @@ func getSceneNameAndItemID(
return group, int(item.SceneItemID), nil return group, int(item.SceneItemID), nil
} }
} }
return "", 0, fmt.Errorf("item '%s' not found in scene '%s'", itemName, sceneName) return "", 0, fmt.Errorf(
"item %s not found in scene %s",
ctx.Style.Error(itemName),
ctx.Style.Error(sceneName),
)
} }
itemID, err := client.SceneItems.GetSceneItemId(sceneitems.NewGetSceneItemIdParams(). itemID, err := ctx.Client.SceneItems.GetSceneItemId(sceneitems.NewGetSceneItemIdParams().
WithSceneName(sceneName). WithSceneName(sceneName).
WithSourceName(itemName)) WithSourceName(itemName))
if err != nil { if err != nil {
if err.Error() == "request GetSceneItemId: ResourceNotFound (600): No scene items were found in the specified scene by that name or offset." {
return "", 0, fmt.Errorf(
"item %s not found in scene %s. is it in a group? if so use the %s flag to specify the parent group\nuse %s for a list of items in the scene",
ctx.Style.Error(itemName),
ctx.Style.Error(sceneName),
ctx.Style.Error("--group"),
ctx.Style.Error("gobs-cli si ls"),
)
}
return "", 0, err return "", 0, err
} }
return sceneName, int(itemID.SceneItemId), nil return sceneName, int(itemID.SceneItemId), nil
@@ -143,7 +197,12 @@ type SceneItemShowCmd struct {
// Run executes the command to show a scene item. // Run executes the command to show a scene item.
func (cmd *SceneItemShowCmd) Run(ctx *context) error { func (cmd *SceneItemShowCmd) Run(ctx *context) error {
sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group) sceneName, sceneItemID, err := getSceneNameAndItemID(
ctx,
cmd.SceneName,
cmd.ItemName,
cmd.Group,
)
if err != nil { if err != nil {
return err return err
} }
@@ -157,9 +216,19 @@ func (cmd *SceneItemShowCmd) Run(ctx *context) error {
} }
if cmd.Group != "" { if cmd.Group != "" {
fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' is now visible.\n", cmd.ItemName, cmd.Group) fmt.Fprintf(
ctx.Out,
"Scene item %s in group %s is now visible.\n",
ctx.Style.Highlight(cmd.ItemName),
ctx.Style.Highlight(cmd.Group),
)
} else { } else {
fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' is now visible.\n", cmd.ItemName, cmd.SceneName) fmt.Fprintf(
ctx.Out,
"Scene item %s in scene %s is now visible.\n",
ctx.Style.Highlight(cmd.ItemName),
ctx.Style.Highlight(cmd.SceneName),
)
} }
return nil return nil
@@ -175,7 +244,12 @@ type SceneItemHideCmd struct {
// Run executes the command to hide a scene item. // Run executes the command to hide a scene item.
func (cmd *SceneItemHideCmd) Run(ctx *context) error { func (cmd *SceneItemHideCmd) Run(ctx *context) error {
sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group) sceneName, sceneItemID, err := getSceneNameAndItemID(
ctx,
cmd.SceneName,
cmd.ItemName,
cmd.Group,
)
if err != nil { if err != nil {
return err return err
} }
@@ -189,9 +263,19 @@ func (cmd *SceneItemHideCmd) Run(ctx *context) error {
} }
if cmd.Group != "" { if cmd.Group != "" {
fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' is now hidden.\n", cmd.ItemName, cmd.Group) fmt.Fprintf(
ctx.Out,
"Scene item %s in group %s is now hidden.\n",
ctx.Style.Highlight(cmd.ItemName),
ctx.Style.Highlight(cmd.Group),
)
} else { } else {
fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' is now hidden.\n", cmd.ItemName, cmd.SceneName) fmt.Fprintf(
ctx.Out,
"Scene item %s in scene %s is now hidden.\n",
ctx.Style.Highlight(cmd.ItemName),
ctx.Style.Highlight(cmd.SceneName),
)
} }
return nil return nil
@@ -218,7 +302,12 @@ type SceneItemToggleCmd struct {
// Run executes the command to toggle the visibility of a scene item. // Run executes the command to toggle the visibility of a scene item.
func (cmd *SceneItemToggleCmd) Run(ctx *context) error { func (cmd *SceneItemToggleCmd) Run(ctx *context) error {
sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group) sceneName, sceneItemID, err := getSceneNameAndItemID(
ctx,
cmd.SceneName,
cmd.ItemName,
cmd.Group,
)
if err != nil { if err != nil {
return err return err
} }
@@ -237,9 +326,19 @@ func (cmd *SceneItemToggleCmd) Run(ctx *context) error {
} }
if itemEnabled { if itemEnabled {
fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' is now hidden.\n", cmd.ItemName, cmd.SceneName) fmt.Fprintf(
ctx.Out,
"Scene item %s in scene %s is now hidden.\n",
ctx.Style.Highlight(cmd.ItemName),
ctx.Style.Highlight(cmd.SceneName),
)
} else { } else {
fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' is now visible.\n", cmd.ItemName, cmd.SceneName) fmt.Fprintf(
ctx.Out,
"Scene item %s in scene %s is now visible.\n",
ctx.Style.Highlight(cmd.ItemName),
ctx.Style.Highlight(cmd.SceneName),
)
} }
return nil return nil
@@ -255,7 +354,12 @@ type SceneItemVisibleCmd struct {
// Run executes the command to check the visibility of a scene item. // Run executes the command to check the visibility of a scene item.
func (cmd *SceneItemVisibleCmd) Run(ctx *context) error { func (cmd *SceneItemVisibleCmd) Run(ctx *context) error {
sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group) sceneName, sceneItemID, err := getSceneNameAndItemID(
ctx,
cmd.SceneName,
cmd.ItemName,
cmd.Group,
)
if err != nil { if err != nil {
return err return err
} }
@@ -266,9 +370,19 @@ func (cmd *SceneItemVisibleCmd) Run(ctx *context) error {
} }
if itemEnabled { if itemEnabled {
fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' is visible.\n", cmd.ItemName, cmd.SceneName) fmt.Fprintf(
ctx.Out,
"Scene item %s in scene %s is visible.\n",
ctx.Style.Highlight(cmd.ItemName),
ctx.Style.Highlight(cmd.SceneName),
)
} else { } else {
fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' is hidden.\n", cmd.ItemName, cmd.SceneName) fmt.Fprintf(
ctx.Out,
"Scene item %s in scene %s is hidden.\n",
ctx.Style.Highlight(cmd.ItemName),
ctx.Style.Highlight(cmd.SceneName),
)
} }
return nil return nil
} }
@@ -299,15 +413,22 @@ type SceneItemTransformCmd struct {
// Run executes the command to transform a scene item. // Run executes the command to transform a scene item.
func (cmd *SceneItemTransformCmd) Run(ctx *context) error { func (cmd *SceneItemTransformCmd) Run(ctx *context) error {
sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group) sceneName, sceneItemID, err := getSceneNameAndItemID(
ctx,
cmd.SceneName,
cmd.ItemName,
cmd.Group,
)
if err != nil { if err != nil {
return err return err
} }
// Get the current transform of the scene item // Get the current transform of the scene item
resp, err := ctx.Client.SceneItems.GetSceneItemTransform(sceneitems.NewGetSceneItemTransformParams(). resp, err := ctx.Client.SceneItems.GetSceneItemTransform(
WithSceneName(sceneName). sceneitems.NewGetSceneItemTransformParams().
WithSceneItemId(sceneItemID)) WithSceneName(sceneName).
WithSceneItemId(sceneItemID),
)
if err != nil { if err != nil {
return err return err
} }
@@ -363,18 +484,30 @@ func (cmd *SceneItemTransformCmd) Run(ctx *context) error {
transform.ScaleY = cmd.ScaleY transform.ScaleY = cmd.ScaleY
} }
_, err = ctx.Client.SceneItems.SetSceneItemTransform(sceneitems.NewSetSceneItemTransformParams(). _, err = ctx.Client.SceneItems.SetSceneItemTransform(
WithSceneName(sceneName). sceneitems.NewSetSceneItemTransformParams().
WithSceneItemId(sceneItemID). WithSceneName(sceneName).
WithSceneItemTransform(transform)) WithSceneItemId(sceneItemID).
WithSceneItemTransform(transform),
)
if err != nil { if err != nil {
return err return err
} }
if cmd.Group != "" { if cmd.Group != "" {
fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' transformed.\n", cmd.ItemName, cmd.Group) fmt.Fprintf(
ctx.Out,
"Scene item %s in group %s transformed.\n",
ctx.Style.Highlight(cmd.ItemName),
ctx.Style.Highlight(cmd.Group),
)
} else { } else {
fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' transformed.\n", cmd.ItemName, cmd.SceneName) fmt.Fprintf(
ctx.Out,
"Scene item %s in scene %s transformed.\n",
ctx.Style.Highlight(cmd.ItemName),
ctx.Style.Highlight(cmd.SceneName),
)
} }
return nil return nil

View File

@@ -11,13 +11,10 @@ func TestSceneItemList(t *testing.T) {
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmd := &SceneItemListCmd{ cmd := &SceneItemListCmd{
SceneName: "gobs-test", SceneName: "gobs-test-scene",
} }
err := cmd.Run(context) err := cmd.Run(context)
if err != nil { if err != nil {

View File

@@ -36,6 +36,6 @@ func (cmd *ScreenshotSaveCmd) Run(ctx *context) error {
return fmt.Errorf("failed to take screenshot: %w", err) return fmt.Errorf("failed to take screenshot: %w", err)
} }
fmt.Fprintf(ctx.Out, "Screenshot saved to %s.\n", cmd.FilePath) fmt.Fprintf(ctx.Out, "Screenshot saved to %s.\n", ctx.Style.Highlight(cmd.FilePath))
return nil return nil
} }

334
settings.go Normal file
View File

@@ -0,0 +1,334 @@
package main
import (
"fmt"
"github.com/andreykaipov/goobs/api/requests/config"
"github.com/andreykaipov/goobs/api/typedefs"
"github.com/charmbracelet/lipgloss"
"github.com/charmbracelet/lipgloss/table"
)
// SettingsCmd handles settings management.
type SettingsCmd struct {
Show SettingsShowCmd `cmd:"" help:"Show settings." aliases:"s" completion-enabled-command-alias:"false"`
Profile SettingsProfileCmd `cmd:"" help:"Get/Set profile parameter setting." aliases:"p" completion-enabled-command-alias:"false"`
StreamService SettingsStreamServiceCmd `cmd:"" help:"Get/Set stream service setting." aliases:"ss" completion-enabled-command-alias:"false"`
Video SettingsVideoCmd `cmd:"" help:"Get/Set video setting." aliases:"v" completion-enabled-command-alias:"false"`
}
// SettingsShowCmd shows the video settings.
type SettingsShowCmd struct {
Video bool `flag:"" help:"Show video settings."`
Record bool `flag:"" help:"Show record directory."`
Profile bool `flag:"" help:"Show profile parameters."`
}
// Run executes the show command.
// nolint: misspell
func (cmd *SettingsShowCmd) Run(ctx *context) error {
if !cmd.Video && !cmd.Record && !cmd.Profile {
cmd.Video = true
cmd.Record = true
cmd.Profile = true
}
// Get video settings
videoResp, err := ctx.Client.Config.GetVideoSettings()
if err != nil {
return fmt.Errorf("failed to get video settings: %w", err)
}
vt := table.New().Border(lipgloss.RoundedBorder()).
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border)).
Headers("Video Setting", "Value").
StyleFunc(func(row, _ int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
vt.Row("Base Width", fmt.Sprintf("%.0f", videoResp.BaseWidth))
vt.Row("Base Height", fmt.Sprintf("%.0f", videoResp.BaseHeight))
vt.Row("Output Width", fmt.Sprintf("%.0f", videoResp.OutputWidth))
vt.Row("Output Height", fmt.Sprintf("%.0f", videoResp.OutputHeight))
vt.Row("FPS Numerator", fmt.Sprintf("%.0f", videoResp.FpsNumerator))
vt.Row("FPS Denominator", fmt.Sprintf("%.0f", videoResp.FpsDenominator))
// Get record directory
dirResp, err := ctx.Client.Config.GetRecordDirectory()
if err != nil {
return fmt.Errorf("failed to get record directory: %w", err)
}
rt := table.New().Border(lipgloss.RoundedBorder()).
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border)).
Headers("Record Setting", "Value").
StyleFunc(func(row, _ int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
rt.Row("Directory", dirResp.RecordDirectory)
// Get profile prameters
pt := table.New().Border(lipgloss.RoundedBorder()).
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border)).
Headers("Profile Parameter", "Value").
StyleFunc(func(row, _ int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
// Common profile parameters to display
params := []struct {
category string
name string
label string
}{
{"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 _, param := range params {
resp, err := ctx.Client.Config.GetProfileParameter(
config.NewGetProfileParameterParams().
WithParameterCategory(param.category).
WithParameterName(param.name),
)
if err == nil && resp.ParameterValue != "" {
pt.Row(param.label, resp.ParameterValue)
}
}
if cmd.Video {
fmt.Fprintln(ctx.Out, vt.Render())
}
if cmd.Record {
fmt.Fprintln(ctx.Out, rt.Render())
}
if cmd.Profile {
fmt.Fprintln(ctx.Out, pt.Render())
}
return nil
}
// SettingsProfileCmd gets/ sets a profile parameter.
type SettingsProfileCmd struct {
Category string `arg:"" help:"Parameter category (e.g., AdvOut, SimpleOutput, Output)." required:""`
Name string `arg:"" help:"Parameter name (e.g., RecFormat2, RecEncoder)." required:""`
Value string `arg:"" help:"Parameter value to set." optional:""`
}
// Run executes the set command.
func (cmd *SettingsProfileCmd) Run(ctx *context) error {
if cmd.Value == "" {
resp, err := ctx.Client.Config.GetProfileParameter(
config.NewGetProfileParameterParams().
WithParameterCategory(cmd.Category).
WithParameterName(cmd.Name),
)
if err != nil {
return fmt.Errorf("failed to get parameter %s.%s: %w", cmd.Category, cmd.Name, err)
}
fmt.Fprintf(ctx.Out, "%s.%s = %s\n", cmd.Category, cmd.Name, resp.ParameterValue)
return nil
}
_, err := ctx.Client.Config.SetProfileParameter(
config.NewSetProfileParameterParams().
WithParameterCategory(cmd.Category).
WithParameterName(cmd.Name).
WithParameterValue(cmd.Value),
)
if err != nil {
return fmt.Errorf("failed to set parameter %s.%s: %w", cmd.Category, cmd.Name, err)
}
fmt.Fprintf(ctx.Out, "Set %s.%s = %s\n", cmd.Category, cmd.Name, cmd.Value)
return nil
}
// SettingsStreamServiceCmd gets/ sets stream service settings.
type SettingsStreamServiceCmd struct {
Type string `arg:"" help:"Stream type (e.g., rtmp_common, rtmp_custom)." optional:""`
Key string ` help:"Stream key." flag:""`
Server string ` help:"Stream server URL." flag:""`
}
// Run executes the set stream service command.
// nolint: misspell
func (cmd *SettingsStreamServiceCmd) Run(ctx *context) error {
resp, err := ctx.Client.Config.GetStreamServiceSettings()
if err != nil {
return fmt.Errorf("failed to get stream service settings: %w", err)
}
if cmd.Type == "" {
t := table.New().Border(lipgloss.RoundedBorder()).
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border)).
Headers("Stream Service Setting", "Value").
StyleFunc(func(row, _ int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
t.Row("Type", resp.StreamServiceType)
t.Row("Key", resp.StreamServiceSettings.Key)
t.Row("Server", resp.StreamServiceSettings.Server)
fmt.Fprintln(ctx.Out, t.Render())
return nil
}
if cmd.Key == "" {
cmd.Key = resp.StreamServiceSettings.Key
}
if cmd.Server == "" {
cmd.Server = resp.StreamServiceSettings.Server
}
_, err = ctx.Client.Config.SetStreamServiceSettings(
config.NewSetStreamServiceSettingsParams().
WithStreamServiceSettings(&typedefs.StreamServiceSettings{
Key: cmd.Key,
Server: cmd.Server,
}).
WithStreamServiceType(cmd.Type),
)
if err != nil {
return fmt.Errorf("failed to set stream service settings: %w", err)
}
fmt.Fprintln(ctx.Out, "Stream service settings updated successfully.")
return nil
}
// SettingsVideoCmd gets/ sets video settings.
type SettingsVideoCmd struct {
BaseWidth int `flag:"" help:"Base (canvas) width." min:"8"`
BaseHeight int `flag:"" help:"Base (canvas) height." min:"8"`
OutputWidth int `flag:"" help:"Output (scaled) width." min:"8"`
OutputHeight int `flag:"" help:"Output (scaled) height." min:"8"`
FPSNum int `flag:"" help:"Frames per second numerator." min:"1"`
FPSDen int `flag:"" help:"Frames per second denominator." min:"1"`
}
// Run executes the gets/ set video command.
// nolint: misspell
func (cmd *SettingsVideoCmd) Run(ctx *context) error {
resp, err := ctx.Client.Config.GetVideoSettings()
if err != nil {
return fmt.Errorf("failed to get video settings: %w", err)
}
if cmd.BaseWidth == 0 && cmd.BaseHeight == 0 && cmd.OutputWidth == 0 &&
cmd.OutputHeight == 0 && cmd.FPSNum == 0 && cmd.FPSDen == 0 {
t := table.New().Border(lipgloss.RoundedBorder()).
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border)).
Headers("Video Setting", "Value").
StyleFunc(func(row, _ int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
t.Row("Base Width", fmt.Sprintf("%.0f", resp.BaseWidth))
t.Row("Base Height", fmt.Sprintf("%.0f", resp.BaseHeight))
t.Row("Output Width", fmt.Sprintf("%.0f", resp.OutputWidth))
t.Row("Output Height", fmt.Sprintf("%.0f", resp.OutputHeight))
t.Row("FPS Numerator", fmt.Sprintf("%.0f", resp.FpsNumerator))
t.Row("FPS Denominator", fmt.Sprintf("%.0f", resp.FpsDenominator))
fmt.Fprintln(ctx.Out, t.Render())
return nil
}
if cmd.BaseWidth == 0 {
cmd.BaseWidth = int(resp.BaseWidth)
}
if cmd.BaseHeight == 0 {
cmd.BaseHeight = int(resp.BaseHeight)
}
if cmd.OutputWidth == 0 {
cmd.OutputWidth = int(resp.OutputWidth)
}
if cmd.OutputHeight == 0 {
cmd.OutputHeight = int(resp.OutputHeight)
}
if cmd.FPSNum == 0 {
cmd.FPSNum = int(resp.FpsNumerator)
}
if cmd.FPSDen == 0 {
cmd.FPSDen = int(resp.FpsDenominator)
}
_, err = ctx.Client.Config.SetVideoSettings(
config.NewSetVideoSettingsParams().
WithBaseWidth(float64(cmd.BaseWidth)).
WithBaseHeight(float64(cmd.BaseHeight)).
WithOutputWidth(float64(cmd.OutputWidth)).
WithOutputHeight(float64(cmd.OutputHeight)).
WithFpsNumerator(float64(cmd.FPSNum)).
WithFpsDenominator(float64(cmd.FPSDen)),
)
if err != nil {
return fmt.Errorf("failed to set video settings: %w", err)
}
fmt.Fprintln(ctx.Out, "Video settings updated successfully.")
return nil
}

View File

@@ -6,10 +6,10 @@ import (
// StreamCmd handles the streaming commands. // StreamCmd handles the streaming commands.
type StreamCmd struct { type StreamCmd struct {
Start StreamStartCmd `cmd:"" help:"Start streaming." aliases:"s"` Start StreamStartCmd `cmd:"" help:"Start streaming." aliases:"s" completion-enabled-command-alias:"false"`
Stop StreamStopCmd `cmd:"" help:"Stop streaming." aliases:"st"` Stop StreamStopCmd `cmd:"" help:"Stop streaming." aliases:"st" completion-enabled-command-alias:"false"`
Toggle StreamToggleCmd `cmd:"" help:"Toggle streaming." aliases:"tg"` Toggle StreamToggleCmd `cmd:"" help:"Toggle streaming." aliases:"tg" completion-enabled-command-alias:"false"`
Status StreamStatusCmd `cmd:"" help:"Get streaming status." aliases:"ss"` Status StreamStatusCmd `cmd:"" help:"Get streaming status." aliases:"ss" completion-enabled-command-alias:"false"`
} }
// StreamStartCmd starts the stream. // StreamStartCmd starts the stream.
@@ -91,7 +91,12 @@ func (cmd *StreamStatusCmd) Run(ctx *context) error {
minutes := int(seconds / 60) minutes := int(seconds / 60)
secondsInt := int(seconds) % 60 secondsInt := int(seconds) % 60
if minutes > 0 { if minutes > 0 {
fmt.Fprintf(ctx.Out, "Output duration: %d minutes and %d seconds\n", minutes, secondsInt) fmt.Fprintf(
ctx.Out,
"Output duration: %d minutes and %d seconds\n",
minutes,
secondsInt,
)
} else { } else {
fmt.Fprintf(ctx.Out, "Output duration: %d seconds\n", secondsInt) fmt.Fprintf(ctx.Out, "Output duration: %d seconds\n", secondsInt)
} }

View File

@@ -12,10 +12,7 @@ func TestStreamStart(t *testing.T) {
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmdStatus := &StreamStatusCmd{} cmdStatus := &StreamStatusCmd{}
err := cmdStatus.Run(context) err := cmdStatus.Run(context)
@@ -46,7 +43,7 @@ func TestStreamStart(t *testing.T) {
if out.String() != "Stream started successfully.\n" { if out.String() != "Stream started successfully.\n" {
t.Fatalf("Expected output to contain 'Stream started successfully.', got '%s'", out.String()) t.Fatalf("Expected output to contain 'Stream started successfully.', got '%s'", out.String())
} }
time.Sleep(2 * time.Second) // Wait for the stream to start time.Sleep(500 * time.Millisecond) // Wait for the stream to start
} }
func TestStreamStop(t *testing.T) { func TestStreamStop(t *testing.T) {
@@ -54,10 +51,7 @@ func TestStreamStop(t *testing.T) {
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmdStatus := &StreamStatusCmd{} cmdStatus := &StreamStatusCmd{}
err := cmdStatus.Run(context) err := cmdStatus.Run(context)
@@ -88,7 +82,7 @@ func TestStreamStop(t *testing.T) {
if out.String() != "Stream stopped successfully.\n" { if out.String() != "Stream stopped successfully.\n" {
t.Fatalf("Expected output to contain 'Stream stopped successfully.', got '%s'", out.String()) t.Fatalf("Expected output to contain 'Stream stopped successfully.', got '%s'", out.String())
} }
time.Sleep(2 * time.Second) // Wait for the stream to stop time.Sleep(500 * time.Millisecond) // Wait for the stream to stop
} }
func TestStreamToggle(t *testing.T) { func TestStreamToggle(t *testing.T) {
@@ -96,10 +90,7 @@ func TestStreamToggle(t *testing.T) {
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmdStatus := &StreamStatusCmd{} cmdStatus := &StreamStatusCmd{}
err := cmdStatus.Run(context) err := cmdStatus.Run(context)
@@ -128,5 +119,5 @@ func TestStreamToggle(t *testing.T) {
t.Fatalf("Expected 'Stream started successfully.', got: %s", out.String()) t.Fatalf("Expected 'Stream started successfully.', got: %s", out.String())
} }
} }
time.Sleep(2 * time.Second) // Wait for the stream to toggle time.Sleep(500 * time.Millisecond) // Wait for the stream to toggle
} }

View File

@@ -8,10 +8,10 @@ import (
// StudioModeCmd provides commands to manage studio mode in OBS Studio. // StudioModeCmd provides commands to manage studio mode in OBS Studio.
type StudioModeCmd struct { type StudioModeCmd struct {
Enable StudioModeEnableCmd `cmd:"enable" help:"Enable studio mode." aliases:"on"` Enable StudioModeEnableCmd `cmd:"enable" help:"Enable studio mode." aliases:"on" completion-enabled-command-alias:"false"`
Disable StudioModeDisableCmd `cmd:"disable" help:"Disable studio mode." aliases:"off"` Disable StudioModeDisableCmd `cmd:"disable" help:"Disable studio mode." aliases:"off" completion-enabled-command-alias:"false"`
Toggle StudioModeToggleCmd `cmd:"toggle" help:"Toggle studio mode." aliases:"tg"` Toggle StudioModeToggleCmd `cmd:"toggle" help:"Toggle studio mode." aliases:"tg" completion-enabled-command-alias:"false"`
Status StudioModeStatusCmd `cmd:"status" help:"Get studio mode status." aliases:"ss"` Status StudioModeStatusCmd `cmd:"status" help:"Get studio mode status." aliases:"ss" completion-enabled-command-alias:"false"`
} }
// StudioModeEnableCmd provides a command to enable studio mode. // StudioModeEnableCmd provides a command to enable studio mode.
@@ -19,7 +19,9 @@ type StudioModeEnableCmd struct{} // size = 0x0
// Run executes the command to enable studio mode. // Run executes the command to enable studio mode.
func (cmd *StudioModeEnableCmd) Run(ctx *context) error { func (cmd *StudioModeEnableCmd) Run(ctx *context) error {
_, err := ctx.Client.Ui.SetStudioModeEnabled(ui.NewSetStudioModeEnabledParams().WithStudioModeEnabled(true)) _, err := ctx.Client.Ui.SetStudioModeEnabled(
ui.NewSetStudioModeEnabledParams().WithStudioModeEnabled(true),
)
if err != nil { if err != nil {
return fmt.Errorf("failed to enable studio mode: %w", err) return fmt.Errorf("failed to enable studio mode: %w", err)
} }
@@ -33,7 +35,9 @@ type StudioModeDisableCmd struct{} // size = 0x0
// Run executes the command to disable studio mode. // Run executes the command to disable studio mode.
func (cmd *StudioModeDisableCmd) Run(ctx *context) error { func (cmd *StudioModeDisableCmd) Run(ctx *context) error {
_, err := ctx.Client.Ui.SetStudioModeEnabled(ui.NewSetStudioModeEnabledParams().WithStudioModeEnabled(false)) _, err := ctx.Client.Ui.SetStudioModeEnabled(
ui.NewSetStudioModeEnabledParams().WithStudioModeEnabled(false),
)
if err != nil { if err != nil {
return fmt.Errorf("failed to disable studio mode: %w", err) return fmt.Errorf("failed to disable studio mode: %w", err)
} }
@@ -53,7 +57,9 @@ func (cmd *StudioModeToggleCmd) Run(ctx *context) error {
} }
newStatus := !status.StudioModeEnabled newStatus := !status.StudioModeEnabled
_, err = ctx.Client.Ui.SetStudioModeEnabled(ui.NewSetStudioModeEnabledParams().WithStudioModeEnabled(newStatus)) _, err = ctx.Client.Ui.SetStudioModeEnabled(
ui.NewSetStudioModeEnabledParams().WithStudioModeEnabled(newStatus),
)
if err != nil { if err != nil {
return fmt.Errorf("failed to toggle studio mode: %w", err) return fmt.Errorf("failed to toggle studio mode: %w", err)
} }

View File

@@ -10,10 +10,7 @@ func TestStudioModeEnable(t *testing.T) {
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmdEnable := &StudioModeEnableCmd{} cmdEnable := &StudioModeEnableCmd{}
err := cmdEnable.Run(context) err := cmdEnable.Run(context)
@@ -41,10 +38,7 @@ func TestStudioModeDisable(t *testing.T) {
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmdDisable := &StudioModeDisableCmd{} cmdDisable := &StudioModeDisableCmd{}
err := cmdDisable.Run(context) err := cmdDisable.Run(context)

192
style.go Normal file
View File

@@ -0,0 +1,192 @@
// nolint: misspell
package main
import (
"fmt"
"os"
"github.com/charmbracelet/lipgloss"
)
// Style defines colours for the table styles.
type Style struct {
name string
border lipgloss.Color
oddRows lipgloss.Color
evenRows lipgloss.Color
highlight lipgloss.Color
}
// Highlight applies the highlight style to the given text.
func (s *Style) Highlight(text string) string {
return lipgloss.NewStyle().Foreground(s.highlight).Render(text)
}
func (s *Style) Error(text string) string {
return lipgloss.NewStyle().Foreground(lipgloss.Color("#FF0000")).Render(text) // Red for errors
}
func newRedStyle() Style {
return Style{
name: "red",
border: lipgloss.Color("#D32F2F"), // Strong red for border
oddRows: lipgloss.Color("#FFCDD2"), // Very light red for odd rows
evenRows: lipgloss.Color("#EF9A9A"), // Light red for even rows
highlight: lipgloss.Color("#EF9A9A"), // Highlight in light red
}
}
func newMagentaStyle() Style {
return Style{
name: "magenta",
border: lipgloss.Color("#C2185B"), // Strong magenta for border
oddRows: lipgloss.Color("#F8BBD0"), // Very light magenta/pink for odd rows
evenRows: lipgloss.Color("#F48FB1"), // Light magenta/pink for even rows
highlight: lipgloss.Color("#F48FB1"), // Highlight in light magenta/pink
}
}
func newPurpleStyle() Style {
return Style{
name: "purple",
border: lipgloss.Color("#7B1FA2"), // Strong purple for border
oddRows: lipgloss.Color("#E1BEE7"), // Very light purple for odd rows
evenRows: lipgloss.Color("#CE93D8"), // Light purple for even rows
highlight: lipgloss.Color("#CE93D8"), // Highlight in light purple
}
}
func newBlueStyle() Style {
return Style{
name: "blue",
border: lipgloss.Color("#1976D2"), // Medium blue for border
oddRows: lipgloss.Color("#E3F2FD"), // Very light blue for odd rows
evenRows: lipgloss.Color("#BBDEFB"), // Light blue for even rows
highlight: lipgloss.Color("#1976D2"), // Highlight in medium blue
}
}
func newCyanStyle() Style {
return Style{
name: "cyan",
border: lipgloss.Color("#00BFCF"), // A strong cyan for border
oddRows: lipgloss.Color("#E0F7FA"), // Very light cyan for odd rows
evenRows: lipgloss.Color("#B2EBF2"), // Slightly darker light cyan for even rows
highlight: lipgloss.Color("#00BFCF"), // Highlight in strong cyan
}
}
func newGreenStyle() Style {
return Style{
name: "green",
border: lipgloss.Color("#43A047"), // Medium green for border
oddRows: lipgloss.Color("#E8F5E9"), // Very light green for odd rows
evenRows: lipgloss.Color("#C8E6C9"), // Light green for even rows
highlight: lipgloss.Color("#43A047"), // Highlight in medium green
}
}
func newYellowStyle() Style {
return Style{
name: "yellow",
border: lipgloss.Color("#FBC02D"), // Strong yellow for border
oddRows: lipgloss.Color("#FFF9C4"), // Very light yellow for odd rows
evenRows: lipgloss.Color("#FFF59D"), // Light yellow for even rows
highlight: lipgloss.Color("#FBC02D"), // Highlight in strong yellow
}
}
func newOrangeStyle() Style {
return Style{
name: "orange",
border: lipgloss.Color("#F57C00"), // Strong orange for border
oddRows: lipgloss.Color("#FFF3E0"), // Very light orange for odd rows
evenRows: lipgloss.Color("#FFE0B2"), // Light orange for even rows
highlight: lipgloss.Color("#F57C00"), // Highlight in strong orange
}
}
func newWhiteStyle() Style {
return Style{
name: "white",
border: lipgloss.Color("#FFFFFF"), // White for border
oddRows: lipgloss.Color("#F0F0F0"), // Very light grey for odd rows
evenRows: lipgloss.Color("#E0E0E0"), // Light grey for even rows
highlight: lipgloss.Color("#FFFFFF"), // Highlight in white
}
}
func newGreyStyle() Style {
return Style{
name: "grey",
border: lipgloss.Color("#9E9E9E"), // Medium grey for border
oddRows: lipgloss.Color("#F5F5F5"), // Very light grey for odd rows
evenRows: lipgloss.Color("#EEEEEE"), // Light grey for even rows
highlight: lipgloss.Color("#9E9E9E"), // Highlight in medium grey
}
}
func newNavyBlueStyle() Style {
return Style{
name: "navy",
border: lipgloss.Color("#001F3F"), // Navy blue for border
oddRows: lipgloss.Color("#CFE2F3"), // Very light blue for odd rows
evenRows: lipgloss.Color("#A9CCE3"), // Light blue for even rows
highlight: lipgloss.Color("#001F3F"), // Highlight in navy blue
}
}
func newBlackStyle() Style {
return Style{
name: "black",
border: lipgloss.Color("#000000"), // Black for border
oddRows: lipgloss.Color("#333333"), // Dark grey for odd rows
evenRows: lipgloss.Color("#444444"), // Slightly lighter dark grey for even rows
highlight: lipgloss.Color("#000000"), // Highlight in black
}
}
func styleFromFlag(cfg StyleConfig) *Style {
var style Style
switch cfg.Style {
case "red":
style = newRedStyle()
case "magenta":
style = newMagentaStyle()
case "purple":
style = newPurpleStyle()
case "blue":
style = newBlueStyle()
case "cyan":
style = newCyanStyle()
case "green":
style = newGreenStyle()
case "yellow":
style = newYellowStyle()
case "orange":
style = newOrangeStyle()
case "white":
style = newWhiteStyle()
case "grey":
style = newGreyStyle()
case "navy":
style = newNavyBlueStyle()
case "black":
style = newBlackStyle()
default:
err := os.Setenv("NO_COLOR", "1") // nolint: misspell
if err != nil {
// If we can't set NO_COLOR, we just log the error and continue
// This is a fallback to ensure that the application can still run
fmt.Fprintf(os.Stderr, "Error setting NO_COLOR: %v\n", err)
}
}
// If noBorder is true, we disable the border styling
if cfg.NoBorder {
style.border = ""
}
return &style
}

90
text.go Normal file
View File

@@ -0,0 +1,90 @@
package main
import (
"fmt"
"strings"
"github.com/andreykaipov/goobs/api/requests/inputs"
)
// TextCmd provides commands for managing text inputs in OBS.
type TextCmd struct {
Current TextCurrentCmd `cmd:"current" help:"Display current text for a text input." aliases:"c"`
Update TextUpdateCmd `cmd:"update" help:"Update the text of a text input." aliases:"u"`
}
// TextCurrentCmd provides a command to display the current text of a text input.
type TextCurrentCmd struct {
InputName string `arg:"" help:"Name of the text source."`
}
// Run executes the command to display the current text of a text input.
func (cmd *TextCurrentCmd) Run(ctx *context) error {
resp, err := ctx.Client.Inputs.GetInputSettings(
inputs.NewGetInputSettingsParams().WithInputName(cmd.InputName),
)
if err != nil {
return fmt.Errorf("failed to get input settings: %w", err)
}
// Check if the input is a text input
kind := resp.InputKind
if !strings.HasPrefix(kind, "text_") {
return fmt.Errorf("input %s is of %s", cmd.InputName, kind)
}
currentText, ok := resp.InputSettings["text"]
if !ok {
return fmt.Errorf("input %s does not have a 'text' setting", cmd.InputName)
}
if currentText == "" {
currentText = "(empty)"
}
fmt.Fprintf(
ctx.Out,
"Current text for source %s: %s\n",
ctx.Style.Highlight(cmd.InputName),
currentText,
)
return nil
}
// TextUpdateCmd provides a command to update the text of a text input.
type TextUpdateCmd struct {
InputName string `arg:"" help:"Name of the text source."`
NewText string `arg:"" help:"New text to set for the source." default:""`
}
// Run executes the command to update the text of a text input.
func (cmd *TextUpdateCmd) Run(ctx *context) error {
resp, err := ctx.Client.Inputs.GetInputSettings(
inputs.NewGetInputSettingsParams().WithInputName(cmd.InputName),
)
if err != nil {
return fmt.Errorf("failed to get input settings: %w", err)
}
// Check if the input is a text input
kind := resp.InputKind
if !strings.HasPrefix(kind, "text_") {
return fmt.Errorf("input %s is of %s", cmd.InputName, kind)
}
if _, err := ctx.Client.Inputs.SetInputSettings(&inputs.SetInputSettingsParams{
InputName: &cmd.InputName,
InputSettings: map[string]any{"text": &cmd.NewText},
}); err != nil {
return fmt.Errorf("failed to update text for source %s: %w", cmd.InputName, err)
}
if cmd.NewText == "" {
cmd.NewText = "(empty)"
}
fmt.Fprintf(
ctx.Out,
"Updated text for source %s to: %s\n",
ctx.Style.Highlight(cmd.InputName),
cmd.NewText,
)
return nil
}

55
util.go
View File

@@ -2,7 +2,12 @@
package main package main
import "strings" import (
"fmt"
"os"
"strings"
"time"
)
func snakeCaseToTitleCase(snake string) string { func snakeCaseToTitleCase(snake string) string {
words := strings.Split(snake, "_") words := strings.Split(snake, "_")
@@ -16,9 +21,15 @@ func snakeCaseToTitleCase(snake string) string {
func getEnabledMark(enabled bool) string { func getEnabledMark(enabled bool) string {
if enabled { if enabled {
return "\u2713" // check mark if os.Getenv("NO_COLOR") != "" { // nolint: misspell
return "✓"
}
return "●"
} }
return "\u274c" // cross mark if os.Getenv("NO_COLOR") != "" { // nolint: misspell
return "✗"
}
return "○"
} }
func trimPrefix(s, prefix string) string { func trimPrefix(s, prefix string) string {
@@ -27,3 +38,41 @@ func trimPrefix(s, prefix string) string {
} }
return s return s
} }
func parseTimeStringToMilliseconds(timeStr string) (float64, error) {
parts := strings.Split(timeStr, ":")
var durationStr string
switch len(parts) {
case 1:
// Format: SS -> "SSs"
durationStr = parts[0] + "s"
case 2:
// Format: MM:SS -> "MMmSSs"
durationStr = parts[0] + "m" + parts[1] + "s"
case 3:
// Format: HH:MM:SS -> "HHhMMmSSs"
durationStr = parts[0] + "h" + parts[1] + "m" + parts[2] + "s"
default:
return 0, fmt.Errorf("invalid time format: %s", timeStr)
}
duration, err := time.ParseDuration(durationStr)
if err != nil {
return 0, fmt.Errorf("failed to parse duration: %w", err)
}
return duration.Seconds() * 1000, nil
}
func formatMillisecondsToTimeString(ms float64) string {
totalSeconds := int(ms / 1000)
hours := totalSeconds / 3600
minutes := (totalSeconds % 3600) / 60
seconds := totalSeconds % 60
if hours > 0 {
return fmt.Sprintf("%02d:%02d:%02d", hours, minutes, seconds)
}
return fmt.Sprintf("%02d:%02d", minutes, seconds)
}

View File

@@ -2,38 +2,8 @@ package main
import ( import (
"fmt" "fmt"
"runtime/debug"
"strings"
"github.com/alecthomas/kong"
) )
var version string
// VersionFlag is a custom flag type for displaying version information.
type VersionFlag string
// Decode implements the kong.Flag interface for VersionFlag.
func (v VersionFlag) Decode(_ *kong.DecodeContext) error { return nil }
// IsBool implements the kong.Flag interface for VersionFlag.
func (v VersionFlag) IsBool() bool { return true }
// BeforeApply implements the kong.Flag interface for VersionFlag.
func (v VersionFlag) BeforeApply(app *kong.Kong, _ kong.Vars) error { // nolint: unparam
if version == "" {
info, ok := debug.ReadBuildInfo()
if !ok {
return fmt.Errorf("failed to read build info")
}
version = strings.Split(info.Main.Version, "-")[0]
}
fmt.Printf("gobs-cli version: %s\n", version)
app.Exit(0) // Exit the application after printing the version
return nil
}
// ObsVersionCmd handles the version command. // ObsVersionCmd handles the version command.
type ObsVersionCmd struct{} // size = 0x0 type ObsVersionCmd struct{} // size = 0x0

View File

@@ -11,10 +11,7 @@ func TestVersion(t *testing.T) {
defer disconnect() defer disconnect()
var out bytes.Buffer var out bytes.Buffer
context := &context{ context := newContext(client, &out, StyleConfig{})
Client: client,
Out: &out,
}
cmd := &ObsVersionCmd{} cmd := &ObsVersionCmd{}
err := cmd.Run(context) err := cmd.Run(context)