mirror of
https://github.com/onyx-and-iris/gobs-cli.git
synced 2026-04-18 07:03:37 +00:00
Compare commits
7 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 8f1d42b677 | |||
| 620adf7e98 | |||
| 4a7b8a074a | |||
| 0811d711aa | |||
| 306f19eeae | |||
| 43dd77ffdc | |||
| f94ac1ca0c |
10
CHANGELOG.md
10
CHANGELOG.md
@@ -5,6 +5,16 @@ 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
|
||||
|
||||
|
||||
13
README.md
13
README.md
@@ -281,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.
|
||||
|
||||
@@ -9,6 +9,7 @@ import (
|
||||
"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"
|
||||
)
|
||||
|
||||
@@ -130,4 +131,6 @@ func teardown(client *goobs.Client) {
|
||||
client.Stream.StopStream()
|
||||
client.Record.StopRecord()
|
||||
client.Outputs.StopReplayBuffer()
|
||||
client.Ui.SetStudioModeEnabled(ui.NewSetStudioModeEnabledParams().
|
||||
WithStudioModeEnabled(false))
|
||||
}
|
||||
|
||||
69
record.go
69
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.
|
||||
@@ -19,7 +22,19 @@ type RecordStartCmd struct{} // size = 0x0
|
||||
|
||||
// Run executes the command to start recording.
|
||||
func (cmd *RecordStartCmd) Run(ctx *context) error {
|
||||
_, err := ctx.Client.Record.StartRecord()
|
||||
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()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@@ -32,11 +47,20 @@ type RecordStopCmd struct{} // size = 0x0
|
||||
|
||||
// Run executes the command to stop recording.
|
||||
func (cmd *RecordStopCmd) Run(ctx *context) error {
|
||||
_, err := ctx.Client.Record.StopRecord()
|
||||
status, err := ctx.Client.Record.GetRecordStatus()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
fmt.Fprintln(ctx.Out, "Recording stopped successfully.")
|
||||
|
||||
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))
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -132,3 +156,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,11 +2,12 @@ package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
func TestRecordStartStatusStop(t *testing.T) {
|
||||
func TestRecordStart(t *testing.T) {
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
@@ -16,51 +17,80 @@ func TestRecordStartStatusStop(t *testing.T) {
|
||||
Out: &out,
|
||||
}
|
||||
|
||||
cmdStart := &RecordStartCmd{}
|
||||
err := cmdStart.Run(context)
|
||||
cmdStatus := &RecordStatusCmd{}
|
||||
err := cmdStatus.Run(context)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to start recording: %v", err)
|
||||
t.Fatalf("Failed to get recording status: %v", err)
|
||||
}
|
||||
if out.String() != "Recording started successfully.\n" {
|
||||
t.Fatalf("Expected output to be 'Recording started successfully.', got '%s'", out.String())
|
||||
var active bool
|
||||
if out.String() == "Recording is in progress.\n" {
|
||||
active = true
|
||||
}
|
||||
// Reset output buffer for the next command
|
||||
out.Reset()
|
||||
|
||||
time.Sleep(1 * time.Second) // Wait for a second to ensure recording has started
|
||||
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)
|
||||
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())
|
||||
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 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())
|
||||
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) {
|
||||
|
||||
14
stream.go
14
stream.go
@@ -23,8 +23,7 @@ func (cmd *StreamStartCmd) Run(ctx *context) error {
|
||||
return err
|
||||
}
|
||||
if status.OutputActive {
|
||||
fmt.Fprintln(ctx.Out, "Stream is already active.")
|
||||
return nil
|
||||
return fmt.Errorf("stream is already in progress")
|
||||
}
|
||||
|
||||
_, err = ctx.Client.Stream.StartStream()
|
||||
@@ -32,7 +31,7 @@ func (cmd *StreamStartCmd) Run(ctx *context) error {
|
||||
return err
|
||||
}
|
||||
|
||||
fmt.Fprintln(ctx.Out, "Streaming started successfully.")
|
||||
fmt.Fprintln(ctx.Out, "Stream started successfully.")
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -47,8 +46,7 @@ func (cmd *StreamStopCmd) Run(ctx *context) error {
|
||||
return err
|
||||
}
|
||||
if !status.OutputActive {
|
||||
fmt.Fprintln(ctx.Out, "Stream is already inactive.")
|
||||
return nil
|
||||
return fmt.Errorf("stream is not in progress")
|
||||
}
|
||||
|
||||
_, err = ctx.Client.Stream.StopStream()
|
||||
@@ -56,7 +54,7 @@ func (cmd *StreamStopCmd) Run(ctx *context) error {
|
||||
return err
|
||||
}
|
||||
|
||||
fmt.Fprintln(ctx.Out, "Streaming stopped successfully.")
|
||||
fmt.Fprintln(ctx.Out, "Stream stopped successfully.")
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -71,9 +69,9 @@ func (cmd *StreamToggleCmd) Run(ctx *context) error {
|
||||
}
|
||||
|
||||
if status.OutputActive {
|
||||
fmt.Fprintln(ctx.Out, "Streaming started successfully.")
|
||||
fmt.Fprintln(ctx.Out, "Stream started successfully.")
|
||||
} else {
|
||||
fmt.Fprintln(ctx.Out, "Streaming stopped successfully.")
|
||||
fmt.Fprintln(ctx.Out, "Stream stopped successfully.")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -31,21 +31,22 @@ func TestStreamStart(t *testing.T) {
|
||||
|
||||
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)
|
||||
}
|
||||
|
||||
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())
|
||||
}
|
||||
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) {
|
||||
@@ -72,21 +73,22 @@ func TestStreamStop(t *testing.T) {
|
||||
|
||||
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)
|
||||
}
|
||||
|
||||
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())
|
||||
}
|
||||
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) {
|
||||
@@ -117,15 +119,14 @@ func TestStreamToggle(t *testing.T) {
|
||||
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())
|
||||
if out.String() != "Stream stopped successfully.\n" {
|
||||
t.Fatalf("Expected 'Stream stopped successfully.', got: %s", out.String())
|
||||
}
|
||||
} else {
|
||||
if out.String() != "Streaming started successfully.\n" {
|
||||
t.Fatalf("Expected 'Streaming started successfully.', got: %s", out.String())
|
||||
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
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user