mirror of
https://github.com/onyx-and-iris/gobs-cli.git
synced 2026-04-18 07:03:37 +00:00
Compare commits
17 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 306f19eeae | |||
| 43dd77ffdc | |||
| f94ac1ca0c | |||
| c27a5ea6c5 | |||
| af962a26cc | |||
| 360d45aa47 | |||
| 3deb03cf32 | |||
| f58b2dfeab | |||
| 6ad530ce2e | |||
| d9d3c7c8b2 | |||
|
|
f72e34adfb | ||
| ccb3f59513 | |||
| e3fd88cf92 | |||
| 12dfab5642 | |||
| 7a2765f72c | |||
| 90aa5d4423 | |||
| da010d67a0 |
31
CHANGELOG.md
31
CHANGELOG.md
@@ -5,11 +5,40 @@ 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.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 [Hotkey](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#hotkeycmd)
|
||||
- hotkey commands, see [HotkeyCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#hotkeycmd)
|
||||
|
||||
# [0.4.2] - 2025-05-08
|
||||
|
||||
|
||||
88
README.md
88
README.md
@@ -79,9 +79,14 @@ 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
|
||||
```
|
||||
|
||||
@@ -131,6 +136,7 @@ gobs-cli sceneitem visible --parent=test_group START "Colour Source 4"
|
||||
|
||||
- transform: Transform scene item.
|
||||
- flags:
|
||||
|
||||
*optional*
|
||||
- --parent: Parent group name.
|
||||
|
||||
@@ -161,9 +167,14 @@ 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
|
||||
```
|
||||
|
||||
@@ -270,6 +281,19 @@ 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.
|
||||
@@ -477,5 +501,69 @@ gobs-cli hotkey trigger-sequence OBS_KEY_F1 --ctrl
|
||||
gobs-cli hotkey trigger-sequence OBS_KEY_F1 --shift --ctrl
|
||||
```
|
||||
|
||||
### FilterCmd
|
||||
|
||||
- list: List all filters.
|
||||
|
||||
```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: <source_name>
|
||||
- defaults to current scene
|
||||
|
||||
```console
|
||||
gobs-cli project open
|
||||
|
||||
gobs-cli projector open --monitor-index=1 "test_scene"
|
||||
|
||||
gobs-cli projector open --monitor-index=1 "test_group"
|
||||
```
|
||||
|
||||
|
||||
[userconfigdir]: https://pkg.go.dev/os#UserConfigDir
|
||||
[obs-keyids]: https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h
|
||||
176
filter.go
Normal file
176
filter.go
Normal file
@@ -0,0 +1,176 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"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."`
|
||||
}
|
||||
|
||||
// Run executes the command to list all filters in a scene.
|
||||
func (cmd *FilterListCmd) Run(ctx *context) error {
|
||||
filters, err := ctx.Client.Filters.GetSourceFilterList(
|
||||
filters.NewGetSourceFilterListParams().WithSourceName(cmd.SourceName),
|
||||
)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if len(filters.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 filters.Filters {
|
||||
var lines []string
|
||||
for k, v := range filter.FilterSettings {
|
||||
lines = append(lines, fmt.Sprintf("%s %v", 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
|
||||
}
|
||||
76
filter_test.go
Normal file
76
filter_test.go
Normal file
@@ -0,0 +1,76 @@
|
||||
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,6 +6,7 @@ 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
|
||||
)
|
||||
|
||||
@@ -14,9 +15,13 @@ 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,6 +8,8 @@ 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=
|
||||
@@ -20,6 +22,8 @@ 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=
|
||||
@@ -32,9 +36,15 @@ 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,6 +4,7 @@ import (
|
||||
"fmt"
|
||||
|
||||
"github.com/andreykaipov/goobs/api/requests/sceneitems"
|
||||
"github.com/aquasecurity/table"
|
||||
)
|
||||
|
||||
// GroupCmd provides commands to manage groups in OBS Studio.
|
||||
@@ -17,21 +18,36 @@ 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."`
|
||||
SceneName string `arg:"" help:"Name of the scene to list groups from." default:""`
|
||||
}
|
||||
|
||||
// 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 {
|
||||
fmt.Fprintf(ctx.Out, "Group ID: %d, Source Name: %s\n", item.SceneItemID, item.SourceName)
|
||||
t.AddRow(fmt.Sprintf("%d", item.SceneItemID), item.SourceName, getEnabledMark(item.SceneItemEnabled))
|
||||
}
|
||||
}
|
||||
t.Render()
|
||||
return nil
|
||||
}
|
||||
|
||||
|
||||
11
hotkey.go
11
hotkey.go
@@ -1,10 +1,9 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"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.
|
||||
@@ -24,9 +23,15 @@ func (cmd *HotkeyListCmd) Run(ctx *context) error {
|
||||
return err
|
||||
}
|
||||
|
||||
t := table.New(ctx.Out)
|
||||
t.SetPadding(3)
|
||||
t.SetAlignment(table.AlignLeft)
|
||||
t.SetHeaders("Hotkey Name")
|
||||
|
||||
for _, hotkey := range resp.Hotkeys {
|
||||
fmt.Fprintln(ctx.Out, hotkey)
|
||||
t.AddRow(hotkey)
|
||||
}
|
||||
t.Render()
|
||||
return nil
|
||||
}
|
||||
|
||||
|
||||
16
input.go
16
input.go
@@ -5,6 +5,7 @@ import (
|
||||
"strings"
|
||||
|
||||
"github.com/andreykaipov/goobs/api/requests/inputs"
|
||||
"github.com/aquasecurity/table"
|
||||
)
|
||||
|
||||
// InputCmd provides commands to manage inputs in OBS Studio.
|
||||
@@ -28,21 +29,28 @@ 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)
|
||||
t.SetHeaders("Input Name", "Kind")
|
||||
|
||||
for _, input := range resp.Inputs {
|
||||
if cmd.Input && strings.Contains(input.InputKind, "input") {
|
||||
fmt.Fprintln(ctx.Out, "Input:", input.InputName)
|
||||
t.AddRow(input.InputName, input.InputKind)
|
||||
}
|
||||
if cmd.Output && strings.Contains(input.InputKind, "output") {
|
||||
fmt.Fprintln(ctx.Out, "Output:", input.InputName)
|
||||
t.AddRow(input.InputName, input.InputKind)
|
||||
}
|
||||
if cmd.Colour && strings.Contains(input.InputKind, "color") { // nolint
|
||||
fmt.Fprintln(ctx.Out, "Colour Source:", input.InputName)
|
||||
t.AddRow(input.InputName, input.InputKind)
|
||||
}
|
||||
|
||||
if !cmd.Input && !cmd.Output && !cmd.Colour {
|
||||
fmt.Fprintln(ctx.Out, "Source:", input.InputName)
|
||||
t.AddRow(input.InputName, input.InputKind)
|
||||
}
|
||||
}
|
||||
t.Render()
|
||||
return nil
|
||||
}
|
||||
|
||||
|
||||
140
input_test.go
Normal file
140
input_test.go
Normal file
@@ -0,0 +1,140 @@
|
||||
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())
|
||||
}
|
||||
}
|
||||
}
|
||||
8
main.go
8
main.go
@@ -24,9 +24,9 @@ type ObsConfig struct {
|
||||
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."`
|
||||
@@ -44,6 +44,8 @@ type cli struct {
|
||||
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"`
|
||||
}
|
||||
|
||||
type context struct {
|
||||
@@ -58,7 +60,7 @@ func main() {
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
var cli cli
|
||||
var cli CLI
|
||||
ctx := kong.Parse(
|
||||
&cli,
|
||||
kong.Name("GOBS-CLI"),
|
||||
|
||||
32
main_test.go
32
main_test.go
@@ -6,6 +6,7 @@ import (
|
||||
|
||||
"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"
|
||||
typedefs "github.com/andreykaipov/goobs/api/typedefs"
|
||||
@@ -87,9 +88,39 @@ func setup(client *goobs.Client) {
|
||||
"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"))
|
||||
|
||||
@@ -98,4 +129,5 @@ func teardown(client *goobs.Client) {
|
||||
|
||||
client.Stream.StopStream()
|
||||
client.Record.StopRecord()
|
||||
client.Outputs.StopReplayBuffer()
|
||||
}
|
||||
|
||||
17
profile.go
17
profile.go
@@ -5,6 +5,7 @@ import (
|
||||
"slices"
|
||||
|
||||
"github.com/andreykaipov/goobs/api/requests/config"
|
||||
"github.com/aquasecurity/table"
|
||||
)
|
||||
|
||||
// ProfileCmd provides commands to manage profiles in OBS Studio.
|
||||
@@ -26,10 +27,20 @@ func (cmd *ProfileListCmd) Run(ctx *context) error {
|
||||
return err
|
||||
}
|
||||
|
||||
for _, profile := range profiles.Profiles {
|
||||
fmt.Fprintln(ctx.Out, profile)
|
||||
}
|
||||
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)
|
||||
}
|
||||
t.Render()
|
||||
return nil
|
||||
}
|
||||
|
||||
|
||||
66
projector.go
Normal file
66
projector.go
Normal file
@@ -0,0 +1,66 @@
|
||||
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
|
||||
}
|
||||
46
record.go
46
record.go
@@ -2,16 +2,19 @@ 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"`
|
||||
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"`
|
||||
}
|
||||
|
||||
// RecordStartCmd starts the recording.
|
||||
@@ -32,11 +35,11 @@ type RecordStopCmd struct{} // size = 0x0
|
||||
|
||||
// Run executes the command to stop recording.
|
||||
func (cmd *RecordStopCmd) Run(ctx *context) error {
|
||||
_, err := ctx.Client.Record.StopRecord()
|
||||
resp, err := ctx.Client.Record.StopRecord()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
fmt.Fprintln(ctx.Out, "Recording stopped successfully.")
|
||||
fmt.Fprintf(ctx.Out, "%s", fmt.Sprintf("Recording stopped successfully. Output file: %s\n", resp.OutputPath))
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -132,3 +135,30 @@ 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
|
||||
}
|
||||
|
||||
@@ -2,6 +2,7 @@ package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
@@ -45,7 +46,7 @@ func TestRecordStartStatusStop(t *testing.T) {
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to stop recording: %v", err)
|
||||
}
|
||||
if out.String() != "Recording stopped successfully.\n" {
|
||||
if !strings.Contains(out.String(), "Recording stopped successfully. Output file:") {
|
||||
t.Fatalf("Expected output to be 'Recording stopped successfully.', got '%s'", out.String())
|
||||
}
|
||||
// Reset output buffer for the next command
|
||||
|
||||
@@ -19,7 +19,11 @@ 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()
|
||||
return err
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to start replay buffer: %w", err)
|
||||
}
|
||||
fmt.Fprintln(ctx.Out, "Replay buffer started.")
|
||||
return nil
|
||||
}
|
||||
|
||||
// ReplayBufferStopCmd stops the replay buffer.
|
||||
@@ -28,7 +32,11 @@ 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()
|
||||
return err
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to stop replay buffer: %w", err)
|
||||
}
|
||||
fmt.Fprintln(ctx.Out, "Replay buffer stopped.")
|
||||
return nil
|
||||
}
|
||||
|
||||
// ReplayBufferToggleCmd toggles the replay buffer state.
|
||||
@@ -42,9 +50,9 @@ func (cmd *ReplayBufferToggleCmd) Run(ctx *context) error {
|
||||
}
|
||||
|
||||
if status.OutputActive {
|
||||
fmt.Fprintln(ctx.Out, "Replay buffer started successfully.")
|
||||
fmt.Fprintln(ctx.Out, "Replay buffer started.")
|
||||
} else {
|
||||
fmt.Fprintln(ctx.Out, "Replay buffer stopped successfully.")
|
||||
fmt.Fprintln(ctx.Out, "Replay buffer stopped.")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
85
replaybuffer_test.go
Normal file
85
replaybuffer_test.go
Normal file
@@ -0,0 +1,85 @@
|
||||
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,6 +5,7 @@ import (
|
||||
"slices"
|
||||
|
||||
"github.com/andreykaipov/goobs/api/requests/scenes"
|
||||
"github.com/aquasecurity/table"
|
||||
)
|
||||
|
||||
// SceneCmd provides commands to manage scenes in OBS Studio.
|
||||
@@ -24,10 +25,16 @@ 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 {
|
||||
fmt.Fprintln(ctx.Out, scene.SceneName)
|
||||
t.AddRow(scene.SceneName, scene.SceneUuid)
|
||||
}
|
||||
t.Render()
|
||||
return nil
|
||||
}
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ import (
|
||||
"fmt"
|
||||
|
||||
"github.com/andreykaipov/goobs/api/requests/config"
|
||||
"github.com/aquasecurity/table"
|
||||
)
|
||||
|
||||
// SceneCollectionCmd provides commands to manage scene collections in OBS Studio.
|
||||
@@ -24,10 +25,15 @@ func (cmd *SceneCollectionListCmd) Run(ctx *context) error {
|
||||
return fmt.Errorf("failed to get scene collection list: %w", err)
|
||||
}
|
||||
|
||||
for _, collection := range collections.SceneCollections {
|
||||
fmt.Fprintln(ctx.Out, collection)
|
||||
}
|
||||
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)
|
||||
}
|
||||
t.Render()
|
||||
return nil
|
||||
}
|
||||
|
||||
|
||||
27
sceneitem.go
27
sceneitem.go
@@ -5,6 +5,7 @@ import (
|
||||
|
||||
"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.
|
||||
@@ -19,19 +20,39 @@ type SceneItemCmd struct {
|
||||
|
||||
// SceneItemListCmd provides a command to list all scene items in a scene.
|
||||
type SceneItemListCmd struct {
|
||||
SceneName string `arg:"" help:"Scene name."`
|
||||
SceneName string `arg:"" help:"Name of the scene to list items from." default:""`
|
||||
}
|
||||
|
||||
// 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)
|
||||
}
|
||||
for _, item := range resp.SceneItems {
|
||||
fmt.Fprintf(ctx.Out, "Item ID: %d, Source Name: %s\n", item.SceneItemID, item.SourceName)
|
||||
|
||||
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.AlignLeft)
|
||||
t.SetHeaders("Item Name")
|
||||
|
||||
for _, item := range resp.SceneItems {
|
||||
t.AddRow(item.SourceName)
|
||||
}
|
||||
t.Render()
|
||||
return nil
|
||||
}
|
||||
|
||||
|
||||
22
util.go
Normal file
22
util.go
Normal file
@@ -0,0 +1,22 @@
|
||||
// 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
|
||||
}
|
||||
20
util_test.go
Normal file
20
util_test.go
Normal file
@@ -0,0 +1,20 @@
|
||||
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)
|
||||
}
|
||||
}
|
||||
}
|
||||
30
version_test.go
Normal file
30
version_test.go
Normal file
@@ -0,0 +1,30 @@
|
||||
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 := &VersionCmd{}
|
||||
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,10 +43,16 @@ type VirtualCamToggleCmd struct{} // size = 0x0
|
||||
|
||||
// Run executes the command to toggle the virtual camera.
|
||||
func (c *VirtualCamToggleCmd) Run(ctx *context) error {
|
||||
_, err := ctx.Client.Outputs.ToggleVirtualCam()
|
||||
resp, 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
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user