Compare commits

...

7 Commits

10 changed files with 150 additions and 77 deletions

View File

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

View File

@ -5,6 +5,12 @@ 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/), 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). 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 # [0.3.1] - 2025-05-02
### Added ### Added

View File

@ -373,6 +373,12 @@ gobs-cli replaybuffer start
gobs-cli replaybuffer stop gobs-cli replaybuffer stop
``` ```
- toggle: Toggle replay buffer.
```console
gobs-cli replaybuffer toggle
```
- status: Get replay buffer status. - status: Get replay buffer status.
```console ```console

View File

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

View File

@ -6,11 +6,12 @@ import (
// RecordCmd handles the recording commands. // RecordCmd handles the recording commands.
type RecordCmd struct { type RecordCmd struct {
Start RecordStartCmd `cmd:"" help:"Start recording." aliases:"s"` Start RecordStartCmd `cmd:"" help:"Start recording." aliases:"s"`
Stop RecordStopCmd `cmd:"" help:"Stop recording." aliases:"st"` Stop RecordStopCmd `cmd:"" help:"Stop recording." aliases:"st"`
Toggle RecordToggleCmd `cmd:"" help:"Toggle recording." aliases:"tg"` Toggle RecordToggleCmd `cmd:"" help:"Toggle recording." aliases:"tg"`
Pause RecordPauseCmd `cmd:"" help:"Pause recording." aliases:"p"` Status RecordStatusCmd `cmd:"" help:"Show recording status." aliases:"ss"`
Resume RecordResumeCmd `cmd:"" help:"Resume recording." aliases:"r"` Pause RecordPauseCmd `cmd:"" help:"Pause recording." aliases:"p"`
Resume RecordResumeCmd `cmd:"" help:"Resume recording." aliases:"r"`
} }
// RecordStartCmd starts the recording. // RecordStartCmd starts the recording.
@ -44,25 +45,39 @@ type RecordToggleCmd struct{} // size = 0x0
// Run executes the command to toggle recording. // Run executes the command to toggle recording.
func (cmd *RecordToggleCmd) Run(ctx *context) error { 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() status, err := ctx.Client.Record.GetRecordStatus()
if err != nil { if err != nil {
return err return err
} }
if status.OutputActive { if status.OutputActive {
_, err = ctx.Client.Record.StopRecord() if status.OutputPaused {
if err != nil { fmt.Fprintln(ctx.Out, "Recording is paused.")
return err } else {
fmt.Fprintln(ctx.Out, "Recording is in progress.")
} }
fmt.Fprintln(ctx.Out, "Recording stopped successfully.")
} else { } else {
_, err = ctx.Client.Record.StartRecord() fmt.Fprintln(ctx.Out, "Recording is not in progress.")
if err != nil {
return err
}
fmt.Fprintln(ctx.Out, "Recording started successfully.")
} }
return nil return nil
} }

View File

@ -8,6 +8,7 @@ import (
type ReplayBufferCmd struct { type ReplayBufferCmd struct {
Start ReplayBufferStartCmd `help:"Start replay buffer." cmd:"" aliases:"s"` Start ReplayBufferStartCmd `help:"Start replay buffer." cmd:"" aliases:"s"`
Stop ReplayBufferStopCmd `help:"Stop replay buffer." cmd:"" aliases:"st"` 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"` Status ReplayBufferStatusCmd `help:"Get replay buffer status." cmd:"" aliases:"ss"`
Save ReplayBufferSaveCmd `help:"Save replay buffer." cmd:"" aliases:"sv"` Save ReplayBufferSaveCmd `help:"Save replay buffer." cmd:"" aliases:"sv"`
} }
@ -30,6 +31,24 @@ func (cmd *ReplayBufferStopCmd) Run(ctx *context) error {
return err 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. // ReplayBufferStatusCmd retrieves the status of the replay buffer.
type ReplayBufferStatusCmd struct{} // size = 0x0 type ReplayBufferStatusCmd struct{} // size = 0x0

View File

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

View File

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

View File

@ -23,6 +23,8 @@ func (cmd *StudioModeEnableCmd) Run(ctx *context) error {
if err != nil { if err != nil {
return fmt.Errorf("failed to enable studio mode: %w", err) return fmt.Errorf("failed to enable studio mode: %w", err)
} }
fmt.Fprintln(ctx.Out, "Studio mode is now enabled")
return nil return nil
} }
@ -35,6 +37,8 @@ func (cmd *StudioModeDisableCmd) Run(ctx *context) error {
if err != nil { if err != nil {
return fmt.Errorf("failed to disable studio mode: %w", err) return fmt.Errorf("failed to disable studio mode: %w", err)
} }
fmt.Fprintln(ctx.Out, "Studio mode is now disabled")
return nil return nil
} }

View File

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