mirror of
https://github.com/onyx-and-iris/gobs-cli.git
synced 2025-06-12 14:40:33 +01:00
Compare commits
No commits in common. "main" and "v0.4.0" have entirely different histories.
3
.gitignore
vendored
3
.gitignore
vendored
@ -35,3 +35,6 @@ gobs-cli.1
|
||||
|
||||
# Config files
|
||||
config.yaml
|
||||
|
||||
# Test files
|
||||
*_test.go
|
@ -50,6 +50,3 @@ issues:
|
||||
exclude:
|
||||
# gosec: Duplicated errcheck checks
|
||||
- G104
|
||||
exclude-files:
|
||||
# Exclude vendor directory
|
||||
- main_test.go
|
||||
|
85
CHANGELOG.md
85
CHANGELOG.md
@ -5,92 +5,11 @@ All notable changes to this project will be documented in this file.
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
# [0.10.3] - 2025-06-07
|
||||
|
||||
### Added
|
||||
|
||||
- filter list:
|
||||
- --ffmpeg, --vlc flags
|
||||
- Muted column to list table
|
||||
|
||||
# [0.10.2] - 2025-06-04
|
||||
|
||||
### Added
|
||||
|
||||
- screenshot save command, see [ScreenshotCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#screenshotcmd)
|
||||
|
||||
### Fixed
|
||||
|
||||
- filter list:
|
||||
- sourceName arg now defaults to current scene.
|
||||
- defaults are printed for any unmodified values.
|
||||
- sceneitem list:
|
||||
- prints enabled mark instead of true/false
|
||||
|
||||
# [0.9.0] - 2025-06-02
|
||||
|
||||
### Added
|
||||
|
||||
- --version/-v option. See [Flags](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#flags)
|
||||
|
||||
### Changed
|
||||
|
||||
- version command renamed to obs-version
|
||||
|
||||
# [0.8.2] - 2025-05-29
|
||||
|
||||
### Added
|
||||
|
||||
- record start/stop and stream start/stop commands check outputActive states first.
|
||||
- Errors are returned if the command cannot be performed.
|
||||
|
||||
### Changed
|
||||
|
||||
- The --parent flag for the sceneitem commands has been renamed to --group, see [SceneItemCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#sceneitemcmd)
|
||||
|
||||
# [0.8.0] - 2025-05-27
|
||||
|
||||
### Added
|
||||
|
||||
- record directory command, see [directory under RecordCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#recordcmd)
|
||||
|
||||
### Changed
|
||||
|
||||
- record stop now prints the output path of the recording.
|
||||
|
||||
|
||||
# [0.7.0] - 2025-05-26
|
||||
|
||||
### Added
|
||||
|
||||
- projector commands, see [ProjectorCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#projectorcmd)
|
||||
|
||||
|
||||
# [0.6.1] - 2025-05-25
|
||||
|
||||
### Added
|
||||
|
||||
- filter commands, see [FilterCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#filtercmd)
|
||||
|
||||
### Changed
|
||||
|
||||
- list commands are now printed as tables.
|
||||
- This affects group, hotkey, input, profile, scene, scenecollection and sceneitem command groups.
|
||||
|
||||
# [0.5.0] - 2025-05-22
|
||||
|
||||
### Added
|
||||
|
||||
- hotkey commands, see [HotkeyCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#hotkeycmd)
|
||||
|
||||
# [0.4.2] - 2025-05-08
|
||||
# [0.4.0] - 2025-05-07
|
||||
|
||||
### Added
|
||||
|
||||
- replaybuffer toggle command
|
||||
- studiomode enable/disable now print output to console
|
||||
- stream start/stop now print output to console
|
||||
- Unit tests
|
||||
|
||||
# [0.3.1] - 2025-05-02
|
||||
|
||||
@ -109,4 +28,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
|
||||
### Added
|
||||
|
||||
- Initial release.
|
||||
- Initial release.
|
186
README.md
186
README.md
@ -14,16 +14,10 @@ go install github.com/onyx-and-iris/gobs-cli@latest
|
||||
|
||||
#### Flags
|
||||
|
||||
- --host/-H: Websocket host
|
||||
- --port/-P Websocket port
|
||||
- --password/-p: Websocket password
|
||||
- --timeout/-T: Websocket timeout
|
||||
- --version/-v: Print the gobs-cli version
|
||||
|
||||
Pass `--host`, `--port` and `--password` as flags on the root command, for example:
|
||||
Pass `--host`, `--port` and `--password` as flags to the root command, for example:
|
||||
|
||||
```console
|
||||
gobs-cli --host localhost --port 4455 --password 'websocket password' --help
|
||||
gobs-cli --host=localhost --port=4455 --password=<websocket password> --help
|
||||
```
|
||||
|
||||
#### Environment Variables
|
||||
@ -43,12 +37,10 @@ OBS_TIMEOUT=5
|
||||
|
||||
## Commands
|
||||
|
||||
### ObsVersionCmd
|
||||
|
||||
- Print OBS client and websocket version.
|
||||
### VersionCmd
|
||||
|
||||
```console
|
||||
gobs-cli obs-version
|
||||
gobs-cli version
|
||||
```
|
||||
|
||||
### SceneCmd
|
||||
@ -87,14 +79,9 @@ gobs-cli scene switch --preview LIVE
|
||||
### SceneItemCmd
|
||||
|
||||
- list: List all scene items.
|
||||
|
||||
*optional*
|
||||
- args: SceneName
|
||||
- defaults to current scene
|
||||
|
||||
```console
|
||||
gobs-cli sceneitem list
|
||||
|
||||
gobs-cli sceneitem list LIVE
|
||||
```
|
||||
|
||||
@ -102,7 +89,7 @@ gobs-cli sceneitem list LIVE
|
||||
- flags:
|
||||
|
||||
*optional*
|
||||
- --group: Parent group name.
|
||||
- --parent: Parent group name.
|
||||
- args: SceneName ItemName
|
||||
|
||||
```console
|
||||
@ -113,7 +100,7 @@ gobs-cli sceneitem show START "Colour Source"
|
||||
- flags:
|
||||
|
||||
*optional*
|
||||
- --group: Parent group name.
|
||||
- --parent: Parent group name.
|
||||
- args: SceneName ItemName
|
||||
|
||||
```console
|
||||
@ -124,29 +111,28 @@ gobs-cli sceneitem hide START "Colour Source"
|
||||
- flags:
|
||||
|
||||
*optional*
|
||||
- --group: Parent group name.
|
||||
- --parent: Parent group name.
|
||||
- args: SceneName ItemName
|
||||
|
||||
```console
|
||||
gobs-cli sceneitem toggle --group=test_group START "Colour Source 3"
|
||||
gobs-cli sceneitem toggle --parent=test_group START "Colour Source 3"
|
||||
```
|
||||
|
||||
- visible: Get scene item visibility.
|
||||
- flags:
|
||||
|
||||
*optional*
|
||||
- --group: Parent group name.
|
||||
- --parent: Parent group name.
|
||||
- args: SceneName ItemName
|
||||
|
||||
```console
|
||||
gobs-cli sceneitem visible --group=test_group START "Colour Source 4"
|
||||
gobs-cli sceneitem visible --parent=test_group START "Colour Source 4"
|
||||
```
|
||||
|
||||
- transform: Transform scene item.
|
||||
- flags:
|
||||
|
||||
*optional*
|
||||
- --group: Parent group name.
|
||||
- --parent: Parent group name.
|
||||
|
||||
- --alignment: Alignment of the scene item.
|
||||
- --bounds-alignment: Bounds alignment of the scene item.
|
||||
@ -175,14 +161,9 @@ gobs-cli sceneitem transform \
|
||||
### GroupCmd
|
||||
|
||||
- list: List all groups.
|
||||
|
||||
*optional*
|
||||
- args: SceneName
|
||||
- defaults to current scene
|
||||
|
||||
```console
|
||||
gobs-cli group list
|
||||
|
||||
gobs-cli group list START
|
||||
```
|
||||
|
||||
@ -223,8 +204,6 @@ gobs-cli group status START "test_group"
|
||||
- --input: List all inputs.
|
||||
- --output: List all outputs.
|
||||
- --colour: List all colour sources.
|
||||
- --ffmpeg: List all ffmpeg sources.
|
||||
- --vlc: List all VLC sources.
|
||||
|
||||
```console
|
||||
gobs-cli input list
|
||||
@ -291,19 +270,6 @@ gobs-cli record pause
|
||||
gobs-cli record resume
|
||||
```
|
||||
|
||||
- directory: Get/Set recording directory.
|
||||
|
||||
*optional*
|
||||
- args: RecordDirectory
|
||||
- if not passed the current record directory will be printed.
|
||||
|
||||
```console
|
||||
gobs-cli record directory
|
||||
|
||||
gobs-cli record directory "/home/me/obs-vids/"
|
||||
gobs-cli record directory "C:/Users/me/Videos"
|
||||
```
|
||||
|
||||
### StreamCmd
|
||||
|
||||
- start: Start streaming.
|
||||
@ -407,12 +373,6 @@ gobs-cli replaybuffer start
|
||||
gobs-cli replaybuffer stop
|
||||
```
|
||||
|
||||
- toggle: Toggle replay buffer.
|
||||
|
||||
```console
|
||||
gobs-cli replaybuffer toggle
|
||||
```
|
||||
|
||||
- status: Get replay buffer status.
|
||||
|
||||
```console
|
||||
@ -477,126 +437,4 @@ gobs-cli virtualcam toggle
|
||||
gobs-cli virtualcam status
|
||||
```
|
||||
|
||||
### HotkeyCmd
|
||||
|
||||
- list: List all hotkeys.
|
||||
|
||||
```console
|
||||
gobs-cli hotkey list
|
||||
```
|
||||
|
||||
- trigger: Trigger a hotkey by name.
|
||||
|
||||
```console
|
||||
gobs-cli hotkey trigger OBSBasic.StartStreaming
|
||||
|
||||
gobs-cli hotkey trigger OBSBasic.StopStreaming
|
||||
```
|
||||
|
||||
- trigger-sequence: Trigger a hotkey by sequence.
|
||||
- flags:
|
||||
|
||||
*optional*
|
||||
- --shift: Press shift.
|
||||
- --ctrl: Press control.
|
||||
- --alt: Press alt.
|
||||
- --cmd: Press command (mac).
|
||||
|
||||
- args: keyID
|
||||
- Check [obs-hotkeys.h][obs-keyids] for a full list of OBS key ids.
|
||||
|
||||
```console
|
||||
gobs-cli hotkey trigger-sequence OBS_KEY_F1 --ctrl
|
||||
|
||||
gobs-cli hotkey trigger-sequence OBS_KEY_F1 --shift --ctrl
|
||||
```
|
||||
|
||||
### FilterCmd
|
||||
|
||||
- list: List all filters.
|
||||
|
||||
*optional*
|
||||
- args: SourceName
|
||||
- defaults to current scene
|
||||
|
||||
```console
|
||||
gobs-cli filter list
|
||||
```
|
||||
|
||||
- enable: Enable filter.
|
||||
- args: SourceName FilterName
|
||||
|
||||
```console
|
||||
gobs-cli enable 'Mic/Aux' 'Gain'
|
||||
```
|
||||
|
||||
- disable: Disable filter.
|
||||
- args: SourceName FilterName
|
||||
|
||||
```console
|
||||
gobs-cli disable 'Mic/Aux' 'Gain'
|
||||
```
|
||||
|
||||
- toggle: Toggle filter.
|
||||
- args: SourceName FilterName
|
||||
|
||||
```console
|
||||
gobs-cli toggle 'Mic/Aux' 'Gain'
|
||||
```
|
||||
|
||||
- status: Get filter status.
|
||||
- args: SourceName FilterName
|
||||
|
||||
```console
|
||||
gobs-cli status 'Mic/Aux' 'Gain'
|
||||
```
|
||||
|
||||
### ProjectorCmd
|
||||
|
||||
- list-monitors: List available monitors.
|
||||
|
||||
```console
|
||||
gobs-cli projector list-monitors
|
||||
```
|
||||
|
||||
- open: Open a fullscreen projector for a source on a specific monitor.
|
||||
- flags:
|
||||
|
||||
*optional*
|
||||
- --monitor-index: Index of the monitor to open the projector on.
|
||||
- defaults to 0
|
||||
|
||||
*optional*
|
||||
- args: SourceName
|
||||
- defaults to current scene
|
||||
|
||||
```console
|
||||
gobs-cli projector open
|
||||
|
||||
gobs-cli projector open --monitor-index=1 "test_scene"
|
||||
|
||||
gobs-cli projector open --monitor-index=1 "test_group"
|
||||
```
|
||||
|
||||
### ScreenshotCmd
|
||||
|
||||
- save: Take a screenshot and save it to a file.
|
||||
- flags:
|
||||
|
||||
*optional*
|
||||
- --width:
|
||||
- defaults to 1920
|
||||
- --height:
|
||||
- defaults to 1080
|
||||
- --quality:
|
||||
- defaults to -1
|
||||
|
||||
- args: SourceName FilePath
|
||||
|
||||
```console
|
||||
gobs-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\screenshot.png"
|
||||
```
|
||||
|
||||
|
||||
[userconfigdir]: https://pkg.go.dev/os#UserConfigDir
|
||||
[obs-keyids]: https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h
|
||||
[userconfigdir]: https://pkg.go.dev/os#UserConfigDir
|
@ -7,8 +7,6 @@ vars:
|
||||
PROGRAM: gobs-cli
|
||||
SHELL: '{{if eq .OS "Windows_NT"}}powershell{{end}}'
|
||||
BIN_DIR: bin
|
||||
VERSION:
|
||||
sh: 'git describe --tags $(git rev-list --tags --max-count=1)'
|
||||
|
||||
tasks:
|
||||
default:
|
||||
@ -37,13 +35,13 @@ tasks:
|
||||
build-windows:
|
||||
desc: Build the gobs-cli project for Windows
|
||||
cmds:
|
||||
- GOOS=windows GOARCH=amd64 go build -ldflags "-X 'main.version={{.VERSION}}'" -o {{.BIN_DIR}}/{{.PROGRAM}}_windows_amd64.exe
|
||||
- GOOS=windows GOARCH=amd64 go build -o {{.BIN_DIR}}/{{.PROGRAM}}_windows_amd64.exe
|
||||
internal: true
|
||||
|
||||
build-linux:
|
||||
desc: Build the gobs-cli project for Linux
|
||||
cmds:
|
||||
- GOOS=linux GOARCH=amd64 go build -ldflags "-X 'main.version={{.VERSION}}'" -o {{.BIN_DIR}}/{{.PROGRAM}}_linux_amd64
|
||||
- GOOS=linux GOARCH=amd64 go build -o {{.BIN_DIR}}/{{.PROGRAM}}_linux_amd64
|
||||
internal: true
|
||||
|
||||
test:
|
||||
|
195
filter.go
195
filter.go
@ -1,195 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"maps"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
"github.com/andreykaipov/goobs/api/requests/filters"
|
||||
"github.com/aquasecurity/table"
|
||||
)
|
||||
|
||||
// FilterCmd provides commands to manage filters in OBS Studio.
|
||||
type FilterCmd struct {
|
||||
List FilterListCmd `cmd:"" help:"List all filters." aliases:"ls"`
|
||||
Enable FilterEnableCmd `cmd:"" help:"Enable filter." aliases:"on"`
|
||||
Disable FilterDisableCmd `cmd:"" help:"Disable filter." aliases:"off"`
|
||||
Toggle FilterToggleCmd `cmd:"" help:"Toggle filter." aliases:"tg"`
|
||||
Status FilterStatusCmd `cmd:"" help:"Get filter status." aliases:"ss"`
|
||||
}
|
||||
|
||||
// FilterListCmd provides a command to list all filters in a scene.
|
||||
type FilterListCmd struct {
|
||||
SourceName string `arg:"" help:"Name of the source to list filters from." default:""`
|
||||
}
|
||||
|
||||
// Run executes the command to list all filters in a scene.
|
||||
func (cmd *FilterListCmd) Run(ctx *context) error {
|
||||
if cmd.SourceName == "" {
|
||||
currentScene, err := ctx.Client.Scenes.GetCurrentProgramScene()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get current program scene: %w", err)
|
||||
}
|
||||
cmd.SourceName = currentScene.SceneName
|
||||
}
|
||||
|
||||
sourceFilters, err := ctx.Client.Filters.GetSourceFilterList(
|
||||
filters.NewGetSourceFilterListParams().WithSourceName(cmd.SourceName),
|
||||
)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if len(sourceFilters.Filters) == 0 {
|
||||
fmt.Fprintf(ctx.Out, "No filters found for source %s.\n", cmd.SourceName)
|
||||
return nil
|
||||
}
|
||||
|
||||
t := table.New(ctx.Out)
|
||||
t.SetPadding(3)
|
||||
t.SetAlignment(table.AlignLeft, table.AlignLeft, table.AlignCenter, table.AlignLeft)
|
||||
t.SetHeaders("Filter Name", "Kind", "Enabled", "Settings")
|
||||
|
||||
for _, filter := range sourceFilters.Filters {
|
||||
defaultSettings, err := ctx.Client.Filters.GetSourceFilterDefaultSettings(
|
||||
filters.NewGetSourceFilterDefaultSettingsParams().
|
||||
WithFilterKind(filter.FilterKind),
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get default settings for filter %s: %w",
|
||||
filter.FilterName, err)
|
||||
}
|
||||
maps.Insert(defaultSettings.DefaultFilterSettings, maps.All(filter.FilterSettings))
|
||||
|
||||
var lines []string
|
||||
for k, v := range defaultSettings.DefaultFilterSettings {
|
||||
lines = append(lines, fmt.Sprintf("%s: %v", snakeCaseToTitleCase(k), v))
|
||||
}
|
||||
sort.Slice(lines, func(i, j int) bool {
|
||||
return strings.ToLower(lines[i]) < strings.ToLower(lines[j])
|
||||
})
|
||||
|
||||
t.AddRow(
|
||||
filter.FilterName,
|
||||
snakeCaseToTitleCase(filter.FilterKind),
|
||||
getEnabledMark(filter.FilterEnabled),
|
||||
strings.Join(lines, "\n"),
|
||||
)
|
||||
}
|
||||
t.Render()
|
||||
return nil
|
||||
}
|
||||
|
||||
// FilterEnableCmd provides a command to enable a filter in a scene.
|
||||
type FilterEnableCmd struct {
|
||||
SourceName string `arg:"" help:"Name of the source to enable filter from."`
|
||||
FilterName string `arg:"" help:"Name of the filter to enable."`
|
||||
}
|
||||
|
||||
// Run executes the command to enable a filter in a scene.
|
||||
func (cmd *FilterEnableCmd) Run(ctx *context) error {
|
||||
_, err := ctx.Client.Filters.SetSourceFilterEnabled(
|
||||
filters.NewSetSourceFilterEnabledParams().
|
||||
WithSourceName(cmd.SourceName).
|
||||
WithFilterName(cmd.FilterName).
|
||||
WithFilterEnabled(true),
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to enable filter %s on source %s: %w",
|
||||
cmd.FilterName, cmd.SourceName, err)
|
||||
}
|
||||
fmt.Fprintf(ctx.Out, "Filter %s enabled on source %s.\n",
|
||||
cmd.FilterName, cmd.SourceName)
|
||||
return nil
|
||||
}
|
||||
|
||||
// FilterDisableCmd provides a command to disable a filter in a scene.
|
||||
type FilterDisableCmd struct {
|
||||
SourceName string `arg:"" help:"Name of the source to disable filter from."`
|
||||
FilterName string `arg:"" help:"Name of the filter to disable."`
|
||||
}
|
||||
|
||||
// Run executes the command to disable a filter in a scene.
|
||||
func (cmd *FilterDisableCmd) Run(ctx *context) error {
|
||||
_, err := ctx.Client.Filters.SetSourceFilterEnabled(
|
||||
filters.NewSetSourceFilterEnabledParams().
|
||||
WithSourceName(cmd.SourceName).
|
||||
WithFilterName(cmd.FilterName).
|
||||
WithFilterEnabled(false),
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to disable filter %s on source %s: %w",
|
||||
cmd.FilterName, cmd.SourceName, err)
|
||||
}
|
||||
fmt.Fprintf(ctx.Out, "Filter %s disabled on source %s.\n",
|
||||
cmd.FilterName, cmd.SourceName)
|
||||
return nil
|
||||
}
|
||||
|
||||
// FilterToggleCmd provides a command to toggle a filter in a scene.
|
||||
type FilterToggleCmd struct {
|
||||
SourceName string `arg:"" help:"Name of the source to toggle filter from."`
|
||||
FilterName string `arg:"" help:"Name of the filter to toggle."`
|
||||
}
|
||||
|
||||
// Run executes the command to toggle a filter in a scene.
|
||||
func (cmd *FilterToggleCmd) Run(ctx *context) error {
|
||||
filter, err := ctx.Client.Filters.GetSourceFilter(
|
||||
filters.NewGetSourceFilterParams().
|
||||
WithSourceName(cmd.SourceName).
|
||||
WithFilterName(cmd.FilterName),
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get filter %s on source %s: %w",
|
||||
cmd.FilterName, cmd.SourceName, err)
|
||||
}
|
||||
|
||||
newStatus := !filter.FilterEnabled
|
||||
_, err = ctx.Client.Filters.SetSourceFilterEnabled(
|
||||
filters.NewSetSourceFilterEnabledParams().
|
||||
WithSourceName(cmd.SourceName).
|
||||
WithFilterName(cmd.FilterName).
|
||||
WithFilterEnabled(newStatus),
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to toggle filter %s on source %s: %w",
|
||||
cmd.FilterName, cmd.SourceName, err)
|
||||
}
|
||||
|
||||
if newStatus {
|
||||
fmt.Fprintf(ctx.Out, "Filter %s on source %s is now enabled.\n",
|
||||
cmd.FilterName, cmd.SourceName)
|
||||
} else {
|
||||
fmt.Fprintf(ctx.Out, "Filter %s on source %s is now disabled.\n",
|
||||
cmd.FilterName, cmd.SourceName)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// FilterStatusCmd provides a command to get the status of a filter in a scene.
|
||||
type FilterStatusCmd struct {
|
||||
SourceName string `arg:"" help:"Name of the source to get filter status from."`
|
||||
FilterName string `arg:"" help:"Name of the filter to get status."`
|
||||
}
|
||||
|
||||
// Run executes the command to get the status of a filter in a scene.
|
||||
func (cmd *FilterStatusCmd) Run(ctx *context) error {
|
||||
filter, err := ctx.Client.Filters.GetSourceFilter(
|
||||
filters.NewGetSourceFilterParams().
|
||||
WithSourceName(cmd.SourceName).
|
||||
WithFilterName(cmd.FilterName),
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get status of filter %s on source %s: %w",
|
||||
cmd.FilterName, cmd.SourceName, err)
|
||||
}
|
||||
if filter.FilterEnabled {
|
||||
fmt.Fprintf(ctx.Out, "Filter %s on source %s is enabled.\n",
|
||||
cmd.FilterName, cmd.SourceName)
|
||||
} else {
|
||||
fmt.Fprintf(ctx.Out, "Filter %s on source %s is disabled.\n",
|
||||
cmd.FilterName, cmd.SourceName)
|
||||
}
|
||||
return nil
|
||||
}
|
@ -1,76 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestFilterList(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmd := &FilterListCmd{
|
||||
SourceName: "Mic/Aux",
|
||||
}
|
||||
err := cmd.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to list filters: %v", err)
|
||||
}
|
||||
if !strings.Contains(out.String(), "test_filter") {
|
||||
t.Fatalf("Expected output to contain 'test_filter', got '%s'", out.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestFilterListScene(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmd := &FilterListCmd{
|
||||
SourceName: "gobs-test",
|
||||
}
|
||||
err := cmd.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to list filters in scene: %v", err)
|
||||
}
|
||||
if !strings.Contains(out.String(), "test_filter") {
|
||||
t.Fatalf("Expected output to contain 'test_filter', got '%s'", out.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestFilterListEmpty(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmd := &FilterListCmd{
|
||||
SourceName: "NonExistentSource",
|
||||
}
|
||||
err := cmd.Run(context)
|
||||
if err == nil {
|
||||
t.Fatal("Expected error for non-existent source, but got none")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "No source was found by the name of `NonExistentSource`.") {
|
||||
t.Fatalf(
|
||||
"Expected error to contain 'No source was found by the name of `NonExistentSource`.', got '%s'",
|
||||
err.Error(),
|
||||
)
|
||||
}
|
||||
}
|
5
go.mod
5
go.mod
@ -6,7 +6,6 @@ require (
|
||||
github.com/alecthomas/kong v1.10.0
|
||||
github.com/alecthomas/mango-kong v0.1.0
|
||||
github.com/andreykaipov/goobs v1.5.6
|
||||
github.com/aquasecurity/table v1.10.0
|
||||
github.com/titusjaka/kong-dotenv-go v0.1.0
|
||||
)
|
||||
|
||||
@ -15,13 +14,9 @@ require (
|
||||
github.com/gorilla/websocket v1.5.3 // indirect
|
||||
github.com/hashicorp/logutils v1.0.0 // indirect
|
||||
github.com/joho/godotenv v1.5.1 // indirect
|
||||
github.com/mattn/go-runewidth v0.0.13 // indirect
|
||||
github.com/mitchellh/mapstructure v1.5.0 // indirect
|
||||
github.com/mmcloughlin/profile v0.1.1 // indirect
|
||||
github.com/muesli/mango v0.1.1-0.20220205060214-77e2058169ab // indirect
|
||||
github.com/muesli/roff v0.1.0 // indirect
|
||||
github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d // indirect
|
||||
github.com/rivo/uniseg v0.2.0 // indirect
|
||||
golang.org/x/sys v0.1.0 // indirect
|
||||
golang.org/x/term v0.0.0-20220526004731-065cf7ba2467 // indirect
|
||||
)
|
||||
|
10
go.sum
10
go.sum
@ -8,8 +8,6 @@ github.com/alecthomas/repr v0.4.0 h1:GhI2A8MACjfegCPVq9f1FLvIBS+DrQ2KQBFZP1iFzXc
|
||||
github.com/alecthomas/repr v0.4.0/go.mod h1:Fr0507jx4eOXV7AlPV6AVZLYrLIuIeSOWtW57eE/O/4=
|
||||
github.com/andreykaipov/goobs v1.5.6 h1:eIkEqYN99+2VJvmlY/56Ah60nkRKS6efMQvpM3oUgPQ=
|
||||
github.com/andreykaipov/goobs v1.5.6/go.mod h1:iSZP93FJ4d9X/U1x4DD4IyILLtig+vViqZWBGjLywcY=
|
||||
github.com/aquasecurity/table v1.10.0 h1:gPWV28qp9XSlvXdT3ku8yKQoZE6II0vsmegKpW+dB08=
|
||||
github.com/aquasecurity/table v1.10.0/go.mod h1:eqOmvjjB7AhXFgFqpJUEE/ietg7RrMSJZXyTN8E/wZw=
|
||||
github.com/buger/jsonparser v1.1.1 h1:2PnMjfWD7wBILjqQbt530v576A/cAbQvEW9gGIpYMUs=
|
||||
github.com/buger/jsonparser v1.1.1/go.mod h1:6RYKKt7H4d4+iWqouImQ9R2FZql3VbhNgx27UK13J/0=
|
||||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||
@ -22,8 +20,6 @@ github.com/hexops/gotextdiff v1.0.3 h1:gitA9+qJrrTCsiCl7+kh75nPqQt1cx4ZkudSTLoUq
|
||||
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/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
|
||||
github.com/mattn/go-runewidth v0.0.13 h1:lTGmDsbAYt5DmK6OnoV7EuIF1wEIFAcxld6ypU4OSgU=
|
||||
github.com/mattn/go-runewidth v0.0.13/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
|
||||
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/mmcloughlin/profile v0.1.1 h1:jhDmAqPyebOsVDOCICJoINoLb/AnLBaUw58nFzxWS2w=
|
||||
@ -36,15 +32,9 @@ github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d h1:VhgPp6v9qf9Agr/
|
||||
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/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/rivo/uniseg v0.2.0 h1:S1pD9weZBuJdFmowNwbpi7BJ8TNftyUImj/0WQi72jY=
|
||||
github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
|
||||
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
|
||||
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
|
||||
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=
|
||||
golang.org/x/sys v0.1.0 h1:kunALQeHf1/185U1i0GOB/fy1IPRDDpuoOOqRReG57U=
|
||||
golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/term v0.0.0-20220526004731-065cf7ba2467 h1:CBpWXWQpIRjzmkkA+M7q9Fqnwd2mZr3AFqexg8YTfoM=
|
||||
golang.org/x/term v0.0.0-20220526004731-065cf7ba2467/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
|
||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
|
20
group.go
20
group.go
@ -4,7 +4,6 @@ import (
|
||||
"fmt"
|
||||
|
||||
"github.com/andreykaipov/goobs/api/requests/sceneitems"
|
||||
"github.com/aquasecurity/table"
|
||||
)
|
||||
|
||||
// GroupCmd provides commands to manage groups in OBS Studio.
|
||||
@ -18,36 +17,21 @@ type GroupCmd struct {
|
||||
|
||||
// GroupListCmd provides a command to list all groups in a scene.
|
||||
type GroupListCmd struct {
|
||||
SceneName string `arg:"" help:"Name of the scene to list groups from." default:""`
|
||||
SceneName string `arg:"" help:"Name of the scene to list groups from."`
|
||||
}
|
||||
|
||||
// Run executes the command to list all groups in a scene.
|
||||
func (cmd *GroupListCmd) Run(ctx *context) error {
|
||||
if cmd.SceneName == "" {
|
||||
currentScene, err := ctx.Client.Scenes.GetCurrentProgramScene()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get current program scene: %w", err)
|
||||
}
|
||||
cmd.SceneName = currentScene.SceneName
|
||||
}
|
||||
|
||||
resp, err := ctx.Client.SceneItems.GetSceneItemList(sceneitems.NewGetSceneItemListParams().
|
||||
WithSceneName(cmd.SceneName))
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get scene item list: %w", err)
|
||||
}
|
||||
|
||||
t := table.New(ctx.Out)
|
||||
t.SetPadding(3)
|
||||
t.SetAlignment(table.AlignCenter, table.AlignLeft, table.AlignCenter)
|
||||
t.SetHeaders("ID", "Group Name", "Enabled")
|
||||
|
||||
for _, item := range resp.SceneItems {
|
||||
if item.IsGroup {
|
||||
t.AddRow(fmt.Sprintf("%d", item.SceneItemID), item.SourceName, getEnabledMark(item.SceneItemEnabled))
|
||||
fmt.Fprintf(ctx.Out, "Group ID: %d, Source Name: %s\n", item.SceneItemID, item.SourceName)
|
||||
}
|
||||
}
|
||||
t.Render()
|
||||
return nil
|
||||
}
|
||||
|
||||
|
130
group_test.go
130
group_test.go
@ -1,130 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestGroupList(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmd := &GroupListCmd{
|
||||
SceneName: "Scene",
|
||||
}
|
||||
err := cmd.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to list groups: %v", err)
|
||||
}
|
||||
if !strings.Contains(out.String(), "test_group") {
|
||||
t.Fatalf("Expected output to contain 'test_group', got '%s'", out.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestGroupShow(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmd := &GroupShowCmd{
|
||||
SceneName: "Scene",
|
||||
GroupName: "test_group",
|
||||
}
|
||||
err := cmd.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to show group: %v", err)
|
||||
}
|
||||
if out.String() != "Group test_group is now shown.\n" {
|
||||
t.Fatalf("Expected output to be 'Group test_group is now shown.', got '%s'", out.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestGroupToggle(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmdStatus := &GroupStatusCmd{
|
||||
SceneName: "Scene",
|
||||
GroupName: "test_group",
|
||||
}
|
||||
err := cmdStatus.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get group status: %v", err)
|
||||
}
|
||||
var enabled bool
|
||||
if strings.Contains(out.String(), "Group test_group is shown.") {
|
||||
enabled = true
|
||||
}
|
||||
// Reset output buffer for the next command
|
||||
out.Reset()
|
||||
|
||||
cmdToggle := &GroupToggleCmd{
|
||||
SceneName: "Scene",
|
||||
GroupName: "test_group",
|
||||
}
|
||||
err = cmdToggle.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to toggle group: %v", err)
|
||||
}
|
||||
if enabled {
|
||||
if out.String() != "Group test_group is now hidden.\n" {
|
||||
t.Fatalf("Expected output to be 'Group test_group is now hidden.', got '%s'", out.String())
|
||||
}
|
||||
} else {
|
||||
if out.String() != "Group test_group is now shown.\n" {
|
||||
t.Fatalf("Expected output to be 'Group test_group is now shown.', got '%s'", out.String())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestGroupStatus(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmdShow := &GroupShowCmd{
|
||||
SceneName: "Scene",
|
||||
GroupName: "test_group",
|
||||
}
|
||||
err := cmdShow.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to show group: %v", err)
|
||||
}
|
||||
// Reset output buffer for the next command
|
||||
out.Reset()
|
||||
|
||||
cmdStatus := &GroupStatusCmd{
|
||||
SceneName: "Scene",
|
||||
GroupName: "test_group",
|
||||
}
|
||||
err = cmdStatus.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get group status: %v", err)
|
||||
}
|
||||
if out.String() != "Group test_group is shown.\n" {
|
||||
t.Fatalf("Expected output to be 'Group test_group is shown.', got '%s'", out.String())
|
||||
}
|
||||
}
|
79
hotkey.go
79
hotkey.go
@ -1,79 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"github.com/andreykaipov/goobs/api/requests/general"
|
||||
"github.com/andreykaipov/goobs/api/typedefs"
|
||||
"github.com/aquasecurity/table"
|
||||
)
|
||||
|
||||
// HotkeyCmd provides commands to manage hotkeys in OBS Studio.
|
||||
type HotkeyCmd struct {
|
||||
List HotkeyListCmd `cmd:"" help:"List all hotkeys." aliases:"ls"`
|
||||
Trigger HotkeyTriggerCmd `cmd:"" help:"Trigger a hotkey by name." aliases:"tr"`
|
||||
TriggerSequence HotkeyTriggerSequenceCmd `cmd:"" help:"Trigger a hotkey by sequence." aliases:"trs"`
|
||||
}
|
||||
|
||||
// HotkeyListCmd provides a command to list all hotkeys.
|
||||
type HotkeyListCmd struct{} // size = 0x0
|
||||
|
||||
// Run executes the command to list all hotkeys.
|
||||
func (cmd *HotkeyListCmd) Run(ctx *context) error {
|
||||
resp, err := ctx.Client.General.GetHotkeyList()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
t := table.New(ctx.Out)
|
||||
t.SetPadding(3)
|
||||
t.SetAlignment(table.AlignLeft)
|
||||
t.SetHeaders("Hotkey Name")
|
||||
|
||||
for _, hotkey := range resp.Hotkeys {
|
||||
t.AddRow(hotkey)
|
||||
}
|
||||
t.Render()
|
||||
return nil
|
||||
}
|
||||
|
||||
// HotkeyTriggerCmd provides a command to trigger a hotkey.
|
||||
type HotkeyTriggerCmd struct {
|
||||
Hotkey string `help:"Hotkey name to trigger." arg:""`
|
||||
}
|
||||
|
||||
// Run executes the command to trigger a hotkey.
|
||||
func (cmd *HotkeyTriggerCmd) Run(ctx *context) error {
|
||||
_, err := ctx.Client.General.TriggerHotkeyByName(
|
||||
general.NewTriggerHotkeyByNameParams().WithHotkeyName(cmd.Hotkey),
|
||||
)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// HotkeyTriggerSequenceCmd provides a command to trigger a hotkey sequence.
|
||||
type HotkeyTriggerSequenceCmd struct {
|
||||
Shift bool `flag:"" help:"Shift modifier."`
|
||||
Ctrl bool `flag:"" help:"Control modifier."`
|
||||
Alt bool `flag:"" help:"Alt modifier."`
|
||||
Cmd bool `flag:"" help:"Command modifier."`
|
||||
KeyID string ` help:"Key ID to trigger." arg:""`
|
||||
}
|
||||
|
||||
// Run executes the command to trigger a hotkey sequence.
|
||||
func (cmd *HotkeyTriggerSequenceCmd) Run(ctx *context) error {
|
||||
_, err := ctx.Client.General.TriggerHotkeyByKeySequence(
|
||||
general.NewTriggerHotkeyByKeySequenceParams().
|
||||
WithKeyId(cmd.KeyID).
|
||||
WithKeyModifiers(&typedefs.KeyModifiers{
|
||||
Shift: cmd.Shift,
|
||||
Control: cmd.Ctrl,
|
||||
Alt: cmd.Alt,
|
||||
Command: cmd.Cmd,
|
||||
}),
|
||||
)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
55
input.go
55
input.go
@ -5,7 +5,6 @@ import (
|
||||
"strings"
|
||||
|
||||
"github.com/andreykaipov/goobs/api/requests/inputs"
|
||||
"github.com/aquasecurity/table"
|
||||
)
|
||||
|
||||
// InputCmd provides commands to manage inputs in OBS Studio.
|
||||
@ -21,8 +20,6 @@ type InputListCmd struct {
|
||||
Input bool `flag:"" help:"List all inputs." aliases:"i"`
|
||||
Output bool `flag:"" help:"List all outputs." aliases:"o"`
|
||||
Colour bool `flag:"" help:"List all colour sources." aliases:"c"`
|
||||
Ffmpeg bool `flag:"" help:"List all ffmpeg sources." aliases:"f"`
|
||||
Vlc bool `flag:"" help:"List all VLC sources." aliases:"v"`
|
||||
}
|
||||
|
||||
// Run executes the command to list all inputs.
|
||||
@ -31,53 +28,21 @@ func (cmd *InputListCmd) Run(ctx *context) error {
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
t := table.New(ctx.Out)
|
||||
t.SetPadding(3)
|
||||
t.SetAlignment(table.AlignLeft, table.AlignLeft, table.AlignCenter)
|
||||
t.SetHeaders("Input Name", "Kind", "Muted")
|
||||
|
||||
for _, input := range resp.Inputs {
|
||||
var muteMark string
|
||||
for _, kind := range []string{"input", "output", "ffmpeg", "vlc"} {
|
||||
if strings.Contains(input.InputKind, kind) {
|
||||
resp, err := ctx.Client.Inputs.GetInputMute(
|
||||
inputs.NewGetInputMuteParams().WithInputName(input.InputName),
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get input mute state: %w", err)
|
||||
}
|
||||
muteMark = getEnabledMark(resp.InputMuted)
|
||||
break
|
||||
}
|
||||
if cmd.Input && strings.Contains(input.InputKind, "input") {
|
||||
fmt.Fprintln(ctx.Out, "Input:", input.InputName)
|
||||
}
|
||||
if cmd.Output && strings.Contains(input.InputKind, "output") {
|
||||
fmt.Fprintln(ctx.Out, "Output:", input.InputName)
|
||||
}
|
||||
if cmd.Colour && strings.Contains(input.InputKind, "color") { // nolint
|
||||
fmt.Fprintln(ctx.Out, "Colour Source:", input.InputName)
|
||||
}
|
||||
|
||||
type filter struct {
|
||||
enabled bool
|
||||
keyword string
|
||||
}
|
||||
filters := []filter{
|
||||
{cmd.Input, "input"},
|
||||
{cmd.Output, "output"},
|
||||
{cmd.Colour, "color"}, // nolint: misspell
|
||||
{cmd.Ffmpeg, "ffmpeg"},
|
||||
{cmd.Vlc, "vlc"},
|
||||
}
|
||||
|
||||
var added bool
|
||||
for _, f := range filters {
|
||||
if f.enabled && strings.Contains(input.InputKind, f.keyword) {
|
||||
t.AddRow(input.InputName, input.InputKind, muteMark)
|
||||
added = true
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if !added && (!cmd.Input && !cmd.Output && !cmd.Colour && !cmd.Ffmpeg && !cmd.Vlc) {
|
||||
t.AddRow(input.InputName, input.InputKind, muteMark)
|
||||
if !cmd.Input && !cmd.Output && !cmd.Colour {
|
||||
fmt.Fprintln(ctx.Out, "Source:", input.InputName)
|
||||
}
|
||||
}
|
||||
t.Render()
|
||||
return nil
|
||||
}
|
||||
|
||||
|
140
input_test.go
140
input_test.go
@ -1,140 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestInputList(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmd := &InputListCmd{}
|
||||
err := cmd.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to list inputs: %v", err)
|
||||
}
|
||||
|
||||
expectedInputs := []string{
|
||||
"Desktop Audio",
|
||||
"Mic/Aux",
|
||||
"Colour Source",
|
||||
"Colour Source 2",
|
||||
"Colour Source 3",
|
||||
}
|
||||
output := out.String()
|
||||
for _, input := range expectedInputs {
|
||||
if !strings.Contains(output, input) {
|
||||
t.Fatalf("Expected output to contain '%s', got '%s'", input, output)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestInputListFilterInput(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmd := &InputListCmd{Input: true}
|
||||
err := cmd.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to list inputs with filter: %v", err)
|
||||
}
|
||||
|
||||
expectedInputs := []string{
|
||||
"Mic/Aux",
|
||||
}
|
||||
expectedFilteredOut := []string{
|
||||
"Desktop Audio",
|
||||
"Colour Source",
|
||||
"Colour Source 2",
|
||||
"Colour Source 3",
|
||||
}
|
||||
for _, input := range expectedInputs {
|
||||
if !strings.Contains(out.String(), input) {
|
||||
t.Fatalf("Expected output to contain '%s', got '%s'", input, out.String())
|
||||
}
|
||||
}
|
||||
for _, filteredOut := range expectedFilteredOut {
|
||||
if strings.Contains(out.String(), filteredOut) {
|
||||
t.Fatalf("Expected output to NOT contain '%s', got '%s'", filteredOut, out.String())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestInputListFilterOutput(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmd := &InputListCmd{Output: true}
|
||||
err := cmd.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to list outputs with filter: %v", err)
|
||||
}
|
||||
|
||||
expectedInputs := []string{
|
||||
"Desktop Audio",
|
||||
}
|
||||
expectedFilteredOut := []string{
|
||||
"Mic/Aux",
|
||||
"Colour Source",
|
||||
"Colour Source 2",
|
||||
"Colour Source 3",
|
||||
}
|
||||
for _, input := range expectedInputs {
|
||||
if !strings.Contains(out.String(), input) {
|
||||
t.Fatalf("Expected output to contain '%s', got '%s'", input, out.String())
|
||||
}
|
||||
}
|
||||
for _, filteredOut := range expectedFilteredOut {
|
||||
if strings.Contains(out.String(), filteredOut) {
|
||||
t.Fatalf("Expected output to NOT contain '%s', got '%s'", filteredOut, out.String())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestInputListFilterColour(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmd := &InputListCmd{Colour: true}
|
||||
err := cmd.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to list colour inputs with filter: %v", err)
|
||||
}
|
||||
|
||||
expectedInputs := []string{
|
||||
"Colour Source",
|
||||
"Colour Source 2",
|
||||
"Colour Source 3",
|
||||
}
|
||||
for _, input := range expectedInputs {
|
||||
if !strings.Contains(out.String(), input) {
|
||||
t.Fatalf("Expected output to contain '%s', got '%s'", input, out.String())
|
||||
}
|
||||
}
|
||||
}
|
45
main.go
45
main.go
@ -18,36 +18,31 @@ import (
|
||||
|
||||
// ObsConfig holds the configuration for connecting to the OBS WebSocket server.
|
||||
type ObsConfig struct {
|
||||
Host string `flag:"host" help:"Host to connect to." default:"localhost" env:"OBS_HOST" short:"H"`
|
||||
Port int `flag:"port" help:"Port to connect to." default:"4455" env:"OBS_PORT" short:"P"`
|
||||
Password string `flag:"password" help:"Password for authentication." default:"" env:"OBS_PASSWORD" short:"p"`
|
||||
Timeout int `flag:"timeout" help:"Timeout in seconds." default:"5" env:"OBS_TIMEOUT" short:"T"`
|
||||
Host string `flag:"host" help:"Host to connect to." default:"localhost" env:"OBS_HOST"`
|
||||
Port int `flag:"port" help:"Port to connect to." default:"4455" env:"OBS_PORT"`
|
||||
Password string `flag:"password" help:"Password for authentication." default:"" env:"OBS_PASSWORD"`
|
||||
Timeout int `flag:"timeout" help:"Timeout in seconds." default:"5" env:"OBS_TIMEOUT"`
|
||||
}
|
||||
|
||||
// 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.
|
||||
type CLI struct {
|
||||
type cli struct {
|
||||
ObsConfig `embed:"" help:"OBS WebSocket configuration."`
|
||||
|
||||
Man mangokong.ManFlag `help:"Print man page."`
|
||||
Version VersionFlag `help:"Print gobs-cli version information and quit" name:"version" short:"v"`
|
||||
Man mangokong.ManFlag `help:"Print man page."`
|
||||
|
||||
ObsVersion ObsVersionCmd `help:"Print OBS client and websocket version." cmd:"" aliases:"v"`
|
||||
Scene SceneCmd `help:"Manage scenes." cmd:"" aliases:"sc"`
|
||||
Sceneitem SceneItemCmd `help:"Manage scene items." cmd:"" aliases:"si"`
|
||||
Group GroupCmd `help:"Manage groups." cmd:"" aliases:"g"`
|
||||
Input InputCmd `help:"Manage inputs." cmd:"" aliases:"i"`
|
||||
Record RecordCmd `help:"Manage recording." cmd:"" aliases:"rec"`
|
||||
Stream StreamCmd `help:"Manage streaming." cmd:"" aliases:"st"`
|
||||
Scenecollection SceneCollectionCmd `help:"Manage scene collections." cmd:"" aliases:"scn"`
|
||||
Profile ProfileCmd `help:"Manage profiles." cmd:"" aliases:"p"`
|
||||
Replaybuffer ReplayBufferCmd `help:"Manage replay buffer." cmd:"" aliases:"rb"`
|
||||
Studiomode StudioModeCmd `help:"Manage studio mode." cmd:"" aliases:"sm"`
|
||||
Virtualcam VirtualCamCmd `help:"Manage virtual camera." cmd:"" aliases:"vc"`
|
||||
Hotkey HotkeyCmd `help:"Manage hotkeys." cmd:"" aliases:"hk"`
|
||||
Filter FilterCmd `help:"Manage filters." cmd:"" aliases:"f"`
|
||||
Projector ProjectorCmd `help:"Manage projectors." cmd:"" aliases:"prj"`
|
||||
Screenshot ScreenshotCmd `help:"Take screenshots." cmd:"" aliases:"ss"`
|
||||
Version VersionCmd `help:"Show version." cmd:"" aliases:"v"`
|
||||
Scene SceneCmd `help:"Manage scenes." cmd:"" aliases:"sc"`
|
||||
Sceneitem SceneItemCmd `help:"Manage scene items." cmd:"" aliases:"si"`
|
||||
Group GroupCmd `help:"Manage groups." cmd:"" aliases:"g"`
|
||||
Input InputCmd `help:"Manage inputs." cmd:"" aliases:"i"`
|
||||
Record RecordCmd `help:"Manage recording." cmd:"" aliases:"rec"`
|
||||
Stream StreamCmd `help:"Manage streaming." cmd:"" aliases:"st"`
|
||||
Scenecollection SceneCollectionCmd `help:"Manage scene collections." cmd:"" aliases:"scn"`
|
||||
Profile ProfileCmd `help:"Manage profiles." cmd:"" aliases:"p"`
|
||||
Replaybuffer ReplayBufferCmd `help:"Manage replay buffer." cmd:"" aliases:"rb"`
|
||||
Studiomode StudioModeCmd `help:"Manage studio mode." cmd:"" aliases:"sm"`
|
||||
Virtualcam VirtualCamCmd `help:"Manage virtual camera." cmd:"" aliases:"vc"`
|
||||
}
|
||||
|
||||
type context struct {
|
||||
@ -62,7 +57,7 @@ func main() {
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
var cli CLI
|
||||
var cli cli
|
||||
ctx := kong.Parse(
|
||||
&cli,
|
||||
kong.Name("GOBS-CLI"),
|
||||
|
136
main_test.go
136
main_test.go
@ -1,136 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"github.com/andreykaipov/goobs"
|
||||
"github.com/andreykaipov/goobs/api/requests/config"
|
||||
"github.com/andreykaipov/goobs/api/requests/filters"
|
||||
"github.com/andreykaipov/goobs/api/requests/inputs"
|
||||
"github.com/andreykaipov/goobs/api/requests/scenes"
|
||||
"github.com/andreykaipov/goobs/api/requests/ui"
|
||||
typedefs "github.com/andreykaipov/goobs/api/typedefs"
|
||||
)
|
||||
|
||||
func getClient(t *testing.T) (*goobs.Client, func()) {
|
||||
t.Helper()
|
||||
client, err := connectObs(ObsConfig{
|
||||
Host: os.Getenv("OBS_HOST"),
|
||||
Port: 4455,
|
||||
Password: os.Getenv("OBS_PASSWORD"),
|
||||
Timeout: 5,
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to connect to OBS: %v", err)
|
||||
}
|
||||
return client, func() {
|
||||
if err := client.Disconnect(); err != nil {
|
||||
t.Fatalf("Failed to disconnect from OBS: %v", err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestMain(m *testing.M) {
|
||||
client, err := connectObs(ObsConfig{
|
||||
Host: os.Getenv("OBS_HOST"),
|
||||
Port: 4455,
|
||||
Password: os.Getenv("OBS_PASSWORD"),
|
||||
Timeout: 5,
|
||||
})
|
||||
if err != nil {
|
||||
os.Exit(1)
|
||||
}
|
||||
defer client.Disconnect()
|
||||
|
||||
setup(client)
|
||||
|
||||
// Run the tests
|
||||
exitCode := m.Run()
|
||||
|
||||
teardown(client)
|
||||
|
||||
// Exit with the appropriate code
|
||||
os.Exit(exitCode)
|
||||
}
|
||||
|
||||
func setup(client *goobs.Client) {
|
||||
client.Config.SetStreamServiceSettings(config.NewSetStreamServiceSettingsParams().
|
||||
WithStreamServiceType("rtmp_common").
|
||||
WithStreamServiceSettings(&typedefs.StreamServiceSettings{
|
||||
Server: "auto",
|
||||
Key: os.Getenv("OBS_STREAM_KEY"),
|
||||
}))
|
||||
|
||||
client.Config.SetCurrentSceneCollection(config.NewSetCurrentSceneCollectionParams().
|
||||
WithSceneCollectionName("test-collection"))
|
||||
|
||||
client.Scenes.CreateScene(scenes.NewCreateSceneParams().
|
||||
WithSceneName("gobs-test"))
|
||||
client.Inputs.CreateInput(inputs.NewCreateInputParams().
|
||||
WithSceneName("gobs-test").
|
||||
WithInputName("gobs-test-input").
|
||||
WithInputKind("color_source_v3").
|
||||
WithInputSettings(map[string]any{
|
||||
"color": 3279460728,
|
||||
"width": 1920,
|
||||
"height": 1080,
|
||||
"visible": true,
|
||||
}).
|
||||
WithSceneItemEnabled(true))
|
||||
client.Inputs.CreateInput(inputs.NewCreateInputParams().
|
||||
WithSceneName("gobs-test").
|
||||
WithInputName("gobs-test-input-2").
|
||||
WithInputKind("color_source_v3").
|
||||
WithInputSettings(map[string]any{
|
||||
"color": 1789347616,
|
||||
"width": 720,
|
||||
"height": 480,
|
||||
"visible": true,
|
||||
}).
|
||||
WithSceneItemEnabled(true))
|
||||
|
||||
// Create source filter on an audio input
|
||||
client.Filters.CreateSourceFilter(filters.NewCreateSourceFilterParams().
|
||||
WithSourceName("Mic/Aux").
|
||||
WithFilterName("test_filter").
|
||||
WithFilterKind("compressor_filter").
|
||||
WithFilterSettings(map[string]any{
|
||||
"threshold": -20,
|
||||
"ratio": 4,
|
||||
"attack_time": 10,
|
||||
"release_time": 100,
|
||||
"output_gain": -3.6,
|
||||
"sidechain_source": nil,
|
||||
}))
|
||||
|
||||
// Create source filter on a scene
|
||||
client.Filters.CreateSourceFilter(filters.NewCreateSourceFilterParams().
|
||||
WithSourceName("gobs-test").
|
||||
WithFilterName("test_filter").
|
||||
WithFilterKind("luma_key_filter_v2").
|
||||
WithFilterSettings(map[string]any{
|
||||
"luma": 0.5,
|
||||
}))
|
||||
}
|
||||
|
||||
func teardown(client *goobs.Client) {
|
||||
client.Filters.RemoveSourceFilter(filters.NewRemoveSourceFilterParams().
|
||||
WithSourceName("Mic/Aux").
|
||||
WithFilterName("test_filter"))
|
||||
client.Filters.RemoveSourceFilter(filters.NewRemoveSourceFilterParams().
|
||||
WithSourceName("gobs-test").
|
||||
WithFilterName("test_filter"))
|
||||
|
||||
client.Scenes.RemoveScene(scenes.NewRemoveSceneParams().
|
||||
WithSceneName("gobs-test"))
|
||||
|
||||
client.Config.SetCurrentSceneCollection(config.NewSetCurrentSceneCollectionParams().
|
||||
WithSceneCollectionName("default"))
|
||||
|
||||
client.Stream.StopStream()
|
||||
client.Record.StopRecord()
|
||||
client.Outputs.StopReplayBuffer()
|
||||
client.Ui.SetStudioModeEnabled(ui.NewSetStudioModeEnabledParams().
|
||||
WithStudioModeEnabled(false))
|
||||
}
|
15
profile.go
15
profile.go
@ -5,7 +5,6 @@ import (
|
||||
"slices"
|
||||
|
||||
"github.com/andreykaipov/goobs/api/requests/config"
|
||||
"github.com/aquasecurity/table"
|
||||
)
|
||||
|
||||
// ProfileCmd provides commands to manage profiles in OBS Studio.
|
||||
@ -27,20 +26,10 @@ func (cmd *ProfileListCmd) Run(ctx *context) error {
|
||||
return err
|
||||
}
|
||||
|
||||
t := table.New(ctx.Out)
|
||||
t.SetPadding(3)
|
||||
t.SetAlignment(table.AlignLeft, table.AlignCenter)
|
||||
t.SetHeaders("Profile Name", "Current")
|
||||
|
||||
for _, profile := range profiles.Profiles {
|
||||
var enabledMark string
|
||||
if profile == profiles.CurrentProfileName {
|
||||
enabledMark = getEnabledMark(true)
|
||||
}
|
||||
|
||||
t.AddRow(profile, enabledMark)
|
||||
fmt.Fprintln(ctx.Out, profile)
|
||||
}
|
||||
t.Render()
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
|
66
projector.go
66
projector.go
@ -1,66 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/andreykaipov/goobs/api/requests/ui"
|
||||
"github.com/aquasecurity/table"
|
||||
)
|
||||
|
||||
// ProjectorCmd provides a command to manage projectors in OBS.
|
||||
type ProjectorCmd struct {
|
||||
ListMonitors ProjectorListMonitorsCmd `cmd:"" help:"List available monitors." aliases:"ls-m"`
|
||||
Open ProjectorOpenCmd `cmd:"" help:"Open a fullscreen projector for a source on a specific monitor." aliases:"o"`
|
||||
}
|
||||
|
||||
// ProjectorListMonitorsCmd provides a command to list all monitors available for projectors.
|
||||
type ProjectorListMonitorsCmd struct{} // size = 0x0
|
||||
|
||||
// Run executes the command to list all monitors available for projectors.
|
||||
func (cmd *ProjectorListMonitorsCmd) Run(ctx *context) error {
|
||||
monitors, err := ctx.Client.Ui.GetMonitorList()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if len(monitors.Monitors) == 0 {
|
||||
ctx.Out.Write([]byte("No monitors found for projectors.\n"))
|
||||
return nil
|
||||
}
|
||||
|
||||
t := table.New(ctx.Out)
|
||||
t.SetPadding(3)
|
||||
t.SetAlignment(table.AlignCenter, table.AlignLeft)
|
||||
t.SetHeaders("Monitor ID", "Monitor Name")
|
||||
|
||||
for _, monitor := range monitors.Monitors {
|
||||
t.AddRow(fmt.Sprintf("%d", monitor.MonitorIndex), monitor.MonitorName)
|
||||
}
|
||||
|
||||
t.Render()
|
||||
return nil
|
||||
}
|
||||
|
||||
// ProjectorOpenCmd provides a command to open a fullscreen projector for a specific source.
|
||||
type ProjectorOpenCmd struct {
|
||||
MonitorIndex int `flag:"" help:"Index of the monitor to open the projector on." default:"0"`
|
||||
SourceName string ` help:"Name of the source to project." default:"" arg:""`
|
||||
}
|
||||
|
||||
// Run executes the command to show details of a specific projector.
|
||||
func (cmd *ProjectorOpenCmd) Run(ctx *context) error {
|
||||
if cmd.SourceName == "" {
|
||||
currentScene, err := ctx.Client.Scenes.GetCurrentProgramScene()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get current program scene: %w", err)
|
||||
}
|
||||
cmd.SourceName = currentScene.SceneName
|
||||
}
|
||||
|
||||
ctx.Client.Ui.OpenSourceProjector(ui.NewOpenSourceProjectorParams().
|
||||
WithSourceName(cmd.SourceName).
|
||||
WithMonitorIndex(cmd.MonitorIndex))
|
||||
|
||||
fmt.Fprintf(ctx.Out, "Opened projector for source '%s' on monitor index %d.\n", cmd.SourceName, cmd.MonitorIndex)
|
||||
return nil
|
||||
}
|
91
record.go
91
record.go
@ -2,19 +2,15 @@ package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/andreykaipov/goobs/api/requests/config"
|
||||
)
|
||||
|
||||
// RecordCmd handles the recording commands.
|
||||
type RecordCmd struct {
|
||||
Start RecordStartCmd `cmd:"" help:"Start recording." aliases:"s"`
|
||||
Stop RecordStopCmd `cmd:"" help:"Stop recording." aliases:"st"`
|
||||
Toggle RecordToggleCmd `cmd:"" help:"Toggle recording." aliases:"tg"`
|
||||
Status RecordStatusCmd `cmd:"" help:"Show recording status." aliases:"ss"`
|
||||
Pause RecordPauseCmd `cmd:"" help:"Pause recording." aliases:"p"`
|
||||
Resume RecordResumeCmd `cmd:"" help:"Resume recording." aliases:"r"`
|
||||
Directory RecordDirectoryCmd `cmd:"" help:"Get/Set recording directory." aliases:"d"`
|
||||
Start RecordStartCmd `cmd:"" help:"Start recording." aliases:"s"`
|
||||
Stop RecordStopCmd `cmd:"" help:"Stop recording." aliases:"st"`
|
||||
Toggle RecordToggleCmd `cmd:"" help:"Toggle recording." aliases:"tg"`
|
||||
Pause RecordPauseCmd `cmd:"" help:"Pause recording." aliases:"p"`
|
||||
Resume RecordResumeCmd `cmd:"" help:"Resume recording." aliases:"r"`
|
||||
}
|
||||
|
||||
// RecordStartCmd starts the recording.
|
||||
@ -22,19 +18,7 @@ type RecordStartCmd struct{} // size = 0x0
|
||||
|
||||
// Run executes the command to start recording.
|
||||
func (cmd *RecordStartCmd) Run(ctx *context) error {
|
||||
status, err := ctx.Client.Record.GetRecordStatus()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if status.OutputActive {
|
||||
if status.OutputPaused {
|
||||
return fmt.Errorf("recording is already in progress and paused")
|
||||
}
|
||||
return fmt.Errorf("recording is already in progress")
|
||||
}
|
||||
|
||||
_, err = ctx.Client.Record.StartRecord()
|
||||
_, err := ctx.Client.Record.StartRecord()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@ -47,20 +31,11 @@ type RecordStopCmd struct{} // size = 0x0
|
||||
|
||||
// Run executes the command to stop recording.
|
||||
func (cmd *RecordStopCmd) Run(ctx *context) error {
|
||||
status, err := ctx.Client.Record.GetRecordStatus()
|
||||
_, err := ctx.Client.Record.StopRecord()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if !status.OutputActive {
|
||||
return fmt.Errorf("recording is not in progress")
|
||||
}
|
||||
|
||||
resp, err := ctx.Client.Record.StopRecord()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
fmt.Fprintf(ctx.Out, "%s", fmt.Sprintf("Recording stopped successfully. Output file: %s\n", resp.OutputPath))
|
||||
fmt.Fprintln(ctx.Out, "Recording stopped successfully.")
|
||||
return nil
|
||||
}
|
||||
|
||||
@ -82,29 +57,6 @@ func (cmd *RecordToggleCmd) Run(ctx *context) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// RecordStatusCmd shows the recording status.
|
||||
type RecordStatusCmd struct{} // size = 0x0
|
||||
|
||||
// Run executes the command to show recording status.
|
||||
func (cmd *RecordStatusCmd) Run(ctx *context) error {
|
||||
status, err := ctx.Client.Record.GetRecordStatus()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if status.OutputActive {
|
||||
if status.OutputPaused {
|
||||
fmt.Fprintln(ctx.Out, "Recording is paused.")
|
||||
} else {
|
||||
fmt.Fprintln(ctx.Out, "Recording is in progress.")
|
||||
}
|
||||
} else {
|
||||
fmt.Fprintln(ctx.Out, "Recording is not in progress.")
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// RecordPauseCmd pauses the recording.
|
||||
type RecordPauseCmd struct{} // size = 0x0
|
||||
|
||||
@ -156,30 +108,3 @@ func (cmd *RecordResumeCmd) Run(ctx *context) error {
|
||||
fmt.Fprintln(ctx.Out, "Recording resumed successfully.")
|
||||
return nil
|
||||
}
|
||||
|
||||
// RecordDirectoryCmd sets the recording directory.
|
||||
type RecordDirectoryCmd struct {
|
||||
RecordDirectory string `arg:"" help:"Directory to save recordings." default:""`
|
||||
}
|
||||
|
||||
// Run executes the command to set the recording directory.
|
||||
func (cmd *RecordDirectoryCmd) Run(ctx *context) error {
|
||||
if cmd.RecordDirectory == "" {
|
||||
resp, err := ctx.Client.Config.GetRecordDirectory()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
fmt.Fprintf(ctx.Out, "Current recording directory: %s\n", resp.RecordDirectory)
|
||||
return nil
|
||||
}
|
||||
|
||||
_, err := ctx.Client.Config.SetRecordDirectory(
|
||||
config.NewSetRecordDirectoryParams().WithRecordDirectory(cmd.RecordDirectory),
|
||||
)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
fmt.Fprintf(ctx.Out, "Recording directory set to: %s\n", cmd.RecordDirectory)
|
||||
return nil
|
||||
}
|
||||
|
135
record_test.go
135
record_test.go
@ -1,135 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
func TestRecordStart(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmdStatus := &RecordStatusCmd{}
|
||||
err := cmdStatus.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get recording status: %v", err)
|
||||
}
|
||||
var active bool
|
||||
if out.String() == "Recording is in progress.\n" {
|
||||
active = true
|
||||
}
|
||||
// Reset output buffer for the next command
|
||||
out.Reset()
|
||||
|
||||
cmdStart := &RecordStartCmd{}
|
||||
err = cmdStart.Run(context)
|
||||
if active {
|
||||
if err == nil {
|
||||
t.Fatalf("Expected error when starting recording while active, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "recording is already in progress") {
|
||||
t.Fatalf("Expected error message to contain 'recording is already in progress', got '%s'", err.Error())
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to start recording: %v", err)
|
||||
}
|
||||
if out.String() != "Recording started successfully.\n" {
|
||||
t.Fatalf("Expected output to contain 'Recording started successfully.', got '%s'", out.String())
|
||||
}
|
||||
time.Sleep(1 * time.Second) // Wait for the recording to start
|
||||
}
|
||||
|
||||
func TestRecordStop(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmdStatus := &RecordStatusCmd{}
|
||||
err := cmdStatus.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get recording status: %v", err)
|
||||
}
|
||||
var active bool
|
||||
if out.String() == "Recording is in progress.\n" {
|
||||
active = true
|
||||
}
|
||||
// Reset output buffer for the next command
|
||||
out.Reset()
|
||||
|
||||
cmdStop := &RecordStopCmd{}
|
||||
err = cmdStop.Run(context)
|
||||
if !active {
|
||||
if err == nil {
|
||||
t.Fatalf("Expected error when stopping recording while inactive, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "recording is not in progress") {
|
||||
t.Fatalf("Expected error message to contain 'recording is not in progress', got '%s'", err.Error())
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to stop recording: %v", err)
|
||||
}
|
||||
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())
|
||||
}
|
||||
time.Sleep(1 * time.Second) // Wait for the recording to stop
|
||||
}
|
||||
|
||||
func TestRecordToggle(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmdStatus := &RecordStatusCmd{}
|
||||
err := cmdStatus.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get recording status: %v", err)
|
||||
}
|
||||
var active bool
|
||||
if out.String() == "Recording is in progress.\n" {
|
||||
active = true
|
||||
}
|
||||
// Reset output buffer for the next command
|
||||
out.Reset()
|
||||
|
||||
cmdToggle := &RecordToggleCmd{}
|
||||
err = cmdToggle.Run(context)
|
||||
if err != nil {
|
||||
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 out.String() != "Recording stopped successfully.\n" {
|
||||
t.Fatalf("Expected output to be 'Recording stopped successfully.', got '%s'", out.String())
|
||||
}
|
||||
} else {
|
||||
if out.String() != "Recording started successfully.\n" {
|
||||
t.Fatalf("Expected output to be 'Recording started successfully.', got '%s'", out.String())
|
||||
}
|
||||
}
|
||||
}
|
@ -19,11 +19,7 @@ type ReplayBufferStartCmd struct{} // size = 0x0
|
||||
// Run executes the command to start the replay buffer.
|
||||
func (cmd *ReplayBufferStartCmd) Run(ctx *context) error {
|
||||
_, err := ctx.Client.Outputs.StartReplayBuffer()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to start replay buffer: %w", err)
|
||||
}
|
||||
fmt.Fprintln(ctx.Out, "Replay buffer started.")
|
||||
return nil
|
||||
return err
|
||||
}
|
||||
|
||||
// ReplayBufferStopCmd stops the replay buffer.
|
||||
@ -32,11 +28,7 @@ type ReplayBufferStopCmd struct{} // size = 0x0
|
||||
// Run executes the command to stop the replay buffer.
|
||||
func (cmd *ReplayBufferStopCmd) Run(ctx *context) error {
|
||||
_, err := ctx.Client.Outputs.StopReplayBuffer()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to stop replay buffer: %w", err)
|
||||
}
|
||||
fmt.Fprintln(ctx.Out, "Replay buffer stopped.")
|
||||
return nil
|
||||
return err
|
||||
}
|
||||
|
||||
// ReplayBufferToggleCmd toggles the replay buffer state.
|
||||
@ -50,9 +42,9 @@ func (cmd *ReplayBufferToggleCmd) Run(ctx *context) error {
|
||||
}
|
||||
|
||||
if status.OutputActive {
|
||||
fmt.Fprintln(ctx.Out, "Replay buffer started.")
|
||||
fmt.Fprintln(ctx.Out, "Replay buffer started successfully.")
|
||||
} else {
|
||||
fmt.Fprintln(ctx.Out, "Replay buffer stopped.")
|
||||
fmt.Fprintln(ctx.Out, "Replay buffer stopped successfully.")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
@ -1,85 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestReplayBufferStart(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmd := &ReplayBufferStartCmd{}
|
||||
err := cmd.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to start replay buffer: %v", err)
|
||||
}
|
||||
if out.String() != "Replay buffer started.\n" {
|
||||
t.Fatalf("Expected output to be 'Replay buffer started', got '%s'", out.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestReplayBufferStop(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmd := &ReplayBufferStopCmd{}
|
||||
err := cmd.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to stop replay buffer: %v", err)
|
||||
}
|
||||
if out.String() != "Replay buffer stopped.\n" {
|
||||
t.Fatalf("Expected output to be 'Replay buffer stopped.', got '%s'", out.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestReplayBufferToggle(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmdStatus := &ReplayBufferStatusCmd{}
|
||||
err := cmdStatus.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get replay buffer status: %v", err)
|
||||
}
|
||||
var active bool
|
||||
if strings.Contains(out.String(), "Replay buffer is active") {
|
||||
active = true
|
||||
}
|
||||
// Reset output buffer for the next command
|
||||
out.Reset()
|
||||
|
||||
cmdToggle := &ReplayBufferToggleCmd{}
|
||||
err = cmdToggle.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to toggle replay buffer: %v", err)
|
||||
}
|
||||
if active {
|
||||
if out.String() != "Replay buffer stopped.\n" {
|
||||
t.Fatalf("Expected output to be 'Replay buffer stopped.', got '%s'", out.String())
|
||||
}
|
||||
} else {
|
||||
if out.String() != "Replay buffer started.\n" {
|
||||
t.Fatalf("Expected output to be 'Replay buffer started.', got '%s'", out.String())
|
||||
}
|
||||
}
|
||||
}
|
9
scene.go
9
scene.go
@ -5,7 +5,6 @@ import (
|
||||
"slices"
|
||||
|
||||
"github.com/andreykaipov/goobs/api/requests/scenes"
|
||||
"github.com/aquasecurity/table"
|
||||
)
|
||||
|
||||
// SceneCmd provides commands to manage scenes in OBS Studio.
|
||||
@ -25,16 +24,10 @@ func (cmd *SceneListCmd) Run(ctx *context) error {
|
||||
return err
|
||||
}
|
||||
|
||||
t := table.New(ctx.Out)
|
||||
t.SetPadding(3)
|
||||
t.SetAlignment(table.AlignLeft, table.AlignLeft)
|
||||
t.SetHeaders("Scene Name", "UUID")
|
||||
|
||||
slices.Reverse(scenes.Scenes)
|
||||
for _, scene := range scenes.Scenes {
|
||||
t.AddRow(scene.SceneName, scene.SceneUuid)
|
||||
fmt.Fprintln(ctx.Out, scene.SceneName)
|
||||
}
|
||||
t.Render()
|
||||
return nil
|
||||
}
|
||||
|
||||
|
@ -1,58 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestSceneList(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmd := &SceneListCmd{}
|
||||
err := cmd.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to list scenes: %v", err)
|
||||
}
|
||||
if !strings.Contains(out.String(), "gobs-test") {
|
||||
t.Fatalf("Expected output to contain 'gobs-test', got '%s'", out.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestSceneCurrent(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
// Set the current scene to "gobs-test"
|
||||
cmdSwitch := &SceneSwitchCmd{
|
||||
NewScene: "gobs-test",
|
||||
}
|
||||
err := cmdSwitch.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to switch to scene: %v", err)
|
||||
}
|
||||
// Reset output buffer for the next command
|
||||
out.Reset()
|
||||
|
||||
cmdCurrent := &SceneCurrentCmd{}
|
||||
err = cmdCurrent.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get current scene: %v", err)
|
||||
}
|
||||
if out.String() != "gobs-test\n" {
|
||||
t.Fatalf("Expected output to contain 'gobs-test', got '%s'", out.String())
|
||||
}
|
||||
}
|
@ -4,7 +4,6 @@ import (
|
||||
"fmt"
|
||||
|
||||
"github.com/andreykaipov/goobs/api/requests/config"
|
||||
"github.com/aquasecurity/table"
|
||||
)
|
||||
|
||||
// SceneCollectionCmd provides commands to manage scene collections in OBS Studio.
|
||||
@ -25,15 +24,10 @@ func (cmd *SceneCollectionListCmd) Run(ctx *context) error {
|
||||
return fmt.Errorf("failed to get scene collection list: %w", err)
|
||||
}
|
||||
|
||||
t := table.New(ctx.Out)
|
||||
t.SetPadding(3)
|
||||
t.SetAlignment(table.AlignLeft)
|
||||
t.SetHeaders("Scene Collection Name")
|
||||
|
||||
for _, collection := range collections.SceneCollections {
|
||||
t.AddRow(collection)
|
||||
fmt.Fprintln(ctx.Out, collection)
|
||||
}
|
||||
t.Render()
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
|
92
sceneitem.go
92
sceneitem.go
@ -2,11 +2,9 @@ package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"sort"
|
||||
|
||||
"github.com/andreykaipov/goobs"
|
||||
"github.com/andreykaipov/goobs/api/requests/sceneitems"
|
||||
"github.com/aquasecurity/table"
|
||||
)
|
||||
|
||||
// SceneItemCmd provides commands to manage scene items in OBS Studio.
|
||||
@ -21,83 +19,37 @@ type SceneItemCmd struct {
|
||||
|
||||
// SceneItemListCmd provides a command to list all scene items in a scene.
|
||||
type SceneItemListCmd struct {
|
||||
SceneName string `arg:"" help:"Name of the scene to list items from." default:""`
|
||||
SceneName string `arg:"" help:"Scene name."`
|
||||
}
|
||||
|
||||
// Run executes the command to list all scene items in a scene.
|
||||
func (cmd *SceneItemListCmd) Run(ctx *context) error {
|
||||
if cmd.SceneName == "" {
|
||||
currentScene, err := ctx.Client.Scenes.GetCurrentProgramScene()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get current program scene: %w", err)
|
||||
}
|
||||
cmd.SceneName = currentScene.SceneName
|
||||
}
|
||||
|
||||
resp, err := ctx.Client.SceneItems.GetSceneItemList(sceneitems.NewGetSceneItemListParams().
|
||||
WithSceneName(cmd.SceneName))
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get scene item list: %w", err)
|
||||
}
|
||||
|
||||
if len(resp.SceneItems) == 0 {
|
||||
fmt.Fprintf(ctx.Out, "No scene items found in scene '%s'.\n", cmd.SceneName)
|
||||
return nil
|
||||
}
|
||||
|
||||
t := table.New(ctx.Out)
|
||||
t.SetPadding(3)
|
||||
t.SetAlignment(table.AlignCenter, table.AlignLeft, table.AlignCenter, table.AlignCenter)
|
||||
t.SetHeaders("Item ID", "Item Name", "In Group", "Enabled")
|
||||
|
||||
sort.Slice(resp.SceneItems, func(i, j int) bool {
|
||||
return resp.SceneItems[i].SceneItemID < resp.SceneItems[j].SceneItemID
|
||||
})
|
||||
|
||||
for _, item := range resp.SceneItems {
|
||||
if item.IsGroup {
|
||||
resp, err := ctx.Client.SceneItems.GetGroupSceneItemList(sceneitems.NewGetGroupSceneItemListParams().
|
||||
WithSceneName(item.SourceName))
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get group scene item list for '%s': %w", item.SourceName, err)
|
||||
}
|
||||
|
||||
sort.Slice(resp.SceneItems, func(i, j int) bool {
|
||||
return resp.SceneItems[i].SceneItemID < resp.SceneItems[j].SceneItemID
|
||||
})
|
||||
|
||||
for _, groupItem := range resp.SceneItems {
|
||||
t.AddRow(
|
||||
fmt.Sprintf("%d", groupItem.SceneItemID),
|
||||
groupItem.SourceName,
|
||||
item.SourceName,
|
||||
getEnabledMark(item.SceneItemEnabled && groupItem.SceneItemEnabled),
|
||||
)
|
||||
}
|
||||
} else {
|
||||
t.AddRow(fmt.Sprintf("%d", item.SceneItemID), item.SourceName, "", getEnabledMark(item.SceneItemEnabled))
|
||||
}
|
||||
fmt.Fprintf(ctx.Out, "Item ID: %d, Source Name: %s\n", item.SceneItemID, item.SourceName)
|
||||
}
|
||||
t.Render()
|
||||
return nil
|
||||
}
|
||||
|
||||
// getSceneNameAndItemID retrieves the scene name and item ID for a given item in a scene or group.
|
||||
func getSceneNameAndItemID(
|
||||
client *goobs.Client,
|
||||
sceneName string,
|
||||
itemName string,
|
||||
group string,
|
||||
parent string,
|
||||
) (string, int, error) {
|
||||
if group != "" {
|
||||
if parent != "" {
|
||||
resp, err := client.SceneItems.GetGroupSceneItemList(sceneitems.NewGetGroupSceneItemListParams().
|
||||
WithSceneName(group))
|
||||
WithSceneName(parent))
|
||||
if err != nil {
|
||||
return "", 0, err
|
||||
}
|
||||
for _, item := range resp.SceneItems {
|
||||
if item.SourceName == itemName {
|
||||
return group, int(item.SceneItemID), nil
|
||||
return parent, int(item.SceneItemID), nil
|
||||
}
|
||||
}
|
||||
return "", 0, fmt.Errorf("item '%s' not found in scene '%s'", itemName, sceneName)
|
||||
@ -114,7 +66,7 @@ func getSceneNameAndItemID(
|
||||
|
||||
// SceneItemShowCmd provides a command to show a scene item.
|
||||
type SceneItemShowCmd struct {
|
||||
Group string `flag:"" help:"Parent group name."`
|
||||
Parent string `flag:"" help:"Parent group name."`
|
||||
|
||||
SceneName string `arg:"" help:"Scene name."`
|
||||
ItemName string `arg:"" help:"Item name."`
|
||||
@ -122,7 +74,7 @@ type SceneItemShowCmd struct {
|
||||
|
||||
// Run executes the command to show a scene item.
|
||||
func (cmd *SceneItemShowCmd) Run(ctx *context) error {
|
||||
sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group)
|
||||
sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Parent)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@ -135,8 +87,8 @@ func (cmd *SceneItemShowCmd) Run(ctx *context) error {
|
||||
return err
|
||||
}
|
||||
|
||||
if cmd.Group != "" {
|
||||
fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' is now visible.\n", cmd.ItemName, cmd.Group)
|
||||
if cmd.Parent != "" {
|
||||
fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' is now visible.\n", cmd.ItemName, cmd.Parent)
|
||||
} else {
|
||||
fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' is now visible.\n", cmd.ItemName, cmd.SceneName)
|
||||
}
|
||||
@ -146,7 +98,7 @@ func (cmd *SceneItemShowCmd) Run(ctx *context) error {
|
||||
|
||||
// SceneItemHideCmd provides a command to hide a scene item.
|
||||
type SceneItemHideCmd struct {
|
||||
Group string `flag:"" help:"Parent group name."`
|
||||
Parent string `flag:"" help:"Parent group name."`
|
||||
|
||||
SceneName string `arg:"" help:"Scene name."`
|
||||
ItemName string `arg:"" help:"Item name."`
|
||||
@ -154,7 +106,7 @@ type SceneItemHideCmd struct {
|
||||
|
||||
// Run executes the command to hide a scene item.
|
||||
func (cmd *SceneItemHideCmd) Run(ctx *context) error {
|
||||
sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group)
|
||||
sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Parent)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@ -167,8 +119,8 @@ func (cmd *SceneItemHideCmd) Run(ctx *context) error {
|
||||
return err
|
||||
}
|
||||
|
||||
if cmd.Group != "" {
|
||||
fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' is now hidden.\n", cmd.ItemName, cmd.Group)
|
||||
if cmd.Parent != "" {
|
||||
fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' is now hidden.\n", cmd.ItemName, cmd.Parent)
|
||||
} else {
|
||||
fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' is now hidden.\n", cmd.ItemName, cmd.SceneName)
|
||||
}
|
||||
@ -189,7 +141,7 @@ func getItemEnabled(client *goobs.Client, sceneName string, itemID int) (bool, e
|
||||
|
||||
// SceneItemToggleCmd provides a command to toggle the visibility of a scene item.
|
||||
type SceneItemToggleCmd struct {
|
||||
Group string `flag:"" help:"Parent group name."`
|
||||
Parent string `flag:"" help:"Parent group name."`
|
||||
|
||||
SceneName string `arg:"" help:"Scene name."`
|
||||
ItemName string `arg:"" help:"Item name."`
|
||||
@ -197,7 +149,7 @@ type SceneItemToggleCmd struct {
|
||||
|
||||
// Run executes the command to toggle the visibility of a scene item.
|
||||
func (cmd *SceneItemToggleCmd) Run(ctx *context) error {
|
||||
sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group)
|
||||
sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Parent)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@ -226,7 +178,7 @@ func (cmd *SceneItemToggleCmd) Run(ctx *context) error {
|
||||
|
||||
// SceneItemVisibleCmd provides a command to check the visibility of a scene item.
|
||||
type SceneItemVisibleCmd struct {
|
||||
Group string `flag:"" help:"Parent group name."`
|
||||
Parent string `flag:"" help:"Parent group name."`
|
||||
|
||||
SceneName string `arg:"" help:"Scene name."`
|
||||
ItemName string `arg:"" help:"Item name."`
|
||||
@ -234,7 +186,7 @@ type SceneItemVisibleCmd struct {
|
||||
|
||||
// Run executes the command to check the visibility of a scene item.
|
||||
func (cmd *SceneItemVisibleCmd) Run(ctx *context) error {
|
||||
sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group)
|
||||
sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Parent)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@ -257,7 +209,7 @@ type SceneItemTransformCmd struct {
|
||||
SceneName string `arg:"" help:"Scene name."`
|
||||
ItemName string `arg:"" help:"Item name."`
|
||||
|
||||
Group string `flag:"" help:"Parent group name."`
|
||||
Parent string `flag:"" help:"Parent group name."`
|
||||
|
||||
Alignment float64 `flag:"" help:"Alignment of the scene item."`
|
||||
BoundsAlignment float64 `flag:"" help:"Bounds alignment of the scene item."`
|
||||
@ -278,7 +230,7 @@ type SceneItemTransformCmd struct {
|
||||
|
||||
// Run executes the command to transform a scene item.
|
||||
func (cmd *SceneItemTransformCmd) Run(ctx *context) error {
|
||||
sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group)
|
||||
sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Parent)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@ -350,8 +302,8 @@ func (cmd *SceneItemTransformCmd) Run(ctx *context) error {
|
||||
return err
|
||||
}
|
||||
|
||||
if cmd.Group != "" {
|
||||
fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' transformed.\n", cmd.ItemName, cmd.Group)
|
||||
if cmd.Parent != "" {
|
||||
fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' transformed.\n", cmd.ItemName, cmd.Parent)
|
||||
} else {
|
||||
fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' transformed.\n", cmd.ItemName, cmd.SceneName)
|
||||
}
|
||||
|
@ -1,32 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestSceneItemList(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmd := &SceneItemListCmd{
|
||||
SceneName: "gobs-test",
|
||||
}
|
||||
err := cmd.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to list scene items: %v", err)
|
||||
}
|
||||
if !strings.Contains(out.String(), "gobs-test-input") {
|
||||
t.Fatalf("Expected output to contain 'gobs-test-input', got '%s'", out.String())
|
||||
}
|
||||
if !strings.Contains(out.String(), "gobs-test-input-2") {
|
||||
t.Fatalf("Expected output to contain 'gobs-test-input-2', got '%s'", out.String())
|
||||
}
|
||||
}
|
@ -1,41 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"path/filepath"
|
||||
|
||||
"github.com/andreykaipov/goobs/api/requests/sources"
|
||||
)
|
||||
|
||||
// ScreenshotCmd provides commands to manage screenshots in OBS Studio.
|
||||
type ScreenshotCmd struct {
|
||||
Save ScreenshotSaveCmd `cmd:"" help:"Take a screenshot and save it to a file." aliases:"sv"`
|
||||
}
|
||||
|
||||
// ScreenshotSaveCmd represents the command to save a screenshot of a source in OBS.
|
||||
type ScreenshotSaveCmd struct {
|
||||
SourceName string `arg:"" help:"Name of the source to take a screenshot of."`
|
||||
FilePath string `arg:"" help:"Path to the file where the screenshot will be saved."`
|
||||
Width float64 ` help:"Width of the screenshot in pixels." flag:"" default:"1920"`
|
||||
Height float64 ` help:"Height of the screenshot in pixels." flag:"" default:"1080"`
|
||||
Quality float64 ` help:"Quality of the screenshot (1-100)." flag:"" default:"-1"`
|
||||
}
|
||||
|
||||
// Run executes the command to take a screenshot and save it to a file.
|
||||
func (cmd *ScreenshotSaveCmd) Run(ctx *context) error {
|
||||
_, err := ctx.Client.Sources.SaveSourceScreenshot(
|
||||
sources.NewSaveSourceScreenshotParams().
|
||||
WithSourceName(cmd.SourceName).
|
||||
WithImageFormat(trimPrefix(filepath.Ext(cmd.FilePath), ".")).
|
||||
WithImageFilePath(cmd.FilePath).
|
||||
WithImageWidth(cmd.Width).
|
||||
WithImageHeight(cmd.Height).
|
||||
WithImageCompressionQuality(cmd.Quality),
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to take screenshot: %w", err)
|
||||
}
|
||||
|
||||
fmt.Fprintf(ctx.Out, "Screenshot saved to %s.\n", cmd.FilePath)
|
||||
return nil
|
||||
}
|
30
stream.go
30
stream.go
@ -17,21 +17,10 @@ type StreamStartCmd struct{} // size = 0x0
|
||||
|
||||
// Run executes the command to start streaming.
|
||||
func (cmd *StreamStartCmd) Run(ctx *context) error {
|
||||
// Check if the stream is already active
|
||||
status, err := ctx.Client.Stream.GetStreamStatus()
|
||||
_, err := ctx.Client.Stream.StartStream()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if status.OutputActive {
|
||||
return fmt.Errorf("stream is already in progress")
|
||||
}
|
||||
|
||||
_, err = ctx.Client.Stream.StartStream()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
fmt.Fprintln(ctx.Out, "Stream started successfully.")
|
||||
return nil
|
||||
}
|
||||
|
||||
@ -40,21 +29,10 @@ type StreamStopCmd struct{} // size = 0x0
|
||||
|
||||
// Run executes the command to stop streaming.
|
||||
func (cmd *StreamStopCmd) Run(ctx *context) error {
|
||||
// Check if the stream is already inactive
|
||||
status, err := ctx.Client.Stream.GetStreamStatus()
|
||||
_, err := ctx.Client.Stream.StopStream()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if !status.OutputActive {
|
||||
return fmt.Errorf("stream is not in progress")
|
||||
}
|
||||
|
||||
_, err = ctx.Client.Stream.StopStream()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
fmt.Fprintln(ctx.Out, "Stream stopped successfully.")
|
||||
return nil
|
||||
}
|
||||
|
||||
@ -69,9 +47,9 @@ func (cmd *StreamToggleCmd) Run(ctx *context) error {
|
||||
}
|
||||
|
||||
if status.OutputActive {
|
||||
fmt.Fprintln(ctx.Out, "Stream started successfully.")
|
||||
fmt.Fprintln(ctx.Out, "Streaming started successfully.")
|
||||
} else {
|
||||
fmt.Fprintln(ctx.Out, "Stream stopped successfully.")
|
||||
fmt.Fprintln(ctx.Out, "Streaming stopped successfully.")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
132
stream_test.go
132
stream_test.go
@ -1,132 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
func TestStreamStart(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmdStatus := &StreamStatusCmd{}
|
||||
err := cmdStatus.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get stream status: %v", err)
|
||||
}
|
||||
var active bool
|
||||
if strings.Contains(out.String(), "Output active: true") {
|
||||
active = true
|
||||
}
|
||||
// Reset output buffer for the next command
|
||||
out.Reset()
|
||||
|
||||
cmdStart := &StreamStartCmd{}
|
||||
err = cmdStart.Run(context)
|
||||
if active {
|
||||
if err == nil {
|
||||
t.Fatalf("Expected error when starting stream while active, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "stream is already in progress") {
|
||||
t.Fatalf("Expected error message to contain 'stream is already in progress', got '%s'", err.Error())
|
||||
}
|
||||
return
|
||||
}
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to start stream: %v", err)
|
||||
}
|
||||
if out.String() != "Stream started successfully.\n" {
|
||||
t.Fatalf("Expected output to contain 'Stream started successfully.', got '%s'", out.String())
|
||||
}
|
||||
time.Sleep(2 * time.Second) // Wait for the stream to start
|
||||
}
|
||||
|
||||
func TestStreamStop(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmdStatus := &StreamStatusCmd{}
|
||||
err := cmdStatus.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get stream status: %v", err)
|
||||
}
|
||||
var active bool
|
||||
if strings.Contains(out.String(), "Output active: true") {
|
||||
active = true
|
||||
}
|
||||
// Reset output buffer for the next command
|
||||
out.Reset()
|
||||
|
||||
cmdStop := &StreamStopCmd{}
|
||||
err = cmdStop.Run(context)
|
||||
if !active {
|
||||
if err == nil {
|
||||
t.Fatalf("Expected error when stopping stream while inactive, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "stream is not in progress") {
|
||||
t.Fatalf("Expected error message to contain 'stream is not in progress', got '%s'", err.Error())
|
||||
}
|
||||
return
|
||||
}
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to stop stream: %v", err)
|
||||
}
|
||||
if out.String() != "Stream stopped successfully.\n" {
|
||||
t.Fatalf("Expected output to contain 'Stream stopped successfully.', got '%s'", out.String())
|
||||
}
|
||||
time.Sleep(2 * time.Second) // Wait for the stream to stop
|
||||
}
|
||||
|
||||
func TestStreamToggle(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmdStatus := &StreamStatusCmd{}
|
||||
err := cmdStatus.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get stream status: %v", err)
|
||||
}
|
||||
var active bool
|
||||
if strings.Contains(out.String(), "Output active: true") {
|
||||
active = true
|
||||
}
|
||||
// Reset output buffer for the next command
|
||||
out.Reset()
|
||||
|
||||
cmdToggle := &StreamToggleCmd{}
|
||||
err = cmdToggle.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to toggle stream: %v", err)
|
||||
}
|
||||
|
||||
if active {
|
||||
if out.String() != "Stream stopped successfully.\n" {
|
||||
t.Fatalf("Expected 'Stream stopped successfully.', got: %s", out.String())
|
||||
}
|
||||
} else {
|
||||
if out.String() != "Stream started successfully.\n" {
|
||||
t.Fatalf("Expected 'Stream started successfully.', got: %s", out.String())
|
||||
}
|
||||
}
|
||||
time.Sleep(2 * time.Second) // Wait for the stream to toggle
|
||||
}
|
@ -23,8 +23,6 @@ func (cmd *StudioModeEnableCmd) Run(ctx *context) error {
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to enable studio mode: %w", err)
|
||||
}
|
||||
|
||||
fmt.Fprintln(ctx.Out, "Studio mode is now enabled")
|
||||
return nil
|
||||
}
|
||||
|
||||
@ -37,8 +35,6 @@ func (cmd *StudioModeDisableCmd) Run(ctx *context) error {
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to disable studio mode: %w", err)
|
||||
}
|
||||
|
||||
fmt.Fprintln(ctx.Out, "Studio mode is now disabled")
|
||||
return nil
|
||||
}
|
||||
|
||||
|
@ -1,68 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestStudioModeEnable(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmdEnable := &StudioModeEnableCmd{}
|
||||
err := cmdEnable.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to enable studio mode: %v", err)
|
||||
}
|
||||
if out.String() != "Studio mode is now enabled\n" {
|
||||
t.Fatalf("expected 'Studio mode is now enabled', got: %s", out.String())
|
||||
}
|
||||
// Reset output buffer for the next command
|
||||
out.Reset()
|
||||
|
||||
cmdStatus := &StudioModeStatusCmd{}
|
||||
err = cmdStatus.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to get studio mode status: %v", err)
|
||||
}
|
||||
if out.String() != "Studio mode is enabled\n" {
|
||||
t.Fatalf("expected 'Studio mode is enabled', got: %s", out.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestStudioModeDisable(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmdDisable := &StudioModeDisableCmd{}
|
||||
err := cmdDisable.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to disable studio mode: %v", err)
|
||||
}
|
||||
if out.String() != "Studio mode is now disabled\n" {
|
||||
t.Fatalf("expected 'Studio mode is now disabled', got: %s", out.String())
|
||||
}
|
||||
// Reset output buffer for the next command
|
||||
out.Reset()
|
||||
|
||||
cmdStatus := &StudioModeStatusCmd{}
|
||||
err = cmdStatus.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to get studio mode status: %v", err)
|
||||
}
|
||||
if out.String() != "Studio mode is disabled\n" {
|
||||
t.Fatalf("expected 'Studio mode is disabled', got: %s", out.String())
|
||||
}
|
||||
}
|
29
util.go
29
util.go
@ -1,29 +0,0 @@
|
||||
// Package util provides utility functions for the application.
|
||||
|
||||
package main
|
||||
|
||||
import "strings"
|
||||
|
||||
func snakeCaseToTitleCase(snake string) string {
|
||||
words := strings.Split(snake, "_")
|
||||
for i, word := range words {
|
||||
if len(word) > 0 {
|
||||
words[i] = strings.ToUpper(word[:1]) + word[1:]
|
||||
}
|
||||
}
|
||||
return strings.Join(words, " ")
|
||||
}
|
||||
|
||||
func getEnabledMark(enabled bool) string {
|
||||
if enabled {
|
||||
return "\u2713" // green check mark
|
||||
}
|
||||
return "\u274c" // red cross mark
|
||||
}
|
||||
|
||||
func trimPrefix(s, prefix string) string {
|
||||
if strings.HasPrefix(s, prefix) {
|
||||
return s[len(prefix):]
|
||||
}
|
||||
return s
|
||||
}
|
20
util_test.go
20
util_test.go
@ -1,20 +0,0 @@
|
||||
package main
|
||||
|
||||
import "testing"
|
||||
|
||||
func TestSnakeCaseToTitleCase(t *testing.T) {
|
||||
tests := []struct {
|
||||
input string
|
||||
expected string
|
||||
}{
|
||||
{"hello_world", "Hello World"},
|
||||
{"snake_case_to_title_case", "Snake Case To Title Case"},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
result := snakeCaseToTitleCase(test.input)
|
||||
if result != test.expected {
|
||||
t.Errorf("Expected '%s' but got '%s'", test.expected, result)
|
||||
}
|
||||
}
|
||||
}
|
36
version.go
36
version.go
@ -2,43 +2,13 @@ package main
|
||||
|
||||
import (
|
||||
"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.
|
||||
type ObsVersionCmd struct{} // size = 0x0
|
||||
// VersionCmd handles the version command.
|
||||
type VersionCmd struct{} // size = 0x0
|
||||
|
||||
// Run executes the command to get the OBS client version.
|
||||
func (cmd *ObsVersionCmd) Run(ctx *context) error {
|
||||
func (cmd *VersionCmd) Run(ctx *context) error {
|
||||
version, err := ctx.Client.General.GetVersion()
|
||||
if err != nil {
|
||||
return err
|
||||
|
@ -1,30 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestVersion(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
var out bytes.Buffer
|
||||
context := &context{
|
||||
Client: client,
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmd := &ObsVersionCmd{}
|
||||
err := cmd.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get version: %v", err)
|
||||
}
|
||||
if !strings.Contains(out.String(), "OBS Client Version:") {
|
||||
t.Fatalf("Expected output to contain 'OBS Client Version:', got '%s'", out.String())
|
||||
}
|
||||
if !strings.Contains(out.String(), "with Websocket Version:") {
|
||||
t.Fatalf("Expected output to contain 'with Websocket Version:', got '%s'", out.String())
|
||||
}
|
||||
}
|
@ -43,16 +43,10 @@ type VirtualCamToggleCmd struct{} // size = 0x0
|
||||
|
||||
// Run executes the command to toggle the virtual camera.
|
||||
func (c *VirtualCamToggleCmd) Run(ctx *context) error {
|
||||
resp, err := ctx.Client.Outputs.ToggleVirtualCam()
|
||||
_, err := ctx.Client.Outputs.ToggleVirtualCam()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to toggle virtual camera: %w", err)
|
||||
}
|
||||
|
||||
if resp.OutputActive {
|
||||
fmt.Fprintln(ctx.Out, "Virtual camera is now active.")
|
||||
} else {
|
||||
fmt.Fprintln(ctx.Out, "Virtual camera is now inactive.")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user