Compare commits

..

15 Commits

Author SHA1 Message Date
7fa43eb35c add unit tests 2025-05-08 05:04:03 +01:00
8aeb7cb183 add studiomode enable/disable output 2025-05-08 01:19:11 +01:00
6e25927bc1 add stream start/stop output 2025-05-08 01:18:58 +01:00
dd0bbfc0da add missing record status command
add replaybuffer toggle to readme
2025-05-08 00:47:15 +01:00
c04324d173 add 0.4.0 to changelog 2025-05-07 20:24:30 +01:00
36d0753bd9 use ToggleRecord()/ToggleStream methods 2025-05-07 20:17:26 +01:00
3095c0c49d add replaybuffer toggle command 2025-05-07 20:16:44 +01:00
53bbb58cfb keep struct names consistent 2025-05-07 20:16:31 +01:00
5f2fe05caa fix date 2025-05-02 13:33:29 +01:00
c653047c66 add 0.3.1 to changelog 2025-05-02 12:26:42 +01:00
30fabe8cfc add env file resolver 2025-05-02 12:24:46 +01:00
8cf969c906 add task to view man page
move man tasks into Taskfile.man.yaml
2025-04-29 18:35:58 +01:00
3540c60c4b reword 2025-04-29 16:59:08 +01:00
b2c5980b4a use task var 2025-04-29 16:54:51 +01:00
da1ef9f993 upd task name + outfile name 2025-04-29 16:50:45 +01:00
23 changed files with 838 additions and 92 deletions

9
.gitignore vendored
View File

@@ -26,5 +26,12 @@ go.work
# End of gignore: github.com/onyx-and-iris/gignore
# Environment
.env
.envrc
*_test.go
# Man pages
gobs-cli.1
# Config files
config.yaml

View File

@@ -50,3 +50,6 @@ issues:
exclude:
# gosec: Duplicated errcheck checks
- G104
exclude-files:
# Exclude vendor directory
- main_test.go

View File

@@ -5,6 +5,19 @@ 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.4.0] - 2025-05-07
### Added
- replaybuffer toggle command
# [0.3.1] - 2025-05-02
### Added
- --man flag for generating/viewing a man page.
- Ability to load env vars from env files, see the [README](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#environment-variables)
# [0.2.0] - 2025-04-27
### Added

View File

@@ -22,17 +22,19 @@ gobs-cli --host=localhost --port=4455 --password=<websocket password> --help
#### Environment Variables
Load connection details from your environment:
Store and load environment variables from:
```bash
#!/usr/bin/env bash
- A `.env` file in the cwd
- $XDG_CONFIG_HOME / gobs-cli / config.env (see [os.UserConfigDir][userconfigdir])
export OBS_HOST=localhost
export OBS_PORT=4455
export OBS_PASSWORD=<websocket password>
export OBS_TIMEOUT=5
```env
OBS_HOST=localhost
OBS_PORT=4455
OBS_PASSWORD=<websocket password>
OBS_TIMEOUT=5
```
## Commands
### VersionCmd
@@ -371,6 +373,12 @@ gobs-cli replaybuffer start
gobs-cli replaybuffer stop
```
- toggle: Toggle replay buffer.
```console
gobs-cli replaybuffer toggle
```
- status: Get replay buffer status.
```console
@@ -433,4 +441,6 @@ gobs-cli virtualcam toggle
```console
gobs-cli virtualcam status
```
```
[userconfigdir]: https://pkg.go.dev/os#UserConfigDir

17
Taskfile.man.yaml Normal file
View File

@@ -0,0 +1,17 @@
version: '3'
tasks:
default:
desc: View man page
cmds:
- task: view
view:
desc: View man page
cmds:
- go run . --man | man -l -
generate:
desc: Generate man page
cmds:
- go run . --man > {{.PROGRAM}}.1

View File

@@ -1,5 +1,8 @@
version: '3'
includes:
man: Taskfile.man.yaml
vars:
PROGRAM: gobs-cli
SHELL: '{{if eq .OS "Windows_NT"}}powershell{{end}}'
@@ -50,8 +53,3 @@ tasks:
desc: Clean the build artifacts
cmds:
- '{{.SHELL}} rm -r {{.BIN_DIR}}'
manfile:
desc: Generate manfile
cmds:
- go run . --man > manfile

2
go.mod
View File

@@ -6,12 +6,14 @@ 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/titusjaka/kong-dotenv-go v0.1.0
)
require (
github.com/buger/jsonparser v1.1.1 // indirect
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/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

4
go.sum
View File

@@ -18,6 +18,8 @@ github.com/hashicorp/logutils v1.0.0 h1:dLEQVugN8vlakKOUE3ihGLTZJRB4j+M2cdTm/ORI
github.com/hashicorp/logutils v1.0.0/go.mod h1:QIAnNjmIWmVIIkWDTG1z5v++HQmx9WQRO+LraFDTW64=
github.com/hexops/gotextdiff v1.0.3 h1:gitA9+qJrrTCsiCl7+kh75nPqQt1cx4ZkudSTLoUqJM=
github.com/hexops/gotextdiff v1.0.3/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/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,5 +34,7 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
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=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

130
group_test.go Normal file
View File

@@ -0,0 +1,130 @@
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())
}
}

11
main.go
View File

@@ -7,11 +7,13 @@ import (
"fmt"
"io"
"os"
"path/filepath"
"time"
"github.com/alecthomas/kong"
mangokong "github.com/alecthomas/mango-kong"
"github.com/andreykaipov/goobs"
kongdotenv "github.com/titusjaka/kong-dotenv-go"
)
// ObsConfig holds the configuration for connecting to the OBS WebSocket server.
@@ -49,11 +51,18 @@ type context struct {
}
func main() {
cli := cli{}
userConfigDir, err := os.UserConfigDir()
if err != nil {
fmt.Fprintf(os.Stderr, "Error getting user config directory: %v\n", err)
os.Exit(1)
}
var cli cli
ctx := kong.Parse(
&cli,
kong.Name("GOBS-CLI"),
kong.Description("A command line tool to interact with OBS Websocket."),
kong.Configuration(kongdotenv.ENVFileReader, ".env", filepath.Join(userConfigDir, "gobs-cli", "config.env")),
)
client, err := connectObs(cli.ObsConfig)

101
main_test.go Normal file
View File

@@ -0,0 +1,101 @@
package main
import (
"os"
"testing"
"github.com/andreykaipov/goobs"
"github.com/andreykaipov/goobs/api/requests/config"
"github.com/andreykaipov/goobs/api/requests/inputs"
"github.com/andreykaipov/goobs/api/requests/scenes"
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))
}
func teardown(client *goobs.Client) {
client.Scenes.RemoveScene(scenes.NewRemoveSceneParams().
WithSceneName("gobs-test"))
client.Config.SetCurrentSceneCollection(config.NewSetCurrentSceneCollectionParams().
WithSceneCollectionName("default"))
client.Stream.StopStream()
client.Record.StopRecord()
}

View File

@@ -9,18 +9,18 @@ import (
// ProfileCmd provides commands to manage profiles in OBS Studio.
type ProfileCmd struct {
List ListProfileCmd `help:"List profiles." cmd:"" aliases:"ls"`
Current CurrentProfileCmd `help:"Get current profile." cmd:"" aliases:"c"`
Switch SwitchProfileCmd `help:"Switch profile." cmd:"" aliases:"sw"`
Create CreateProfileCmd `help:"Create profile." cmd:"" aliases:"new"`
Remove RemoveProfileCmd `help:"Remove profile." cmd:"" aliases:"rm"`
List ProfileListCmd `help:"List profiles." cmd:"" aliases:"ls"`
Current ProfileCurrentCmd `help:"Get current profile." cmd:"" aliases:"c"`
Switch ProfileSwitchCmd `help:"Switch profile." cmd:"" aliases:"sw"`
Create ProfileCreateCmd `help:"Create profile." cmd:"" aliases:"new"`
Remove ProfileRemoveCmd `help:"Remove profile." cmd:"" aliases:"rm"`
}
// ListProfileCmd provides a command to list all profiles.
type ListProfileCmd struct{} // size = 0x0
// ProfileListCmd provides a command to list all profiles.
type ProfileListCmd struct{} // size = 0x0
// Run executes the command to list all profiles.
func (cmd *ListProfileCmd) Run(ctx *context) error {
func (cmd *ProfileListCmd) Run(ctx *context) error {
profiles, err := ctx.Client.Config.GetProfileList()
if err != nil {
return err
@@ -33,11 +33,11 @@ func (cmd *ListProfileCmd) Run(ctx *context) error {
return nil
}
// CurrentProfileCmd provides a command to get the current profile.
type CurrentProfileCmd struct{} // size = 0x0
// ProfileCurrentCmd provides a command to get the current profile.
type ProfileCurrentCmd struct{} // size = 0x0
// Run executes the command to get the current profile.
func (cmd *CurrentProfileCmd) Run(ctx *context) error {
func (cmd *ProfileCurrentCmd) Run(ctx *context) error {
profiles, err := ctx.Client.Config.GetProfileList()
if err != nil {
return err
@@ -47,13 +47,13 @@ func (cmd *CurrentProfileCmd) Run(ctx *context) error {
return nil
}
// SwitchProfileCmd provides a command to switch to a different profile.
type SwitchProfileCmd struct {
// ProfileSwitchCmd provides a command to switch to a different profile.
type ProfileSwitchCmd struct {
Name string `arg:"" help:"Name of the profile to switch to." required:""`
}
// Run executes the command to switch to a different profile.
func (cmd *SwitchProfileCmd) Run(ctx *context) error {
func (cmd *ProfileSwitchCmd) Run(ctx *context) error {
profiles, err := ctx.Client.Config.GetProfileList()
if err != nil {
return err
@@ -74,13 +74,13 @@ func (cmd *SwitchProfileCmd) Run(ctx *context) error {
return nil
}
// CreateProfileCmd provides a command to create a new profile.
type CreateProfileCmd struct {
// ProfileCreateCmd provides a command to create a new profile.
type ProfileCreateCmd struct {
Name string `arg:"" help:"Name of the profile to create." required:""`
}
// Run executes the command to create a new profile.
func (cmd *CreateProfileCmd) Run(ctx *context) error {
func (cmd *ProfileCreateCmd) Run(ctx *context) error {
profiles, err := ctx.Client.Config.GetProfileList()
if err != nil {
return err
@@ -100,13 +100,13 @@ func (cmd *CreateProfileCmd) Run(ctx *context) error {
return nil
}
// RemoveProfileCmd provides a command to remove an existing profile.
type RemoveProfileCmd struct {
// ProfileRemoveCmd provides a command to remove an existing profile.
type ProfileRemoveCmd struct {
Name string `arg:"" help:"Name of the profile to delete." required:""`
}
// Run executes the command to remove an existing profile.
func (cmd *RemoveProfileCmd) Run(ctx *context) error {
func (cmd *ProfileRemoveCmd) Run(ctx *context) error {
profiles, err := ctx.Client.Config.GetProfileList()
if err != nil {
return err

View File

@@ -6,11 +6,12 @@ import (
// 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"`
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"`
}
// RecordStartCmd starts the recording.
@@ -44,25 +45,39 @@ type RecordToggleCmd struct{} // size = 0x0
// Run executes the command to toggle recording.
func (cmd *RecordToggleCmd) Run(ctx *context) error {
// Check if recording is in progress
status, err := ctx.Client.Record.ToggleRecord()
if err != nil {
return err
}
if status.OutputActive {
fmt.Fprintln(ctx.Out, "Recording started successfully.")
} else {
fmt.Fprintln(ctx.Out, "Recording stopped successfully.")
}
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 {
_, err = ctx.Client.Record.StopRecord()
if err != nil {
return err
if status.OutputPaused {
fmt.Fprintln(ctx.Out, "Recording is paused.")
} else {
fmt.Fprintln(ctx.Out, "Recording is in progress.")
}
fmt.Fprintln(ctx.Out, "Recording stopped successfully.")
} else {
_, err = ctx.Client.Record.StartRecord()
if err != nil {
return err
}
fmt.Fprintln(ctx.Out, "Recording started successfully.")
fmt.Fprintln(ctx.Out, "Recording is not in progress.")
}
return nil
}

105
record_test.go Normal file
View File

@@ -0,0 +1,105 @@
package main
import (
"bytes"
"testing"
"time"
)
func TestRecordStartStatusStop(t *testing.T) {
client, disconnect := getClient(t)
defer disconnect()
var out bytes.Buffer
context := &context{
Client: client,
Out: &out,
}
cmdStart := &RecordStartCmd{}
err := cmdStart.Run(context)
if err != nil {
t.Fatalf("Failed to start recording: %v", err)
}
if out.String() != "Recording started successfully.\n" {
t.Fatalf("Expected output to be 'Recording started successfully.', got '%s'", out.String())
}
// Reset output buffer for the next command
out.Reset()
time.Sleep(1 * time.Second) // Wait for a second to ensure recording has started
cmdStatus := &RecordStatusCmd{}
err = cmdStatus.Run(context)
if err != nil {
t.Fatalf("Failed to get recording status: %v", err)
}
if out.String() != "Recording is in progress.\n" {
t.Fatalf("Expected output to be 'Recording is in progress.', got '%s'", out.String())
}
// Reset output buffer for the next command
out.Reset()
cmdStop := &RecordStopCmd{}
err = cmdStop.Run(context)
if err != nil {
t.Fatalf("Failed to stop recording: %v", err)
}
if out.String() != "Recording stopped successfully.\n" {
t.Fatalf("Expected output to be 'Recording stopped successfully.', got '%s'", out.String())
}
// Reset output buffer for the next command
out.Reset()
time.Sleep(1 * time.Second) // Wait for a second to ensure recording has stopped
cmdStatus = &RecordStatusCmd{}
err = cmdStatus.Run(context)
if err != nil {
t.Fatalf("Failed to get recording status: %v", err)
}
if out.String() != "Recording is not in progress.\n" {
t.Fatalf("Expected output to be 'Recording is not in progress.', got '%s'", out.String())
}
}
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())
}
}
}

View File

@@ -8,6 +8,7 @@ import (
type ReplayBufferCmd struct {
Start ReplayBufferStartCmd `help:"Start replay buffer." cmd:"" aliases:"s"`
Stop ReplayBufferStopCmd `help:"Stop replay buffer." cmd:"" aliases:"st"`
Toggle ReplayBufferToggleCmd `help:"Toggle replay buffer." cmd:"" aliases:"tg"`
Status ReplayBufferStatusCmd `help:"Get replay buffer status." cmd:"" aliases:"ss"`
Save ReplayBufferSaveCmd `help:"Save replay buffer." cmd:"" aliases:"sv"`
}
@@ -30,6 +31,24 @@ func (cmd *ReplayBufferStopCmd) Run(ctx *context) error {
return err
}
// ReplayBufferToggleCmd toggles the replay buffer state.
type ReplayBufferToggleCmd struct{} // size = 0x0
// Run executes the command to toggle the replay buffer.
func (cmd *ReplayBufferToggleCmd) Run(ctx *context) error {
status, err := ctx.Client.Outputs.ToggleReplayBuffer()
if err != nil {
return err
}
if status.OutputActive {
fmt.Fprintln(ctx.Out, "Replay buffer started successfully.")
} else {
fmt.Fprintln(ctx.Out, "Replay buffer stopped successfully.")
}
return nil
}
// ReplayBufferStatusCmd retrieves the status of the replay buffer.
type ReplayBufferStatusCmd struct{} // size = 0x0

58
scene_test.go Normal file
View File

@@ -0,0 +1,58 @@
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())
}
}

View File

@@ -8,17 +8,17 @@ import (
// SceneCollectionCmd provides commands to manage scene collections in OBS Studio.
type SceneCollectionCmd struct {
List ListSceneCollectionCmd `help:"List scene collections." cmd:"" aliases:"ls"`
Current CurrentSceneCollectionCmd `help:"Get current scene collection." cmd:"" aliases:"c"`
Switch SwitchSceneCollectionCmd `help:"Switch scene collection." cmd:"" aliases:"sw"`
Create CreateSceneCollectionCmd `help:"Create scene collection." cmd:"" aliases:"new"`
List SceneCollectionListCmd `help:"List scene collections." cmd:"" aliases:"ls"`
Current SceneCollectionCurrentCmd `help:"Get current scene collection." cmd:"" aliases:"c"`
Switch SceneCollectionSwitchCmd `help:"Switch scene collection." cmd:"" aliases:"sw"`
Create SceneCollectionCreateCmd `help:"Create scene collection." cmd:"" aliases:"new"`
}
// ListSceneCollectionCmd provides a command to list all scene collections.
type ListSceneCollectionCmd struct{} // size = 0x0
// SceneCollectionListCmd provides a command to list all scene collections.
type SceneCollectionListCmd struct{} // size = 0x0
// Run executes the command to list all scene collections.
func (cmd *ListSceneCollectionCmd) Run(ctx *context) error {
func (cmd *SceneCollectionListCmd) Run(ctx *context) error {
collections, err := ctx.Client.Config.GetSceneCollectionList()
if err != nil {
return fmt.Errorf("failed to get scene collection list: %w", err)
@@ -31,11 +31,11 @@ func (cmd *ListSceneCollectionCmd) Run(ctx *context) error {
return nil
}
// CurrentSceneCollectionCmd provides a command to get the current scene collection.
type CurrentSceneCollectionCmd struct{} // size = 0x0
// SceneCollectionCurrentCmd provides a command to get the current scene collection.
type SceneCollectionCurrentCmd struct{} // size = 0x0
// Run executes the command to get the current scene collection.
func (cmd *CurrentSceneCollectionCmd) Run(ctx *context) error {
func (cmd *SceneCollectionCurrentCmd) Run(ctx *context) error {
collections, err := ctx.Client.Config.GetSceneCollectionList()
if err != nil {
return fmt.Errorf("failed to get scene collection list: %w", err)
@@ -45,13 +45,13 @@ func (cmd *CurrentSceneCollectionCmd) Run(ctx *context) error {
return nil
}
// SwitchSceneCollectionCmd provides a command to switch to a different scene collection.
type SwitchSceneCollectionCmd struct {
// SceneCollectionSwitchCmd provides a command to switch to a different scene collection.
type SceneCollectionSwitchCmd struct {
Name string `arg:"" help:"Name of the scene collection to switch to." required:""`
}
// Run executes the command to switch to a different scene collection.
func (cmd *SwitchSceneCollectionCmd) Run(ctx *context) error {
func (cmd *SceneCollectionSwitchCmd) Run(ctx *context) error {
collections, err := ctx.Client.Config.GetSceneCollectionList()
if err != nil {
return err
@@ -74,13 +74,13 @@ func (cmd *SwitchSceneCollectionCmd) Run(ctx *context) error {
return nil
}
// CreateSceneCollectionCmd provides a command to create a new scene collection.
type CreateSceneCollectionCmd struct {
// SceneCollectionCreateCmd provides a command to create a new scene collection.
type SceneCollectionCreateCmd struct {
Name string `arg:"" help:"Name of the scene collection to create." required:""`
}
// Run executes the command to create a new scene collection.
func (cmd *CreateSceneCollectionCmd) Run(ctx *context) error {
func (cmd *SceneCollectionCreateCmd) Run(ctx *context) error {
_, err := ctx.Client.Config.CreateSceneCollection(
config.NewCreateSceneCollectionParams().WithSceneCollectionName(cmd.Name),
)

32
sceneitem_test.go Normal file
View File

@@ -0,0 +1,32 @@
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())
}
}

View File

@@ -17,10 +17,22 @@ type StreamStartCmd struct{} // size = 0x0
// Run executes the command to start streaming.
func (cmd *StreamStartCmd) Run(ctx *context) error {
_, err := ctx.Client.Stream.StartStream()
// Check if the stream is already active
status, err := ctx.Client.Stream.GetStreamStatus()
if err != nil {
return err
}
if status.OutputActive {
fmt.Fprintln(ctx.Out, "Stream is already active.")
return nil
}
_, err = ctx.Client.Stream.StartStream()
if err != nil {
return err
}
fmt.Fprintln(ctx.Out, "Streaming started successfully.")
return nil
}
@@ -29,10 +41,22 @@ type StreamStopCmd struct{} // size = 0x0
// Run executes the command to stop streaming.
func (cmd *StreamStopCmd) Run(ctx *context) error {
_, err := ctx.Client.Stream.StopStream()
// Check if the stream is already inactive
status, err := ctx.Client.Stream.GetStreamStatus()
if err != nil {
return err
}
if !status.OutputActive {
fmt.Fprintln(ctx.Out, "Stream is already inactive.")
return nil
}
_, err = ctx.Client.Stream.StopStream()
if err != nil {
return err
}
fmt.Fprintln(ctx.Out, "Streaming stopped successfully.")
return nil
}
@@ -41,19 +65,15 @@ type StreamToggleCmd struct{} // size = 0x0
// Run executes the command to toggle streaming.
func (cmd *StreamToggleCmd) Run(ctx *context) error {
status, err := ctx.Client.Stream.GetStreamStatus()
status, err := ctx.Client.Stream.ToggleStream()
if err != nil {
return err
}
if status.OutputActive {
_, err = ctx.Client.Stream.StopStream()
fmt.Fprintf(ctx.Out, "Stopping stream...\n")
fmt.Fprintln(ctx.Out, "Streaming started successfully.")
} else {
_, err = ctx.Client.Stream.StartStream()
fmt.Fprintf(ctx.Out, "Starting stream...\n")
}
if err != nil {
return err
fmt.Fprintln(ctx.Out, "Streaming stopped successfully.")
}
return nil
}

131
stream_test.go Normal file
View File

@@ -0,0 +1,131 @@
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 err != nil {
t.Fatalf("Failed to start stream: %v", err)
}
time.Sleep(1 * time.Second) // Wait for the stream to start
if active {
if out.String() != "Stream is already active.\n" {
t.Fatalf("Expected 'Stream is already active.', got: %s", out.String())
}
} else {
if out.String() != "Streaming started successfully.\n" {
t.Fatalf("Expected 'Streaming started successfully.', got: %s", out.String())
}
}
}
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 err != nil {
t.Fatalf("Failed to stop stream: %v", err)
}
time.Sleep(1 * time.Second) // Wait for the stream to stop
if active {
if out.String() != "Streaming stopped successfully.\n" {
t.Fatalf("Expected 'Streaming stopped successfully.', got: %s", out.String())
}
} else {
if out.String() != "Stream is already inactive.\n" {
t.Fatalf("Expected 'Stream is already inactive.', got: %s", out.String())
}
}
}
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)
}
time.Sleep(1 * time.Second) // Wait for the stream to toggle
if active {
if out.String() != "Streaming stopped successfully.\n" {
t.Fatalf("Expected 'Streaming stopped successfully.', got: %s", out.String())
}
} else {
if out.String() != "Streaming started successfully.\n" {
t.Fatalf("Expected 'Streaming started successfully.', got: %s", out.String())
}
}
}

View File

@@ -23,6 +23,8 @@ 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
}
@@ -35,6 +37,8 @@ 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
}

68
studiomode_test.go Normal file
View File

@@ -0,0 +1,68 @@
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())
}
}

View File

@@ -6,17 +6,17 @@ import (
// VirtualCamCmd handles the virtual camera commands.
type VirtualCamCmd struct {
Start StartVirtualCamCmd `help:"Start virtual camera." cmd:"" aliases:"s"`
Stop StopVirtualCamCmd `help:"Stop virtual camera." cmd:"" aliases:"st"`
Toggle ToggleVirtualCamCmd `help:"Toggle virtual camera." cmd:"" aliases:"tg"`
Status StatusVirtualCamCmd `help:"Get virtual camera status." cmd:"" aliases:"ss"`
Start VirtualCamStartCmd `help:"Start virtual camera." cmd:"" aliases:"s"`
Stop VirtualCamStopCmd `help:"Stop virtual camera." cmd:"" aliases:"st"`
Toggle VirtualCamToggleCmd `help:"Toggle virtual camera." cmd:"" aliases:"tg"`
Status VirtualCamStatusCmd `help:"Get virtual camera status." cmd:"" aliases:"ss"`
}
// StartVirtualCamCmd starts the virtual camera.
type StartVirtualCamCmd struct{} // size = 0x0
// VirtualCamStartCmd starts the virtual camera.
type VirtualCamStartCmd struct{} // size = 0x0
// Run executes the command to start the virtual camera.
func (c *StartVirtualCamCmd) Run(ctx *context) error {
func (c *VirtualCamStartCmd) Run(ctx *context) error {
_, err := ctx.Client.Outputs.StartVirtualCam()
if err != nil {
return fmt.Errorf("failed to start virtual camera: %w", err)
@@ -25,11 +25,11 @@ func (c *StartVirtualCamCmd) Run(ctx *context) error {
return nil
}
// StopVirtualCamCmd stops the virtual camera.
type StopVirtualCamCmd struct{} // size = 0x0
// VirtualCamStopCmd stops the virtual camera.
type VirtualCamStopCmd struct{} // size = 0x0
// Run executes the command to stop the virtual camera.
func (c *StopVirtualCamCmd) Run(ctx *context) error {
func (c *VirtualCamStopCmd) Run(ctx *context) error {
_, err := ctx.Client.Outputs.StopVirtualCam()
if err != nil {
return fmt.Errorf("failed to stop virtual camera: %w", err)
@@ -38,11 +38,11 @@ func (c *StopVirtualCamCmd) Run(ctx *context) error {
return nil
}
// ToggleVirtualCamCmd toggles the virtual camera.
type ToggleVirtualCamCmd struct{} // size = 0x0
// VirtualCamToggleCmd toggles the virtual camera.
type VirtualCamToggleCmd struct{} // size = 0x0
// Run executes the command to toggle the virtual camera.
func (c *ToggleVirtualCamCmd) Run(ctx *context) error {
func (c *VirtualCamToggleCmd) Run(ctx *context) error {
_, err := ctx.Client.Outputs.ToggleVirtualCam()
if err != nil {
return fmt.Errorf("failed to toggle virtual camera: %w", err)
@@ -50,11 +50,11 @@ func (c *ToggleVirtualCamCmd) Run(ctx *context) error {
return nil
}
// StatusVirtualCamCmd retrieves the status of the virtual camera.
type StatusVirtualCamCmd struct{} // size = 0x0
// VirtualCamStatusCmd retrieves the status of the virtual camera.
type VirtualCamStatusCmd struct{} // size = 0x0
// Run executes the command to get the status of the virtual camera.
func (c *StatusVirtualCamCmd) Run(ctx *context) error {
func (c *VirtualCamStatusCmd) Run(ctx *context) error {
status, err := ctx.Client.Outputs.GetVirtualCamStatus()
if err != nil {
return fmt.Errorf("failed to get virtual camera status: %w", err)