add 0.8.2 to CHANGELOG

rename --parent option to --group

CHANGELOG.md

@@ -5,6 +5,17 @@ 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.2]
+
+### Added
+
+-   record start/stop and stream start/stop commands check outputActive states first. 
+    -   Errors are returned if the command cannot be performed.
+
+### Changed
+
+-   The --parent flag for the sceneitem commands has been renamed to --group, see [SceneItemCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#sceneitemcmd)
+
 # [0.8.0] - 2025-05-27
 
 ### Added

README.md

@@ -94,7 +94,7 @@ gobs-cli sceneitem list LIVE
     -   flags:
 
         *optional*
-        -   --parent: Parent group name.
+        -   --group: Parent group name.
     -   args: SceneName ItemName
 
 ```console
@@ -105,7 +105,7 @@ gobs-cli sceneitem show START "Colour Source"
     -   flags:
 
         *optional*
-        -   --parent: Parent group name.
+        -   --group: Parent group name.
     -   args: SceneName ItemName
 
 ```console
@@ -116,29 +116,29 @@ gobs-cli sceneitem hide START "Colour Source"
     -   flags:
 
         *optional*
-        -   --parent: Parent group name.
+        -   --group: Parent group name.
     -   args: SceneName ItemName
 
 ```console
-gobs-cli sceneitem toggle --parent=test_group START "Colour Source 3"
+gobs-cli sceneitem toggle --group=test_group START "Colour Source 3"
 ```
 
 -   visible: Get scene item visibility.
     -   flags:
 
         *optional*
-        -   --parent: Parent group name.
+        -   --group: Parent group name.
     -   args: SceneName ItemName
 
 ```console
-gobs-cli sceneitem visible --parent=test_group START "Colour Source 4"
+gobs-cli sceneitem visible --group=test_group START "Colour Source 4"
 ```
 
 -   transform: Transform scene item.
     -   flags:
         
         *optional*
-        -   --parent: Parent group name.
+        -   --group: Parent group name.
 
         -   --alignment: Alignment of the scene item.
         -   --bounds-alignment: Bounds alignment of the scene item.

main_test.go

@@ -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))
 }

record.go

@@ -22,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
 	}
@@ -35,6 +47,15 @@ type RecordStopCmd struct{} // size = 0x0
 
 // Run executes the command to stop recording.
 func (cmd *RecordStopCmd) Run(ctx *context) error {
+	status, err := ctx.Client.Record.GetRecordStatus()
+	if err != nil {
+		return err
+	}
+
+	if !status.OutputActive {
+		return fmt.Errorf("recording is not in progress")
+	}
+
 	resp, err := ctx.Client.Record.StopRecord()
 	if err != nil {
 		return err

record_test.go

@@ -7,7 +7,7 @@ import (
 	"time"
 )
 
-func TestRecordStartStatusStop(t *testing.T) {
+func TestRecordStart(t *testing.T) {
 	client, disconnect := getClient(t)
 	defer disconnect()
 
@@ -17,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 !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
-	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) {

sceneitem.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"fmt"
+	"sort"
 
 	"github.com/andreykaipov/goobs"
 	"github.com/andreykaipov/goobs/api/requests/sceneitems"
@@ -46,31 +47,57 @@ func (cmd *SceneItemListCmd) Run(ctx *context) error {
 
 	t := table.New(ctx.Out)
 	t.SetPadding(3)
-	t.SetAlignment(table.AlignLeft)
-	t.SetHeaders("Item Name")
+	t.SetAlignment(table.AlignCenter, table.AlignLeft, table.AlignCenter, table.AlignCenter)
+	t.SetHeaders("Item ID", "Item Name", "In Group", "Enabled")
+
+	sort.Slice(resp.SceneItems, func(i, j int) bool {
+		return resp.SceneItems[i].SceneItemID < resp.SceneItems[j].SceneItemID
+	})
 
 	for _, item := range resp.SceneItems {
-		t.AddRow(item.SourceName)
+		if item.IsGroup {
+			resp, err := ctx.Client.SceneItems.GetGroupSceneItemList(sceneitems.NewGetGroupSceneItemListParams().
+				WithSceneName(item.SourceName))
+			if err != nil {
+				return fmt.Errorf("failed to get group scene item list for '%s': %w", item.SourceName, err)
+			}
+
+			sort.Slice(resp.SceneItems, func(i, j int) bool {
+				return resp.SceneItems[i].SceneItemID < resp.SceneItems[j].SceneItemID
+			})
+
+			for _, groupItem := range resp.SceneItems {
+				t.AddRow(
+					fmt.Sprintf("%d", groupItem.SceneItemID),
+					groupItem.SourceName,
+					item.SourceName,
+					fmt.Sprintf("%t", item.SceneItemEnabled && groupItem.SceneItemEnabled),
+				)
+			}
+		} else {
+			t.AddRow(fmt.Sprintf("%d", item.SceneItemID), item.SourceName, "", fmt.Sprintf("%t", item.SceneItemEnabled))
+		}
 	}
 	t.Render()
 	return nil
 }
 
+// getSceneNameAndItemID retrieves the scene name and item ID for a given item in a scene or group.
 func getSceneNameAndItemID(
 	client *goobs.Client,
 	sceneName string,
 	itemName string,
-	parent string,
+	group string,
 ) (string, int, error) {
-	if parent != "" {
+	if group != "" {
 		resp, err := client.SceneItems.GetGroupSceneItemList(sceneitems.NewGetGroupSceneItemListParams().
-			WithSceneName(parent))
+			WithSceneName(group))
 		if err != nil {
 			return "", 0, err
 		}
 		for _, item := range resp.SceneItems {
 			if item.SourceName == itemName {
-				return parent, int(item.SceneItemID), nil
+				return group, int(item.SceneItemID), nil
 			}
 		}
 		return "", 0, fmt.Errorf("item '%s' not found in scene '%s'", itemName, sceneName)
@@ -87,7 +114,7 @@ func getSceneNameAndItemID(
 
 // SceneItemShowCmd provides a command to show a scene item.
 type SceneItemShowCmd struct {
-	Parent string `flag:"" help:"Parent group name."`
+	Group string `flag:"" help:"Parent group name."`
 
 	SceneName string `arg:"" help:"Scene name."`
 	ItemName  string `arg:"" help:"Item name."`
@@ -95,7 +122,7 @@ type SceneItemShowCmd struct {
 
 // Run executes the command to show a scene item.
 func (cmd *SceneItemShowCmd) Run(ctx *context) error {
-	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Parent)
+	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group)
 	if err != nil {
 		return err
 	}
@@ -108,8 +135,8 @@ func (cmd *SceneItemShowCmd) Run(ctx *context) error {
 		return err
 	}
 
-	if cmd.Parent != "" {
-		fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' is now visible.\n", cmd.ItemName, cmd.Parent)
+	if cmd.Group != "" {
+		fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' is now visible.\n", cmd.ItemName, cmd.Group)
 	} else {
 		fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' is now visible.\n", cmd.ItemName, cmd.SceneName)
 	}
@@ -119,7 +146,7 @@ func (cmd *SceneItemShowCmd) Run(ctx *context) error {
 
 // SceneItemHideCmd provides a command to hide a scene item.
 type SceneItemHideCmd struct {
-	Parent string `flag:"" help:"Parent group name."`
+	Group string `flag:"" help:"Parent group name."`
 
 	SceneName string `arg:"" help:"Scene name."`
 	ItemName  string `arg:"" help:"Item name."`
@@ -127,7 +154,7 @@ type SceneItemHideCmd struct {
 
 // Run executes the command to hide a scene item.
 func (cmd *SceneItemHideCmd) Run(ctx *context) error {
-	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Parent)
+	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group)
 	if err != nil {
 		return err
 	}
@@ -140,8 +167,8 @@ func (cmd *SceneItemHideCmd) Run(ctx *context) error {
 		return err
 	}
 
-	if cmd.Parent != "" {
-		fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' is now hidden.\n", cmd.ItemName, cmd.Parent)
+	if cmd.Group != "" {
+		fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' is now hidden.\n", cmd.ItemName, cmd.Group)
 	} else {
 		fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' is now hidden.\n", cmd.ItemName, cmd.SceneName)
 	}
@@ -162,7 +189,7 @@ func getItemEnabled(client *goobs.Client, sceneName string, itemID int) (bool, e
 
 // SceneItemToggleCmd provides a command to toggle the visibility of a scene item.
 type SceneItemToggleCmd struct {
-	Parent string `flag:"" help:"Parent group name."`
+	Group string `flag:"" help:"Parent group name."`
 
 	SceneName string `arg:"" help:"Scene name."`
 	ItemName  string `arg:"" help:"Item name."`
@@ -170,7 +197,7 @@ type SceneItemToggleCmd struct {
 
 // Run executes the command to toggle the visibility of a scene item.
 func (cmd *SceneItemToggleCmd) Run(ctx *context) error {
-	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Parent)
+	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group)
 	if err != nil {
 		return err
 	}
@@ -199,7 +226,7 @@ func (cmd *SceneItemToggleCmd) Run(ctx *context) error {
 
 // SceneItemVisibleCmd provides a command to check the visibility of a scene item.
 type SceneItemVisibleCmd struct {
-	Parent string `flag:"" help:"Parent group name."`
+	Group string `flag:"" help:"Parent group name."`
 
 	SceneName string `arg:"" help:"Scene name."`
 	ItemName  string `arg:"" help:"Item name."`
@@ -207,7 +234,7 @@ type SceneItemVisibleCmd struct {
 
 // Run executes the command to check the visibility of a scene item.
 func (cmd *SceneItemVisibleCmd) Run(ctx *context) error {
-	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Parent)
+	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group)
 	if err != nil {
 		return err
 	}
@@ -230,7 +257,7 @@ type SceneItemTransformCmd struct {
 	SceneName string `arg:"" help:"Scene name."`
 	ItemName  string `arg:"" help:"Item name."`
 
-	Parent string `flag:"" help:"Parent group name."`
+	Group string `flag:"" help:"Parent group name."`
 
 	Alignment       float64 `flag:"" help:"Alignment of the scene item."`
 	BoundsAlignment float64 `flag:"" help:"Bounds alignment of the scene item."`
@@ -251,7 +278,7 @@ type SceneItemTransformCmd struct {
 
 // Run executes the command to transform a scene item.
 func (cmd *SceneItemTransformCmd) Run(ctx *context) error {
-	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Parent)
+	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group)
 	if err != nil {
 		return err
 	}
@@ -323,8 +350,8 @@ func (cmd *SceneItemTransformCmd) Run(ctx *context) error {
 		return err
 	}
 
-	if cmd.Parent != "" {
-		fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' transformed.\n", cmd.ItemName, cmd.Parent)
+	if cmd.Group != "" {
+		fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' transformed.\n", cmd.ItemName, cmd.Group)
 	} else {
 		fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' transformed.\n", cmd.ItemName, cmd.SceneName)
 	}

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
 }

stream_test.go

@@ -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
 }