mirror of
https://github.com/onyx-and-iris/gobs-cli.git
synced 2026-01-02 03:57:51 +00:00
Compare commits
21 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 1cf983a647 | |||
| dbc26bf6ff | |||
| 101c7552b2 | |||
| 1c0ef025c1 | |||
| 2b7b8e0bd5 | |||
| 040ece840c | |||
| c6406888a9 | |||
| f65af8298d | |||
| 1dfb6f87ac | |||
| 866aedde7c | |||
| 9eb6c8a282 | |||
| eb30cae5b7 | |||
| e6c03a2c92 | |||
| f6b82383f9 | |||
| 55f3b0c981 | |||
| 7da80a1ad2 | |||
| ea4ca2aeb9 | |||
| d2f0a64180 | |||
| f01fd0ca84 | |||
| 10d50df445 | |||
| 06cefe58ed |
24
CHANGELOG.md
24
CHANGELOG.md
@ -5,6 +5,30 @@ 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.14.1] - 2025-07-14
|
||||
|
||||
### Added
|
||||
|
||||
- text command group, see [TextCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#textcmd)
|
||||
|
||||
# [0.13.3] - 2025-06-27
|
||||
|
||||
### Changed
|
||||
|
||||
- usage is now printed on errors.
|
||||
- help is printed in compact mode. This should make it easier to page through help on the root command.
|
||||
|
||||
### Fixed
|
||||
|
||||
- Item ID alignment in sceneitem list table.
|
||||
|
||||
# [0.13.0] - 2025-06-23
|
||||
|
||||
### Added
|
||||
|
||||
- record split and record chapter commands, see [RecordCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#recordcmd)
|
||||
- As of OBS 30.2.0, the only file format supporting *record chapter* is Hybrid MP4.
|
||||
|
||||
# [0.12.1] - 2025-06-21
|
||||
|
||||
### Added
|
||||
|
||||
99
README.md
99
README.md
@ -4,6 +4,16 @@ A command line interface for OBS Websocket v5
|
||||
|
||||
For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
|
||||
|
||||
-----
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Installation](#installation)
|
||||
- [Configuration](#configuration)
|
||||
- [Style](#style)
|
||||
- [Commands](#commands)
|
||||
- [License](#license)
|
||||
|
||||
## Installation
|
||||
|
||||
```console
|
||||
@ -40,6 +50,36 @@ OBS_PASSWORD=<websocket password>
|
||||
OBS_TIMEOUT=5
|
||||
```
|
||||
|
||||
## Style
|
||||
|
||||
Styling is opt-in, by default you will get a colourless output:
|
||||
|
||||

|
||||
|
||||
You may enable styling with the --style/-s flag:
|
||||
|
||||
```console
|
||||
gobs-cli --style="red" sceneitem list
|
||||
```
|
||||
|
||||
Available styles: _red, magenta, purple, blue, cyan, green, yellow, orange, white, grey, navy, black_
|
||||
|
||||

|
||||
|
||||
Optionally you may disable border colouring with the --no-border flag:
|
||||
|
||||

|
||||
|
||||
```console
|
||||
gobs-cli --style="red" --no-border sceneitem list
|
||||
```
|
||||
|
||||
Or with environment variables:
|
||||
|
||||
```env
|
||||
GOBS_STYLE=red
|
||||
GOBS_STYLE_NO_BORDER=true
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
@ -262,6 +302,22 @@ gobs-cli input unmute "Mic/Aux"
|
||||
gobs-cli input toggle "Mic/Aux"
|
||||
```
|
||||
|
||||
### TextCmd
|
||||
|
||||
- current: Display current text for a text input.
|
||||
- args: InputName
|
||||
|
||||
```console
|
||||
gobs-cli text current "My Text Input"
|
||||
```
|
||||
|
||||
- update: Update the text of a text input.
|
||||
- args: InputName NewText
|
||||
|
||||
```console
|
||||
gobs-cli text update "My Text Input" "hi OBS!"
|
||||
```
|
||||
|
||||
### RecordCmd
|
||||
|
||||
- start: Start recording.
|
||||
@ -313,6 +369,21 @@ gobs-cli record directory "/home/me/obs-vids/"
|
||||
gobs-cli record directory "C:/Users/me/Videos"
|
||||
```
|
||||
|
||||
- split: Split recording.
|
||||
|
||||
```console
|
||||
gobs-cli record split
|
||||
```
|
||||
|
||||
- chapter: Create a chapter in the recording.
|
||||
|
||||
*optional*
|
||||
- arg: ChapterName
|
||||
|
||||
```console
|
||||
gobs-cli record chapter "Chapter Name"
|
||||
```
|
||||
|
||||
### StreamCmd
|
||||
|
||||
- start: Start streaming.
|
||||
@ -606,33 +677,9 @@ gobs-cli projector open --monitor-index=1 "test_group"
|
||||
gobs-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\screenshot.png"
|
||||
```
|
||||
|
||||
## Style
|
||||
## License
|
||||
|
||||
By default styling is disabled but you may enable and configure it in the following ways:
|
||||
|
||||
- --style/-s: Style used in output.
|
||||
- GOBS_STYLE
|
||||
- --no-border/-b: Disable table border styling in output.
|
||||
- GOBS_STYLE_NO_BORDER
|
||||
|
||||
Available styles:
|
||||
|
||||
- red
|
||||
- magenta
|
||||
- purple
|
||||
- blue
|
||||
- cyan
|
||||
- green
|
||||
- yellow
|
||||
- orange
|
||||
- white
|
||||
- grey
|
||||
- navy
|
||||
- black
|
||||
|
||||
```console
|
||||
gobs-cli --style=cyan --no-border scene list
|
||||
```
|
||||
`gobs-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
|
||||
|
||||
|
||||
[userconfigdir]: https://pkg.go.dev/os#UserConfigDir
|
||||
|
||||
@ -22,6 +22,7 @@ tasks:
|
||||
cmds:
|
||||
- task: build-windows
|
||||
- task: build-linux
|
||||
- task: build-macos
|
||||
|
||||
vet:
|
||||
desc: Vet the code
|
||||
@ -46,6 +47,12 @@ tasks:
|
||||
- GOOS=linux GOARCH=amd64 go build -ldflags "-X 'main.version={{.VERSION}}'" -o {{.BIN_DIR}}/{{.PROGRAM}}_linux_amd64
|
||||
internal: true
|
||||
|
||||
build-macos:
|
||||
desc: Build the gobs-cli project for macOS
|
||||
cmds:
|
||||
- GOOS=darwin GOARCH=amd64 go build -ldflags "-X 'main.version={{.VERSION}}'" -o {{.BIN_DIR}}/{{.PROGRAM}}_darwin_amd64
|
||||
internal: true
|
||||
|
||||
test:
|
||||
desc: Run tests
|
||||
cmds:
|
||||
|
||||
@ -33,7 +33,7 @@ func TestFilterListScene(t *testing.T) {
|
||||
context := newContext(client, &out, StyleConfig{})
|
||||
|
||||
cmd := &FilterListCmd{
|
||||
SourceName: "gobs-test",
|
||||
SourceName: "gobs-test-scene",
|
||||
}
|
||||
err := cmd.Run(context)
|
||||
if err != nil {
|
||||
|
||||
@ -2,11 +2,20 @@ package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func skipIfSkipGroupTests(t *testing.T) {
|
||||
if os.Getenv("GOBS_TEST_SKIP_GROUP_TESTS") != "" {
|
||||
t.Skip("Skipping group tests due to GOBS_TEST_SKIP_GROUP_TESTS environment variable")
|
||||
}
|
||||
}
|
||||
|
||||
func TestGroupList(t *testing.T) {
|
||||
skipIfSkipGroupTests(t)
|
||||
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
@ -26,6 +35,8 @@ func TestGroupList(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestGroupShow(t *testing.T) {
|
||||
skipIfSkipGroupTests(t)
|
||||
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
@ -46,6 +57,8 @@ func TestGroupShow(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestGroupToggle(t *testing.T) {
|
||||
skipIfSkipGroupTests(t)
|
||||
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
@ -87,6 +100,8 @@ func TestGroupToggle(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestGroupStatus(t *testing.T) {
|
||||
skipIfSkipGroupTests(t)
|
||||
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
|
||||
BIN
img/coloured-border.png
Executable file
BIN
img/coloured-border.png
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 6.1 KiB |
BIN
img/coloured-no-border.png
Executable file
BIN
img/coloured-no-border.png
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 6.1 KiB |
BIN
img/colourless.png
Executable file
BIN
img/colourless.png
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 4.6 KiB |
@ -22,9 +22,8 @@ func TestInputList(t *testing.T) {
|
||||
expectedInputs := []string{
|
||||
"Desktop Audio",
|
||||
"Mic/Aux",
|
||||
"Colour Source",
|
||||
"Colour Source 2",
|
||||
"Colour Source 3",
|
||||
"gobs-test-input",
|
||||
"gobs-test-input-2",
|
||||
}
|
||||
output := out.String()
|
||||
for _, input := range expectedInputs {
|
||||
@ -52,9 +51,8 @@ func TestInputListFilterInput(t *testing.T) {
|
||||
}
|
||||
expectedFilteredOut := []string{
|
||||
"Desktop Audio",
|
||||
"Colour Source",
|
||||
"Colour Source 2",
|
||||
"Colour Source 3",
|
||||
"gobs-test-input",
|
||||
"gobs-test-input-2",
|
||||
}
|
||||
for _, input := range expectedInputs {
|
||||
if !strings.Contains(out.String(), input) {
|
||||
@ -86,9 +84,8 @@ func TestInputListFilterOutput(t *testing.T) {
|
||||
}
|
||||
expectedFilteredOut := []string{
|
||||
"Mic/Aux",
|
||||
"Colour Source",
|
||||
"Colour Source 2",
|
||||
"Colour Source 3",
|
||||
"gobs-test-input",
|
||||
"gobs-test-input-2",
|
||||
}
|
||||
for _, input := range expectedInputs {
|
||||
if !strings.Contains(out.String(), input) {
|
||||
@ -116,9 +113,8 @@ func TestInputListFilterColour(t *testing.T) {
|
||||
}
|
||||
|
||||
expectedInputs := []string{
|
||||
"Colour Source",
|
||||
"Colour Source 2",
|
||||
"Colour Source 3",
|
||||
"gobs-test-input",
|
||||
"gobs-test-input-2",
|
||||
}
|
||||
for _, input := range expectedInputs {
|
||||
if !strings.Contains(out.String(), input) {
|
||||
|
||||
37
main.go
37
main.go
@ -8,6 +8,8 @@ import (
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"runtime/debug"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/alecthomas/kong"
|
||||
@ -16,6 +18,19 @@ import (
|
||||
kongdotenv "github.com/titusjaka/kong-dotenv-go"
|
||||
)
|
||||
|
||||
var version string // Version of the CLI, set at build time.
|
||||
|
||||
// VersionFlag is a custom flag type that prints the version and exits.
|
||||
type VersionFlag string
|
||||
|
||||
func (v VersionFlag) Decode(_ *kong.DecodeContext) error { return nil } // nolint: revive
|
||||
func (v VersionFlag) IsBool() bool { return true } // nolint: revive
|
||||
func (v VersionFlag) BeforeApply(app *kong.Kong, vars kong.Vars) error { // nolint: revive, unparam
|
||||
fmt.Printf("gobs-cli version: %s\n", vars["version"])
|
||||
app.Exit(0)
|
||||
return nil
|
||||
}
|
||||
|
||||
// ObsConfig holds the configuration for connecting to the OBS WebSocket server.
|
||||
type ObsConfig struct {
|
||||
Host string `flag:"host" help:"Host to connect to." default:"localhost" env:"OBS_HOST" short:"H"`
|
||||
@ -31,7 +46,7 @@ type StyleConfig struct {
|
||||
}
|
||||
|
||||
// CLI is the main command line interface structure.
|
||||
// It embeds the ObsConfig struct to inherit its fields and flags.
|
||||
// It embeds ObsConfig and StyleConfig to provide configuration options.
|
||||
type CLI struct {
|
||||
ObsConfig `embed:"" help:"OBS WebSocket configuration."`
|
||||
StyleConfig `embed:"" help:"Style configuration."`
|
||||
@ -44,6 +59,7 @@ type CLI struct {
|
||||
Sceneitem SceneItemCmd `help:"Manage scene items." cmd:"" aliases:"si" group:"Scene Item"`
|
||||
Group GroupCmd `help:"Manage groups." cmd:"" aliases:"g" group:"Group"`
|
||||
Input InputCmd `help:"Manage inputs." cmd:"" aliases:"i" group:"Input"`
|
||||
Text TextCmd `help:"Manage text inputs." cmd:"" aliases:"t" group:"Text Input"`
|
||||
Record RecordCmd `help:"Manage recording." cmd:"" aliases:"rec" group:"Recording"`
|
||||
Stream StreamCmd `help:"Manage streaming." cmd:"" aliases:"st" group:"Streaming"`
|
||||
Scenecollection SceneCollectionCmd `help:"Manage scene collections." cmd:"" aliases:"scn" group:"Scene Collection"`
|
||||
@ -81,10 +97,25 @@ func main() {
|
||||
var cli CLI
|
||||
ctx := kong.Parse(
|
||||
&cli,
|
||||
kong.Name("GOBS-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")),
|
||||
)
|
||||
kong.UsageOnError(),
|
||||
kong.ConfigureHelp(kong.HelpOptions{
|
||||
Compact: true,
|
||||
}),
|
||||
kong.Vars{
|
||||
"version": func() string {
|
||||
if version == "" {
|
||||
info, ok := debug.ReadBuildInfo()
|
||||
if !ok {
|
||||
return "(unable to read build info)"
|
||||
}
|
||||
version = strings.Split(info.Main.Version, "-")[0]
|
||||
}
|
||||
return version
|
||||
}(),
|
||||
})
|
||||
|
||||
client, err := connectObs(cli.ObsConfig)
|
||||
ctx.FatalIfErrorf(err)
|
||||
|
||||
64
main_test.go
64
main_test.go
@ -2,7 +2,9 @@ package main
|
||||
|
||||
import (
|
||||
"os"
|
||||
"runtime"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/andreykaipov/goobs"
|
||||
"github.com/andreykaipov/goobs/api/requests/config"
|
||||
@ -62,13 +64,23 @@ func setup(client *goobs.Client) {
|
||||
Key: os.Getenv("OBS_STREAM_KEY"),
|
||||
}))
|
||||
|
||||
client.Config.SetCurrentSceneCollection(config.NewSetCurrentSceneCollectionParams().
|
||||
WithSceneCollectionName("test-collection"))
|
||||
client.Config.CreateProfile(config.NewCreateProfileParams().
|
||||
WithProfileName("gobs-test-profile"))
|
||||
time.Sleep(100 * time.Millisecond) // Wait for the profile to be created
|
||||
client.Config.SetProfileParameter(config.NewSetProfileParameterParams().
|
||||
WithParameterCategory("SimpleOutput").
|
||||
WithParameterName("RecRB").
|
||||
WithParameterValue("true"))
|
||||
// hack to ensure the Replay Buffer setting is applied
|
||||
client.Config.SetCurrentProfile(config.NewSetCurrentProfileParams().
|
||||
WithProfileName("Untitled"))
|
||||
client.Config.SetCurrentProfile(config.NewSetCurrentProfileParams().
|
||||
WithProfileName("gobs-test-profile"))
|
||||
|
||||
client.Scenes.CreateScene(scenes.NewCreateSceneParams().
|
||||
WithSceneName("gobs-test"))
|
||||
WithSceneName("gobs-test-scene"))
|
||||
client.Inputs.CreateInput(inputs.NewCreateInputParams().
|
||||
WithSceneName("gobs-test").
|
||||
WithSceneName("gobs-test-scene").
|
||||
WithInputName("gobs-test-input").
|
||||
WithInputKind("color_source_v3").
|
||||
WithInputSettings(map[string]any{
|
||||
@ -79,7 +91,7 @@ func setup(client *goobs.Client) {
|
||||
}).
|
||||
WithSceneItemEnabled(true))
|
||||
client.Inputs.CreateInput(inputs.NewCreateInputParams().
|
||||
WithSceneName("gobs-test").
|
||||
WithSceneName("gobs-test-scene").
|
||||
WithInputName("gobs-test-input-2").
|
||||
WithInputKind("color_source_v3").
|
||||
WithInputSettings(map[string]any{
|
||||
@ -90,6 +102,37 @@ func setup(client *goobs.Client) {
|
||||
}).
|
||||
WithSceneItemEnabled(true))
|
||||
|
||||
// ensure Desktop Audio input is created
|
||||
desktopAudioKinds := map[string]string{
|
||||
"windows": "wasapi_output_capture",
|
||||
"linux": "pulse_output_capture",
|
||||
"darwin": "coreaudio_output_capture",
|
||||
}
|
||||
platform := os.Getenv("GOBS_TEST_PLATFORM")
|
||||
if platform == "" {
|
||||
platform = runtime.GOOS
|
||||
}
|
||||
client.Inputs.CreateInput(inputs.NewCreateInputParams().
|
||||
WithSceneName("gobs-test-scene").
|
||||
WithInputName("Desktop Audio").
|
||||
WithInputKind(desktopAudioKinds[platform]).
|
||||
WithInputSettings(map[string]any{
|
||||
"device_id": "default",
|
||||
}))
|
||||
// ensure Mic/Aux input is created
|
||||
micKinds := map[string]string{
|
||||
"windows": "wasapi_input_capture",
|
||||
"linux": "pulse_input_capture",
|
||||
"darwin": "coreaudio_input_capture",
|
||||
}
|
||||
client.Inputs.CreateInput(inputs.NewCreateInputParams().
|
||||
WithSceneName("gobs-test-scene").
|
||||
WithInputName("Mic/Aux").
|
||||
WithInputKind(micKinds[platform]).
|
||||
WithInputSettings(map[string]any{
|
||||
"device_id": "default",
|
||||
}))
|
||||
|
||||
// Create source filter on an audio input
|
||||
client.Filters.CreateSourceFilter(filters.NewCreateSourceFilterParams().
|
||||
WithSourceName("Mic/Aux").
|
||||
@ -106,7 +149,7 @@ func setup(client *goobs.Client) {
|
||||
|
||||
// Create source filter on a scene
|
||||
client.Filters.CreateSourceFilter(filters.NewCreateSourceFilterParams().
|
||||
WithSourceName("gobs-test").
|
||||
WithSourceName("gobs-test-scene").
|
||||
WithFilterName("test_filter").
|
||||
WithFilterKind("luma_key_filter_v2").
|
||||
WithFilterSettings(map[string]any{
|
||||
@ -115,18 +158,21 @@ func setup(client *goobs.Client) {
|
||||
}
|
||||
|
||||
func teardown(client *goobs.Client) {
|
||||
client.Config.RemoveProfile(config.NewRemoveProfileParams().
|
||||
WithProfileName("gobs-test-profile"))
|
||||
|
||||
client.Filters.RemoveSourceFilter(filters.NewRemoveSourceFilterParams().
|
||||
WithSourceName("Mic/Aux").
|
||||
WithFilterName("test_filter"))
|
||||
client.Filters.RemoveSourceFilter(filters.NewRemoveSourceFilterParams().
|
||||
WithSourceName("gobs-test").
|
||||
WithSourceName("gobs-test-scene").
|
||||
WithFilterName("test_filter"))
|
||||
|
||||
client.Scenes.RemoveScene(scenes.NewRemoveSceneParams().
|
||||
WithSceneName("gobs-test"))
|
||||
WithSceneName("gobs-test-scene"))
|
||||
|
||||
client.Config.SetCurrentSceneCollection(config.NewSetCurrentSceneCollectionParams().
|
||||
WithSceneCollectionName("default"))
|
||||
WithSceneCollectionName("Untitled"))
|
||||
|
||||
client.Stream.StopStream()
|
||||
client.Record.StopRecord()
|
||||
|
||||
68
record.go
68
record.go
@ -4,6 +4,7 @@ import (
|
||||
"fmt"
|
||||
|
||||
"github.com/andreykaipov/goobs/api/requests/config"
|
||||
"github.com/andreykaipov/goobs/api/requests/record"
|
||||
)
|
||||
|
||||
// RecordCmd handles the recording commands.
|
||||
@ -15,6 +16,8 @@ type RecordCmd struct {
|
||||
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"`
|
||||
Split RecordSplitCmd `cmd:"" help:"Split recording." aliases:"sp"`
|
||||
Chapter RecordChapterCmd `cmd:"" help:"Create a chapter in the recording." aliases:"c"`
|
||||
}
|
||||
|
||||
// RecordStartCmd starts the recording.
|
||||
@ -187,3 +190,68 @@ func (cmd *RecordDirectoryCmd) Run(ctx *context) error {
|
||||
fmt.Fprintf(ctx.Out, "Recording directory set to: %s\n", ctx.Style.Highlight(cmd.RecordDirectory))
|
||||
return nil
|
||||
}
|
||||
|
||||
// RecordSplitCmd splits the current recording.
|
||||
type RecordSplitCmd struct{} // size = 0x0
|
||||
|
||||
// Run executes the command to split the recording.
|
||||
func (cmd *RecordSplitCmd) 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")
|
||||
}
|
||||
if status.OutputPaused {
|
||||
return fmt.Errorf("recording is paused, cannot split")
|
||||
}
|
||||
|
||||
_, err = ctx.Client.Record.SplitRecordFile()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
fmt.Fprintln(ctx.Out, "Recording split successfully.")
|
||||
return nil
|
||||
}
|
||||
|
||||
// RecordChapterCmd creates a chapter in the recording.
|
||||
type RecordChapterCmd struct {
|
||||
ChapterName string `arg:"" help:"Name of the chapter to create." default:""`
|
||||
}
|
||||
|
||||
// Run executes the command to create a chapter in the recording.
|
||||
func (cmd *RecordChapterCmd) 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")
|
||||
}
|
||||
if status.OutputPaused {
|
||||
return fmt.Errorf("recording is paused, cannot create chapter")
|
||||
}
|
||||
|
||||
var params *record.CreateRecordChapterParams
|
||||
if cmd.ChapterName == "" {
|
||||
params = record.NewCreateRecordChapterParams()
|
||||
} else {
|
||||
params = record.NewCreateRecordChapterParams().WithChapterName(cmd.ChapterName)
|
||||
}
|
||||
|
||||
_, err = ctx.Client.Record.CreateRecordChapter(params)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if cmd.ChapterName == "" {
|
||||
cmd.ChapterName = "unnamed"
|
||||
}
|
||||
|
||||
fmt.Fprintf(ctx.Out, "Chapter %s created successfully.\n", ctx.Style.Highlight(cmd.ChapterName))
|
||||
return nil
|
||||
}
|
||||
|
||||
@ -44,7 +44,7 @@ func TestRecordStart(t *testing.T) {
|
||||
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
|
||||
time.Sleep(500 * time.Millisecond) // Wait for the recording to start
|
||||
}
|
||||
|
||||
func TestRecordStop(t *testing.T) {
|
||||
@ -84,7 +84,7 @@ func TestRecordStop(t *testing.T) {
|
||||
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
|
||||
time.Sleep(500 * time.Millisecond) // Wait for the recording to stop
|
||||
}
|
||||
|
||||
func TestRecordToggle(t *testing.T) {
|
||||
@ -112,8 +112,6 @@ func TestRecordToggle(t *testing.T) {
|
||||
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())
|
||||
@ -123,4 +121,5 @@ func TestRecordToggle(t *testing.T) {
|
||||
t.Fatalf("Expected output to be 'Recording started successfully.', got '%s'", out.String())
|
||||
}
|
||||
}
|
||||
time.Sleep(500 * time.Millisecond) // Wait for the toggle to take effect
|
||||
}
|
||||
|
||||
@ -2,11 +2,21 @@ package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
func skipIfSkipReplayBufferTests(t *testing.T) {
|
||||
if os.Getenv("GOBS_TEST_SKIP_REPLAYBUFFER_TESTS") != "" {
|
||||
t.Skip("Skipping replay buffer tests due to GOBS_TEST_SKIP_REPLAYBUFFER_TESTS environment variable")
|
||||
}
|
||||
}
|
||||
|
||||
func TestReplayBufferStart(t *testing.T) {
|
||||
skipIfSkipReplayBufferTests(t)
|
||||
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
@ -21,9 +31,12 @@ func TestReplayBufferStart(t *testing.T) {
|
||||
if out.String() != "Replay buffer started.\n" {
|
||||
t.Fatalf("Expected output to be 'Replay buffer started', got '%s'", out.String())
|
||||
}
|
||||
time.Sleep(500 * time.Millisecond) // Wait for the replay buffer to start
|
||||
}
|
||||
|
||||
func TestReplayBufferStop(t *testing.T) {
|
||||
skipIfSkipReplayBufferTests(t)
|
||||
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
@ -38,9 +51,12 @@ func TestReplayBufferStop(t *testing.T) {
|
||||
if out.String() != "Replay buffer stopped.\n" {
|
||||
t.Fatalf("Expected output to be 'Replay buffer stopped.', got '%s'", out.String())
|
||||
}
|
||||
time.Sleep(500 * time.Millisecond) // Wait for the replay buffer to stop
|
||||
}
|
||||
|
||||
func TestReplayBufferToggle(t *testing.T) {
|
||||
skipIfSkipReplayBufferTests(t)
|
||||
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
@ -73,4 +89,5 @@ func TestReplayBufferToggle(t *testing.T) {
|
||||
t.Fatalf("Expected output to be 'Replay buffer started.', got '%s'", out.String())
|
||||
}
|
||||
}
|
||||
time.Sleep(500 * time.Millisecond) // Wait for the toggle to take effect
|
||||
}
|
||||
|
||||
@ -17,8 +17,8 @@ func TestSceneList(t *testing.T) {
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to list scenes: %v", err)
|
||||
}
|
||||
if out.String() == "Current program scene: gobs-test\n" {
|
||||
t.Fatalf("Expected output to be 'Current program scene: gobs-test', got '%s'", out.String())
|
||||
if out.String() == "Current program scene: gobs-test-scene\n" {
|
||||
t.Fatalf("Expected output to be 'Current program scene: gobs-test-scene', got '%s'", out.String())
|
||||
}
|
||||
}
|
||||
|
||||
@ -29,9 +29,9 @@ func TestSceneCurrent(t *testing.T) {
|
||||
var out bytes.Buffer
|
||||
context := newContext(client, &out, StyleConfig{})
|
||||
|
||||
// Set the current scene to "gobs-test"
|
||||
// Set the current scene to "gobs-test-scene"
|
||||
cmdSwitch := &SceneSwitchCmd{
|
||||
NewScene: "gobs-test",
|
||||
NewScene: "gobs-test-scene",
|
||||
}
|
||||
err := cmdSwitch.Run(context)
|
||||
if err != nil {
|
||||
@ -45,7 +45,7 @@ func TestSceneCurrent(t *testing.T) {
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get current scene: %v", err)
|
||||
}
|
||||
if out.String() != "Current program scene: gobs-test\n" {
|
||||
t.Fatalf("Expected output to be 'Current program scene: gobs-test', got '%s'", out.String())
|
||||
if out.String() != "Current program scene: gobs-test-scene\n" {
|
||||
t.Fatalf("Expected output to be 'Current program scene: gobs-test-scene', got '%s'", out.String())
|
||||
}
|
||||
}
|
||||
|
||||
@ -59,7 +59,7 @@ func (cmd *SceneItemListCmd) Run(ctx *context) error {
|
||||
style := lipgloss.NewStyle().Padding(0, 3)
|
||||
switch col {
|
||||
case 0:
|
||||
style = style.Align(lipgloss.Left)
|
||||
style = style.Align(lipgloss.Center)
|
||||
case 1:
|
||||
style = style.Align(lipgloss.Left)
|
||||
case 2:
|
||||
|
||||
@ -14,7 +14,7 @@ func TestSceneItemList(t *testing.T) {
|
||||
context := newContext(client, &out, StyleConfig{})
|
||||
|
||||
cmd := &SceneItemListCmd{
|
||||
SceneName: "gobs-test",
|
||||
SceneName: "gobs-test-scene",
|
||||
}
|
||||
err := cmd.Run(context)
|
||||
if err != nil {
|
||||
|
||||
@ -43,7 +43,7 @@ func TestStreamStart(t *testing.T) {
|
||||
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
|
||||
time.Sleep(500 * time.Millisecond) // Wait for the stream to start
|
||||
}
|
||||
|
||||
func TestStreamStop(t *testing.T) {
|
||||
@ -82,7 +82,7 @@ func TestStreamStop(t *testing.T) {
|
||||
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
|
||||
time.Sleep(500 * time.Millisecond) // Wait for the stream to stop
|
||||
}
|
||||
|
||||
func TestStreamToggle(t *testing.T) {
|
||||
@ -119,5 +119,5 @@ func TestStreamToggle(t *testing.T) {
|
||||
t.Fatalf("Expected 'Stream started successfully.', got: %s", out.String())
|
||||
}
|
||||
}
|
||||
time.Sleep(2 * time.Second) // Wait for the stream to toggle
|
||||
time.Sleep(500 * time.Millisecond) // Wait for the stream to toggle
|
||||
}
|
||||
|
||||
85
text.go
Normal file
85
text.go
Normal file
@ -0,0 +1,85 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/andreykaipov/goobs/api/requests/inputs"
|
||||
)
|
||||
|
||||
// TextCmd provides commands for managing text inputs in OBS.
|
||||
type TextCmd struct {
|
||||
Current TextCurrentCmd `cmd:"current" help:"Display current text for a text input." aliases:"c"`
|
||||
Update TextUpdateCmd `cmd:"update" help:"Update the text of a text input." aliases:"u"`
|
||||
}
|
||||
|
||||
// TextCurrentCmd provides a command to display the current text of a text input.
|
||||
type TextCurrentCmd struct {
|
||||
InputName string `arg:"" help:"Name of the text source."`
|
||||
}
|
||||
|
||||
// Run executes the command to display the current text of a text input.
|
||||
func (cmd *TextCurrentCmd) Run(ctx *context) error {
|
||||
resp, err := ctx.Client.Inputs.GetInputSettings(
|
||||
inputs.NewGetInputSettingsParams().WithInputName(cmd.InputName),
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get input settings: %w", err)
|
||||
}
|
||||
|
||||
// Check if the input is a text input
|
||||
kind := resp.InputKind
|
||||
if !strings.HasPrefix(kind, "text_") {
|
||||
return fmt.Errorf("input %s is of %s", cmd.InputName, kind)
|
||||
}
|
||||
|
||||
currentText, ok := resp.InputSettings["text"]
|
||||
if !ok {
|
||||
return fmt.Errorf("input %s does not have a 'text' setting", cmd.InputName)
|
||||
}
|
||||
if currentText == "" {
|
||||
currentText = "(empty)"
|
||||
}
|
||||
fmt.Fprintf(
|
||||
ctx.Out,
|
||||
"Current text for source %s: %s\n",
|
||||
ctx.Style.Highlight(cmd.InputName),
|
||||
currentText,
|
||||
)
|
||||
return nil
|
||||
}
|
||||
|
||||
// TextUpdateCmd provides a command to update the text of a text input.
|
||||
type TextUpdateCmd struct {
|
||||
InputName string `arg:"" help:"Name of the text source."`
|
||||
NewText string `arg:"" help:"New text to set for the source." default:""`
|
||||
}
|
||||
|
||||
// Run executes the command to update the text of a text input.
|
||||
func (cmd *TextUpdateCmd) Run(ctx *context) error {
|
||||
resp, err := ctx.Client.Inputs.GetInputSettings(
|
||||
inputs.NewGetInputSettingsParams().WithInputName(cmd.InputName),
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get input settings: %w", err)
|
||||
}
|
||||
|
||||
// Check if the input is a text input
|
||||
kind := resp.InputKind
|
||||
if !strings.HasPrefix(kind, "text_") {
|
||||
return fmt.Errorf("input %s is of %s", cmd.InputName, kind)
|
||||
}
|
||||
|
||||
if _, err := ctx.Client.Inputs.SetInputSettings(&inputs.SetInputSettingsParams{
|
||||
InputName: &cmd.InputName,
|
||||
InputSettings: map[string]any{"text": &cmd.NewText},
|
||||
}); err != nil {
|
||||
return fmt.Errorf("failed to update text for source %s: %w", cmd.InputName, err)
|
||||
}
|
||||
|
||||
if cmd.NewText == "" {
|
||||
cmd.NewText = "(empty)"
|
||||
}
|
||||
fmt.Fprintf(ctx.Out, "Updated text for source %s to: %s\n", ctx.Style.Highlight(cmd.InputName), cmd.NewText)
|
||||
return nil
|
||||
}
|
||||
30
version.go
30
version.go
@ -2,38 +2,8 @@ package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"runtime/debug"
|
||||
"strings"
|
||||
|
||||
"github.com/alecthomas/kong"
|
||||
)
|
||||
|
||||
var version string
|
||||
|
||||
// VersionFlag is a custom flag type for displaying version information.
|
||||
type VersionFlag string
|
||||
|
||||
// Decode implements the kong.Flag interface.
|
||||
func (v VersionFlag) Decode(_ *kong.DecodeContext) error { return nil }
|
||||
|
||||
// IsBool implements the kong.Flag interface.
|
||||
func (v VersionFlag) IsBool() bool { return true }
|
||||
|
||||
// BeforeApply implements the kong.Flag interface.
|
||||
func (v VersionFlag) BeforeApply(app *kong.Kong, _ kong.Vars) error { // nolint: unparam
|
||||
if version == "" {
|
||||
info, ok := debug.ReadBuildInfo()
|
||||
if !ok {
|
||||
return fmt.Errorf("failed to read build info")
|
||||
}
|
||||
version = strings.Split(info.Main.Version, "-")[0]
|
||||
}
|
||||
|
||||
fmt.Printf("gobs-cli version: %s\n", version)
|
||||
app.Exit(0) // Exit the application after printing the version
|
||||
return nil
|
||||
}
|
||||
|
||||
// ObsVersionCmd handles the version command.
|
||||
type ObsVersionCmd struct{} // size = 0x0
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user